diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/live | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/live')
| -rw-r--r-- | data/zh_cn/live/2016-11-01/api-docs.php | 77864 |
1 files changed, 77864 insertions, 0 deletions
diff --git a/data/zh_cn/live/2016-11-01/api-docs.php b/data/zh_cn/live/2016-11-01/api-docs.php new file mode 100644 index 0000000..7cfd5a3 --- /dev/null +++ b/data/zh_cn/live/2016-11-01/api-docs.php @@ -0,0 +1,77864 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'live', + 'version' => '2016-11-01', + ], + 'directories' => [ + [ + 'id' => 387610, + 'title' => '域名管理', + 'type' => 'directory', + 'children' => [ + 'AddLiveDomain', + 'AddLiveDomainPlayMapping', + 'DeleteLiveDomainPlayMapping', + 'AddLiveDomainMapping', + 'DeleteLiveDomain', + 'DeleteLiveDomainMapping', + 'DescribeLiveDomainMapping', + 'DescribeLiveDomainDetail', + 'DescribeLiveUserDomains', + 'StartLiveDomain', + 'StopLiveDomain', + 'DescribeLiveCertificateDetail', + 'DescribeLiveDomainCertificateInfo', + 'DescribeLiveCertificateList', + 'SetLiveDomainCertificate', + 'BatchDeleteLiveDomainConfigs', + 'BatchSetLiveDomainConfigs', + 'DescribeLiveDomainConfigs', + 'DescribeLiveDomainByCertificate', + 'DescribeLiveHttpsDomainList', + 'ModifyLiveDomainSchdmByProperty', + 'DescribeLiveUserTags', + 'VerifyLiveDomainOwner', + 'DescribeLiveVerifyContent', + 'ChangeLiveDomainResourceGroup', + ], + ], + [ + 'id' => 387636, + 'title' => '直播预热', + 'type' => 'directory', + 'children' => [ + 'SetLiveStreamPreloadTasks', + 'DescribeLiveStreamPreloadTasks', + 'HotLiveRtcStream', + ], + ], + [ + 'id' => 387640, + 'title' => '直播拉流', + 'type' => 'directory', + 'children' => [ + 'AddLivePullStreamInfoConfig', + 'DescribeLivePullStreamConfig', + 'DeleteLivePullStreamInfoConfig', + 'SetLiveLazyPullStreamInfoConfig', + 'DescribeLiveLazyPullStreamConfig', + 'DeleteLiveLazyPullStreamInfoConfig', + 'UpdateLivePullStreamInfoConfig', + ], + ], + [ + 'id' => 387648, + 'title' => '直播流管理', + 'type' => 'directory', + 'children' => [ + 'DescribeLiveStreamsBlockList', + 'DescribeLiveStreamsControlHistory', + 'DescribeLiveStreamBitRateData', + 'DescribeLiveStreamsOnlineList', + 'DescribeLiveStreamsPublishList', + 'ForbidLiveStream', + 'ResumeLiveStream', + 'DescribeLiveDomainOnlineUserNum', + 'DescribeLiveDomainFrameRateAndBitRateData', + 'DescribeLiveDomainLimit', + 'DescribeLiveStreamState', + ], + ], + [ + 'id' => 387660, + 'title' => '主备合流 ', + 'type' => 'directory', + 'children' => [ + 'DeleteLiveStreamMerge', + 'AddLiveStreamMerge', + 'DescribeLiveStreamMerge', + ], + ], + [ + 'id' => 387664, + 'title' => '直播延播', + 'type' => 'directory', + 'children' => [ + 'DeleteLiveDelayConfig', + 'UpdateLiveDelayConfig', + 'DescribeLiveDelayConfig', + 'ListLiveDelayConfig', + 'CreateLiveDelayConfig', + ], + ], + [ + 'id' => 387670, + 'title' => '推流回调', + 'type' => 'directory', + 'children' => [ + 'SetLiveStreamsNotifyUrlConfig', + 'DescribeLiveStreamsNotifyUrlConfig', + 'DeleteLiveStreamsNotifyUrlConfig', + 'DescribeLiveStreamsNotifyRecords', + ], + ], + [ + 'id' => 387675, + 'title' => '直播安全', + 'type' => 'directory', + 'children' => [ + 'DeleteLiveStreamBlock', + 'SetLiveStreamBlock', + 'DescribeStreamLocationBlock', + ], + ], + [ + 'id' => 387679, + 'title' => '直播时移', + 'type' => 'directory', + 'children' => [ + 'DescribeLiveShiftConfigs', + 'OpenLiveShift', + 'CloseLiveShift', + ], + ], + [ + 'id' => 387683, + 'title' => '直播转码', + 'type' => 'directory', + 'children' => [ + 'AddLiveStreamTranscode', + 'AddCustomLiveStreamTranscode', + 'AddRtsLiveStreamTranscode', + 'UpdateCustomLiveStreamTranscode', + 'UpdateLiveStreamTranscode', + 'UpdateRtsLiveStreamTranscode', + 'DeleteLiveStreamTranscode', + 'DescribeLiveStreamTranscodeInfo', + 'AddTrancodeSEI', + ], + ], + [ + 'id' => 387693, + 'title' => '直播录制存储至VOD', + 'type' => 'directory', + 'children' => [ + 'AddLiveRecordVodConfig', + 'UpdateLiveRecordVodConfig', + 'DeleteLiveRecordVodConfig', + 'DescribeLiveRecordVodConfigs', + ], + ], + [ + 'id' => 387698, + 'title' => '直播录制存储至OSS', + 'type' => 'directory', + 'children' => [ + 'AddLiveAppRecordConfig', + 'RealTimeRecordCommand', + 'UpdateLiveAppRecordConfig', + 'DeleteLiveAppRecordConfig', + 'DeleteLiveStreamRecordIndexFiles', + 'DescribeLiveRecordConfig', + 'DescribeLiveStreamRecordContent', + 'CreateLiveStreamRecordIndexFiles', + 'DescribeLiveStreamRecordIndexFile', + 'DescribeLiveStreamRecordIndexFiles', + 'AddLiveRecordNotifyConfig', + 'DeleteLiveRecordNotifyConfig', + 'DescribeLiveRecordNotifyConfig', + 'UpdateLiveRecordNotifyConfig', + 'DescribeLiveRecordNotifyRecords', + ], + ], + [ + 'id' => 387714, + 'title' => '直播截图', + 'type' => 'directory', + 'children' => [ + 'AddLiveAppSnapshotConfig', + 'DeleteLiveAppSnapshotConfig', + 'DeleteSnapshotFiles', + 'DescribeLiveSnapshotConfig', + 'UpdateLiveAppSnapshotConfig', + 'DescribeLiveStreamSnapshotInfo', + 'DescribeLiveSnapshotNotifyConfig', + 'DeleteLiveSnapshotNotifyConfig', + 'AddLiveSnapshotNotifyConfig', + 'UpdateLiveSnapshotNotifyConfig', + 'SetSnapshotCallbackAuth', + 'QuerySnapshotCallbackAuth', + 'DeleteSnapshotCallbackAuth', + ], + ], + [ + 'id' => 387728, + 'title' => '直播封装', + 'type' => 'directory', + 'children' => [ + 'AddLivePackageConfig', + 'UpdateLivePackageConfig', + 'DescribeLivePackageConfig', + 'DeleteLivePackageConfig', + ], + ], + [ + 'id' => 387733, + 'title' => '直播审核', + 'type' => 'directory', + 'children' => [ + 'AddLiveSnapshotDetectPornConfig', + 'AddLiveDetectNotifyConfig', + 'DescribeLiveSnapshotDetectPornConfig', + 'DescribeLiveDetectNotifyConfig', + 'UpdateLiveSnapshotDetectPornConfig', + 'UpdateLiveDetectNotifyConfig', + 'DeleteLiveSnapshotDetectPornConfig', + 'DeleteLiveDetectNotifyConfig', + 'AddLiveAudioAuditConfig', + 'AddLiveAudioAuditNotifyConfig', + 'DeleteLiveAudioAuditConfig', + 'DeleteLiveAudioAuditNotifyConfig', + 'UpdateLiveAudioAuditNotifyConfig', + 'UpdateLiveAudioAuditConfig', + 'DescribeLiveAudioAuditConfig', + 'DescribeLiveAudioAuditNotifyConfig', + ], + ], + [ + 'id' => 387750, + 'title' => '全球加速', + 'type' => 'directory', + 'children' => [ + 'CreateLivePrivateLine', + 'DeleteLivePrivateLine', + 'DescribeLivePrivateLineAreas', + 'DescribeLivePrivateLineAvailGA', + ], + ], + [ + 'id' => 387755, + 'title' => '直播延迟', + 'type' => 'directory', + 'children' => [ + 'DescribeLiveStreamDelayConfig', + 'SetLiveStreamDelayConfig', + ], + ], + [ + 'id' => 387758, + 'title' => '监控统计', + 'type' => 'directory', + 'children' => [ + 'DescribeLiveDomainBpsData', + 'DescribeLiveDomainTrafficData', + 'DescribeLiveStreamTranscodeMetricData', + 'DescribeLiveCenterStreamRateData', + 'DescribeLiveDomainBpsDataByLayer', + 'DescribeLiveDomainPushBpsData', + 'DescribeLiveDomainPushTrafficData', + 'DescribeLiveStreamPushMetricDetailData', + 'DescribeLiveDomainPublishErrorCode', + 'DescribeLiveUpVideoAudioInfo', + 'DescribeLiveDomainRealTimeBpsData', + 'DescribeLiveDomainRealTimeTrafficData', + 'DescribeLiveDomainRealTimeHttpCodeData', + 'DescribeLiveStreamHistoryUserNum', + 'DescribeLiveStreamCount', + 'DescribeLiveStreamTranscodeStreamNum', + 'DescribeLiveDomainPvUvData', + 'DescribeLiveTopDomainsByFlow', + 'DescribeLiveStreamsTotalCount', + 'DescribeLiveStreamMetricDetailData', + 'DescribeLiveStreamDetailFrameRateAndBitRateData', + 'DescribeLiveUserStreamMetricData', + ], + ], + [ + 'id' => 387781, + 'title' => '用量查询', + 'type' => 'directory', + 'children' => [ + 'DescribeLiveDomainRecordUsageData', + 'DescribeLiveDomainSnapshotData', + 'DescribeLiveDetectPornData', + 'DescribeDomainUsageData', + 'DescribeLivePushProxyUsageData', + 'DescribeLiveRealtimeDeliveryAcc', + 'DescribeLiveDomainTimeShiftData', + 'DescribeLiveDomainStreamTranscodeData', + 'DescribeLiveProducerUsageData', + 'DescribeLiveDomainMonitoringUsageData', + 'DescribeLiveDelayedStreamingUsage', + 'DescribeLiveGrtnDuration', + 'DescribeMeterLiveBypassDuration', + 'DescribeLiveDrmUsageData', + 'DescribeLiveRtcRecordUsageData', + ], + ], + [ + 'id' => 387797, + 'title' => '云导播', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 387798, + 'title' => '导播台管理', + 'type' => 'directory', + 'children' => [ + 'CreateCaster', + 'SetCasterConfig', + 'DescribeCasterConfig', + 'DescribeCasters', + 'DescribeCasterStreamUrl', + 'CopyCaster', + 'StartCaster', + 'StopCaster', + 'DeleteCaster', + 'RestartCaster', + 'UpdateCasterResourceGroup', + ], + ], + [ + 'id' => 387810, + 'title' => '输入源媒体管理', + 'type' => 'directory', + 'children' => [ + 'AddCasterVideoResource', + 'DeleteCasterVideoResource', + 'ModifyCasterVideoResource', + 'DescribeCasterVideoResources', + ], + ], + [ + 'id' => 387815, + 'title' => '布局管理', + 'type' => 'directory', + 'children' => [ + 'AddCasterLayout', + 'DeleteCasterLayout', + 'ModifyCasterLayout', + 'DescribeCasterLayouts', + ], + ], + [ + 'id' => 387820, + 'title' => '组件管理', + 'type' => 'directory', + 'children' => [ + 'AddCasterComponent', + 'DeleteCasterComponent', + 'ModifyCasterComponent', + 'DescribeCasterComponents', + ], + ], + [ + 'id' => 387825, + 'title' => '场景与音频管理', + 'type' => 'directory', + 'children' => [ + 'CopyCasterSceneConfig', + 'DeleteCasterSceneConfig', + 'UpdateCasterSceneConfig', + 'SetCasterSceneConfig', + 'DescribeCasterScenes', + 'UpdateCasterSceneAudio', + 'DescribeCasterSceneAudio', + 'StartCasterScene', + 'StopCasterScene', + ], + ], + [ + 'id' => 387835, + 'title' => '通道管理', + 'type' => 'directory', + 'children' => [ + 'SetCasterChannel', + 'DescribeCasterChannels', + ], + ], + [ + 'id' => 387838, + 'title' => '备播管理', + 'type' => 'directory', + 'children' => [ + 'EffectCasterUrgent', + 'EffectCasterVideoResource', + ], + ], + [ + 'id' => 387841, + 'title' => '新播单型导播台管理', + 'type' => 'directory', + 'children' => [ + 'AddShowIntoShowList', + 'RemoveShowFromShowList', + 'ModifyShowList', + 'DescribeShowList', + 'PlayChoosenShow', + 'InitializeAutoShowListTask', + 'DescribeAutoShowListTasks', + 'EditShowAndReplace', + 'GetEditingJobInfo', + 'SetShowListBackground', + ], + ], + [ + 'id' => 387852, + 'title' => '虚拟演播厅管理', + 'type' => 'directory', + 'children' => [ + 'AddStudioLayout', + 'DeleteStudioLayout', + 'ModifyStudioLayout', + 'DescribeStudioLayouts', + ], + ], + [ + 'id' => 387857, + 'title' => '（旧）播单型导播台', + 'type' => 'directory', + 'children' => [ + 'AddCasterEpisode', + 'DeleteCasterEpisode', + 'ModifyCasterEpisode', + 'AddCasterEpisodeGroup', + 'DeleteCasterEpisodeGroup', + 'AddCasterEpisodeGroupContent', + 'AddCasterProgram', + 'DescribeCasterProgram', + 'ModifyCasterProgram', + 'DeleteCasterProgram', + 'AddPlaylistItems', + 'DeletePlaylistItems', + 'ListPlaylistItems', + 'EditPlaylist', + 'DeletePlaylist', + 'ListPlaylist', + 'StartPlaylist', + 'StopPlaylist', + ], + ], + ], + ], + [ + 'id' => 387876, + 'title' => '云端合流', + 'type' => 'directory', + 'children' => [ + 'CreateMixStream', + 'UpdateMixStream', + 'DescribeMixStreamList', + 'DeleteMixStream', + 'CreateCustomTemplate', + 'DeleteCustomTemplate', + 'GetCustomTemplate', + 'GetAllCustomTemplates', + ], + ], + [ + 'id' => 387885, + 'title' => '直播水印', + 'type' => 'directory', + 'children' => [ + 'AddLiveStreamWatermark', + 'DeleteLiveStreamWatermark', + 'UpdateLiveStreamWatermark', + 'DynamicUpdateWaterMarkStreamRule', + 'DescribeLiveStreamWatermarks', + 'AddLiveStreamWatermarkRule', + 'DeleteLiveStreamWatermarkRule', + 'UpdateLiveStreamWatermarkRule', + 'DescribeLiveStreamWatermarkRules', + ], + ], + [ + 'id' => 387895, + 'title' => '边缘转码', + 'type' => 'directory', + 'children' => [ + 'ListEdgeTranscodeTemplate', + 'GetEdgeTranscodeTemplate', + 'CreateEdgeTranscodeJob', + 'DeleteEdgeTranscodeJob', + 'ListEdgeTranscodeJob', + 'GetEdgeTranscodeJob', + 'UpdateEdgeTranscodeJob', + 'StartEdgeTranscodeJob', + 'StopEdgeTranscodeJob', + ], + ], + [ + 'id' => 387905, + 'title' => '直播日志', + 'type' => 'directory', + 'children' => [ + 'EnableLiveRealtimeLogDelivery', + 'DisableLiveRealtimeLogDelivery', + 'ModifyLiveRealtimeLogDelivery', + 'CreateLiveRealTimeLogDelivery', + 'DeleteLiveRealtimeLogDelivery', + 'DescribeLiveDomainRealtimeLogDelivery', + 'ListLiveRealtimeLogDelivery', + 'ListLiveRealtimeLogDeliveryDomains', + 'ListLiveRealtimeLogDeliveryInfos', + 'DescribeLivePushProxyLog', + 'DeleteLiveRealTimeLogLogstore', + 'DescribeLiveDomainLog', + ], + ], + [ + 'id' => 387918, + 'title' => '直播监播', + 'type' => 'directory', + 'children' => [ + 'CreateLiveStreamMonitor', + 'UpdateLiveStreamMonitor', + 'DescribeLiveStreamMonitorList', + 'StartLiveStreamMonitor', + 'StopLiveStreamMonitor', + 'DeleteLiveStreamMonitor', + ], + ], + [ + 'id' => 387925, + 'title' => '互动消息服务端接口', + 'type' => 'directory', + 'children' => [ + 'GetMessageToken', + 'CreateMessageApp', + 'UpdateMessageApp', + 'ListMessageApp', + 'GetMessageApp', + 'QueryMessageApp', + 'DeleteMessageApp', + 'CreateMessageGroup', + 'UpdateMessageGroup', + 'ListMessageGroupUser', + 'ListMessageGroup', + 'GetMessageGroup', + 'JoinMessageGroup', + 'MuteAllGroupUser', + 'MuteGroupUser', + 'CancelMuteGroupUser', + 'CancelMuteAllGroupUser', + 'LeaveMessageGroup', + 'SendLike', + 'SendMessageToGroup', + 'SendMessageToGroupUsers', + 'ListMessage', + 'ListMessageGroupUserById', + 'BatchGetOnlineUsers', + 'ListMuteGroupUser', + ], + ], + [ + 'id' => 387951, + 'title' => '互动消息（新）', + 'type' => 'directory', + 'children' => [ + 'CreateLiveMessageApp', + 'CreateLiveMessageGroup', + 'DescribeLiveMessageGroup', + 'ModifyLiveMessageGroup', + 'DeleteLiveMessageGroup', + 'ListLiveMessageGroups', + 'ListLiveMessageGroupByPage', + 'ModifyLiveMessageGroupBand', + 'DescribeLiveMessageGroupBand', + 'CheckLiveMessageUsersOnline', + 'CheckLiveMessageUsersInGroup', + 'ListLiveMessageGroupUsers', + 'ListLiveMessageGroupMessages', + 'UnbanLiveMessageGroup', + 'RecoverLiveMessageDeletedGroup', + 'BanLiveMessageGroup', + 'AddLiveMessageGroupBand', + 'RemoveLiveMessageGroupBand', + 'DeleteLiveMessageGroupMessage', + 'DeleteLiveMessageUserMessage', + 'SendLiveMessageGroup', + 'SendLiveMessageUser', + 'ListLiveMessageApps', + 'DescribeLiveMessageApp', + 'ModifyLiveMessageAppDisable', + 'ModifyLiveMessageAppAudit', + 'ModifyLiveMessageAppCallback', + 'KickLiveMessageGroupUser', + 'ModifyLiveMessageUserInfo', + ], + ], + [ + 'id' => 387981, + 'title' => '实时音视频', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 387982, + 'title' => '云端录制 ', + 'type' => 'directory', + 'children' => [ + 'StartRtcCloudRecording', + 'UpdateRtcCloudRecording', + 'StopRtcCloudRecording', + 'DescribeRtcCloudRecordingFiles', + ], + ], + [ + 'id' => 387987, + 'title' => '频道管理', + 'type' => 'directory', + 'children' => [ + 'DescribeChannelParticipants', + 'DescribeChannelUsers', + 'RemoveTerminals', + 'CreateRTCWhipStreamAddress', + 'CreateRoomRealTimeStreamAddress', + 'DeleteChannel', + 'ListRTCLiveRooms', + ], + ], + [ + 'id' => 387995, + 'title' => '旁路转推', + 'type' => 'directory', + 'children' => [ + 'StartLiveMPUTask', + 'UpdateLiveMPUTask', + 'StopLiveMPUTask', + 'ListRtcMPUTaskDetail', + 'SetLiveMpuTaskSei', + ], + ], + [ + 'id' => 388001, + 'title' => '事件回调', + 'type' => 'directory', + 'children' => [ + 'CreateEventSub', + 'ListEventSub', + 'ListEventSubEvent', + 'UpdateEventSub', + 'DeleteEventSub', + 'CreateRtcMPUEventSub', + 'UpdateRtcMPUEventSub', + 'DeleteRtcMPUEventSub', + 'DescribeRtcMPUEventSub', + 'ListRtcMPUEventSubRecord', + ], + ], + [ + 'id' => 388012, + 'title' => '质量数据', + 'type' => 'directory', + 'children' => [ + 'DescribeLiveInteractionMetricData', + ], + ], + [ + 'id' => 388014, + 'title' => '实时语音转文字/翻译', + 'type' => 'directory', + 'children' => [ + 'CreateRtcAsrTask', + 'QueryRtcAsrTasks', + 'StopRtcAsrTask', + 'DeleteRtcAsrTask', + ], + ], + ], + ], + [ + 'id' => 388019, + 'title' => '实时字幕', + 'type' => 'directory', + 'children' => [ + 'DeleteLiveAIProduceRules', + 'DescribeLiveAIProduceRules', + 'UpdateLiveAIProduceRules', + 'AddLiveAIProduceRules', + 'AddLiveAISubtitle', + 'DeleteLiveAISubtitle', + 'UpdateLiveAISubtitle', + 'DescribeLiveAISubtitle', + ], + ], + [ + 'id' => 388028, + 'title' => '虚拟背景', + 'type' => 'directory', + 'children' => [ + 'CreateLiveAIStudio', + 'DeleteLiveAIStudio', + 'ModifyLiveAIStudio', + 'DescribeLiveAIStudio', + ], + ], + [ + 'id' => 388033, + 'title' => '拉流转推 ', + 'type' => 'directory', + 'children' => [ + 'CreateLivePullToPush', + 'UpdateLivePullToPush', + 'DeleteLivePullToPush', + 'DescribeLivePullToPush', + 'DescribeLivePullToPushList', + 'StopLivePullToPush', + 'RestartLivePullToPush', + ], + ], + [ + 'id' => 388041, + 'title' => '双流灾备 ', + 'type' => 'directory', + 'children' => [ + 'SetLiveDomainMultiStreamConfig', + 'SetLiveDomainMultiStreamOptimalMode', + 'SetLiveDomainMultiStreamMaster', + 'DescribeLiveDomainMultiStreamConfig', + 'QueryLiveDomainMultiStreamList', + ], + ], + [ + 'id' => 388047, + 'title' => '边缘脚本', + 'type' => 'directory', + 'children' => [ + 'DescribeLiveDomainStagingConfig', + 'PublishLiveStagingConfigToProduction', + 'RollbackLiveStagingConfig', + 'SetLiveDomainStagingConfig', + 'DeleteLiveSpecificStagingConfig', + ], + ], + [ + 'id' => 388053, + 'title' => '工具箱', + 'type' => 'directory', + 'children' => [ + 'DescribeLiveIpInfo', + 'DescribeLiveStreamAuthChecking', + ], + ], + [ + 'id' => 388056, + 'title' => '标签管理', + 'type' => 'directory', + 'children' => [ + 'TagLiveResources', + 'UnTagLiveResources', + 'ListLiveTagResources', + 'DescribeLiveTagResources', + ], + ], + [ + 'id' => 388061, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 388062, + 'title' => '中心转推', + 'type' => 'directory', + 'children' => [ + 'AddLiveCenterTransfer', + 'UpdateLiveCenterTransfer', + 'DescribeLiveCenterTransfer', + 'DeleteLiveCenterTransfer', + ], + ], + [ + 'id' => 388067, + 'title' => '边缘转推', + 'type' => 'directory', + 'children' => [ + 'DescribeLiveEdgeTransfer', + 'DeleteLiveEdgeTransfer', + 'SetLiveEdgeTransfer', + ], + ], + 'DescribeLiveUserBillPrediction', + 'DescribeRTSNativeSDKFirstFrameCost', + 'DescribeRTSNativeSDKPlayTime', + 'DescribeRTSNativeSDKPlayFailStatus', + 'DescribeRTSNativeSDKFirstFrameDelay', + 'DescribeRTSNativeSDKVvData', + 'DescribeLiveRealtimeLogAuthorized', + 'DescribeUpBpsPeakData', + 'DescribeUpBpsPeakOfLine', + 'DescribeUpPeakPublishStreamData', + 'DescribeDomainWithIntegrity', + 'DescribeToutiaoLivePlay', + 'DescribeToutiaoLivePublish', + 'DescribeRtcCloudTranscode', + 'StartRtcCloudTranscode', + 'StopRtcCloudTranscode', + ], + ], + ], + 'components' => [ + 'schemas' => [ + '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', + ], + 'ItemId' => [ + 'title' => '应用标识', + 'type' => 'string', + ], + 'AppType' => [ + 'title' => '应用类型', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1-普通应用，2-内嵌SDK.', + ], + 'AppName' => [ + 'title' => '应用名称', + 'type' => 'string', + ], + ], + ], + 'LicenseInstanceAppDTO' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'ItemId' => [ + 'title' => 'itemId', + 'type' => 'string', + ], + 'UserId' => [ + 'title' => 'userId', + 'type' => 'integer', + 'format' => 'int64', + ], + 'BeginOn' => [ + 'title' => 'beginOn', + 'type' => 'string', + ], + 'ExpiredOn' => [ + 'title' => 'expiredOn', + 'type' => 'string', + ], + 'Status' => [ + 'title' => 'status', + 'type' => 'string', + ], + 'InstanceId' => [ + 'title' => 'instanceId', + 'type' => 'string', + ], + 'ContractNo' => [ + 'title' => 'contractNo', + 'type' => 'string', + ], + 'CreationTime' => [ + 'title' => 'creationTime', + 'type' => 'string', + ], + 'ModificationTime' => [ + 'title' => 'modificationTime', + 'type' => 'string', + ], + 'AppId' => [ + 'title' => 'appId', + 'type' => 'string', + ], + 'LicenseConfigs' => [ + 'title' => 'LicenseConfigDTOS', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SubscriptionImp' => [ + 'title' => 'subscriptionImp', + 'type' => 'string', + ], + 'SubscriptionPkg' => [ + 'title' => 'subscriptionPkg', + 'type' => 'string', + ], + 'SdkId' => [ + 'title' => 'sdkId', + 'type' => 'integer', + 'format' => 'int32', + ], + 'BusinessType' => [ + 'title' => 'businessType', + 'type' => 'string', + ], + 'SdkName' => [ + 'title' => 'sdkName', + 'type' => 'string', + ], + 'Subscription' => [ + 'title' => 'subscription', + 'type' => 'string', + ], + 'FeatureIds' => [ + 'title' => 'featureIds', + 'type' => 'string', + ], + 'IsTrial' => [ + 'title' => 'isTrial', + 'type' => 'boolean', + ], + ], + ], + 'required' => false, + ], + ], + ], + ], + ], + 'apis' => [ + 'AddLiveDomain' => [ + 'summary' => '调用该接口添加直播域名，一次只能提交一个域名。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '106844', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'LiveDomainType', + 'in' => 'query', + 'schema' => [ + 'description' => '域名业务类型。取值：'."\n" + ."\n" + .'- **liveVideo**：播流域名。如果选择DomainName（需要接入直播的域名）为播流域名时，则域名业务类型必须选择为liveVideo。'."\n" + .'- **liveEdge**：边缘推流域名。如果选择DomainName（需要接入直播的域名）为推流域名时，则域名业务类型必须选择为liveEdge。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'liveVideo', + 'enum' => [ + 'liveVideo', + 'liveEdge', + 'liveGrtnPub', + 'liveGrtnSub', + ], + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要接入直播的推流域名或播流域名。支持泛域名，以英文句号（.）开头。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'example.aliyundoc.com', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '直播域名单元化信息。取值：'."\n" + ."\n" + .'- **cn-beijing**：北京。'."\n" + .'- **cn-shanghai**：上海。'."\n" + .'- **cn-shenzhen**：深圳。'."\n" + .'- **cn-qingdao**：青岛。'."\n" + .'- **ap-southeast-1**：新加坡。'."\n" + .'- **eu-central-1**：德国。'."\n" + .'- **ap-northeast-1**：东京。'."\n" + .'- **ap-southeast-5**：雅加达。'."\n" + ."\n" + .'>Region（直播域名单元化信息）与Scope（加速区域）之间不存在相互限制。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'CheckUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '健康检测URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://demo.aliyundoc.com/status.html', + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'schema' => [ + 'description' => '加速区域。国际用户、中国站L3及以上用户设置有效。取值：'."\n" + ."\n" + .'- **domestic**（默认值）：中国内地。'."\n" + .'- **overseas**：海外及港澳台加速。'."\n" + .'- **global**：全球加速。', + 'type' => 'string', + 'required' => false, + 'example' => 'domestic', + ], + ], + [ + 'name' => 'TopLevelDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '顶级接入域。', + 'type' => 'string', + 'required' => false, + 'example' => 'learn.aliyundoc.com', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '', + 'description' => '资源组ID。关于资源组的更多信息，请参见[什么是资源组](~~2381067~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzw******', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签健。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'Specified DomainName is malformed.', + ], + [ + 'errorCode' => 'InvalidRegion.Malformed', + 'errorMessage' => 'Specified Region is malformed.', + ], + [ + 'errorCode' => 'InvalidSource.Content.Malformed', + 'errorMessage' => 'Specified source content is malformed.', + ], + [ + 'errorCode' => 'InvalidTypeContent.Mismatch', + 'errorMessage' => 'Specified source type does not math the specified source content.', + ], + [ + 'errorCode' => 'MissingSource.Content', + 'errorMessage' => 'Specified source content is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingSource.Type', + 'errorMessage' => 'Specified source type is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidSource.Type.Malformed', + 'errorMessage' => 'Specified source type is malformed.', + ], + [ + 'errorCode' => 'InvalidSource.Priority.Malformed', + 'errorMessage' => 'Specified source priority is malformed.', + ], + [ + 'errorCode' => 'InvalidScope.Malformed', + 'errorMessage' => 'Specified Scope is malformed.', + ], + [ + 'errorCode' => 'SourceIp.Exceed', + 'errorMessage' => 'The Certificate you provided is malformed!', + ], + [ + 'errorCode' => 'InvalidCertificate', + 'errorMessage' => 'The Certificate you provided is malformed!', + ], + [ + 'errorCode' => 'InvalidCertificate.TooLong', + 'errorMessage' => 'The Certificate you provided is over the max length!', + ], + [ + 'errorCode' => 'InnerAddDomainDenied', + 'errorMessage' => 'Your account haven\'t bind aoneId, can not add domain.', + ], + [ + 'errorCode' => 'CheckSourceHealthFailed', + 'errorMessage' => 'sources ip or source domain check health failed，please input right source.', + ], + [ + 'errorCode' => 'ExtensiveAndAllBothExist', + 'errorMessage' => 'Extensive domain and the domain begins with \'all.\' can not exist at the same time.', + ], + [ + 'errorCode' => 'CdnTypeNotSupportExtensiveDomain', + 'errorMessage' => 'Extensive domain not supported for this cdn type.', + ], + [ + 'errorCode' => 'ExtensiveAndSpecificDomainConflict', + 'errorMessage' => 'Extensive domain and corresponding specific domain are mutually exclusive.', + ], + [ + 'errorCode' => 'InvalidDomainNameLevel', + 'errorMessage' => 'Domain name suffixed with alicdn.com only support third level.', + ], + [ + 'errorCode' => 'TopLevelDomain.NotFound', + 'errorMessage' => 'TopLevelDomain is not exist.', + ], + [ + 'errorCode' => 'EntityNotExists.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + [ + 'errorCode' => 'InvalidStatus.ResourceGroup', + 'errorMessage' => 'It\'s now allowed to do this operation because of the current status of resource-group.', + ], + [ + 'errorCode' => 'NotInternationRealIdentity', + 'errorMessage' => 'You need to do real name authentication when you use Chinese mainland resources.', + ], + [ + 'errorCode' => 'RecordCheckNotAvailable', + 'errorMessage' => 'Please try again later.', + ], + [ + 'errorCode' => 'IcpBlack', + 'errorMessage' => 'The domain is on the ICP blacklist.', + ], + [ + 'errorCode' => 'IspBlack', + 'errorMessage' => 'The domain is on the ISP blacklist.', + ], + [ + 'errorCode' => 'DomainNotRecordedAliyun', + 'errorMessage' => 'The domain not access Ali Cloud for the record please access.', + ], + [ + 'errorCode' => 'Abs.CheckUrl.Malformed', + 'errorMessage' => 'The CheckUrl you provided is malformed!', + ], + [ + 'errorCode' => 'DomainOwnerVerifyFail', + 'errorMessage' => 'Owner verification of the root domain failed.', + ], + [ + 'errorCode' => 'TopLevelDomain.Mismatch', + 'errorMessage' => 'The specified TopLevelDomain does not match webSiteType.', + ], + [ + 'errorCode' => 'InvalidResourceGroupId.Malformed', + 'errorMessage' => 'Specified ResourceGroupId is malformed.', + ], + [ + 'errorCode' => 'DomainReserved', + 'errorMessage' => 'The root domain of your domain is reserved by another account.', + ], + [ + 'errorCode' => 'ExceedLimit', + 'errorMessage' => 'The number of domains has exceeded the limit.', + ], + [ + 'errorCode' => 'LockFail', + 'errorMessage' => 'Domain has been occupied.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccountException', + 'errorMessage' => 'Account exception. Please open ticket to make an appeal.', + ], + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + ], + [ + [ + 'errorCode' => 'InvalidUser', + 'errorMessage' => 'The user\'s account is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":"{\\n\\t\\"Code\\":\\"InternalError\\",\\n\\t\\"HostId\\":\\"live.aliyuncs.com\\",\\n\\t\\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n\\t\\"RequestId\\":\\"6EBD1AC4-C34D-4BE1-963E-B688A228BE31\\"\\n}\\n"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<AddLiveDomainResponse>\\r\\n\\t<RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>\\r\\n</AddLiveDomainResponse>","errorExample":"{\\n\\t\\"RequestId\\":\\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}\\n"}]', + 'title' => '添加直播域名', + 'description' => '- 添加直播域名之前，必须先开通视频直播服务。具体操作请参见[开通服务](~~195292~~)。'."\n" + .'- 添加新的域名时，必须先进行验证，再调用本接口添加域名。您可以选择DNS解析验证或文件验证。请参见[验证域名归属权](~~184466~~)。'."\n" + .'- 使用视频直播需要进行推流和播流，您需要分别添加推流域名和播流域名，一次只能提交一个域名。'."\n" + .'- 完成添加域名操作后，还需要对添加的域名进行CNAME解析，请参见[配置CNAME域名解析](~~84929~~)。'."\n" + ."\n" + .'- 在添加推流域名和播流域名后，您需要关联域名，才能使用视频直播服务，具体操作请参见[关联域名](~~199338~~)。'."\n" + ."\n" + .'><notice>从2019年2月19日起，通过AddLiveDomain添加的域名不支持中心推流的方式，通过CDN API添加的新域名同样不支持中心推流。请使用边缘推流添加一个推流域名（调用AddLiveDomain，业务类型为liveEdge），一个播流域名（调用AddLiveDomain，业务类型为liveVideo），并做关联（调用[AddLiveDomainMapping](~~2847792~~)），2019年2月19日之前添加的域名不受影响。'."\n" + .'></notice>'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddLiveDomainPlayMapping' => [ + 'summary' => '添加主播流域名和子播流域名映射。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106846', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'PlayDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '子播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.aliyundoc.com', + ], + ], + [ + 'name' => 'PullDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","type":"json"}]', + 'title' => '添加主播放和子播放域名映射', + 'description' => '先调用[AddLiveDomain接口](~~88327~~)添加主播流域名和子播流域名，才能调用本接口添加主播流域名和子播流域名映射。'."\n" + ."\n" + .'## QPS限制'."\n" + ."\n" + .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveDomainPlayMapping' => [ + 'summary' => '删除主播流域名和子播流域名的映射关系配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106928', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'PlayDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '子播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.aliyundoc.com', + ], + ], + [ + 'name' => 'PullDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveDomainPlayMappingResponse>\\r\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\r\\n</DeleteLiveDomainPlayMappingResponse>","errorExample":""}]', + 'title' => '删除播流域名的映射关系', + 'description' => '先添加主播流域名和子播流域名映射，才能调用本接口删除主播流域名和子播流域名的映射关系配置。使用API添加主播流域名和子播流域名映射，请参见[添加主播流域名和子播流域名映射](~~173091~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + ."\n" + .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddLiveDomainMapping' => [ + 'summary' => '添加直播域名播流域名和推流域名的映射关系配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '106845', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'PushDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '您的推流域名。域名类型为：**liveEdge**。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'PullDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '您的播流域名。域名类型为：**liveVideo**。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPushDomain', + 'errorMessage' => 'The PushDomain should be liveEdge type.', + ], + [ + 'errorCode' => 'InvalidPullDomain', + 'errorMessage' => 'The PullDomain should be liveVideo type.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<AddLiveDomainMappingResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</AddLiveDomainMappingResponse>","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\", \\n}"}]', + 'title' => '添加播流域名和推流域名的映射关系', + 'description' => '先调用[AddLiveDomain接口](~~2847789~~)添加播流域名和推流域名，才能调用本接口添加直播域名中播流域名和推流域名的映射关系配置。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveDomain' => [ + 'summary' => '删除本条直播域名的全部相关记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106925', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的推流或播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '94E3559F-7B6A-4A5E-AFFD-44E2A208A249', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specific value of parameter DomainName is malformed.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Delete live region parameters have error.', + ], + [ + 'errorCode' => 'InvalidOperation', + 'errorMessage' => 'Delete domain until configure compete.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94E3559F-7B6A-4A5E-AFFD-44E2A208A249\\"\\n}","type":"json"}]', + 'title' => '删除已添加的直播域名', + 'description' => '- DeleteLiveDomain调用成功后，将删除本条直播域名的全部相关记录，请谨慎操作。'."\n" + .'- 为了避免此域名不可访问，建议您在删除域名前到域名解析服务商处恢复域名A记录。如果您的域名注册商在阿里云，请登录[云解析DNS控制台](https://account.aliyun.com/login/login.htm?oauth_callback=https%3A%2F%2Fdns.console.aliyun.com%2F%3Fspm%3Da2c4g.11186623.0.0.3cda841fcvk7Qs&lang=zh)，导航到**域名解析**页面，找到域名后点击**解析设置**将CNAME修改为A记录。如果您的域名是在其他注册商，需前往域名所在注册商进行配置，配置方法与此相似。'."\n" + .'- 如果您仅需要暂停使用该直播域名，建议您使用[StopLiveDomain](~~2847799~~)接口。'."\n" + ."\n" + .'></notice>'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveDomainMapping' => [ + 'summary' => '删除直播域名播流域名和推流域名的映射关系配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '106927', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'PushDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名。域名类型为：**liveEdge**。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'PullDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。域名类型为：**liveVideo**。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPushDomain', + 'errorMessage' => 'The PushDomain should be liveEdge type.', + ], + [ + 'errorCode' => 'InvalidPullDomain', + 'errorMessage' => 'The PullDomain should be liveVideo type.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DeleteLiveDomainMappingResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteLiveDomainMappingResponse>","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\", \\n}"}]', + 'title' => '删除直播域名的映射关系', + 'description' => '先添加直播域名中播流域名和推流域名的映射关系配置，才能调用本接口删除直播域名中播流域名和推流域名的映射关系配置。使用API添加播流域名和推流域名的映射关系，请参见[添加播流域名和推流域名的映射关系](~~2847792~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + ."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveDomainMapping' => [ + 'summary' => '查询推流域名、主播流域名和子播流域名映射。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '您要查询的域名。域名可以是以下类型：'."\n" + ."\n" + .'- 推流域名。'."\n" + ."\n" + .'- 主播流域名。'."\n" + ."\n" + .'- 子播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F6CD8', + ], + 'LiveDomainModels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveDomainModel' => [ + 'description' => '直播域名映射列表。', + 'type' => 'array', + 'items' => [ + 'description' => '直播域名映射列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '查询域名的属性。取值：'."\n" + ."\n" + .'- **vhost**：主播流域名。'."\n" + .'- **publish**：推流域名。'."\n" + .'- **play**：子播流域名。', + 'type' => 'string', + 'example' => 'play', + ], + 'DomainName' => [ + 'description' => '查询域名的映射域名。', + 'type' => 'string', + 'example' => 'example.aliyundoc.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F6CD8\\",\\n \\"LiveDomainModels\\": {\\n \\"LiveDomainModel\\": [\\n {\\n \\"Type\\": \\"play\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDomainMappingResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F6CD8</RequestId>\\n <LiveDomainModels>\\n <Type>play</Type>\\n <DomainName>example.aliyundoc.com</DomainName>\\n </LiveDomainModels>\\n</DescribeLiveDomainMappingResponse>","errorExample":""}]', + 'title' => '查询直播域名映射', + 'description' => '先获取需要查询的推流域名、主播流域名和子播流域名，再调用本接口查询直播域名映射。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为500次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveDomainDetail' => [ + 'summary' => '查询指定推流域名或播流域名的基本配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107014', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播推流域名或播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DomainDetail' => [ + 'description' => '域名配置详情。', + 'type' => 'object', + 'properties' => [ + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'liveCert****', + ], + 'Cname' => [ + 'description' => 'CNAME域名。为直播域名生成一个CNAME域名，需要在域名解析服务商处将直播域名CNAME解析到该域名。'."\n" + .'>由于Local DNS的解析记录存在缓存时间，因此在配置域名的CNAME解析记录之后大约会延迟10分钟才会显示CNAME解析记录配置成功。详细内容，请参见[CNAME解析常见问题](~~362010~~)。', + 'type' => 'string', + 'example' => 'learn.developer.aliyundoc.com', + ], + 'Description' => [ + 'description' => '域名备注，说明信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'DomainName' => [ + 'description' => '直播推流域名或播流域名。', + 'type' => 'string', + 'example' => 'demo.aliyundoc.com', + ], + 'DomainStatus' => [ + 'description' => '直播域名运行状态。取值：'."\n" + ."\n" + .'- **online**：启用。'."\n" + .'- **offline**：停用。'."\n" + .'- **configuring**：配置中。', + 'type' => 'string', + 'example' => 'online', + ], + 'GmtCreated' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2018-07-27T06:51:25Z', + ], + 'GmtModified' => [ + 'description' => '最近修改时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2018-08-07T06:51Z', + ], + 'LiveDomainType' => [ + 'description' => '域名业务类型。取值：'."\n" + ."\n" + .'- **liveVideo**：播流域名。'."\n" + .'- **liveEdge**：边缘推流域名。', + 'type' => 'string', + 'example' => 'liveVideo', + ], + 'Region' => [ + 'description' => '域名所属地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'SSLProtocol' => [ + 'description' => '是否开启SSL证书。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'SSLPub' => [ + 'description' => '证书公钥。', + 'type' => 'string', + 'example' => 'Public Key', + ], + 'Scope' => [ + 'description' => '加速区域。取值：'."\n" + ."\n" + .'- **domestic**：中国内地。'."\n" + .'- **overseas**：海外及港澳台加速。'."\n" + .'- **global**：全球加速。', + 'type' => 'string', + 'example' => 'domestic', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-**k3bpq2yjw22**', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '09ABE829-6CD3-4FE0-AFEE-556113E29727', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DomainDetail\\": {\\n \\"CertName\\": \\"liveCert****\\",\\n \\"Cname\\": \\"learn.developer.aliyundoc.com\\",\\n \\"Description\\": \\"test\\",\\n \\"DomainName\\": \\"demo.aliyundoc.com\\",\\n \\"DomainStatus\\": \\"online\\",\\n \\"GmtCreated\\": \\"2018-07-27T06:51:25Z\\",\\n \\"GmtModified\\": \\"2018-08-07T06:51Z\\",\\n \\"LiveDomainType\\": \\"liveVideo\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"SSLProtocol\\": \\"on\\",\\n \\"SSLPub\\": \\"Public Key\\",\\n \\"Scope\\": \\"domestic\\",\\n \\"ResourceGroupId\\": \\"rg-**k3bpq2yjw22**\\"\\n },\\n \\"RequestId\\": \\"09ABE829-6CD3-4FE0-AFEE-556113E29727\\"\\n}","type":"json"}]', + 'title' => '获取指定直播域名配置的基本信息', + 'description' => '本接口支持查询指定推流域名或播流域名的基本配置信息。'."\n" + .'如果是新增域名的查询，域名配置完成需要一定时间，分钟级别，完全配置成功后可支持查询。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveUserDomains' => [ + 'summary' => '查询用户名下所有的直播域名。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '107118', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'LiveDomainType', + 'in' => 'query', + 'schema' => [ + 'description' => '直播域名业务类型。取值：'."\n" + .'- **liveVideo**：播流域名。'."\n" + .'- **liveEdge**：边缘推流域名。'."\n" + ."\n" + .'>如果不设置此参数，则请求参数DomainName默认查询用户所有直播推流和播流域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveVideo', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值为**20**，最大值为**50**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。取值范围：**1~100000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '域名模糊匹配过滤。'."\n" + ."\n" + .'>- 如果LiveDomainType（直播域名业务类型）取值为liveVideo，此参数不传值时，默认查询用户播流域名的相关信息。- 如果LiveDomainType（直播域名业务类型）取值为liveEdge，此参数不传值时，默认查询用户推流域名的相关信息。', + 'type' => 'string', + 'required' => false, + 'example' => '*.aliyundoc.com', + ], + ], + [ + 'name' => 'RegionName', + 'in' => 'query', + 'schema' => [ + 'description' => '域名所属地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DomainSearchType', + 'in' => 'query', + 'schema' => [ + 'description' => '域名查询类型。取值：'."\n" + ."\n" + .'- **fuzzy_match**（默认值）：模糊匹配。'."\n" + .'- **pre_match**：前匹配。'."\n" + .'- **suf_match**：后匹配。'."\n" + .'- **full_match**：完全匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'fuzzy_match', + ], + ], + [ + 'name' => 'DomainStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '域名状态。取值：'."\n" + ."\n" + .'- **online**：运行中（表示域名服务状态正常）。'."\n" + .'- **offline**：已停止。'."\n" + .'- **configuring**：配置中。', + 'type' => 'string', + 'required' => false, + 'example' => 'online', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签健。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-**kzvyjetyjjm**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Domains' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PageData' => [ + 'description' => '域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回直播域名的状态信息。', + 'type' => 'object', + 'properties' => [ + 'Cname' => [ + 'description' => '直播域名对应的CNAME域名。', + 'type' => 'string', + 'example' => 'learn.developer.aliyundoc.com', + ], + 'Description' => [ + 'description' => '描述信息', + 'type' => 'string', + 'example' => 'test', + ], + 'DomainName' => [ + 'description' => '域名名称。', + 'type' => 'string', + 'example' => 'demo.aliyundoc.com', + ], + 'GmtCreated' => [ + 'description' => '直播域名创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2017-08-29T12:15:36Z', + ], + 'GmtModified' => [ + 'description' => '直播域名修改时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2017-12-29T12:15:36Z', + ], + 'LiveDomainStatus' => [ + 'description' => '域名状态。取值：'."\n" + ."\n" + .'- **online**：运行中（表示域名服务状态正常）。'."\n" + .'- **offline**：已停止。'."\n" + .'- **configuring**：配置中。', + 'type' => 'string', + 'example' => 'online', + ], + 'LiveDomainType' => [ + 'description' => '直播域名业务类型。取值：'."\n" + ."\n" + .'- **liveVideo**：播流域名。'."\n" + .'- **liveEdge**：边缘推流域名。', + 'type' => 'string', + 'example' => 'liveVideo', + ], + 'RegionName' => [ + 'description' => '域名所属地域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-**kzvyjetyjjm**', + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '返回数据的当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E4EBD2BF-5EB0-4476-8829-9D94E1B15267', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPageNumber.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter PageNumber is not supported.', + ], + [ + 'errorCode' => 'InvalidPageSize.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter PageSize is not supported.', + ], + [ + 'errorCode' => 'InvalidDomainStatus.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter DomainStatus is not supported.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specific value of parameter DomainName is malformed.', + ], + [ + 'errorCode' => 'InvalidDomainSearchType.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter DomainSearchType is not supported.', + ], + [ + 'errorCode' => 'InvalidDomainSearchType.Malformed', + 'errorMessage' => 'he specified value of parameter DomainSearchType is invalid.', + ], + [ + 'errorCode' => 'InvalidLiveDomainType.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter LiveDomainType is not supported.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Domains\\": {\\n \\"PageData\\": [\\n {\\n \\"Cname\\": \\"learn.developer.aliyundoc.com\\",\\n \\"Description\\": \\"test\\",\\n \\"DomainName\\": \\"demo.aliyundoc.com\\",\\n \\"GmtCreated\\": \\"2017-08-29T12:15:36Z\\",\\n \\"GmtModified\\": \\"2017-12-29T12:15:36Z\\",\\n \\"LiveDomainStatus\\": \\"online\\",\\n \\"LiveDomainType\\": \\"liveVideo\\",\\n \\"RegionName\\": \\"cn-beijing\\",\\n \\"ResourceGroupId\\": \\"rg-**kzvyjetyjjm**\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"RequestId\\": \\"E4EBD2BF-5EB0-4476-8829-9D94E1B15267\\",\\n \\"TotalCount\\": 1\\n}","type":"json"}]', + 'title' => '查询用户名下所有的直播域名', + 'description' => '本接口目前支持的直播域名业务类型为播流域名和边缘推流域名。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StartLiveDomain' => [ + 'summary' => '启用状态为停用的直播域名，将DomainStatus变更为online。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107241', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播推流域名或播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RecordCheckNotAvailable', + 'errorMessage' => 'Please try again later.', + ], + [ + 'errorCode' => 'IcpBlack', + 'errorMessage' => 'The domain is on the ICP blacklist.', + ], + [ + 'errorCode' => 'IspBlack', + 'errorMessage' => 'The domain is on the ISP blacklist.', + ], + [ + 'errorCode' => 'DomainNotRecordedAliyun', + 'errorMessage' => 'The domain not access Ali Cloud for the record please access.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + 'title' => '启用直播域名', + 'description' => '如果您的域名账户已欠费或您的域名处于非法状态，则无法正常调用此接口。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopLiveDomain' => [ + 'summary' => '停用状态为启用的直播域名，将DomainStatus变更为offline。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107251', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播推流域名或播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '324AEFFF-308C-4DA7-8CD3-01B277B98F28', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"324AEFFF-308C-4DA7-8CD3-01B277B98F28\\"\\n}","type":"json"}]', + 'title' => '停用直播域名', + 'description' => '停用该直播域名后，域名信息仍保留。针对直播域名的请求，系统将自动回源处理。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveCertificateDetail' => [ + 'summary' => '查询证书详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'CertName', + 'in' => 'query', + 'schema' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Cert-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'Cert-****', + ], + 'Cert' => [ + 'description' => '证书内容。', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C7C69682-7F88-40DD-A198-10D0309E439B', + ], + 'CertId' => [ + 'description' => '证书ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23451111', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'CertNameNotFound', + 'errorMessage' => 'The cert name is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CertName\\": \\"Cert-****\\",\\n \\"Cert\\": \\"-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----\\",\\n \\"RequestId\\": \\"C7C69682-7F88-40DD-A198-10D0309E439B\\",\\n \\"CertId\\": 23451111\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveCertificateDetailResponse>\\n<RequestId>C7C69682-7F88-40DD-A198-10D0309E439B</RequestId>\\n<CertId>23451111</CertId>\\n<CertName>Cert-****</CertName>\\n<Cert>-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----</Cert>\\n</DescribeLiveCertificateDetailResponse>","errorExample":"{\\n \\"CertId\\": xxx,\\n \\"RequestId\\": \\"C7C69682-7F88-40DD-A198-10D0309E439B\\",\\n \\"CertName\\": \\"证书名称\\",\\n \\"Cert\\": \\"-----BEGIN CERTIFICATE-----xxx-----END CERTIFICATE-----\\"\\n}"}]', + 'title' => '查询证书信息', + 'description' => '您可在视频直播控制台[证书服务](~~2584962~~)页面先获取证书名称，再调用本接口查询证书详细信息。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveDomainCertificateInfo' => [ + 'summary' => '获取指定直播域名证书信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107011', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名或推流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5C1E43DC-9E51-4771-82C0-7D5ECEB547A1', + ], + 'CertInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CertInfo' => [ + 'description' => '证书信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '个人测试证书（免费版）状态。取值：'."\n" + ."\n" + .'- **success**：已生效。'."\n" + .'- **checking**：检测域名是否在阿里云直播。'."\n" + .'- **cname_error**：域名没有切到阿里云直播。'."\n" + .'- **domain_invalid**：域名包含非法字符。'."\n" + .'- **unsupport_wildcard**：不支持泛域名。'."\n" + .'- **applying**：证书申请中。'."\n" + .'- **failed**：证书申请失败。'."\n" + ."\n" + .'>**status**只有在域名证书为个人测试证书（免费版）时有意义。当域名证书不是个人测试证书（免费版）时，会返回空值。', + 'type' => 'string', + 'example' => 'success', + ], + 'CertLife' => [ + 'description' => '证书时长。'."\n" + .' - 有效期大于12个月的，显示XX year(s) XX month(s)。例如，2 years 3 months表示有效期为2年3个月。'."\n" + .'- 有效期小于12个月的，显示为XX month(s)。例如，3 months表示有效期为3个月。'."\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n", + 'type' => 'string', + 'example' => '3 months', + ], + 'CertExpireTime' => [ + 'description' => '证书过期时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2018-06-03T22:03:39Z', + ], + 'SSLPub' => [ + 'description' => '证书公钥。', + 'type' => 'string', + 'example' => 'yourSSLPub', + ], + 'SSLProtocol' => [ + 'description' => 'HTTPS开启状态。取值：'."\n" + .'- **on**：已开启。'."\n" + .'- **off**：未开启。', + 'type' => 'string', + 'example' => 'on', + ], + 'CertType' => [ + 'description' => '证书类型。取值：'."\n" + ."\n" + .'- **free**：个人测试证书（免费版）。'."\n" + .'- **cas**：云盾证书。'."\n" + .'- **upload**：自定义上传。', + 'type' => 'string', + 'example' => 'cas', + ], + 'CertDomainName' => [ + 'description' => '证书匹配的播流域名或推流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'Cert-****', + ], + 'CertOrg' => [ + 'description' => '证书组织。', + 'type' => 'string', + 'example' => 'Let\'s Encrypt', + ], + 'DomainName' => [ + 'description' => '播流域名或推流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5C1E43DC-9E51-4771-82C0-7D5ECEB547A1\\",\\n \\"CertInfos\\": {\\n \\"CertInfo\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"CertLife\\": \\"3 months\\",\\n \\"CertExpireTime\\": \\"2018-06-03T22:03:39Z\\",\\n \\"SSLPub\\": \\"yourSSLPub\\",\\n \\"SSLProtocol\\": \\"on\\",\\n \\"CertType\\": \\"cas\\",\\n \\"CertDomainName\\": \\"example.com\\",\\n \\"CertName\\": \\"Cert-****\\",\\n \\"CertOrg\\": \\"Let\'s Encrypt\\",\\n \\"DomainName\\": \\"example.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<SetLiveDomainCertificateResponse>\\n<CertInfos>\\n <CertInfo>\\n <Status>success</Status>\\n <CertLife>3 months</CertLife>\\n <DomainName>example.com</DomainName>\\n <SSLPub>yourSSLPub</SSLPub>\\n <CertOrg>Let\'s Encrypt</CertOrg>\\n <CertDomainName>example.com</CertDomainName>\\n <CertType>cas</CertType>\\n <CertExpireTime>2018-06-03T22:03:39Z</CertExpireTime>\\n <CertName>Cert-****</CertName>\\n <SSLProtocol>on</SSLProtocol>\\n </CertInfo>\\n</CertInfos>\\n<RequestId>5C1E43DC-9E51-4771-82C0-7D5ECEB547A1</RequestId>\\n</SetLiveDomainCertificateResponse>","errorExample":""}]', + 'title' => '查询指定直播域名证书信息', + 'description' => '先获取直播域名，再调用本接口获取指定直播域名证书信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特殊错误码'."\n" + .'|ErrorCode 错误码 |Message 错误信息 |HTTP 状态 |语义 |'."\n" + .'| ------------- |------------ | ----- | ----- |'."\n" + .'|InvalidDomain.NotFound |The domain provided does not belong to you. |404 |域名不存在或不属于当前用户。|', + ], + 'DescribeLiveCertificateList' => [ + 'summary' => '查询指定域名或请求账号下的所有证书列表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '您的推流域名和播流域名。多个域名用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'demo.aliyundoc.com,example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'CertificateListModel' => [ + 'description' => '数据类型。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '证书个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CertList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Cert' => [ + 'description' => '证书列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '证书列表信息。', + 'type' => 'object', + 'properties' => [ + 'LastTime' => [ + 'description' => '证书签发时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1512388659', + ], + 'Fingerprint' => [ + 'description' => '证书指纹。', + 'type' => 'string', + 'example' => '****', + ], + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'Cert-****', + ], + 'Issuer' => [ + 'description' => '证书发行商。', + 'type' => 'string', + 'example' => '*****', + ], + 'CertId' => [ + 'description' => '证书ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'Common' => [ + 'description' => '证书的CN属性。', + 'type' => 'string', + 'example' => 'example.net', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"CertificateListModel\\": {\\n \\"Count\\": 2,\\n \\"CertList\\": {\\n \\"Cert\\": [\\n {\\n \\"LastTime\\": 1512388659,\\n \\"Fingerprint\\": \\"****\\",\\n \\"CertName\\": \\"Cert-****\\",\\n \\"Issuer\\": \\"*****\\",\\n \\"CertId\\": 123456,\\n \\"Common\\": \\"example.net\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveCertificateListResponse>\\n<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n<CertificateListModel>\\n <Count>2</Count>\\n <CertList>\\n <Cert>\\n <Fingerprint>****</Fingerprint>\\n <Issuer>*****</Issuer>\\n <CertId>123456</CertId>\\n <CertName>Cert-****</CertName>\\n <LastTime>1512388659</LastTime>\\n <Common>example.net</Common>\\n </Cert>\\n </CertList>\\n</CertificateListModel>\\n</DescribeLiveCertificateListResponse>","errorExample":""}]', + 'title' => '获取证书列表信息', + 'description' => '如果请求中指定域名，则返回域名下的证书。如果请求中未指定域名，则返回请求账号下的所有证书。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetLiveDomainCertificate' => [ + 'summary' => '设置某域名下证书功能是否启用及修改证书信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '指定证书所属加速域名。属于`https`加速类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'developer.aliyundoc.com', + ], + ], + [ + 'name' => 'CertName', + 'in' => 'query', + 'schema' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Cert-****', + ], + ], + [ + 'name' => 'CertType', + 'in' => 'query', + 'schema' => [ + 'description' => '证书类型。取值：'."\n" + ."\n" + .'- **upload**：上传证书。'."\n" + .'- **cas**：证书中心证书。'."\n" + .'- **free**：个人测试证书（免费版）。', + 'type' => 'string', + 'required' => false, + 'example' => 'free', + 'enum' => [ + 'free', + 'cas', + 'upload', + ], + ], + ], + [ + 'name' => 'SSLProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTPS证书是否启用。取值： '."\n" + .'- **on**：启用。如果取值为**on**，则必须同时设置请求参数SSLPub和SSLPri。'."\n" + .'- **off**（默认值）：不启用。', + 'type' => 'string', + 'required' => true, + 'example' => 'off', + ], + ], + [ + 'name' => 'SSLPub', + 'in' => 'query', + 'schema' => [ + 'description' => '公钥内容。'."\n" + ."\n" + .'> 当SSLProtocol取值为on时，本参数才必填。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '****', + ], + ], + [ + 'name' => 'SSLPri', + 'in' => 'query', + 'schema' => [ + 'description' => '私钥内容。'."\n" + ."\n" + .'> 当SSLProtocol取值为on时，本参数才必填。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '****', + ], + ], + [ + 'name' => 'ForceSet', + 'in' => 'query', + 'schema' => [ + 'description' => '忽略证书名称重复的校验，覆盖原有同名证书信息。固定取值：**1**。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidSSLProtocol.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter SSLProtocol is not supported.', + ], + [ + 'errorCode' => 'SSLPub.MissingParameter', + 'errorMessage' => 'An input parameter "SSLPub" that is mandatory for processing the request is not supplied.', + ], + [ + 'errorCode' => 'SSLPri.MissingParameter', + 'errorMessage' => 'An input parameter "SSLPri" that is mandatory for processing the request is not supplied.', + ], + [ + 'errorCode' => 'InvalidSSLPub', + 'errorMessage' => 'The SSLPub you provided is malformed!', + ], + [ + 'errorCode' => 'InvalidSSLPri', + 'errorMessage' => 'The SSLPri you provided is malformed!', + ], + [ + 'errorCode' => 'Certificate.MissMatch', + 'errorMessage' => 'The SSLPri does not math the specified Certificate!', + ], + [ + 'errorCode' => 'InvalidCertificate.TooLong', + 'errorMessage' => 'The Certificate you provided is over the max length!', + ], + [ + 'errorCode' => 'InvalidCertName.TooLong', + 'errorMessage' => 'The Certificate name you provided is over the max length 128!', + ], + [ + 'errorCode' => 'IllegalOperationDomain', + 'errorMessage' => 'You are not authorized to operate the domain.', + ], + [ + 'errorCode' => 'Certificate.NotPermittedOff', + 'errorMessage' => 'Turn off certificate will change domain scheduling, please contact customer service', + ], + [ + 'errorCode' => 'Certificate.SettedNotEffect', + 'errorMessage' => 'Certificate was successfully setted but does\'t take effect for protecting current service, please contact customer service', + ], + [ + 'errorCode' => 'Certificate.NotFind', + 'errorMessage' => 'Not find the certificate info.', + ], + [ + 'errorCode' => 'AuthenticationFailed', + 'errorMessage' => 'Authentication failed.', + ], + [ + 'errorCode' => 'SetDomainCertificate.ParameterError', + 'errorMessage' => 'Parameters have error.', + ], + [ + 'errorCode' => 'InvalidSSLPubOrInvalidSSLPri', + 'errorMessage' => 'The SSLPri or SSLPub you provided is malformed!', + ], + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'Certificate is not exist or its status is error.', + ], + [ + 'errorCode' => 'DeleteFailed', + 'errorMessage' => 'Delete certificate is failed.', + ], + [ + 'errorCode' => 'Certificate.Duplicated', + 'errorMessage' => 'The certificate name is duplicated.', + ], + [ + 'errorCode' => 'Certificate.FormatError', + 'errorMessage' => 'The certificate format is error.', + ], + [ + 'errorCode' => 'Certificate.KeyNull', + 'errorMessage' => 'The private key is not null.', + ], + [ + 'errorCode' => 'Key.Malformed', + 'errorMessage' => 'The private key format is error.', + ], + [ + 'errorCode' => 'CertStorage.failed', + 'errorMessage' => 'The certificate storage failed.', + ], + [ + 'errorCode' => 'CertificateContent.Duplicated', + 'errorMessage' => 'The certificate is already uploaded, please don\'t upload again.', + ], + [ + 'errorCode' => 'Certificate.Expired', + 'errorMessage' => 'The certificate is expired.', + ], + [ + 'errorCode' => 'InvalidDomain.notOnline', + 'errorMessage' => 'The domain is not online, please check the domain status and try again later.', + ], + [ + 'errorCode' => 'Decode.Error', + 'errorMessage' => 'The certificate sslpub or sslpri decode error.', + ], + [ + 'errorCode' => 'sslPub.Error', + 'errorMessage' => 'The SSLPub encoded failed.', + ], + [ + 'errorCode' => 'sslPri.Error', + 'errorMessage' => 'The SSLPri encoded failed.', + ], + [ + 'errorCode' => 'DomainInSafeMode', + 'errorMessage' => 'This domain is in the safe mode. if you want to do this operation, please contact us!', + ], + [ + 'errorCode' => 'DomainInProtectedMode', + 'errorMessage' => 'This domain is in the protected mode. if you want to do this operation, please contact us!', + ], + [ + 'errorCode' => 'FunctionMutex', + 'errorMessage' => 'Function is mutex with other function.', + ], + [ + 'errorCode' => 'DomainOffline', + 'errorMessage' => 'The domain is not online, please check the domain status and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => 'Illegal domain operate is not permitted.', + ], + ], + [ + [ + 'errorCode' => 'CertName.MissingParameter', + 'errorMessage' => 'The CertName parameter is required.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<SetLiveDomainCertificateResponse>\\n\\t<RequestId>0AEDAF20-4DDF-4165-8750-47FF9C1929C9</RequestId>\\n</SetLiveDomainCertificateResponse>\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}"}]', + 'title' => '设置域名证书', + 'description' => '先获取直播域名，再调用本接口设置域名下证书是否启用和修改证书信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BatchDeleteLiveDomainConfigs' => [ + 'summary' => '批量删除域名配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainNames', + 'in' => 'query', + 'schema' => [ + 'description' => '您的推流域名或播流域名。多个域名使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com,example.aliyundoc.com,example.com', + ], + ], + [ + 'name' => 'FunctionNames', + 'in' => 'query', + 'schema' => [ + 'description' => '功能列表名称。多个功能使用英文逗号（,）分隔。更多详情，请参考下表**Functions功能说明**。', + 'type' => 'string', + 'required' => true, + 'example' => 'referer_white_list_set,ip_black_list_set', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Invalid%s.ValueNotSupported', + 'errorMessage' => 'FunctionName [%s] is not supported.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + 'title' => '批量删除域名配置', + 'description' => '先获取需要删除配置的直播域名，再调用本接口批量删除域名配置。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '## Functions格式说明'."\n" + ."\n" + .'- 示例如下所示：'."\n" + .'`[{"functionArgs":[{"argName":"domain_name","argValue":"developer.aliyundoc.com"}],"functionName":"set_req_host_header"}]`'."\n" + ."\n" + .'- 某些功能，如filetype_based_ttl_set，可以设置多条记录，当需要更新其中某条记录时，可通过该条记录的configId来指定，示例如下所示：'."\n" + .'`[{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]`'."\n" + ."\n" + .'## Functions功能说明'."\n" + ."\n" + .'| 名称 | 参数 |'."\n" + .'|---------------|--------|'."\n" + .'| **referer_white_list_set**：refer白名单。| **refer_domain_allow_list**：白名单列表，多个使用英文逗号（,）分隔。<br>**allow_empty**：是否允许空refer进入。取值：**on**或**off**。|'."\n" + .'| **referer_black_list_set**：refer黑名单。| **refer_domain_deny_list**：黑名单列表，多个使用英文逗号（,）分隔。<br>**allow_empty**：是否允许空refer进入。取值：**on**或**off**。|'."\n" + .'| **filetype_based_ttl_set**：文件过期时间设置。| **ttl**：cache时间。单位：秒，取值范围是1~99999999（3年多一些）。<br>**file_type**：文件类型。多个使用英文逗号（,）隔开。<br>**weight**：权重。取值范围：**1~99**。|'."\n" + .'| **path_based_ttl_set**：目录过期时间设置。| **ttl**：cache时间。单位：秒，取值范围是1~99999999（3年多一些）。<br>**path**：目录。必须以正斜线（/）开头。<br>**weight**：权重。取值范围：**1~99**。|'."\n" + .'| **oss_auth**：OSS鉴权Bucket。| **oss_bucket_id**：用户bucket地址。|'."\n" + .'| **ip_black_list_set**：IP黑名单。| **ip_list**：IP列表。多个使用英文逗号（,）隔开。|'."\n" + .'| **ip_allow_list_set**：IP白名单。| **ip_list**：IP列表。多个使用英文逗号（,）隔开。|'."\n" + .'| **ip_white_list_set**：访问频次控制免拦截。| **ip_list**：IP列表。多个使用英文逗号（,）隔开。|'."\n" + .'| **error_page**：错误页面重定向。| **error_code**：错误码。<br>**rewrite_page**：重定向页面。|'."\n" + .'| **set_req_host_header**：修改回源Host头。| **domain_name**：回源Host头内容。|'."\n" + .'| **set_hashkey_args**：忽略URL参数。| **hashkey_args**：保留参数的列表。多个使用英文逗号（,）分隔。<br>**disable**：是否忽略所有参数。取值：仅支持on（忽略所有参数）或off（不忽略）。|'."\n" + .'| **aliauth**：阿里鉴权。| **auth_type**：鉴权类型。取值：**type_a**（鉴权A）、**no_auth**（关闭鉴权）。<br>**auth_key1**：鉴权key1，鉴权key支持大写字母、小写字母、数字，建议设置长度为8~32个字符。<br>**auth_key2**：鉴权key2。<br>**ali_auth_delta**：自定义鉴权缓冲时间，单位：分钟。建议最小设置为1分钟，无上限限制。<br>**auth_m3u8**：是否开启m3u8内容改写，对m3u8里面的ts补齐对应的鉴权，可以避免ts的访问鉴权失败。取值：**on**（默认值）或**off**。|'."\n" + .'| **remote_auth**：直播远程鉴权 。|**enable**：是否开启远程鉴权，必填项。取值：on或off。<br>**remote_auth_path** ： 鉴权服务器地址，必填项。<br>**remote_auth_pattern** ：鉴权模式串。有以下功能可设置：<br>- **param**：是否向鉴权服务器透传推流URL中的参数，取值pass（默认）或fail。<br>- **args_white**：透传指定参数设置，多个参数用英文逗号（,）分隔。<br>- **args_black**：不透传指定参数设置，多个参数用英文逗号（,）分隔。<br>- **code**：鉴权状态码，code=XXX，鉴权服务器在鉴权成功时返回给直播的HTTP状态码。例如：code=200。code=~XXX，鉴权服务器在鉴权失败时返回给直播的HTTP状态码。例如：code=~403。<br>- **delta** ：鉴权超时时长。<br>- **retry**：鉴权超时重试次数。<br>- **timeout**：鉴权超时行为，取值：**pass**或**fail**。**pass**：视频直播将直接通过用户请求。**fail**：视频直播将响应鉴权失败状态码（403）给用户。<br>- **async**：异步鉴权，取值**on**（开启异步鉴权）或**off**（默认，关闭异步鉴权）。|'."\n" + .'| **set_resp_header**：设置响应头（浏览器端可见）。| **key**：响应头。取值：<br>**Content-Type。**<br>**Cache-Control。**<br>**Content-Disposition。**<br>**Content-Language。**<br>**Expires。**<br>**Access-Control-Allow-Origin。**<br>**Access-Control-Allow-Methods。**<br>**Access-Control-Allow-Headers。**<br>**Access-Control-Max-Age。**<br>**Access-Control-Expose-Headers。**<br>**value**：响应头内容。删除填写null。<br>|'."\n" + .'| **https_force**：强制HTTPS跳转。| **enable**：功能开关。取值：**on**或**off**。https_force和http_force只能存在其中一个，两者为互斥关系，配置另外一个需要先删除原来的配置。|'."\n" + .'| **http_force**：强制HTTP跳转。| **enable**：功能开关。取值：**on**或**off**。https_force和http_force只能存在其中一个，两者为互斥关系，配置另外一个需要先删除原来的配置。|'."\n" + .'| **forward_scheme**：自适应回源。| **enable**：功能开关，取值：**on**或**off**。<br>**scheme_origin**：回源站协议 （http、https、follow）。 <br>**scheme_origin_port**：回源站协议端口（80、443、80:443）。|'."\n" + .'| **green_manager**：鉴黄功能。| **enable**：是否开启鉴黄功能。取值：**on**或**off**。|'."\n" + .'| **tmd_signature**：自定义的访问频次控制规则。| **name**：规则名称。域名内不可重复。<br>**path**：可重复，需校验URI路径合法性。<br>**pathType**：匹配规则。**0**前缀匹配，**1**完全匹配。<br>**interval**：监测时长。单位：秒。参数限制必须≥10。<br>**count**：单IP访问次数。<br>**action**：阻断类型。**0**封禁，**1**人机识别。<br>**ttl**：阻断时长。单位：秒。|'."\n" + .'|**l2_oss_key**：L2 OSS 回源私钥。| **private_oss_auth**：是否开启私有OSS鉴权功能。取值：**on**或**off**。|'."\n" + .'|**video_seek**：视频切片拖拽开关。 |**enable**：功能开关。取值：**on**或**off**。|'."\n" + .'|**gzip**：页面Gzip优化 。|**enable**：功能开关。取值：**on**或**off**。|'."\n" + .'|**tesla**：页面优化加速。 |**enable**：功能开关。取值：**on**或**off**。|'."\n" + .'|**ali_ua**：User-Agent限制访问。 |**ua**：User-Agent。<br>**type**：名单类型。取值**black**和**white**。|'."\n" + .'|**host_redirect:rewrite**功能。 |**regex**：需要重写的URL。例如 ^/$。<br>**replacement**：目标URL。例如 /go/act/sale/tbzlsy.php。<br>**flag**：仅支持：redirect、break。|'."\n" + .'|**ipv6**：ipv6配置。 |**switch**：开关（必填）。取值：**on**或**off**，开启功能，一旦开启后，如需关闭请取消勾选，不要删除配置，否则不生效。<br>**region**：开启IPv6功能的地域，取值：cn-beijing（北京）、cn-shanghai（上海）、cn-shenzhen（深圳）、cn-qingdao（青岛）、apsoutheast-1（新加坡）、eu-central-1（德国）、ap-northeast-1（东京）、ap-southeast-5（雅加达）。|'."\n" + .'|**ali_location**：区域限制访问。 |**location**：地域列表。<br>**type**：名单类型。取值**black**或**white**。|'."\n" + .'|**cc_defense**：防CC攻击。 |**enable**：开启或关闭防CC攻击。取值：**on**或**off**。|'."\n" + .'|**alilive**：视频直播配置。 | **notify_url**：直播通知URL。<br>**enable**：功能开关。取值：**on**或**off**。<br>**live_forbid_flv**：禁止播放flv。取值：**on**或**off**。<br>**live_forbid_rtmp**：禁止播放rtmp。取值：**on**或**off**。<br>l**ive_forbid_hls**：禁止播放hls。取值：**on**或**off**。|'."\n" + .'|**ali_grtn**：grtn业务接入开关。 |**grtn_rts_pub**：RTS推流开关，推流域名使用。取值：**on**或**off**。<br>**grtn_rts_play**：RTS播流开关，播流域名使用。取值：**on**或**off**。<br>**grtn_rts_transcode**：RTS H5播放自动转码开关。取值：**on**或**off**。|'."\n" + .'|**edge_function**：边缘函数。 |必填参数：<br>**rule**：DSL规则。<br>**pri**：优先级。<br>**enable**：本条规则是否生效。取值：**on**或**off**。<br>可选参数：<br>**name**：规则名称。<br> **pos**：规则执行位置。<br>**brk**：命中本条规则后，当前执行位置剩余规则均跳过。<br> **option**：option管控。<br> **grammar**：grammar管控。可选值：空、es2、js。<br> **jsmode**：js域名白单管控，可选值：**redirect**或**bypass**。|'."\n" + .'|**https_tls_version**：TLS协议版本。 |**tls10**：开启TLSv1.0，默认为**on**。取值：**on**或**off**。<br>**tls11**：开启TLSv1.1，默认为**on**。取值：**on**或**off**。<br> **tls12**：开启TLSv1.2，默认为**on**。取值：**on**或**off**。<br> **tls13**：开启TLSv1.3，默认为**on**。取值：**on**或**off**。|'."\n" + .'|**https_option**：http协议设置。 |**http2**：是否开启http2，默认为**off**。取值：**on**或**off**。<br>**live_http2**：是否开启live\\_http2，默认为**off**。取值：**on**或**off**。|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BatchSetLiveDomainConfigs' => [ + 'summary' => '批量配置域名。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106875', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainNames', + 'in' => 'query', + 'schema' => [ + 'description' => '需要进行批量配置的域名。取值可以是推流域名、主播流域名或子播流域名。多个域名用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com,example.aliyundoc.com,example.com', + ], + ], + [ + 'name' => 'Functions', + 'in' => 'query', + 'schema' => [ + 'description' => '功能列表。'."\n" + ."\n" + .'某些功能，如`filetype_based_ttl_set`，可以设置多条记录，当需要更新其中某条记录时，可通过该条记录的`configId`来指定。更多信息，请参见下表**Function格式说明**和**Functions功能说明**。', + 'type' => 'string', + 'required' => true, + 'example' => ' [{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidFunctions.Malformed', + 'errorMessage' => 'Specified Functions is malformed.', + ], + [ + 'errorCode' => 'InvalidFunctionArgs.Malformed', + 'errorMessage' => 'The specified FunctionArgs is invalid.', + ], + [ + 'errorCode' => 'InvalidArgValue.Malformed', + 'errorMessage' => 'Specified ArgValue is malformed.', + ], + [ + 'errorCode' => 'Invalid%s.ValueNotSupported', + 'errorMessage' => 'FunctionName [%s] is not supported.', + ], + [ + 'errorCode' => 'Invalid%s.Malformed', + 'errorMessage' => 'ArgValue [%s] is malformed.', + ], + [ + 'errorCode' => 'MissingParameter%s', + 'errorMessage' => 'The specified value of ArgName[%s] is missing.', + ], + [ + 'errorCode' => 'FunctionMutex', + 'errorMessage' => 'Function is mutex with other function.', + ], + [ + 'errorCode' => 'RewriteHostRely', + 'errorMessage' => 'Domain name is configured as rewrite host by others.', + ], + [ + 'errorCode' => 'ConfigurationConflicts', + 'errorMessage' => 'The staging environment has a configuration in effect and cannot modify the production environment configuration.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<BatchSetLiveDomainConfigsResponse>\\n\\t<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</BatchSetLiveDomainConfigsResponse>\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}"}]', + 'title' => '批量配置域名', + 'description' => '先获取需要进行配置的直播域名，再调用本接口批量配置域名。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '## Functions格式说明'."\n" + ."\n" + .'- 示例如下所示：'."\n" + .'`[{"functionArgs":[{"argName":"domain_name","argValue":"developer.aliyundoc.com"}],"functionName":"set_req_host_header"}]`'."\n" + ."\n" + .'- 某些功能，如filetype_based_ttl_set，可以设置多条记录，当需要更新其中某条记录时，可通过该条记录的configId来指定，示例如下所示：'."\n" + .'`[{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]`'."\n" + ."\n" + .'## Functions功能说明'."\n" + ."\n" + .'| 名称 | 参数 |'."\n" + .'|---------------|--------|'."\n" + .'| **referer_white_list_set**：refer白名单。| **refer_domain_allow_list**：白名单列表，多个使用英文逗号（,）分隔。<br>**allow_empty**：是否允许空refer进入。取值：**on**或**off**。|'."\n" + .'| **referer_black_list_set**：refer黑名单。| **refer_domain_deny_list**：黑名单列表，多个使用英文逗号（,）分隔。<br>**allow_empty**：是否允许空refer进入。取值：**on**或**off**。|'."\n" + .'| **filetype_based_ttl_set**：文件过期时间设置。| **ttl**：cache时间。单位：秒，取值范围是1~99999999（3年多一些）。<br>**file_type**：文件类型。多个使用英文逗号（,）隔开。<br>**weight**：权重。取值范围：**1~99**。|'."\n" + .'| **path_based_ttl_set**：目录过期时间设置。| **ttl**：cache时间。单位：秒，取值范围是1~99999999（3年多一些）。<br>**path**：目录。必须以正斜线（/）开头。<br>**weight**：权重。取值范围：**1~99**。|'."\n" + .'| **oss_auth**：OSS鉴权Bucket。| **oss_bucket_id**：用户bucket地址。|'."\n" + .'| **ip_black_list_set**：IP黑名单。| **ip_list**：IP列表。多个使用英文逗号（,）隔开。|'."\n" + .'| **ip_allow_list_set**：IP白名单。| **ip_list**：IP列表。多个使用英文逗号（,）隔开。|'."\n" + .'| **ip_white_list_set**：访问频次控制免拦截。| **ip_list**：IP列表。多个使用英文逗号（,）隔开。|'."\n" + .'| **error_page**：错误页面重定向。| **error_code**：错误码。<br>**rewrite_page**：重定向页面。|'."\n" + .'| **set_req_host_header**：修改回源Host头。| **domain_name**：回源Host头内容。|'."\n" + .'| **set_hashkey_args**：忽略URL参数。| **hashkey_args**：保留参数的列表。多个使用英文逗号（,）分隔。<br>**disable**：是否忽略所有参数。取值：仅支持on（忽略所有参数）或off（不忽略）。|'."\n" + .'| **aliauth**：阿里鉴权。| **auth_type**：鉴权类型。取值：**type_a**（鉴权A）、**no_auth**（关闭鉴权）。<br>**auth_key1**：鉴权key1，鉴权key支持大写字母、小写字母、数字，建议设置长度为8~32个字符。<br>**auth_key2**：鉴权key2。<br>**ali_auth_delta**：自定义鉴权缓冲时间，单位：秒。建议最小设置为60秒，无上限限制。<br>**auth_m3u8**：是否开启m3u8内容改写，对m3u8里面的ts补齐对应的鉴权，可以避免ts的访问鉴权失败。取值：**on**（默认值）或**off**。|'."\n" + .'| **remote_auth**：直播远程鉴权 。|**enable**：是否开启远程鉴权，必填项。取值：on或off。<br>**remote_auth_path** ： 鉴权服务器地址，必填项。<br>**remote_auth_pattern** ：鉴权模式串。有以下功能可设置：<br>- **param**：是否向鉴权服务器透传推流URL中的参数，取值pass（默认）或fail。<br>- **args_white**：透传指定参数设置，多个参数用英文逗号（,）分隔。<br>- **args_black**：不透传指定参数设置，多个参数用英文逗号（,）分隔。<br>- **code**：鉴权状态码，code=XXX，鉴权服务器在鉴权成功时返回给直播的HTTP状态码。例如：code=200。code=~XXX，鉴权服务器在鉴权失败时返回给直播的HTTP状态码。例如：code=~403。<br>- **delta** ：鉴权超时时长。<br>- **retry**：鉴权超时重试次数。<br>- **timeout**：鉴权超时行为，取值：**pass**或**fail**。**pass**：视频直播将直接通过用户请求。**fail**：视频直播将响应鉴权失败状态码（403）给用户。<br>- **async**：异步鉴权，取值**on**（开启异步鉴权）或**off**（默认，关闭异步鉴权）。|'."\n" + .'| **set_resp_header**：设置响应头（浏览器端可见）。| **key**：响应头。取值：<br>**Content-Type。**<br>**Cache-Control。**<br>**Content-Disposition。**<br>**Content-Language。**<br>**Expires。**<br>**Access-Control-Allow-Origin。**<br>**Access-Control-Allow-Methods。**<br>**Access-Control-Allow-Headers。**<br>**Access-Control-Max-Age。**<br>**Access-Control-Expose-Headers。**<br>**value**：响应头内容。删除填写null。<br>|'."\n" + .'| **https_force**：强制HTTPS跳转。| **enable**：功能开关。取值：**on**或**off**。https_force和http_force只能存在其中一个，两者为互斥关系，配置另外一个需要先删除原来的配置。|'."\n" + .'| **http_force**：强制HTTP跳转。| **enable**：功能开关。取值：**on**或**off**。https_force和http_force只能存在其中一个，两者为互斥关系，配置另外一个需要先删除原来的配置。|'."\n" + .'| **forward_scheme**：自适应回源。| **enable**：功能开关，取值：**on**或**off**。<br>**scheme_origin**：回源站协议 （http、https、follow）。 <br>**scheme_origin_port**：回源站协议端口（80、443、80:443）。|'."\n" + .'| **green_manager**：鉴黄功能。| **enable**：是否开启鉴黄功能。取值：**on**或**off**。|'."\n" + .'| **tmd_signature**：自定义的访问频次控制规则。| **name**：规则名称。域名内不可重复。<br>**path**：可重复，需校验URI路径合法性。<br>**pathType**：匹配规则。**0**前缀匹配，**1**完全匹配。<br>**interval**：监测时长。单位：秒。参数限制必须≥10。<br>**count**：单IP访问次数。<br>**action**：阻断类型。**0**封禁，**1**人机识别。<br>**ttl**：阻断时长。单位：秒。|'."\n" + .'|**l2_oss_key**：L2 OSS 回源私钥。| **private_oss_auth**：是否开启私有OSS鉴权功能。取值：**on**或**off**。|'."\n" + .'|**video_seek**：视频切片拖拽开关。 |**enable**：功能开关。取值：**on**或**off**。|'."\n" + .'|**gzip**：页面Gzip优化 。|**enable**：功能开关。取值：**on**或**off**。|'."\n" + .'|**tesla**：页面优化加速。 |**enable**：功能开关。取值：**on**或**off**。|'."\n" + .'|**ali_ua**：User-Agent限制访问。 |**ua**：User-Agent。<br>**type**：名单类型。取值**black**和**white**。|'."\n" + .'|**host_redirect:rewrite**功能。 |**regex**：需要重写的URL。例如 ^/$。<br>**replacement**：目标URL。例如 /go/act/sale/tbzlsy.php。<br>**flag**：仅支持：redirect、break。|'."\n" + .'|**ipv6**：ipv6配置。 |**switch**：开关（必填）。取值：**on**或**off**，开启功能，一旦开启后，如需关闭请取消勾选，不要删除配置，否则不生效。<br>**region**：开启IPv6功能的地域，取值：cn-beijing（北京）、cn-shanghai（上海）、cn-shenzhen（深圳）、cn-qingdao（青岛）、apsoutheast-1（新加坡）、eu-central-1（德国）、ap-northeast-1（东京）、ap-southeast-5（雅加达）。|'."\n" + .'|**ali_location**：区域限制访问。 |**location**：地域列表。<br>**type**：名单类型。取值**black**或**white**。|'."\n" + .'|**cc_defense**：防CC攻击。 |**enable**：开启或关闭防CC攻击。取值：**on**或**off**。|'."\n" + .'|**alilive**：视频直播配置。 | **notify_url**：直播通知URL。<br>**enable**：功能开关。取值：**on**或**off**。<br>**live_forbid_flv**：禁止播放flv。取值：**on**或**off**。<br>**live_forbid_rtmp**：禁止播放rtmp。取值：**on**或**off**。<br>l**ive_forbid_hls**：禁止播放hls。取值：**on**或**off**。|'."\n" + .'|**ali_grtn**：grtn业务接入开关。 |**grtn_rts_pub**：RTS推流开关，推流域名使用。取值：**on**或**off**。<br>**grtn_rts_play**：RTS播流开关，播流域名使用。取值：**on**或**off**。<br>**grtn_rts_transcode**：RTS H5播放自动转码开关。取值：**on**或**off**。|'."\n" + .'|**edge_function**：边缘函数。 |必填参数：<br>**rule**：DSL规则。<br>**pri**：优先级。<br>**enable**：本条规则是否生效。取值：**on**或**off**。<br>可选参数：<br>**name**：规则名称。<br> **pos**：规则执行位置。<br>**brk**：命中本条规则后，当前执行位置剩余规则均跳过。<br> **option**：option管控。<br> **grammar**：grammar管控。可选值：空、es2、js。<br> **jsmode**：js域名白单管控，可选值：**redirect**或**bypass**。|'."\n" + .'|**https_tls_version**：TLS协议版本。 |**tls10**：开启TLSv1.0，默认为**on**。取值：**on**或**off**。<br>**tls11**：开启TLSv1.1，默认为**on**。取值：**on**或**off**。<br> **tls12**：开启TLSv1.2，默认为**on**。取值：**on**或**off**。<br> **tls13**：开启TLSv1.3，默认为**on**。取值：**on**或**off**。|'."\n" + .'|**https_option**：http协议设置。 |**http2**：是否开启http2，默认为**off**。取值：**on**或**off**。<br>**live_http2**：是否开启live\\_http2，默认为**off**。取值：**on**或**off**。|', + 'extraInfo' => '| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" + .'|---------------|---------------|---------|---------------|'."\n" + .'|InvalidFunctions.Malformed | Specified Functions is malformed. | 400 | 指定的Functions不合法。 |'."\n" + .'| InvalidFunctionName.ValueNotSupported | unctionName %s is not supported. | 400 | 不支持的FunctionName %s（%s为具体功能名）。|'."\n" + .'| InvalidArgName.ValueNotSupported | ArgName %s is not supported. | 400 | 不支持的ArgName %s（%s为具体参数名）。 |'."\n" + .'| InvalidArgValue.Malformed | Specified ArgValue is malformed. | 400 | 指定的ArgValue不合法。 |', + ], + 'DescribeLiveDomainConfigs' => [ + 'summary' => '查询直播域名配置，一次可查询多个功能配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '您的推流域名或播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'FunctionNames', + 'in' => 'query', + 'schema' => [ + 'description' => '功能列表名称。多个功能使用英文逗号（,）分隔。更多详情，请参见下表**Functions功能说明**。', + 'type' => 'string', + 'required' => true, + 'example' => 'set_req_host_header,set_hashkey_args', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED', + ], + 'DomainConfigs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DomainConfig' => [ + 'description' => '直播域名配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '配置状态，取值：'."\n" + ."\n" + .'- **success**：配置成功。'."\n" + .'- **testing**：测试中。'."\n" + .'- **failed**：配置失败。'."\n" + .'- **configuring**：配置中。', + 'type' => 'string', + 'example' => 'success', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'string', + 'example' => '5003576', + ], + 'FunctionName' => [ + 'description' => '域名配置功能名称。', + 'type' => 'string', + 'example' => 'set_req_host_header', + ], + 'FunctionArgs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FunctionArg' => [ + 'description' => '域名功能配置参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ArgName' => [ + 'description' => '参数名称。', + 'type' => 'string', + 'example' => 'domain_name', + ], + 'ArgValue' => [ + 'description' => '参数值。', + 'type' => 'string', + 'example' => 'developer.aliyundoc.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Invalid%s.ValueNotSupported', + 'errorMessage' => 'FunctionName [%s] is not supported.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidUser', + 'errorMessage' => 'The user\'s account is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED\\",\\n \\"DomainConfigs\\": {\\n \\"DomainConfig\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"ConfigId\\": \\"5003576\\",\\n \\"FunctionName\\": \\"set_req_host_header\\",\\n \\"FunctionArgs\\": {\\n \\"FunctionArg\\": [\\n {\\n \\"ArgName\\": \\"domain_name\\",\\n \\"ArgValue\\": \\"developer.aliyundoc.com\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveDomainConfigsResponse>\\n<RequestId>F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED</RequestId>\\n<DomainConfigs>\\n <DomainConfig>\\n <Status>success</Status>\\n <FunctionName>set_req_host_header</FunctionName>\\n <ConfigId>5003576</ConfigId>\\n <FunctionArgs>\\n <FunctionArg>\\n <ArgValue>developer.aliyundoc.com</ArgValue>\\n <ArgName>domain_name</ArgName>\\n </FunctionArg>\\n </FunctionArgs>\\n </DomainConfig>\\n</DomainConfigs>\\n</DescribeLiveDomainConfigsResponse>","errorExample":"{\\n \\"RequestId\\": \\"F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED\\",\\n \\"DomainConfigs\\": {\\n \\"DomainConfig\\": [\\n { \\n \\"Status\\": \\"success\\",\\n \\"FunctionArgs\\": {\\n \\"FunctionArg\\": [\\n {\\n \\"ArgName\\": \\"domain_name\\",\\n \\"ArgValue\\": \\"testscdn3.cdnpe.com\\"\\n }\\n ]\\n },\\n \\"ConfigId\\": 5003576,\\n \\"FunctionName\\": \\"set_req_host_header\\"\\n },\\n {\\n \\"FunctionArgs\\": {\\n \\"Status\\": \\"success\\",\\n \\"FunctionArg\\": [\\n {\\n \\"ArgName\\": \\"file_type\\",\\n \\"ArgValue\\": \\"txt\\"\\n },\\n {\\n \\"ArgName\\": \\"ttl\\",\\n \\"ArgValue\\": \\"13\\"\\n },\\n {\\n \\"ArgName\\": \\"weight\\",\\n \\"ArgValue\\": \\"8\\"\\n }\\n ]\\n },\\n \\"ConfigId\\": 5068995,\\n \\"FunctionName\\": \\"filetype_based_ttl_set\\"\\n }\\n ]\\n }\\n}"}]', + 'title' => '查询直播域名配置', + 'description' => '此接口一次可查询多个功能配置。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '## Functions功能说明'."\n" + ."\n\n" + .'>所有参数值均按照字符串类型处理。 某些功能，例如：**filetype_based_ttl_set**，可以设置多条纪录。当需要更新其中某条纪录时，可通过该条纪录的**configId**来指定。 '."\n" + ."\n\n" + .'| 名称 | 参数 |'."\n" + .'|---------------|--------|'."\n" + .'| **referer_white_list_set**：refer白名单。| **refer_domain_allow_list**：白名单列表，多个使用英文逗号（,）分隔。<br>**allow_empty**：是否允许空refer进入。取值：**on**或**off**。|'."\n" + .'| **referer_black_list_set**：refer黑名单。| **refer_domain_deny_list**：黑名单列表，多个使用英文逗号（,）分隔。<br>**allow_empty**：是否允许空refer进入。取值：**on**或**off**。|'."\n" + .'| **filetype_based_ttl_set**：文件过期时间设置。| **ttl**：cache时间。单位：秒。<br>**file_type**：文件类型。多个使用英文逗号（,）隔开。<br>**weight**：权重。取值范围：**1~99**。|'."\n" + .'| **path_based_ttl_set**：目录过期时间设置。| **ttl**：cache时间。单位：秒。<br>**path**：目录。必须以正斜线（/）开头。<br>**weight**：权重。取值范围：**1~99**。|'."\n" + .'| **oss_auth**：OSS鉴权Bucket。| **oss_bucket_id**：用户bucket名称。|'."\n" + .'| **ip_black_list_set**：IP黑名单。| **ip_list**：IP列表。多个使用英文逗号（,）隔开。|'."\n" + .'| **ip_allow_list_set**：IP白名单。| **ip_list**：IP列表。多个使用英文逗号（,）隔开。|'."\n" + .'| **ip_white_list_set**：访问频次控制免拦截。| **ip_list**：IP列表。多个使用英文逗号（,）隔开。|'."\n" + .'| **error_page**：错误页面重定向。| **error_code**：错误码。<br>**rewrite_page**：重定向页面。|'."\n" + .'| **set_req_host_header**：修改回源Host头。| **domain_name**：回源Host头内容。|'."\n" + .'| **set_hashkey_args**：忽略url参数。| **hashkey_args**：保留参数的列表。多个使用英文逗号（,）分隔。<br>**disable**：是否忽略所有参数。取值：仅支持on（忽略所有参数）或off（不忽略）。|'."\n" + .'| **aliauth**：阿里鉴权。| **auth_type**：鉴权类型。取值：**type_a**（鉴权A）、**no_auth**（关闭鉴权）。<br>**auth_key1**：鉴权key1，鉴权key需为16~32个字符，支持大写字母、小写字母、数字。<br>**auth_key2**：鉴权key2。<br>**ali_auth_delta**：自定义鉴权缓冲时间，单位：秒。建议最小设置为60秒，无上限限制。|'."\n" + .'| **remote_auth**：直播远程鉴权 。|**enable**：是否开启远程鉴权，必填项。取值：on或off。<br>**remote_auth_path** ： 鉴权服务器地址，必填项。<br>**remote_auth_pattern** ：鉴权模式串。有以下功能可设置：<br>- **param**：是否向鉴权服务器透传推流URL中的参数，取值pass（默认）或fail。<br>- **args_white**：透传指定参数设置，多个参数用英文逗号（,）分隔。<br>- **args_black**：不透传指定参数设置，多个参数用英文逗号（,）分隔。<br>- **code**：鉴权状态码，code=XXX，鉴权服务器在鉴权成功时返回给直播的HTTP状态码。例如：code=200。code=~XXX，鉴权服务器在鉴权失败时返回给直播的HTTP状态码。例如：code=~403。<br>- **delta** ：鉴权超时时长。<br>- **retry**：鉴权超时重试次数。<br>- **timeout**：鉴权超时行为，取值：**pass**或**fail**。**pass**：视频直播将直接通过用户请求。**fail**：视频直播将响应鉴权失败状态码（403）给用户。<br>- **async**：异步鉴权，取值**on**（开启异步鉴权）或**off**（默认，关闭异步鉴权）。|'."\n" + .'| **set_resp_header**：设置响应头（浏览器端可见）。| **key**：响应头。<br>**value**：响应头内容。删除填写null。|'."\n" + .'| **https_force**：强制HTTPS跳转。| **enable**：功能开关。取值：**on**或**off**。https_force和http_force只能存在其中一个，两者为互斥关系，配置另外一个需要先删除原来的配置。|'."\n" + .'| **http_force**：强制HTTP跳转。| **enable**：功能开关。取值：**on**或**off**。https_force和http_force只能存在其中一个，两者为互斥关系，配置另外一个需要先删除原来的配置。|'."\n" + .'| **l2_oss_key**：L2 OSS 回源私钥。| **private_oss_auth**：是否开启私有OSS鉴权功能。取值：**on**或**off**。|'."\n" + .'| **green_manager**：鉴黄功能。| **enable**：是否开启鉴黄功能。取值：**on**或**off**。|'."\n" + .'| **tmd_signature**：自定义的访问频次控制规则。| **name**：规则名称。域名内不可重复。<br>**path**：可重复，需校验uri路径合法性。<br>**pathType**：匹配规则。**0**前缀匹配，**1**完全匹配。<br>**interval**：监测时长。单位：秒。参数限制必须≥10。<br>**count**：单IP访问次数。<br>**action**：阻断类型。**0**封禁，**1**人机识别。<br>**ttl**：阻断时长。单位：秒。|'."\n" + .'| **forward_scheme**：自适应回源。| **enable**：功能开关，取值：on或off。<br>**scheme_origin**：回源站协议（http、https、follow）。<br>**scheme_origin_port**：回源站协议端口（80、443、80:443）。|'."\n" + .'| **video_seek**：视频切片拖拽开关。| **enable**：功能开关，取值：on或off。|'."\n" + .'| **gzip**：页面Gzip优化。| **enable**：功能开关，取值：on或off。|'."\n" + .'| **tesla**：页面优化加速。| **enable**：功能开关，取值：on或off。|'."\n" + .'| **ali_ua**：User-Agent限制访问。| **ua**：User-Agent<br>**type**：取值类型（black、white）。|'."\n" + .'| **host_redirect**：rewrite功能。| **regex**：需要重写的URL，例如 ^/$。<br>**replacement**：目标URL，例如 /go/act/sale/tbzlsy.php。<br>**flag**：仅支持：redirect、break。|'."\n" + .'| **ipv6**：ipv6配置。| **switch**：必填，开关，支持on或off，开启功能，一旦开启后，如需关闭请取消勾选，不要删除配置，否则不生效。<br>**region**：开启IPv6功能的地区，取值：cn-beijing（北京）、cn-shanghai（上海）、cn-shenzhen（深圳）、cn-qingdao（青岛）、apsoutheast-1（新加坡）、eu-central-1（德国）、ap-northeast-1（东京）、ap-southeast-5（雅加达）。|'."\n" + .'| **ali_location**：区域限制访问。| **location**：地域列表。|'."\n" + .'| **type**：取值类型。| black、white。|'."\n" + .'| **enable**：功能开关。| 取值：on或off。|'."\n" + .'| **live_forbid_flv**：禁止播放flv。| 取值：on或off。|'."\n" + .'| **live_forbid_rtmp**：禁止播放rtmp。| 取值：on或off。|'."\n" + .'| **live_forbid_hls**：禁止播放hls。| 取值：on或off。|'."\n" + .'|**https_option**：http协议设置。 |**http2**：是否开启http2，默认为**off**。取值：**on**或**off**。<br>**live\\_http2**：是否开启live_http2，默认为**off**。取值：**on**或**off**。|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveDomainByCertificate' => [ + 'summary' => '根据证书信息获取加速域名。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '191820', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'SSLPub', + 'in' => 'query', + 'schema' => [ + 'description' => '证书公钥，需要base64编码后再进行encodeURIComponent。支持pem格式。', + 'type' => 'string', + 'required' => true, + 'example' => '******', + ], + ], + [ + 'name' => 'SSLStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '表示返回的域名列表只包含开启或关闭HTTPS的域名。'."\n" + .'- **true**：开启。'."\n" + .'- **false**：关闭。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'CertInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CertInfo' => [ + 'description' => '证书信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'CertCaIsLegacy' => [ + 'description' => '证书CA废弃状态。取值：'."\n" + .'- **yes**：已废弃。'."\n" + .'- **no**：正常，未废弃。', + 'type' => 'string', + 'example' => 'yes', + ], + 'CertExpireTime' => [ + 'description' => '证书过期时间。', + 'type' => 'string', + 'example' => 'Nov 29 00:00:00 2016 GMT', + ], + 'CertExpired' => [ + 'description' => '证书过期状态。 取值：'."\n" + .'- **yes**：已过期。'."\n" + .'- **no**：未过期。', + 'type' => 'string', + 'example' => 'yes', + ], + 'CertStartTime' => [ + 'description' => '证书开始时间。', + 'type' => 'string', + 'example' => 'Nov 29 23:59:59 2017 GMT', + ], + 'CertSubjectCommonName' => [ + 'description' => '证书所有者名称。', + 'type' => 'string', + 'example' => 'owner', + ], + 'CertType' => [ + 'description' => '证书类型，取值：**RSA**、**DSA**、**ECDSA**。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'DomainList' => [ + 'description' => '如果该返回值不为空，则将该列表与证书做匹配，多个用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'example.com,aliyundoc.com', + ], + 'DomainNames' => [ + 'description' => '证书匹配的域名（DNS字段），多个用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => '*.example.com,aliyundoc.com', + ], + 'Issuer' => [ + 'description' => '证书颁发机构。', + 'type' => 'string', + 'example' => 'C=US, O=Symantec Corporation, OU=Symantec Trust Network, OU=Domain Validated SSL, CN=Symantec Basic DV SSL CA - G1', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Certificate.FormatError', + 'errorMessage' => 'The format of the certificate is invalid.', + ], + [ + 'errorCode' => 'SSLPub.MissingParameter', + 'errorMessage' => 'The Cert parameter is required.', + ], + [ + 'errorCode' => 'Decode.Error', + 'errorMessage' => 'Error decoding the SSLPub certificate.', + ], + [ + 'errorCode' => 'Certificate.DecodeError', + 'errorMessage' => 'An error occurred while decoding the certificate.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CertInfos\\": {\\n \\"CertInfo\\": [\\n {\\n \\"CertCaIsLegacy\\": \\"yes\\",\\n \\"CertExpireTime\\": \\"Nov 29 00:00:00 2016 GMT\\",\\n \\"CertExpired\\": \\"yes\\",\\n \\"CertStartTime\\": \\"Nov 29 23:59:59 2017 GMT\\",\\n \\"CertSubjectCommonName\\": \\"owner\\",\\n \\"CertType\\": \\"RSA\\",\\n \\"DomainList\\": \\"example.com,aliyundoc.com\\",\\n \\"DomainNames\\": \\"*.example.com,aliyundoc.com\\",\\n \\"Issuer\\": \\"C=US, O=Symantec Corporation, OU=Symantec Trust Network, OU=Domain Validated SSL, CN=Symantec Basic DV SSL CA - G1\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDomainByCertificateResponse>\\n <RequestId>ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D</RequestId>\\n <CertInfos>\\n <CertExpireTime>Nov 29 00:00:00 2016 GMT</CertExpireTime>\\n <CertStartTime>Nov 29 23:59:59 2017 GMT</CertStartTime>\\n <CertType>RSA</CertType>\\n <CertSubjectCommonName>owner</CertSubjectCommonName>\\n <CertCaIsLegacy>yes</CertCaIsLegacy>\\n <DomainNames>*.example.com,aliyundoc.com</DomainNames>\\n <CertExpired>yes</CertExpired>\\n <Issuer>C=US, O=Symantec Corporation, OU=Symantec Trust Network, OU=Domain Validated SSL, CN=Symantec Basic DV SSL CA - G1</Issuer>\\n <DomainList>example.com,aliyundoc.com</DomainList>\\n </CertInfos>\\n</DescribeLiveDomainByCertificateResponse>","errorExample":""}]', + 'title' => '查询证书匹配的域名列表', + 'description' => '调用本接口可根据证书信息查询匹配的加速域名。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveHttpsDomainList' => [ + 'summary' => '查询用户证书服务所有已配置证书信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '191821', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '取得第几页，取值范围为：**[1,10000]**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，默认为**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'demo.aliyun.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'CertInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CertInfo' => [ + 'description' => '证书信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'CertCommonName' => [ + 'description' => '证书主域名。', + 'type' => 'string', + 'example' => 'example.org', + ], + 'CertExpireTime' => [ + 'description' => '证书过期时间。', + 'type' => 'string', + 'example' => '2018-12-26 14:45:09', + ], + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'CertStartTime' => [ + 'description' => '证书开始时间。', + 'type' => 'string', + 'example' => '2018-11-26 14:45:09', + ], + 'CertStatus' => [ + 'description' => '证书状态。'."\n" + .'- **ok**：正常。'."\n" + .'- **mismatch**：域名与证书不匹配。'."\n" + .'- **expired**：已过期。'."\n" + .'- **expire_soon**：即将过期。', + 'type' => 'string', + 'example' => 'mismatch', + ], + 'CertType' => [ + 'description' => '证书类型。'."\n" + .'- **cas**：云盾证书。'."\n" + .'- **upload**：自定义上传。', + 'type' => 'string', + 'example' => 'cas', + ], + 'CertUpdateTime' => [ + 'description' => '证书更新时间。', + 'type' => 'string', + 'example' => '2019-01-08 18:33:16', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F5E8DF64-7175-4186-9B06-F002C0BBD0C5', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoHttpsDomain', + 'errorMessage' => 'Your account doesn\'t have https domain.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CertInfos\\": {\\n \\"CertInfo\\": [\\n {\\n \\"CertCommonName\\": \\"example.org\\",\\n \\"CertExpireTime\\": \\"2018-12-26 14:45:09\\",\\n \\"CertName\\": \\"test\\",\\n \\"CertStartTime\\": \\"2018-11-26 14:45:09\\",\\n \\"CertStatus\\": \\"mismatch\\",\\n \\"CertType\\": \\"cas\\",\\n \\"CertUpdateTime\\": \\"2019-01-08 18:33:16\\",\\n \\"DomainName\\": \\"example.com\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"F5E8DF64-7175-4186-9B06-F002C0BBD0C5\\",\\n \\"TotalCount\\": 16\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveHttpsDomainListResponse>\\n <TotalCount>16</TotalCount>\\n <RequestId>F5E8DF64-7175-4186-9B06-F002C0BBD0C5</RequestId>\\n <CertInfos>\\n <CertStartTime>2018-11-26 14:45:09</CertStartTime>\\n <CertExpireTime>2018-12-26 14:45:09</CertExpireTime>\\n <CertUpdateTime>2019-01-08 18:33:16</CertUpdateTime>\\n <CertType>cas</CertType>\\n <CertName>test</CertName>\\n <CertStatus>mismatch</CertStatus>\\n <DomainName>example.com</DomainName>\\n <CertCommonName>example.org</CertCommonName>\\n </CertInfos>\\n</DescribeLiveHttpsDomainListResponse>","errorExample":""}]', + 'title' => '查询证书服务列表接口', + 'description' => '调用本接口可查询证书服务中该用户所有已配置的证书和域名信息。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ModifyLiveDomainSchdmByProperty' => [ + 'summary' => '修改直播域名加速区域。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107191', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需修改加速区域的直播域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Property', + 'in' => 'query', + 'schema' => [ + 'description' => '修改加速区域。'."\n" + .'{“coverage”:“overseas”} 指的是该配置面向的是海外区域。下面是对三个支持的coverage值的说明：'."\n" + .'- domestic：中国内地。'."\n" + .'- overseas：海外及港澳台加速。'."\n" + .'- global：全球加速。', + 'type' => 'string', + 'required' => true, + 'example' => '{"coverage":"global"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Schedule.NotFound', + 'errorMessage' => 'there is no schedule domain found by the targeted coverage value', + ], + [ + 'errorCode' => 'DomainTraffic.ExceedThreshold', + 'errorMessage' => 'not allowed to do this operation because the last day traffic exceeds the threshold', + ], + [ + 'errorCode' => 'Domain.BeianInvalid', + 'errorMessage' => 'not allowed to do this operation because the domain registration record invalid in China main land', + ], + [ + 'errorCode' => 'Schedule.ChangeFail', + 'errorMessage' => 'change domain failed', + ], + [ + 'errorCode' => 'LockFail', + 'errorMessage' => 'The domain name is being used by another operation, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyLiveDomainSchdmByPropertyResponse>\\n <RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>\\n</ModifyLiveDomainSchdmByPropertyResponse>","errorExample":""}]', + 'title' => '修改直播域名加速区域', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveUserTags' => [ + 'summary' => '调用DescribeLiveUserTags查询用户标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6B0256B6-2442-5BEF-B8D6-A0C28A801DFC', + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签key。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签key。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签Value。', + 'type' => 'array', + 'items' => [ + 'description' => '标签Value。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6B0256B6-2442-5BEF-B8D6-A0C28A801DFC\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": [\\n \\"value1\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveUserTagsResponse>\\n <RequestId>6B0256B6-2442-5BEF-B8D6-A0C28A801DFC</RequestId>\\n <Tags>\\n <Key>key1</Key>\\n <Value>value1</Value>\\n </Tags>\\n</DescribeLiveUserTagsResponse>","errorExample":""}]', + 'title' => '获取直播用户标签', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'VerifyLiveDomainOwner' => [ + 'summary' => '调用VerifyLiveDomainOwner验证域名归属权。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107290', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '校验的域名。仅支持单域名校验。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'VerifyType', + 'in' => 'query', + 'schema' => [ + 'description' => '域名归属权验证方式，取值：'."\n" + ."\n" + .'- dnsCheck：DNS解析验证。'."\n" + .'- fileCheck：文件验证。', + 'type' => 'string', + 'required' => true, + 'example' => 'dnsCheck', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '校验内容。', + 'type' => 'string', + 'example' => 'verify_dffeb6610035dcb77b413******', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1BA6D7CE-55F1-5926-8764-F8663473AD0D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DomainOwnerVerifyFail', + 'errorMessage' => 'Owner verification of the root domain failed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Content\\": \\"verify_dffeb6610035dcb77b413******\\",\\n \\"RequestId\\": \\"1BA6D7CE-55F1-5926-8764-F8663473AD0D\\"\\n}","errorExample":""},{"type":"xml","example":"<VerifyLiveDomainOwnerResponse>\\n <Content>verify_dffeb6610035dcb77b413******</Content>\\n <RequestId>1BA6D7CE-55F1-5926-8764-F8663473AD0D</RequestId>\\n</VerifyLiveDomainOwnerResponse>","errorExample":""}]', + 'title' => '验证直播域名拥有者', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'DescribeLiveVerifyContent' => [ + 'summary' => '用于获取指定域名的归属校验内容。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '只支持单个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '校验内容。', + 'type' => 'string', + 'example' => 'verify_dffeb6610035dcb77b413******', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": \\"verify_dffeb6610035dcb77b413******\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\"\\n}","type":"json"}]', + 'title' => '查询校验归属权内容', + 'description' => '- 该API支持单个域名的验证内容查询。'."\n" + .'- 单用户调用频率限制为30次/秒。'."\n" + .'- 调用此API需要提供待验证的域名作为参数。'."\n" + .'- 成功调用后返回校验内容及请求ID，可用于后续操作或记录。', + ], + 'ChangeLiveDomainResourceGroup' => [ + 'summary' => '更改直播域名所属的资源组，即从原有资源组移入指定的资源组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235330', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '您的推流域名或播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '待转入的资源组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-****ke6uuxw****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******8F-F82F-10E2-BAE1-A036FD******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'LiveServiceNotFound', + 'errorMessage' => 'Your account does not open Live service yet', + ], + [ + 'errorCode' => 'LockFail', + 'errorMessage' => 'Domain has been occupied.', + ], + ], + 403 => [ + [ + 'errorCode' => 'EntityNotExist.ResourceGroup', + 'errorMessage' => 'The resource group does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******8F-F82F-10E2-BAE1-A036FD******\\"\\n}","type":"json"}]', + 'title' => '直播域名资源转组', + 'description' => '本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'SetLiveStreamPreloadTasks' => [ + 'summary' => '设置直播预热任务，支持批量设置直播流预热。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'PlayUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '直播URL，支持批量设置多个直播URL，多个URL之间用逗号（,）分隔，不超过100个。', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp://guide.aliyundoc.com/liveApp****/liveStream****', + ], + ], + [ + 'name' => 'Area', + 'in' => 'query', + 'schema' => [ + 'description' => '预热区域。取值：'."\n" + .'- domestic：中国内地。'."\n" + .'- overseas：海外及港澳台加速。'."\n" + .'- global：全球加速。'."\n" + .' '."\n" + .'如果不传该参数，默认的预热区域为您的域名所配置的加速区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'domestic', + 'enum' => [ + 'domestic', + 'overseas', + 'global', + ], + ], + ], + [ + 'name' => 'PreloadedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '预热开始时间，UTC格式，例如：2016-06-29T19:00:00Z，不填默认预热1小时。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-29T19:00:00Z', + ], + ], + [ + 'name' => 'PreloadedEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '预热结束时间，UTC格式，例如：2016-06-30T19:00:00Z，EndTime和StartTime之间的间隔不能超过6小时。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-30T19:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'FailedURL' => [ + 'description' => '预热任务设置失败的URL条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PreloadTasksMessages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PreloadTasksMessage' => [ + 'description' => '直播预热详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '直播预热详细信息。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '预热任务是否成功。取值：'."\n" + .'- Successfully：成功。'."\n" + .'- InternalError：失败。', + 'type' => 'string', + 'example' => 'Successfully', + ], + 'PlayUrl' => [ + 'description' => '直播URL。', + 'type' => 'string', + 'example' => 'rtmp://guide.aliyundoc.com/liveApp****/liveStream****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'yourTaskId', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => '36E0E523-E0C6-5D95-A465-A8EA2DCBA2A5', + ], + 'Status' => [ + 'description' => '任务状态。取值：'."\n" + .'- Success：成功。'."\n" + .'- Failed：失败。'."\n" + ."\n" + .'> 只要有一条任务创建失败即为失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'SuccessURL' => [ + 'description' => '预热任务设置成功的URL条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalURL' => [ + 'description' => '预热任务里URL总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not match the specified start time.', + ], + [ + 'errorCode' => 'Duration.Exceed', + 'errorMessage' => 'Duration between StartTime and EndTime is too long.', + ], + [ + 'errorCode' => 'QuotaExceeded.PreloadTaskslimit', + 'errorMessage' => 'Exceed max task count limit', + ], + [ + 'errorCode' => 'NoSpecialConfiguration', + 'errorMessage' => 'no special configuration for domain name.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"FailedURL\\": 0,\\n \\"PreloadTasksMessages\\": {\\n \\"PreloadTasksMessage\\": [\\n {\\n \\"Description\\": \\"Successfully\\",\\n \\"PlayUrl\\": \\"rtmp://guide.aliyundoc.com/liveApp****/liveStream****\\",\\n \\"TaskId\\": \\"yourTaskId\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"36E0E523-E0C6-5D95-A465-A8EA2DCBA2A5\\",\\n \\"Status\\": \\"Success\\",\\n \\"SuccessURL\\": 1,\\n \\"TotalURL\\": 1\\n}","errorExample":""},{"type":"xml","example":"<SetLiveStreamPreloadTasksResponse>\\n <FailedURL>0</FailedURL>\\n <PreloadTasksMessages>\\n <Description>Successfully</Description>\\n <PlayUrl>rtmp://guide.aliyundoc.com/liveApp****/liveStream****</PlayUrl>\\n <TaskId>yourTaskId</TaskId>\\n </PreloadTasksMessages>\\n <RequestId>36E0E523-E0C6-5D95-A465-A8EA2DCBA2A5</RequestId>\\n <Status>Success</Status>\\n <SuccessURL>1</SuccessURL>\\n <TotalURL>1</TotalURL>\\n</SetLiveStreamPreloadTasksResponse>","errorExample":""}]', + 'title' => '设置直播预热任务', + 'description' => '- 调用本接口可支持批量设置直播流预热，最多可一次性设置100个直播URL。'."\n" + .'- 直播预热仅不支持HLS格式的地址。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveStreamPreloadTasks' => [ + 'summary' => '仅支持查询最近3天内的数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。您可以通过调用[SetLiveStreamPreloadTasks](~~2519938~~)接口获取预热任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourTaskId', + ], + ], + [ + 'name' => 'PlayUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '直播URL，支持批量设置多个直播URL，多个URL之间用逗号（,）分隔，不超过100个。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://guide.aliyundoc.com/liveApp****/liveStream****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小，最大100，取值：1~100之间的任意整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '20', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '取得第几页，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态。取值：'."\n" + .'- complete：已完成。'."\n" + .'- pending：等待预热。'."\n" + .'- preloading：预热中。'."\n" + .'- failed：预热失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'complete', + 'enum' => [ + 'complete', + 'pending', + 'preloading', + 'failed', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间，UTC格式，例如：2016-06-29T19:00:00Z，开始时间必须在近3天内。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-29T19:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，UTC格式，例如：2016-06-30T19:00:00Z，EndTime和StartTime之间的间隔不能超过3天。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-30T19:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '分页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PreloadTasks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PreloadTask' => [ + 'description' => '直播预热详情。', + 'type' => 'array', + 'items' => [ + 'description' => '直播预热详情。', + 'type' => 'object', + 'properties' => [ + 'Area' => [ + 'description' => '预热区域。取值：'."\n" + .'- domestic：中国内地。'."\n" + .'- overseas：海外及港澳台加速。'."\n" + .'- global：全球加速。'."\n" + ."\n" + .'> 如果不传该参数，默认的预热区域为您的域名所配置的加速区域。', + 'type' => 'string', + 'example' => 'domestic', + ], + 'CreateTime' => [ + 'description' => '预热任务创建时间。', + 'type' => 'string', + 'example' => '2016-06-29T19:00:00Z', + ], + 'Description' => [ + 'description' => '预热任务是否成功。取值：'."\n" + .'- Successfully：成功。'."\n" + .'- InternalError：失败。', + 'type' => 'string', + 'example' => 'Successfully', + ], + 'DomainName' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'PlayUrl' => [ + 'description' => '直播URL。', + 'type' => 'string', + 'example' => 'rtmp://guide.aliyundoc.com/liveApp****/liveStream****', + ], + 'PreloadedEndTime' => [ + 'description' => '预热结束时间。', + 'type' => 'string', + 'example' => '2016-06-30T19:00:00Z', + ], + 'PreloadedStartTime' => [ + 'description' => '预热开始时间。', + 'type' => 'string', + 'example' => '2016-06-29T19:00:00Z', + ], + 'Process' => [ + 'description' => '进度百分比。', + 'type' => 'string', + 'example' => '100%', + ], + 'Status' => [ + 'description' => '任务状态。取值：'."\n" + .'- Success：成功。'."\n" + .'- Failed：失败。'."\n" + ."\n" + .'> 只要有一条任务创建失败即为失败', + 'type' => 'string', + 'example' => 'Success', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'yourTaskId', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E1564CBC-DCFE-5E1B-8B78-8DED9A39F334', + ], + 'TotalNum' => [ + 'description' => '符合条件的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not match the specified start time.', + ], + [ + 'errorCode' => 'Duration.Exceed', + 'errorMessage' => 'Duration between StartTime and EndTime is too long.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2,\\n \\"PreloadTasks\\": {\\n \\"PreloadTask\\": [\\n {\\n \\"Area\\": \\"domestic\\",\\n \\"CreateTime\\": \\"2016-06-29T19:00:00Z\\",\\n \\"Description\\": \\"Successfully\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"PlayUrl\\": \\"rtmp://guide.aliyundoc.com/liveApp****/liveStream****\\",\\n \\"PreloadedEndTime\\": \\"2016-06-30T19:00:00Z\\",\\n \\"PreloadedStartTime\\": \\"2016-06-29T19:00:00Z\\",\\n \\"Process\\": \\"100%\\",\\n \\"Status\\": \\"Success\\",\\n \\"TaskId\\": \\"yourTaskId\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"E1564CBC-DCFE-5E1B-8B78-8DED9A39F334\\",\\n \\"TotalNum\\": 1,\\n \\"TotalPage\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamPreloadTasksResponse>\\n <PageNum>1</PageNum>\\n <PageSize>2</PageSize>\\n <PreloadTasks>\\n <Area>domestic</Area>\\n <CreateTime>2016-06-29T19:00:00Z</CreateTime>\\n <Description>Successfully</Description>\\n <DomainName>example.com</DomainName>\\n <PlayUrl>rtmp://guide.aliyundoc.com/liveApp****/liveStream****</PlayUrl>\\n <PreloadedEndTime>2016-06-30T19:00:00Z</PreloadedEndTime>\\n <PreloadedStartTime>2016-06-29T19:00:00Z</PreloadedStartTime>\\n <Process>100%</Process>\\n <Status>Success</Status>\\n <TaskId>yourTaskId</TaskId>\\n </PreloadTasks>\\n <RequestId>E1564CBC-DCFE-5E1B-8B78-8DED9A39F334</RequestId>\\n <TotalNum>1</TotalNum>\\n <TotalPage>1</TotalPage>\\n</DescribeLiveStreamPreloadTasksResponse>","errorExample":""}]', + 'title' => '查询直播预热任务', + 'description' => '本接口仅支持查询最近3天内的数据。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'HotLiveRtcStream' => [ + 'summary' => '设置RTC流预热。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '142376', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '预热直播流App名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'app', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '预热直播流名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'stream', + ], + ], + [ + 'name' => 'RegionCode', + 'in' => 'query', + 'schema' => [ + 'description' => '预热区域，详细内容请查看RegionCode对应简码表格。'."\n" + ."\n" + .'> 预热区域粒度海外是国家简码，中国或中国内地是各省简码。'."\n" + .'> - 如果传入某个RegionCode后返回CodeRegionHasNoNode，说明对应区域没有L1节点覆盖，无法预热，可以更换RegionCode', + 'type' => 'string', + 'required' => true, + 'example' => 'ZHJ', + ], + ], + [ + 'name' => 'AudioMsid', + 'in' => 'query', + 'schema' => [ + 'description' => '音频Msid。', + 'type' => 'string', + 'required' => true, + 'example' => 'rts audio', + ], + ], + [ + 'name' => 'VideoMsid', + 'in' => 'query', + 'schema' => [ + 'description' => '视频Msid。', + 'type' => 'string', + 'required' => true, + 'example' => 'rts video', + ], + ], + [ + 'name' => 'ConnectionTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '预热链接保持的时间，单位毫秒。默认0是一直保持。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'MediaTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义超时事件的触发时间。单位毫秒。', + 'type' => 'string', + 'required' => false, + 'example' => '100000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16BFE188-B193-4C3C-ADC5-79A7E31486EA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + [ + 'errorCode' => 'NoSpecialConfiguration', + 'errorMessage' => 'no special configuration for domain name.', + ], + [ + 'errorCode' => 'CodeRegionHasNoNode', + 'errorMessage' => 'this region has no corresponding node.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16BFE188-B193-4C3C-ADC5-79A7E31486EA\\"\\n}","errorExample":""},{"type":"xml","example":"<HotLiveRtcStreamResponse>\\n <RequestId>16BFE188-B193-4C3C-ADC5-79A7E31486EA</RequestId>\\n</HotLiveRtcStreamResponse>","errorExample":""}]', + 'title' => '设置RTC流预热', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '### RegionCode对应简码'."\n" + .'**中国或中国内地代码**'."\n" + .'| 中文名 | 简码 |'."\n" + .'|---------------|--------|'."\n" + .'|北京市 | BEJ|'."\n" + .'|天津市 |TAJ |'."\n" + .'| 河北省|HEB |'."\n" + .'|山西省 |SHX |'."\n" + .'|内蒙古自治区 |NMG |'."\n" + .'|辽宁省 |LIA |'."\n" + .'|吉林省 |JIL |'."\n" + .'| 黑龙江省|HLJ |'."\n" + .'|上海市 | SHH|'."\n" + .'| 江苏省| JSU|'."\n" + .'|浙江省 | ZHJ|'."\n" + .'|安徽省 | ANH|'."\n" + .'| 福建省|FUJ |'."\n" + .'|江西省 | JXI|'."\n" + .'|山东省 |SHD |'."\n" + .'| 河南省|HEN |'."\n" + .'| 湖北省| HUB|'."\n" + .'| 湖南省| HUN|'."\n" + .'|广东省 |GUD |'."\n" + .'|广西壮族自治区 | GXI|'."\n" + .'|海南省 |HAI |'."\n" + .'|重庆市 |CHQ |'."\n" + .'| 四川省| SCH|'."\n" + .'|贵州省 | GUI|'."\n" + .'|云南省 | YUN|'."\n" + .'| 西藏自治区|TIB|'."\n" + .'|陕西省 |SHA |'."\n" + .'|甘肃省 |GAN |'."\n" + .'| 青海省|QIH |'."\n" + .'|宁夏回族自治区 |NXA |'."\n" + .'| 新疆维吾尔自治区| XIN|'."\n" + .'| 台湾省| TAI|'."\n" + .'|香港特别行政区 | HKG|'."\n" + .'|澳门特别行政区 |MAC |'."\n" + ."\n" + .'**国家代码**'."\n" + .'| 中文名 | 简码 |'."\n" + .'|---------------|--------|'."\n" + .'|巴布亚新几内亚|PG|'."\n" + .'|斯洛伐克|SK|'."\n" + .'|秘鲁|PE|'."\n" + .'|拉脱维亚|LV|'."\n" + .'|阿拉伯联合酋长国|AE|'."\n" + .'|加拿大|CA|'."\n" + .'|古巴|CU|'."\n" + .'|毛里塔尼亚|MR|'."\n" + .'|日本|JP|'."\n" + .'|亚美尼亚 |AM|'."\n" + .'|土库曼斯坦|TM|'."\n" + .'|俄罗斯|RU|'."\n" + .'|白俄罗斯|BY|'."\n" + .'|几内亚|GN|'."\n" + .'|伊拉克|IQ|'."\n" + .'|阿根廷|AR|'."\n" + .'|智利|CL|'."\n" + .'|斯威士兰|SZ|'."\n" + .'|刚果|CD|'."\n" + .'|比利时|BE|'."\n" + .'|哈萨克斯坦|KZ|'."\n" + .'|塞尔维亚 |RS|'."\n" + .'|土耳其|TR|'."\n" + .'|纳米比亚 |NA|'."\n" + .'|立陶宛|LT|'."\n" + .'|波多黎各 |PR|'."\n" + .'|刚果共和国|CG|'."\n" + .'|新喀里多尼亚 |NC|'."\n" + .'|摩洛哥|MA|'."\n" + .'|格陵兰岛 |GL|'."\n" + .'|科威特|KW|'."\n" + .'|利比里亚|LR|'."\n" + .'|乌克兰|UA|'."\n" + .'|印度尼西亚|ID|'."\n" + .'|缅甸|MM|'."\n" + .'|玻利维亚|BO|'."\n" + .'|摩尔多瓦 |MD|'."\n" + .'|希腊|GR|'."\n" + .'|新西兰|NZ|'."\n" + .'|索罗门群岛|SB|'."\n" + .'|埃塞俄比亚|ET|'."\n" + .'|斐济|FJ|'."\n" + .'|也门|YE|'."\n" + .'|塞浦路斯|CY|'."\n" + .'|波斯尼亚和黑塞哥维那|BA|'."\n" + .'|厄立特里亚|ER|'."\n" + .'|德国|DE|'."\n" + .'|巴基斯坦|PK|'."\n" + .'|中非共和国|CF|'."\n" + .'|克罗地亚|HR|'."\n" + .'|埃及|EG|'."\n" + .'|泰国|TH|'."\n" + .'|哥斯达黎加|CR|'."\n" + .'|坦桑尼亚 |TZ|'."\n" + .'|老挝|LA|'."\n" + .'|利比亚|LY|'."\n" + .'|突尼斯|TN|'."\n" + .'|波兰|PL|'."\n" + .'|英国|GB|'."\n" + .'|赤道几内亚|GQ|'."\n" + .'|中国|CN|'."\n" + .'|冰岛|IS|'."\n" + .'|阿曼|OM|'."\n" + .'|蒙古|MN|'."\n" + .'|乍得|TD|'."\n" + .'|美国|US|'."\n" + .'|墨西哥|MX|'."\n" + .'|吉尔吉斯斯坦 |KG|'."\n" + .'|苏里南|SR|'."\n" + .'|印度|IN|'."\n" + .'|几内亚比绍|GW|'."\n" + .'|委内瑞拉 |VE|'."\n" + .'|意大利|IT|'."\n" + .'|阿尔及利亚|DZ|'."\n" + .'|卡塔尔|QA|'."\n" + .'|法国|FR|'."\n" + .'|南非|ZA|'."\n" + .'|挪威|NO|'."\n" + .'|葡萄牙|PT|'."\n" + .'|匈牙利|HU|'."\n" + .'|韩国|KR|'."\n" + .'|乌兹别克斯坦|UZ|'."\n" + .'|布隆迪|BI|'."\n" + .'|爱沙尼亚|EE|'."\n" + .'|孟加拉国|BD|'."\n" + .'|不丹|BT|'."\n" + .'|阿富汗|AF'."\n" + .'|瑞士|CH|'."\n" + .'|伯利兹|BZ|'."\n" + .'|东帝汶|TL|'."\n" + .'|海地|HT|'."\n" + .'|多哥|TG|'."\n" + .'|阿尔巴尼亚|AL|'."\n" + .'|喀麦隆|CM|'."\n" + .'|尼加拉瓜|NI|'."\n" + .'|尼日利亚|NG|'."\n" + .'|洪都拉斯|HN|'."\n" + .'|布基纳法索|BF|'."\n" + .'|莫桑比克|MZ|'."\n" + .'|格鲁吉亚|GE|'."\n" + .'|瓦努阿图 |VU|'."\n" + .'|巴拉圭|PY|'."\n" + .'|卢森堡|LU|'."\n" + .'|黎巴嫩|LB|'."\n" + .'|乌干达|UG|'."\n" + .'|马里|ML|'."\n" + .'|沙特阿拉伯|SA|'."\n" + .'|巴勒斯坦|PS|'."\n" + .'|黑山|ME|'."\n" + .'|哥伦比亚 |CO|'."\n" + .'|菲律宾|PH|'."\n" + .'|瑞典|SE|'."\n" + .'|芬兰|FI|'."\n" + .'|肯尼亚|KE|'."\n" + .'|罗马尼亚|RO|'."\n" + .'|巴拿马|PA|'."\n" + .'|约旦|JO|'."\n" + .'|卢旺达|RW|'."\n" + .'|莱索托|LS|'."\n" + .'|马其顿|MK|'."\n" + .'|赞比亚|ZM|'."\n" + .'|叙利亚|SY|'."\n" + .'|西班牙|ES|'."\n" + .'|厄瓜多尔|EC|'."\n" + .'|加蓬|GA|'."\n" + .'|爱尔兰|IE|'."\n" + .'|多米尼加共和国|DO|'."\n" + .'|加纳|GH|'."\n" + .'|马达加斯加|MG|'."\n" + .'|马来西亚 |MY|'."\n" + .'|奥地利|AT|'."\n" + .'|塔吉克斯坦|TJ|'."\n" + .'|丹麦|DK|'."\n" + .'|乌拉圭|UY|'."\n" + .'|柬埔寨|KH|'."\n" + .'|塞内加尔|SN|'."\n" + .'|萨尔瓦多|SV|'."\n" + .'|塞拉利昂 |SL|'."\n" + .'|文莱达鲁萨兰国|BN|'."\n" + .'|西撒哈拉 |EH|'."\n" + .'|尼日尔|NE|'."\n" + .'|伊朗|IR|'."\n" + .'|圭亚那|GY|'."\n" + .'|安哥拉|AO|'."\n" + .'|博茨瓦纳|BW|'."\n" + .'|巴西|BR|'."\n" + .'|澳大利亚 |AU|'."\n" + .'|科特迪瓦 |CI|'."\n" + .'|捷克共和国|CZ|'."\n" + .'|冈比亚|GM|'."\n" + .'|贝宁|BJ|'."\n" + .'|越南|VN|'."\n" + .'|苏丹|SD|'."\n" + .'|荷兰|NL|'."\n" + .'|吉布提|DJ|'."\n" + .'|斯洛文尼亚|SI|'."\n" + .'|尼泊尔|NP|'."\n" + .'|津巴布韦|ZW|'."\n" + .'|牙买加|JM|'."\n" + .'|马拉维|MW|'."\n" + .'|阿塞拜疆 |AZ|'."\n" + .'|索马里|SO|'."\n" + .'|以色列|IL|'."\n" + .'|福克兰群岛（马尔维纳斯群岛）|FK'."\n" + .'|朝鲜|KP|'."\n" + .'|危地马拉 |GT|'."\n" + .'|巴哈马|BS|'."\n" + .'|斯里兰卡|LK|'."\n" + .'|新加坡|SG|'."\n" + .'|巴林|BH|', + ], + 'AddLivePullStreamInfoConfig' => [ + 'summary' => '添加拉流配置信息，包括源站地址、开始时间和结束时间。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '您的拉流域名为用户的主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称，用户自定义。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名，用户自定义。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'SourceUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '用户的直播流所在的源站完整url。多个源站可以填多个地址，用英文分号（;）分隔。'."\n" + .'> 仅支持拉取直播流，支持RTMP、FLV、HLS、SRT格式。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp://guide.aliyundoc.com/liveApp****/liveStream****;rtmp://developer.aliyundoc.com/liveApp****/liveStream****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '拉流开始时间。'."\n" + ."\n" + .'StartTime和EndTime时间间隔在7天内。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '拉流结束时间。'."\n" + ."\n" + .'StartTime和EndTime时间间隔在7天内，且EndTime超过当前时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time or current time.', + ], + [ + 'errorCode' => 'Duration.Exceed', + 'errorMessage' => 'Duration between StartTime and EndTime is too long.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + [ + 'errorCode' => 'PullStreamOverLimit', + 'errorMessage' => 'Pull stream is over limit for this domainName.', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","errorExample":""},{"type":"xml","example":"<AddLivePullStreamInfoConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CF8</RequestId>\\n</AddLivePullStreamInfoConfigResponse>","errorExample":""}]', + 'title' => '添加直播拉流配置信息', + 'description' => '- 请确保在使用该接口前，已充分了解直播拉流的收费方式和价格。计费详情，请参见[标准直播](~~195284~~)。'."\n" + ."\n" + .'- 拉流是将第三方直播流地址拉取到阿里直播中心进行加速分发的过程。'."\n" + .'- 本接口仅支持固定拉流方式，即指定拉流的起始时间和结束时间，在指定时间进行拉流直播。'."\n" + .'- 控制台支持固定拉流和触发拉流两种方式，详细内容请参见[拉流配置](~~199452~~)。'."\n" + .'- AppName与StreamName可自定义修改，不同的值生成不同的直播流地址。可用[地址生成器](~~197400~~)生成。'."\n" + .'- (DomainName, AppName, StreamName)三元组只能对应一个配置，如果该三元组已经存在一个配置了，再调用本接口添加配置会返回配置已存在错误。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLivePullStreamConfig' => [ + 'summary' => '调用DescribeLivePullStreamConfig查询域名下拉流配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '您的主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A3136B58-5876-4168-83CA-B562781981A0', + ], + 'LiveAppRecordList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveAppRecord' => [ + 'description' => '拉流配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2016-05-20T01:33:00Z', + ], + 'AppName' => [ + 'description' => '直播流所属应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'SourceUrl' => [ + 'description' => '拉流源站。', + 'type' => 'string', + 'example' => 'guide.aliyundoc.com', + ], + 'StartTime' => [ + 'description' => '开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2016-05-15T01:30:00Z', + ], + 'StreamName' => [ + 'description' => '拉流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'SourceUsing' => [ + 'description' => '当前正在使用的拉流源站。', + 'type' => 'string', + 'example' => 'guide.aliyundoc.com', + ], + 'DomainName' => [ + 'description' => '直播流所属的主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A3136B58-5876-4168-83CA-B562781981A0\\",\\n \\"LiveAppRecordList\\": {\\n \\"LiveAppRecord\\": [\\n {\\n \\"EndTime\\": \\"2016-05-20T01:33:00Z\\",\\n \\"AppName\\": \\"liveApp****\\",\\n \\"SourceUrl\\": \\"guide.aliyundoc.com\\",\\n \\"StartTime\\": \\"2016-05-15T01:30:00Z\\",\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"SourceUsing\\": \\"guide.aliyundoc.com\\",\\n \\"DomainName\\": \\"example.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLivePullStreamConfigResponse>\\n<RequestId>A3136B58-5876-4168-83CA-B562781981A0</RequestId>\\n<LiveAppRecordList>\\n <LiveAppRecord>\\n <SourceUrl>guide.aliyundoc.com</SourceUrl>\\n <StreamName>liveStream****</StreamName>\\n <EndTime>2016-05-20T01:33:00Z</EndTime>\\n <DomainName>example.com</DomainName>\\n <StartTime>2016-05-15T01:30:00Z</StartTime>\\n <SourceUsing>guide.aliyundoc.com</SourceUsing>\\n <AppName>liveApp****</AppName>\\n </LiveAppRecord>\\n</LiveAppRecordList>\\n</DescribeLivePullStreamConfigResponse>","errorExample":"{\\n \\"LiveAppRecordList\\":{\\n \\"LiveAppRecord\\":[{\\n \\"AppName\\":\\"xxxx\\",\\n \\"DomainName\\":\\"live.aliyunlive.com\\",\\n \\"EndTime\\":\\"2016-05-20T01:33:00Z\\",\\n \\"SourceUrl\\":\\"http://test\\",\\n \\"StartTime\\":\\"2016-05-15T01:30:00Z\\",\\n \\"StreamName\\":\\"xxxxxx\\"\\n }]\\n },\\n \\"RequestId\\":\\"A3136B58-5876-4168-83CA-B562781981A0\\"\\n}"}]', + 'title' => '查询域名下拉流配置信息', + 'description' => '本接口目前适用于固定拉流。调用本接口查询域名下固定拉流的配置信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLivePullStreamInfoConfig' => [ + 'summary' => '删除拉流配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。您可调用[DescribeLivePullStreamConfig](~~2847818~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。您可调用[DescribeLivePullStreamConfig](~~2847818~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLivePullStreamInfoConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteLivePullStreamInfoConfigResponse>","errorExample":""}]', + 'title' => '删除直播拉流配置', + 'description' => '本接口目前适用于固定拉流。调用本接口可以删除固定拉流的配置信息。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetLiveLazyPullStreamInfoConfig' => [ + 'summary' => '添加拉流信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。'."\n" + ."\n" + .'> 如果需要全部App都触发回源，则取值**ali_all_app**。', + 'type' => 'string', + 'required' => true, + 'example' => 'ali_all_app', + ], + ], + [ + 'name' => 'PullDomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所在的源站。多个源站使用英文分号（;）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'guide.aliyundoc.com', + ], + ], + [ + 'name' => 'PullAppName', + 'in' => 'query', + 'schema' => [ + 'description' => '回源拉流App。'."\n" + ."\n" + .'> 如果使用播放URL中的App，则此参数为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'livePullApp****', + ], + ], + [ + 'name' => 'TranscodeLazy', + 'in' => 'query', + 'schema' => [ + 'description' => '转码播放触发拉流。默认为**no**。可选值：'."\n" + ."\n" + .'- **yes**'."\n" + ."\n" + .'- **no**', + 'type' => 'string', + 'required' => false, + 'example' => 'no', + ], + ], + [ + 'name' => 'PullProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '回源拉流协议。取值：'."\n" + .'- **rtmp**'."\n" + .'- **httpflv**'."\n" + .'- **hls**', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","errorExample":""},{"type":"xml","example":"<SetLiveLazyPullStreamInfoConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CF8</RequestId>\\n</SetLiveLazyPullStreamInfoConfigResponse>","errorExample":""}]', + 'title' => '配置触发拉流', + 'description' => '本接口的拉流方式属于触发拉流，即当需要拉取的源站开始播放直播流时，自动触发阿里云视频直播服务进行拉流直播。'."\n" + ."\n" + .'> 本接口暂时不支持IPv6协议。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '| 错误代码 | 描述 | HTTP 状态码 | 语义 |'."\n" + .'| ------------- |------------ | ----- | ----- |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records.| 404 |当前账户下未查到域名|'."\n" + .'| IllegalOperation |Illegal domain operate is not permitted. |403 |不支持当前操作，如：非直播类域名|'."\n" + .'|Missing DomainName | DomainName is mandatory for this action. | 400 |缺少参数|'."\n" + .'| InternalError |The request processing has failed due to some unknown error. |500| 后台发生未知错误 |', + ], + 'DescribeLiveLazyPullStreamConfig' => [ + 'summary' => '查询播流域名下触发拉流配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '拉流配置。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A3136B58-5876-4168-83CA-B562781981A0', + ], + 'LiveLazyPullConfigList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveLazyPullConfig' => [ + 'description' => '拉流配置。', + 'type' => 'array', + 'items' => [ + 'description' => '拉流配置。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'PullArgs' => [ + 'description' => '回源拉流参数。', + 'type' => 'string', + 'example' => 'k=v', + ], + 'PullAppName' => [ + 'description' => '回源播流所属应用名称。 使用播放URL中的App则该项为空。', + 'type' => 'string', + 'example' => 'livePullApp****', + ], + 'PullProtocol' => [ + 'description' => '回源播流协议。取值：'."\n" + .'- **rtmp**'."\n" + .'- **httpflv**'."\n" + .'- **hls**', + 'type' => 'string', + 'example' => 'RTMP', + ], + 'PullDomainName' => [ + 'description' => '回源播域名。', + 'type' => 'string', + 'example' => 'guide.aliyundoc.com', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'TranscodeLazy' => [ + 'description' => '转码播放触发拉流。默认为**no**。可选值：'."\n" + ."\n" + .'- **yes**'."\n" + ."\n" + .'- **no**', + 'type' => 'string', + 'example' => 'no', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A3136B58-5876-4168-83CA-B562781981A0\\",\\n \\"LiveLazyPullConfigList\\": {\\n \\"LiveLazyPullConfig\\": [\\n {\\n \\"AppName\\": \\"liveApp****\\",\\n \\"PullArgs\\": \\"k=v\\",\\n \\"PullAppName\\": \\"livePullApp****\\",\\n \\"PullProtocol\\": \\"RTMP\\",\\n \\"PullDomainName\\": \\"guide.aliyundoc.com\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"TranscodeLazy\\": \\"no\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveLazyPullStreamConfigResponse>\\n <RequestId>A3136B58-5876-4168-83CA-B562781981A0</RequestId>\\n <LiveLazyPullConfigList>\\n <AppName>liveApp****</AppName>\\n <PullArgs>k=v</PullArgs>\\n <PullAppName>livePullApp****</PullAppName>\\n <PullProtocol>RTMP</PullProtocol>\\n <PullDomainName>guide.aliyundoc.com</PullDomainName>\\n <DomainName>example.com</DomainName>\\n <TranscodeLazy>no</TranscodeLazy>\\n </LiveLazyPullConfigList>\\n</DescribeLiveLazyPullStreamConfigResponse>","errorExample":""}]', + 'title' => '查询触发拉流配置', + 'description' => '本接口适用于触发拉流，调用本接口查询播流域名下触发拉流配置信息。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特殊错误码'."\n" + .'| 错误代码 | 描述 | HTTP 状态码 | 语义 |'."\n" + .'| ------------- |------------ | ----- | ----- |'."\n" + .'| Missing DomainName | DomainName is mandatory for this action.| 400 |缺少参数。|'."\n" + .'| InvalidDomain.NotFound |The domain provided does not exist in our records. |404 |当前账户下未查到域名。|'."\n" + ."\n", + ], + 'DeleteLiveLazyPullStreamInfoConfig' => [ + 'summary' => '删除触发拉流配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。'."\n" + ."\n" + .'> 如果需要删除全部App对应配置，则取值**ali_all_app**。', + 'type' => 'string', + 'required' => true, + 'example' => 'ali_all_app', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveLazyPullStreamInfoConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteLiveLazyPullStreamInfoConfigResponse>","errorExample":""}]', + 'title' => '删除触发拉流配置信息', + 'description' => '本接口目前适用于触发拉流。调用本接口删除触发拉流配置信息。如果AppName取值为ali_all_app，则可以删除全部App对应的触发拉流配置信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' | 错误代码 | 描述 | HTTP 状态码 | 语义 |'."\n" + .'| ------------- |------------ | ----- | ----- |'."\n" + .'| InternalError | The request processing has failed due to some unknown error.| 500 |后台发生未知错误。|'."\n" + .'|InvalidDomain.NotFound|The domain provided does not exist in our records. |404 |当前账户下未查到域名。|'."\n" + .'|IllegalOperation |Illegal domain operate is not permitted.| 404 |不支持当前操作，如：非直播类域名。|'."\n", + ], + 'UpdateLivePullStreamInfoConfig' => [ + 'summary' => '更新直播拉流配置信息，包括源站地址、开始时间和结束时间。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '您的拉流域名为用户的主播流域名。'."\n" + .'> - 传入DomainName时，请保证传入域名为直播域名，同时调用本接口的用户拥有传入域名的操作权限。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'SourceUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '用户的直播流所在的源站完整url。多个源站可以填多个地址，用英文分号（;）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp://guide.aliyundoc.com/liveApp****/liveStream****;rtmp://developer.aliyundoc.com/liveApp****/liveStream****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '拉流开始时间。'."\n" + ."\n" + .'StartTime和EndTime时间间隔在7天内。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '拉流结束时间。'."\n" + ."\n" + .'StartTime和EndTime时间间隔在7天内，且EndTime超过当前时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'Duration.Exceed', + 'errorMessage' => 'Duration between StartTime and EndTime is too long.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLivePullStreamInfoConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CF8</RequestId>\\n</UpdateLivePullStreamInfoConfigResponse>","errorExample":""}]', + 'title' => '更新直播拉流配置', + 'description' => '本接口目前适用于固定拉流。调用本接口更新直播拉流配置信息，包括源站地址、开始时间和结束时间。'."\n" + ."\n" + .'> 调用本接口修改配置后，直播服务会按照修改后配置重新执行固定拉流，请确保修改操作不会影响线上业务。'."\n" + ."\n" + .'## QPS限制'."\n" + ."\n" + .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特殊错误码'."\n" + .'| 错误代码 | 描述 | HTTP 状态码 | 语义 |'."\n" + .'|------------|--------|---------|------|'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误 |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名 |'."\n" + .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 不支持当前操作，如：非直播类域名 |'."\n" + .'| Duration.Exceed | Duration between StartTime and EndTime is too long. | 400 | 查询时间范围过长|', + ], + 'DescribeLiveStreamsBlockList' => [ + 'summary' => '调用DescribeLiveStreamsBlockList获取域名下直播流播放的黑名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。取值范围：**1~3000**，默认值为**2000**。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '3000', + 'minimum' => '1', + 'example' => '10', + 'default' => '2000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '分页的当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9D855EC8-CF71-4615-B164-F7DFCB23B41D', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalNum' => [ + 'description' => '符合条件的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'StreamUrls' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StreamUrl' => [ + 'description' => '完整流url地址。', + 'type' => 'array', + 'items' => [ + 'description' => '完整流URL地址。', + 'type' => 'string', + 'example' => 'example.com/liveApp****/liveStream****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 2,\\n \\"RequestId\\": \\"9D855EC8-CF71-4615-B164-F7DFCB23B41D\\",\\n \\"TotalPage\\": 2,\\n \\"PageSize\\": 10,\\n \\"TotalNum\\": 11,\\n \\"DomainName\\": \\"example.com\\",\\n \\"StreamUrls\\": {\\n \\"StreamUrl\\": [\\n \\"example.com/liveApp****/liveStream****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamsBlockListResponse>\\n <PageNum>2</PageNum>\\n <RequestId>9D855EC8-CF71-4615-B164-F7DFCB23B41D</RequestId>\\n <TotalPage>2</TotalPage>\\n <PageSize>10</PageSize>\\n <TotalNum>11</TotalNum>\\n <DomainName>example.com</DomainName>\\n <StreamUrls>example.com/liveApp****/liveStream****</StreamUrls>\\n</DescribeLiveStreamsBlockListResponse>","errorExample":""}]', + 'title' => '获取域名下直播流播放的黑名单', + 'description' => '调用本接口获取域名下直播流播放的黑名单。其中直播流指的是主播流。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamsControlHistory' => [ + 'summary' => '获取某个域名或应用下的直播流操作历史。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> EndTime和StartTime之间的间隔不能超过7天。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9C31856F-386D-4DB3-BE79-A0AA493D702A', + ], + 'ControlInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveStreamControlInfo' => [ + 'description' => '直播流的操作记录。', + 'type' => 'array', + 'items' => [ + 'description' => '直播流的操作记录。', + 'type' => 'object', + 'properties' => [ + 'ClientIP' => [ + 'description' => '用户端的IP地址。', + 'type' => 'string', + 'example' => '10.207.XX.XX', + ], + 'TimeStamp' => [ + 'description' => '操作执行的时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-01T16:36:18Z', + ], + 'Action' => [ + 'description' => '执行的操作名称。', + 'type' => 'string', + 'example' => 'DescribeLiveStreamsControlHistory', + ], + 'StreamName' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9C31856F-386D-4DB3-BE79-A0AA493D702A\\",\\n \\"ControlInfo\\": {\\n \\"LiveStreamControlInfo\\": [\\n {\\n \\"ClientIP\\": \\"10.207.XX.XX\\",\\n \\"TimeStamp\\": \\"2015-12-01T16:36:18Z\\",\\n \\"Action\\": \\"DescribeLiveStreamsControlHistory\\",\\n \\"StreamName\\": \\"liveStream****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveStreamsControlHistoryResponse>\\n<RequestId>9C31856F-386D-4DB3-BE79-A0AA493D702A</RequestId>\\n<ControlInfo>\\n <LiveStreamControlInfo>\\n <Action>DescribeLiveStreamsControlHistory</Action>\\n <StreamName>liveStream****</StreamName>\\n <ClientIP>10.207.XX.XX</ClientIP>\\n <TimeStamp>2015-12-01T16:36:18Z</TimeStamp>\\n </LiveStreamControlInfo>\\n</ControlInfo>\\n</DescribeLiveStreamsControlHistoryResponse>","errorExample":""}]', + 'title' => '查询直播流操作历史', + 'description' => '调用本接口获取某个域名或应用下的直播流操作历史。其中直播流操作指的是对这个直播流进行过的接口操作。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamBitRateData' => [ + 'summary' => '查询RTMP协议的直播流在设置时间范围内的一组帧率和码率，适用于获取历史数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名。'."\n" + .'> - 传入DomainName时，请保证传入域名为直播域名，同时调用本接口的用户拥有传入域名的操作权限。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '流的名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> '."\n" + .'> - EndTime要大于StartTime，并且EndTime与StartTime间隔最多为30天', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'FrameRateAndBitRateInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FrameRateAndBitRateInfo' => [ + 'description' => '各直播流的帧率、码率信息。', + 'type' => 'array', + 'items' => [ + 'description' => '各直播流的帧率、码率信息。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '统计时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2016-09-13T16:04:00Z', + ], + 'VideoFrameRate' => [ + 'description' => '直播流的视频帧率。单位：FPS。', + 'type' => 'number', + 'format' => 'float', + 'example' => '30', + ], + 'AudioFrameRate' => [ + 'description' => '直播流的音频帧率。单位：FPS。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'StreamUrl' => [ + 'description' => '直播流的URL。', + 'type' => 'string', + 'example' => 'rtmp://guide.aliyundoc.com/liveAppName****/liveSteamName****', + ], + 'BitRate' => [ + 'description' => '直播流的码率。单位：Bps。', + 'type' => 'number', + 'format' => 'float', + 'example' => '600', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAppName.Malformed', + 'errorMessage' => 'Specified AppName is malformed.', + ], + [ + 'errorCode' => 'InvalidStreamName.Malformed', + 'errorMessage' => 'Specified StreamName is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidTime.ValueNotSupported', + 'errorMessage' => 'StartTime or EndTime is miss match.', + ], + [ + 'errorCode' => 'InvalidStreamNumber.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"FrameRateAndBitRateInfos\\": {\\n \\"FrameRateAndBitRateInfo\\": [\\n {\\n \\"Time\\": \\"2016-09-13T16:04:00Z\\",\\n \\"VideoFrameRate\\": 30,\\n \\"AudioFrameRate\\": 100,\\n \\"StreamUrl\\": \\"rtmp://guide.aliyundoc.com/liveAppName****/liveSteamName****\\",\\n \\"BitRate\\": 600\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamBitRateDataResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n <FrameRateAndBitRateInfos>\\n <FrameRateAndBitRateInfo>\\n <VideoFrameRate>30</VideoFrameRate>\\n <Time>2016-09-13T16:04:00Z</Time>\\n <BitRate>600</BitRate>\\n <AudioFrameRate>100</AudioFrameRate>\\n <StreamUrl>rtmp://guide.aliyundoc.com/liveAppName****/liveSteamName****</StreamUrl>\\n </FrameRateAndBitRateInfo>\\n </FrameRateAndBitRateInfos>\\n</DescribeLiveStreamBitRateDataResponse>","errorExample":""}]', + 'title' => '查询RTMP协议直播流的帧率和码率', + 'description' => '调用本接口查询RTMP协议的直播流在设置时间范围内的一组帧率和码率，适用于获取历史数据。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamsOnlineList' => [ + 'summary' => '查询指定域名或者指定域名下某个应用的所有在线流信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '107103', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。'."\n" + .'> - 传入DomainName时，请保证传入域名为直播域名，同时调用本接口的用户拥有传入域名的操作权限。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称，仅支持输入单个StreamName。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'OnlyStream', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只返回指定字段。取值： '."\n" + ."\n" + .'- **yes**：结果只返回DomainName，AppName，StreamName，PublishTime 字段。 '."\n" + ."\n" + .'- **no**（默认值）：结果返回全部字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'no', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。取值范围：1~3000，默认值为2000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1500', + 'default' => '2000', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '流类型。取值： '."\n" + ."\n" + .'- **all**（默认值）：查询所有流。'."\n" + .' '."\n" + .'- **raw**：查询原始流。'."\n" + .' '."\n" + .'- **trans**：查询转码流。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + 'enum' => [ + 'all', + 'raw', + 'trans', + ], + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定是否模糊匹配流名称。取值：'."\n" + ."\n" + .'- **fuzzy**（默认值）：模糊匹配。'."\n" + ."\n" + .'- **strict**：精准匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'fuzzy', + 'enum' => [ + 'fuzzy', + 'strict', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '在线流信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64- af62-20e91b9676b3', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageNum' => [ + 'description' => '分页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalNum' => [ + 'description' => '符合条件的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'OnlineInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveStreamOnlineInfo' => [ + 'description' => '正在推送流的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '正在推送流的信息。', + 'type' => 'object', + 'properties' => [ + 'AudioDataRate' => [ + 'description' => '直播流的音频码率。单位：Kbps。'."\n" + .'> 此参数需提交工单添加白名单配置后开启，关于如何提交工单，请参见联系我们。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '600', + ], + 'FrameRate' => [ + 'description' => '帧率。单位：FPS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'PublishUrl' => [ + 'description' => '推流完整URL地址。', + 'type' => 'string', + 'example' => 'rtmp://demo.aliyundoc.com/live/test****', + ], + 'StreamName' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'AudioCodecId' => [ + 'description' => '音频Codec ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Height' => [ + 'description' => '视频分辨率高度。单位：pixel。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '720', + ], + 'VideoDataRate' => [ + 'description' => '直播流的视频码率。单位：Kbps。'."\n" + .'> 此参数需提交工单添加白名单配置后开启，关于如何提交工单，请参见联系我们。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '600', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'PublishDomain' => [ + 'description' => '推流域名，使用中心推流的可直接填写播流域名。', + 'type' => 'string', + 'example' => 'demo.aliyundoc.com', + ], + 'PublishTime' => [ + 'description' => '开始推流时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-08-09T02:37:59Z', + ], + 'AppName' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'PublishType' => [ + 'description' => '推流类型，取值：'."\n" + ."\n" + .'- **edge**：边缘推流。'."\n" + ."\n" + .'- **center**：中心推流。', + 'type' => 'string', + 'example' => 'edge', + ], + 'VideoCodecId' => [ + 'description' => '视频Codec ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'Transcoded' => [ + 'description' => '是否是转码流。取值：'."\n" + ."\n" + .'- **yes**：是。'."\n" + ."\n" + .'- **no**：否。', + 'type' => 'string', + 'example' => 'no', + ], + 'Width' => [ + 'description' => '视频分辨率宽度。单位：pixel。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1280', + ], + 'ClientIp' => [ + 'description' => '推流客户端IP。', + 'type' => 'string', + 'example' => '106.11.XX.XX', + ], + 'ServerIp' => [ + 'description' => '推流节点IP。', + 'type' => 'string', + 'example' => '120.221.XX.XX', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'QpsOverLimit', + 'errorMessage' => 'Qps is over limit for this domainName.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not match the specified start time.', + ], + [ + 'errorCode' => 'Duration.Exceed', + 'errorMessage' => 'Duration between StartTime and EndTime is too long.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0df228-4a64- af62-20e91b9676b3\\",\\n \\"TotalPage\\": 2,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalNum\\": 11,\\n \\"OnlineInfo\\": {\\n \\"LiveStreamOnlineInfo\\": [\\n {\\n \\"AudioDataRate\\": 600,\\n \\"FrameRate\\": 15,\\n \\"PublishUrl\\": \\"rtmp://demo.aliyundoc.com/live/test****\\",\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"AudioCodecId\\": 10,\\n \\"Height\\": 720,\\n \\"VideoDataRate\\": 600,\\n \\"DomainName\\": \\"example.com\\",\\n \\"PublishDomain\\": \\"demo.aliyundoc.com\\",\\n \\"PublishTime\\": \\"2021-08-09T02:37:59Z\\",\\n \\"AppName\\": \\"liveApp****\\",\\n \\"PublishType\\": \\"edge\\",\\n \\"VideoCodecId\\": 7,\\n \\"Transcoded\\": \\"no\\",\\n \\"Width\\": 1280,\\n \\"ClientIp\\": \\"106.11.XX.XX\\",\\n \\"ServerIp\\": \\"120.221.XX.XX\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamsOnlineListResponse>\\n <TotalPage>2</TotalPage>\\n <PageNum>1</PageNum>\\n <PageSize>10</PageSize>\\n <RequestId>5c6a2a0df228-4a64- af62-20e91b9676b3</RequestId>\\n <TotalNum>11</TotalNum>\\n <OnlineInfo>\\n <AudioDataRate>600</AudioDataRate>\\n <FrameRate>15</FrameRate>\\n <PublishUrl>rtmp://demo.aliyundoc.com/live/test****</PublishUrl>\\n <StreamName>liveStream****</StreamName>\\n <AudioCodecId>10</AudioCodecId>\\n <Height>720</Height>\\n <VideoDataRate>600</VideoDataRate>\\n <DomainName>example.com</DomainName>\\n <PublishDomain>demo.aliyundoc.com</PublishDomain>\\n <PublishTime>2021-08-09T02:37:59Z</PublishTime>\\n <AppName>liveApp****</AppName>\\n <PublishType>edge</PublishType>\\n <VideoCodecId>7</VideoCodecId>\\n <Transcoded>no</Transcoded>\\n <Width>1280</Width>\\n <ClientIp>106.11.XX.XX</ClientIp>\\n <ServerIp>120.221.XX.XX</ServerIp>\\n </OnlineInfo>\\n</DescribeLiveStreamsOnlineListResponse>","errorExample":""}]', + 'title' => '查询域名在线流列表', + 'description' => '本接口目前支持以下几种流类型： '."\n" + ."\n" + .'- all：查询所有流。'."\n" + ."\n" + .'- raw：查询原始流。'."\n" + ."\n" + .'- trans：查询转码流。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamsPublishList' => [ + 'summary' => '获取某一时间段内某个域名（或域名下某应用或某个流）的历史推流记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '107105', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名或主播流域名。'."\n" + .'> - 传入DomainName时，请保证传入域名为直播域名，同时调用本接口的用户拥有传入域名的操作权限。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '推流时间。'."\n" + ."\n" + .'格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。EndTime和StartTime之间的间隔不能超过30天。'."\n" + ."\n" + .'格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。取值范围：**1~3000**，默认值为**2000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1500', + 'default' => '2000', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '流类型。取值：'."\n" + ."\n" + .'- **不传**：查询原始流。'."\n" + .'- **all**：查询所有流。'."\n" + .'- **trans**：查询转码流。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + 'enum' => [ + 'all', + 'raw', + 'trans', + ], + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定是否模糊匹配流名称。取值：'."\n" + .'- **fuzzy**（默认值）：模糊匹配。'."\n" + .'- **strict**：精准匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'fuzzy', + 'enum' => [ + 'fuzzy', + 'strict', + ], + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式。取值：'."\n" + ."\n" + .'- **stream_name_desc**：按直播流名称倒序。'."\n" + .'- **stream_name_asc**：按直播流名称升序。'."\n" + .'- **publish_time_desc**：按推流时间倒序。'."\n" + .'- **publish_time_asc**（默认值）：按推流时间升序。', + 'type' => 'string', + 'required' => false, + 'example' => 'publish_time_desc', + 'enum' => [ + 'stream_name_desc', + 'stream_name_asc', + 'publish_time_desc', + 'publish_time_asc', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageNum' => [ + 'description' => '分页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => ' 40A4F36D-A7CC-473A-88E7-154F92242566', + ], + 'TotalNum' => [ + 'description' => '符合条件的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'PublishInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveStreamPublishInfo' => [ + 'description' => '推流记录信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EdgeNodeAddr' => [ + 'description' => 'CDN上行节点IP。', + 'type' => 'string', + 'example' => '10.175.XX.XX', + ], + 'PublishUrl' => [ + 'description' => '推流完整URL地址。', + 'type' => 'string', + 'example' => 'rtmp://demo.aliyundoc.com/liveApp****/liveStream****', + ], + 'StreamName' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'DomainName' => [ + 'description' => '推流域名或主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'StopTime' => [ + 'description' => '停止推流时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-02T03:11:19Z', + ], + 'TranscodeId' => [ + 'description' => '转码模板ID。'."\n" + .'> 当Transcoded参数为no时，不返回此参数。', + 'type' => 'string', + 'example' => 'ld', + ], + 'PublishDomain' => [ + 'description' => '推流域名。', + 'type' => 'string', + 'example' => 'demo.aliyundoc.com', + ], + 'AppName' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'PublishTime' => [ + 'description' => '开始推流时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-02T03:05:53Z', + ], + 'PublishType' => [ + 'description' => '推流类型。取值：'."\n" + ."\n" + .'- **edge**：边缘推流。'."\n" + .'- **center**：中心推流。'."\n", + 'type' => 'string', + 'example' => 'edge', + ], + 'Transcoded' => [ + 'description' => '是否是转码流。', + 'type' => 'string', + 'example' => 'yes', + ], + 'ClientAddr' => [ + 'description' => '主播IP。', + 'type' => 'string', + 'example' => '10.175.XX.XX', + ], + 'StreamUrl' => [ + 'description' => '播流的URL。', + 'type' => 'string', + 'example' => 'http://example.com/liveApp****/liveStream****.flv', + ], + 'AliInnerErrorFlags' => [ + 'description' => '断流原因错误码。格式为：3个数字或1个数字。', + 'type' => 'string', + 'example' => '002', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'QpsOverLimit', + 'errorMessage' => 'Qps is over limit for this domainName.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not match the specified start time.', + ], + [ + 'errorCode' => 'Duration.Exceed', + 'errorMessage' => 'Duration between StartTime and EndTime is too long.', + ], + [ + 'errorCode' => 'LiveServiceNotFound', + 'errorMessage' => 'Your account does not open Live service yet', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalPage\\": 2,\\n \\"PageNum\\": 2,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\" 40A4F36D-A7CC-473A-88E7-154F92242566\\",\\n \\"TotalNum\\": 11,\\n \\"PublishInfo\\": {\\n \\"LiveStreamPublishInfo\\": [\\n {\\n \\"EdgeNodeAddr\\": \\"10.175.XX.XX\\",\\n \\"PublishUrl\\": \\"rtmp://demo.aliyundoc.com/liveApp****/liveStream****\\",\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"StopTime\\": \\"2015-12-02T03:11:19Z\\",\\n \\"TranscodeId\\": \\"ld\\",\\n \\"PublishDomain\\": \\"demo.aliyundoc.com\\",\\n \\"AppName\\": \\"liveApp****\\",\\n \\"PublishTime\\": \\"2015-12-02T03:05:53Z\\",\\n \\"PublishType\\": \\"edge\\",\\n \\"Transcoded\\": \\"yes\\",\\n \\"ClientAddr\\": \\"10.175.XX.XX\\",\\n \\"StreamUrl\\": \\"http://example.com/liveApp****/liveStream****.flv\\",\\n \\"AliInnerErrorFlags\\": \\"002\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveStreamsPublishListResponse>\\n<TotalNum>11</TotalNum>\\n<TotalPage>2</TotalPage>\\n<PageSize>10</PageSize>\\n<PageNum>2</PageNum>\\n<RequestId> 40A4F36D-A7CC-473A-88E7-154F92242566</RequestId>\\n<PublishInfo>\\n <LiveStreamPublishInfo>\\n <PublishUrl>rtmp://demo.aliyundoc.com/liveApp****/liveStream****</PublishUrl>\\n <ClientAddr>10.175.XX.XX</ClientAddr>\\n <StreamName>liveStream****</StreamName>\\n <TranscodeId>ld</TranscodeId>\\n <DomainName>example.com</DomainName>\\n <EdgeNodeAddr>10.175.XX.XX</EdgeNodeAddr>\\n <PublishDomain>demo.aliyundoc.com</PublishDomain>\\n <Transcoded>yes</Transcoded>\\n <PublishTime>2015-12-02T03:05:53Z</PublishTime>\\n <PublishType>edge</PublishType>\\n <StreamUrl>http://example.com/liveApp****/liveStream****.flv</StreamUrl>\\n <StopTime>2015-12-02T03:11:19Z</StopTime>\\n <AppName>liveApp****</AppName>\\n </LiveStreamPublishInfo>\\n</PublishInfo>\\n</DescribeLiveStreamsPublishListResponse>","errorExample":"{\\n \\"PageNum\\":2,\\n \\"PageSize\\":10,\\n \\"PublishInfo\\":{\\n \\"LiveStreamPublishInfo\\":[{\\n \\"AppName\\":\\"xchen\\",\\n \\"ClientAddr\\":\\"10.175.60.33\\",\\n \\"DomainName\\":\\"test101.cdnpe.com\\",\\n \\"EdgeNodeAddr\\":\\"10.175.30.21\\",\\n \\"PublishDomain\\":\\"test101.cdnpe.com\\",\\n \\"PublishTime\\":\\"2015-12-02T03:05:53Z\\",\\n \\"PublishUrl\\":\\"rtmp://test101.cdnpe.com/xchen\\",\\n \\"StopTime\\":\\"2015-12-02T03:11:19Z\\",\\n \\"StreamName\\":\\"testxchen\\",\\n \\"StreamUrl\\":\\"rtmp://xxx/xxxx\\"\\n }]\\n },\\n \\"RequestId\\":\\"1C0E0C22-77B7-42AC-8212-AF99B2E0077F\\",\\n \\"TotalNum\\":11,\\n \\"TotalPage\\":2\\n}"}]', + 'title' => '查询域名历史流列表', + 'description' => '调用本接口最多可查询近30天的历史流。返回的数据为查询时间段内的在线流信息。本接口目前支持以下排序方式：'."\n" + ."\n" + .'- stream_name_desc：按直播流名称倒序。'."\n" + ."\n" + .'- stream_name_asc：按直播流名称升序。'."\n" + ."\n" + .'- publish_time_desc：按推流时间倒序。'."\n" + ."\n" + .'- publish_time_asc：按推流时间升序。'."\n" + ."\n\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为3次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ForbidLiveStream' => [ + 'summary' => '禁止某条流的推送，可以预设某个时刻将流恢复。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'LiveStreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '用于指定禁止推流或者播流。目前仅支持禁止推流：**publisher**。', + 'type' => 'string', + 'required' => true, + 'example' => 'publisher', + 'enum' => [ + 'publisher', + ], + ], + ], + [ + 'name' => 'Oneshot', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只断流不加入黑名单。取值：'."\n" + ."\n" + .'- **yes**：只断流不加黑名单（支持上行推送或上行播流）。'."\n" + ."\n" + .'- **no**：断流加入黑名单。'."\n" + ."\n" + .'> 不填默认为no。', + 'type' => 'string', + 'required' => false, + 'example' => 'yes', + 'enum' => [ + 'yes', + 'no', + ], + ], + ], + [ + 'name' => 'ResumeTime', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复流的时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> - 当**Oneshot**参数为**no**时，ResumeTime不传值时默认禁止直播流指定时间为6个月。'."\n" + .'> - 如果传值则可在ResumeTime指定的时间点解除限制，恢复直播流。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-01T10:37:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16BFE188-B193-4C3C-ADC5-79A7E31486EA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidResumeTime.Malformed', + 'errorMessage' => 'Specified parameter ResumeTime is not valid.', + ], + [ + 'errorCode' => 'QuotaExceeded.Blacklist', + 'errorMessage' => 'Exceed max blacklist count limit', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16BFE188-B193-4C3C-ADC5-79A7E31486EA\\"\\n}","errorExample":""},{"type":"xml","example":"<ForbidLiveStreamResponse>\\n <RequestId>16BFE188-B193-4C3C-ADC5-79A7E31486EA</RequestId>\\n</ForbidLiveStreamResponse>","errorExample":""}]', + 'title' => '禁止直播流', + 'description' => '调用本接口禁止某条流的推送，可以预设某个时刻将流恢复。如果没有预设时间，请通过[ResumeLiveStream](~~2847831~~)接口恢复直播流。本接口目前仅支持publisher（主播推流）。'."\n" + ."\n" + .'> - 本接口通过添加黑名单的方式禁止直播流，上限为10,000路，超出限制将禁用失败，请您注意统计当前禁用流的数量。请通过[DescribeLiveStreamsBlockList接口](~~2847825~~)查询禁用流数量。'."\n" + .'> - 若只中断直播流，而不加入黑名单，则不会占用黑名单中的10000 个名额。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ResumeLiveStream' => [ + 'summary' => '恢复某条流的推送。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'LiveStreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '用于指定主播推流或客户端播流。目前支持：**publisher**（主播推流）。', + 'type' => 'string', + 'required' => true, + 'example' => 'publisher', + 'enum' => [ + 'publisher', + ], + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流所属应用名称。可以填为*，表示所有AppName（即不限制AppName）。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16BFE188-B193-4C3C-ADC5-79A7E31486EA', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16BFE188-B193-4C3C-ADC5-79A7E31486EA\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<ResumeLiveStreamResponse>\\n\\t<RequestId>16BFE188-B193-4C3C-ADC5-79A7E31486EA</RequestId>\\n</ResumeLiveStreamResponse>","errorExample":"{\\n \\"RequestId\\":\\"16BFE188-B193-4C3C-ADC5-79A7E31486EA\\"\\n}"}]', + 'title' => '开始或恢复某条直播流的推送', + 'description' => '调用本接口恢复某条推流的推送。本接口目前仅支持publisher（主播推流）。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveDomainOnlineUserNum' => [ + 'summary' => '查询域名下所有流的在线人数信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107024', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'QueryTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2018-12-27T13:09:21Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3A3A8C3D-F8B2-4FBF-9319-771A11B855FA', + ], + 'UserCount' => [ + 'description' => '查询时间下域名的所有在线人数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StreamCount' => [ + 'description' => '流数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OnlineUserInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveStreamOnlineUserNumInfo' => [ + 'description' => '流的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StreamName' => [ + 'description' => '流名称。', + 'type' => 'string', + 'example' => 'rtmp://example.com/test/liveStream****_3_1', + ], + 'Infos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Info' => [ + 'description' => '流统计信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserNumber' => [ + 'description' => '转码流或原始流的人数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TranscodeTemplate' => [ + 'description' => '转码模板。origin为原始流。', + 'type' => 'string', + 'example' => 'origin', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + [ + 'errorCode' => 'InvalidQueryTime.Exceed', + 'errorMessage' => 'QueryTime exceed three month.', + ], + [ + 'errorCode' => 'InvalidQueryTime.Malformed', + 'errorMessage' => 'Specified QueryTime is malformed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3A3A8C3D-F8B2-4FBF-9319-771A11B855FA\\",\\n \\"UserCount\\": 1,\\n \\"StreamCount\\": 1,\\n \\"OnlineUserInfo\\": {\\n \\"LiveStreamOnlineUserNumInfo\\": [\\n {\\n \\"StreamName\\": \\"rtmp://example.com/test/liveStream****_3_1\\",\\n \\"Infos\\": {\\n \\"Info\\": [\\n {\\n \\"UserNumber\\": 1,\\n \\"TranscodeTemplate\\": \\"origin\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDomainOnlineUserNumResponse>\\n<StreamCount>1</StreamCount>\\n<OnlineUserInfo>\\n <LiveStreamOnlineUserNumInfo>\\n <StreamName>rtmp://example.com/test/liveStream****_3_1</StreamName>\\n <Infos>\\n <Info>\\n <TranscodeTemplate>origin</TranscodeTemplate>\\n <UserNumber>1</UserNumber>\\n </Info>\\n </Infos>\\n </LiveStreamOnlineUserNumInfo>\\n</OnlineUserInfo>\\n<RequestId>3A3A8C3D-F8B2-4FBF-9319-771A11B855FA</RequestId>\\n<UserCount>1</UserCount>\\n</DescribeLiveDomainOnlineUserNumResponse>","errorExample":""}]', + 'title' => '查询域名下所有流某分钟的在线人数信息', + 'description' => '本接口目前只支持FLV、RTS和RTMP播放在线人数统计，暂不支持HLS播放在线人数统计。 数据采集和统计有一定延迟，建议您查询5分钟前的数据。'."\n" + ."\n" + .'>请使用本接口替换原有的DescribeLiveStreamOnlineUserNum（已废弃）接口。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为200次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveDomainFrameRateAndBitRateData' => [ + 'summary' => '查询推流域名下流帧率和码率数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名。'."\n" + .'> - 传入DomainName时，请保证传入域名为直播域名，同时调用本接口的用户拥有传入域名的操作权限。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'QueryTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2019-02-21T08:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C3F2C2C4-59BB-4B62-81FF-345BE557E3E3', + ], + 'FrameRateAndBitRateInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FrameRateAndBitRateInfo' => [ + 'description' => '播流的帧率和码率信息。', + 'type' => 'array', + 'items' => [ + 'description' => '播流的帧率和码率信息。', + 'type' => 'object', + 'properties' => [ + 'VideoFrameRate' => [ + 'description' => '直播流的视频帧率。单位：FPS。', + 'type' => 'number', + 'format' => 'float', + 'example' => '24.9', + ], + 'StreamUrl' => [ + 'description' => '直播流的URL。', + 'type' => 'string', + 'example' => 'rtmp://demo.aliyundoc.com/test/liveStream****_3_4', + ], + 'AudioFrameRate' => [ + 'description' => '直播流的音频帧率。单位：FPS。', + 'type' => 'number', + 'format' => 'float', + 'example' => '42.9', + ], + 'BitRate' => [ + 'description' => '直播流的码率。单位：Bps。', + 'type' => 'number', + 'format' => 'float', + 'example' => '30693.96', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + [ + 'errorCode' => 'InvalidQueryTime.Exceed', + 'errorMessage' => 'QueryTime exceed three month.', + ], + [ + 'errorCode' => 'InvalidQueryTime.Malformed', + 'errorMessage' => 'Specified QueryTime is malformed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3F2C2C4-59BB-4B62-81FF-345BE557E3E3\\",\\n \\"FrameRateAndBitRateInfos\\": {\\n \\"FrameRateAndBitRateInfo\\": [\\n {\\n \\"VideoFrameRate\\": 24.9,\\n \\"StreamUrl\\": \\"rtmp://demo.aliyundoc.com/test/liveStream****_3_4\\",\\n \\"AudioFrameRate\\": 42.9,\\n \\"BitRate\\": 30693.96\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDomainFrameRateAndBitRateDataResponse>\\n <RequestId>C3F2C2C4-59BB-4B62-81FF-345BE557E3E3</RequestId>\\n <FrameRateAndBitRateInfos>\\n <FrameRateAndBitRateInfo>\\n <VideoFrameRate>24.9</VideoFrameRate>\\n <BitRate>30693.96</BitRate>\\n <AudioFrameRate>42.9</AudioFrameRate>\\n <StreamUrl>rtmp://demo.aliyundoc.com/test/liveStream****_3_4</StreamUrl>\\n </FrameRateAndBitRateInfo>\\n </FrameRateAndBitRateInfos>\\n</DescribeLiveDomainFrameRateAndBitRateDataResponse>","errorExample":""}]', + 'title' => '查询直播域名下流帧率和码率数据', + 'description' => '调用本接口查询的推流实时码率和帧率可以用来感知上行推流质量。数据采集和统计有一定延迟，建议查询5分钟前的数据。'."\n" + ."\n" + .'>请使用本接口替换原有的DescribeLiveStreamsFrameRateAndBitRateData（已废弃）接口。'."\n" + ."\n\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveDomainLimit' => [ + 'summary' => '调用DescribeLiveDomainLimit查询指定播流域名的推流数量限制和转码数量限制。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '推流数量限制和转码数量限制列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A3136B58-5876-4168-83CA-B562********', + ], + 'LiveDomainLimitList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveDomainLimit' => [ + 'description' => '推流数量限制和转码数量限制列表。', + 'type' => 'array', + 'items' => [ + 'description' => '推流数量限制和转码数量限制列表。', + 'type' => 'object', + 'properties' => [ + 'LimitTranscodeNum' => [ + 'description' => '转码数量限制。单位：个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'CurrentTranscodeNum' => [ + 'description' => '域名当前的转码流数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'LimitNum' => [ + 'description' => '推流数量限制。单位：个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'LimitTransferNum' => [ + 'description' => '中心转推数量限制，单位：个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'CurrentNum' => [ + 'description' => '域名当前的原始流数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CurrentTransferNum' => [ + 'description' => '域名当前的中心转推流数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DomainName' => [ + 'description' => '您查询的主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A3136B58-5876-4168-83CA-B562********\\",\\n \\"LiveDomainLimitList\\": {\\n \\"LiveDomainLimit\\": [\\n {\\n \\"LimitTranscodeNum\\": 50,\\n \\"CurrentTranscodeNum\\": 10,\\n \\"LimitNum\\": 100,\\n \\"LimitTransferNum\\": 50,\\n \\"CurrentNum\\": 10,\\n \\"CurrentTransferNum\\": 10,\\n \\"DomainName\\": \\"example.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDomainLimitResponse>\\n <RequestId>A3136B58-5876-4168-83CA-B562781981A0</RequestId>\\n <LiveDomainLimitList>\\n <LimitTranscodeNum>50</LimitTranscodeNum>\\n <CurrentTranscodeNum>10</CurrentTranscodeNum>\\n <LimitNum>100</LimitNum>\\n <LimitTransferNum>50</LimitTransferNum>\\n <CurrentNum>10</CurrentNum>\\n <CurrentTransferNum>10</CurrentTransferNum>\\n <DomainName>example.com</DomainName>\\n </LiveDomainLimitList>\\n</DescribeLiveDomainLimitResponse>","errorExample":""}]', + 'title' => '查询域名推流数量限制和转码数量限制', + 'description' => '本接口支持的播流域名为主播流域名。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特殊错误码'."\n" + .'| 错误代码 | 描述 | HTTP 状态码 |语义|'."\n" + .'|--------|--------|--------|--------|'."\n" + .'|Missing DomainName|DomainName is mandatory for this action.|400|缺少参数。|'."\n" + .'|InvalidParam|Parameter invalid.|400|参数错误。|'."\n" + .'|InvalidDomain.NotFound|The domain provided does not exist in our records.|404|当前账户下未查到此域名。|', + ], + 'DescribeLiveStreamState' => [ + 'summary' => '实时查询单路流状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播推流域名或播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '推流接入的类型。取值：'."\n" + ."\n" + .'- push：直播推流。'."\n" + ."\n" + .'- pull：触发拉流。'."\n" + ."\n\n" + ."\n", + 'type' => 'string', + 'example' => 'push', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CE6CD79D-0A98-1F22-A15F-FADA74DF2729', + ], + 'StreamState' => [ + 'description' => '流状态。取值：'."\n" + .'- online：推流中，表示正常推流中。'."\n" + .'- offline：不在线（推流失败或者推流结束，具体状态根据推流回调返回，此API不细分）。', + 'type' => 'string', + 'example' => 'online', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Type\\": \\"push\\",\\n \\"RequestId\\": \\"CE6CD79D-0A98-1F22-A15F-FADA74DF2729\\",\\n \\"StreamState\\": \\"online\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveStreamStateResponse>\\n<StreamState>online</StreamState>\\n<Type>push</Type>\\n<RequestId>CE6CD79D-0A98-1F22-A15F-FADA74DF2729</RequestId>\\n</DescribeLiveStreamStateResponse>","errorExample":""}]', + 'title' => '查询单路流状态', + 'description' => '先获取直播域名，再调用本接口实时查询单路流状态。关于不在线状态（offline）的详细信息，请根据推流回调返回的数据获取，本接口不做细分。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveStreamMerge' => [ + 'summary' => '删除在线流合流。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveBLHP6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '合流输出App名称。您可在[主备合流配置](~~606583~~)页面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'app', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '合流输出Stream名称。您可在[主备合流配置](~~606583~~)页面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'StreamName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB9*********', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + [ + 'errorCode' => 'QuotaExceeded.Merge', + 'errorMessage' => 'Exceed max merge count limit', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB9*********\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveStreamMergeResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteLiveStreamMergeResponse>","errorExample":""}]', + 'title' => '删除在线流合流', + 'description' => '本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'AddLiveStreamMerge' => [ + 'summary' => '添加主备合流配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106856', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '合流输出App名称。AppName名称与推流地址中的AppName名称相对应，模板才能生效。不可以填*。', + 'type' => 'string', + 'required' => true, + 'example' => 'app', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '合流输出Stream名称。StreamName名称与推流地址中的StreamName名称相对应，模板才能生效。不可以填*。', + 'type' => 'string', + 'required' => true, + 'example' => 'StreamName', + ], + ], + [ + 'name' => 'InAppName1', + 'in' => 'query', + 'schema' => [ + 'description' => '合流输入主流应用名称，输入的AppName必须与主流推流地址中的AppName保持一致，方可生效。', + 'type' => 'string', + 'required' => true, + 'example' => 'app1', + ], + ], + [ + 'name' => 'InStreamName1', + 'in' => 'query', + 'schema' => [ + 'description' => '合流输入主流直播流名称，输入的AppName必须与主流推流地址中的AppName保持一致，方可生效。', + 'type' => 'string', + 'required' => true, + 'example' => 'InStream1', + ], + ], + [ + 'name' => 'InAppName2', + 'in' => 'query', + 'schema' => [ + 'description' => '合流输入备流应用名称，输入的AppName必须与备流推流地址中的AppName保持一致，方可生效。', + 'type' => 'string', + 'required' => true, + 'example' => 'app2', + ], + ], + [ + 'name' => 'InStreamName2', + 'in' => 'query', + 'schema' => [ + 'description' => '合流输入备流直播流名称，输入的AppName必须与备流推流地址中的AppName保持一致，方可生效。', + 'type' => 'string', + 'required' => true, + 'example' => 'stream2', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '合流开始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2020-05-29T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '合流结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'>开始时间与结束时间最大相差7天。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2020-05-29T01:00:00Z', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流协议，取值：'."\n" + ."\n" + .'- **rtmp**（默认值）'."\n" + ."\n" + .'- **rtc**', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp', + ], + ], + [ + 'name' => 'LiveMerger', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用liveswitch引擎'."\n" + ."\n" + .'- on 使用liveswitch新引擎'."\n" + .'- off 默认值，使用旧引擎（rtmpr等）', + 'type' => 'string', + 'required' => false, + 'example' => 'off', + 'default' => 'off', + ], + ], + [ + 'name' => 'MergeParameters', + 'in' => 'query', + 'schema' => [ + 'description' => '切流相关的配置参数'."\n" + ."\n" + .'1. 明确发生断流时（eof 或 net err），立刻触发主备切换；'."\n" + .'2. 最近5秒内卡顿率超过60%，立刻触发主备切换；'."\n" + .'3. 拉流超时，持续2秒收不到帧数据，触发主备切换；'."\n" + .'4. 未断流、未发生卡顿，但是最近ali_max_no_frame_timeout时间内的平均帧率 小于 ali_low_frame_rate_threshold，立刻触发主备切换。如果用户设置了 ali_max_no_frame_timeout 参数，则3的超时时间会同步更新成 ali_max_no_frame_timeout。'."\n" + .'5. 开启 block_all_jitter 则2、3、4不生效。'."\n" + ."\n" + .'- 取值范围：'."\n" + .'10 > timeout > 2'."\n" + .'200 > threshold > 1'."\n" + .'block的值为0或1', + 'type' => 'string', + 'required' => false, + 'example' => 'ali_low_frame_rate_threshold=10&ali_max_no_frame_timeout=5&block_all_jitter=0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + 'Message' => [ + 'description' => '- 附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题'."\n" + ."\n" + .'- 取值：OK、config invalid, degrade to no livemerger。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + [ + 'errorCode' => 'QuotaExceeded.Merge', + 'errorMessage' => 'Exceed max merge count limit', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + [ + 'errorCode' => 'Duration.Exceed', + 'errorMessage' => 'Duration between StartTime and EndTime is too long.', + ], + [ + 'errorCode' => 'InvalidParam.CodeIllegalDuration', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\",\\n \\"Message\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<AddLiveStreamMergeResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</AddLiveStreamMergeResponse>","errorExample":""}]', + 'title' => '添加主备合流', + 'description' => '本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '>AppName、InAppName1、InAppName2三个配置项中不可与其它两个中任意一个重复；StreamName、InStreamName1、InStreamName2三个配置项中不可与其它两个中任意一个重复。', + 'responseParamsDescription' => 'config invalid, degrade to no livemerger表示liveswitch新引擎的配置不完整，自动降级为旧引擎', + ], + 'DescribeLiveStreamMerge' => [ + 'summary' => '查询主备合流配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveBLHP6S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '合流输出App名称。您可在[主备合流配置](~~606583~~)页面查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'app', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '合流输出Stream名称。您可在[主备合流配置](~~606583~~)页面查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'StreamName', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => '播流协议，取值：'."\n" + ."\n" + .'- **rtmp**（默认值）'."\n" + ."\n" + .'- **rtc**', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'LiveStreamMergeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveStreamMerge' => [ + 'description' => '直播流信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '直播流信息列表。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '合流输出App名称。', + 'type' => 'string', + 'example' => 'app', + ], + 'AppUsing' => [ + 'description' => '当前使用的App。', + 'type' => 'string', + 'example' => 'app1', + ], + 'DomainName' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'EndTime' => [ + 'description' => '合流结束时间。', + 'type' => 'string', + 'example' => '2020-05-29T01:00:00Z', + ], + 'ExtraInAppStreams' => [ + 'description' => '合流输入第3路-第N路的app和stream。', + 'type' => 'string', + 'example' => 'app3/stream3,app4/stream4,app5/stream5,…,appN/streamN', + ], + 'InAppName1' => [ + 'description' => '合流输入主流应用名称。', + 'type' => 'string', + 'example' => 'app1', + ], + 'InAppName2' => [ + 'description' => '合流输入备流应用名称。', + 'type' => 'string', + 'example' => 'app2', + ], + 'InStreamName1' => [ + 'description' => '合流输入主流直播流名称。', + 'type' => 'string', + 'example' => 'InStream1', + ], + 'InStreamName2' => [ + 'description' => '合流输入备流直播流名称。', + 'type' => 'string', + 'example' => 'stream2', + ], + 'Protocol' => [ + 'description' => '直播流协议。', + 'type' => 'string', + 'example' => 'rtmp', + ], + 'StartTime' => [ + 'description' => '合流开始时间。', + 'type' => 'string', + 'example' => '2020-05-29T00:00:00Z', + ], + 'StreamName' => [ + 'description' => '合流输出Stream名称。', + 'type' => 'string', + 'example' => 'StreamName', + ], + 'StreamUsing' => [ + 'description' => '当前使用的Stream。', + 'type' => 'string', + 'example' => 'InStream1', + ], + 'LiveMerger' => [ + 'description' => '当前任务是否使用merge引擎。', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'MergeParameters' => [ + 'description' => '查询任务所对应的切流相关的配置参数'."\n" + ."\n" + .'1. 明确发生断流时（eof 或 net err），立刻触发主备切换；'."\n" + .'2. 最近5秒内卡顿率超过60%，立刻触发主备切换；'."\n" + .'3. 拉流超时，持续2秒收不到帧数据，触发主备切换；'."\n" + .'4. 未断流、未发生卡顿，但是最近ali_max_no_frame_timeout时间内的平均帧率 小于 ali_low_frame_rate_threshold，立刻触发主备切换。如果用户设置了 ali_max_no_frame_timeout 参数，则3的超时时间会同步更新成 ali_max_no_frame_timeout。'."\n" + ."\n" + .'开启 block_all_jitter 则2、3、4不生效。'."\n" + ."\n" + .'取值范围： '."\n" + ."\n" + .'- 10 > ali_max_no_frame_timeout > 2；'."\n" + .'- 200 > ali_low_frame_rate_threshold > 1 ；'."\n" + .'- block_all_jitter的值为0（默认关闭）或 1（开启）。', + 'type' => 'string', + 'example' => 'ali_low_frame_rate_threshold=10&ali_max_no_frame_timeout=5&block_all_jitter=0'."\n", + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + [ + 'errorCode' => 'QuotaExceeded.Merge', + 'errorMessage' => 'Exceed max merge count limit', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LiveStreamMergeList\\": {\\n \\"LiveStreamMerge\\": [\\n {\\n \\"AppName\\": \\"app\\",\\n \\"AppUsing\\": \\"app1\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"EndTime\\": \\"2020-05-29T01:00:00Z\\",\\n \\"ExtraInAppStreams\\": \\"app3/stream3,app4/stream4,app5/stream5,…,appN/streamN\\",\\n \\"InAppName1\\": \\"app1\\",\\n \\"InAppName2\\": \\"app2\\",\\n \\"InStreamName1\\": \\"InStream1\\",\\n \\"InStreamName2\\": \\"stream2\\",\\n \\"Protocol\\": \\"rtmp\\",\\n \\"StartTime\\": \\"2020-05-29T00:00:00Z\\",\\n \\"StreamName\\": \\"StreamName\\",\\n \\"StreamUsing\\": \\"InStream1\\",\\n \\"LiveMerger\\": \\"on\\",\\n \\"MergeParameters\\": \\"ali_low_frame_rate_threshold=10&ali_max_no_frame_timeout=5&block_all_jitter=0\\\\n\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamMergeResponse>\\n <LiveStreamMergeList>\\n <LiveStreamMerge>\\n <AppName>app</AppName>\\n <AppUsing>app1</AppUsing>\\n <DomainName>example.com</DomainName>\\n <EndTime>2020-05-29T01:00:00Z</EndTime>\\n <ExtraInAppStreams>app3/stream3,app4/stream4,app5/stream5,…,appN/streamN</ExtraInAppStreams>\\n <InAppName1>app1</InAppName1>\\n <InAppName2>app2</InAppName2>\\n <InStreamName1>InStream1</InStreamName1>\\n <InStreamName2>stream2</InStreamName2>\\n <Protocol>rtmp</Protocol>\\n <StartTime>2020-05-29T00:00:00Z</StartTime>\\n <StreamName>StreamName</StreamName>\\n <StreamUsing>InStream1</StreamUsing>\\n </LiveStreamMerge>\\n </LiveStreamMergeList>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DescribeLiveStreamMergeResponse>","errorExample":""}]', + 'title' => '查询主备合流配置', + 'description' => '本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteLiveDelayConfig' => [ + 'summary' => '调用DeleteLiveDelayConfig删除直播延播配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveBP94ZY', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。支持通配符*，代表该域名下所有的AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'Stream', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流流名称。支持通配符*，代表该AppName下所有的StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveDelayConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteLiveDelayConfigResponse>","errorExample":""}]', + 'title' => '删除直播延播配置', + 'description' => '本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateLiveDelayConfig' => [ + 'summary' => '更新直播延播配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveBP94ZY', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。支持通配符*，代表该域名下所有的AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'Stream', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流流名称。支持通配符*，代表该AppName下所有的StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'DelayTime', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流延迟播放的时长，仅支持整数。取值：16~3600。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '60', + ], + ], + [ + 'name' => 'TaskTriggerMode', + 'in' => 'query', + 'schema' => [ + 'description' => '任务触发模式，取值：'."\n" + ."\n" + .'- **PUBLISH_ONLY** ：仅支持带延播推流参数触发。'."\n" + ."\n" + .'- **CONFIG_ONLY** ：仅支持配置触发，推流参数无效。'."\n" + ."\n" + .'- **PUBLISH_CONFIG** ：同时支持推流和配置，并且推流参数高优于配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'PUBLISH_ONLY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveDelayConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</UpdateLiveDelayConfigResponse>","errorExample":""}]', + 'title' => '更新直播延播配置', + 'description' => '本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveDelayConfig' => [ + 'summary' => '调用DescribeLiveDelayConfig查询直播延播配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveBP94ZY', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。支持通配符*，代表该域名下所有的AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'Stream', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流流名称。支持通配符*，代表该AppName下所有的StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'App' => [ + 'description' => '直播流所属应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'DelayTime' => [ + 'description' => '直播流延迟播放的时长。', + 'type' => 'string', + 'example' => '60', + ], + 'Domain' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A3136B58-5876-4168-83CA-B562781981A0', + ], + 'Stream' => [ + 'description' => '直播流流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'TaskTriggerMode' => [ + 'description' => '任务触发模式，取值：'."\n" + ."\n" + .'- **PUBLISH_ONLY**：仅支持带延播推流参数触发。'."\n" + ."\n\n" + .'- **CONFIG_ONLY**：仅支持配置触发，推流参数无效。'."\n" + ."\n" + .'- **PUBLISH_CONFIG**：同时支持推流和配置，并且推流参数高优于配置。', + 'type' => 'string', + 'example' => 'PUBLISH_ONLY', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"App\\": \\"liveApp****\\",\\n \\"DelayTime\\": \\"60\\",\\n \\"Domain\\": \\"example.com\\",\\n \\"RequestId\\": \\"A3136B58-5876-4168-83CA-B562781981A0\\",\\n \\"Stream\\": \\"liveStream****\\",\\n \\"TaskTriggerMode\\": \\"PUBLISH_ONLY\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDelayConfigResponse>\\n <Domain>example.com</Domain>\\n <RequestId>A3136B58-5876-4168-83CA-B562781981A0</RequestId>\\n <TaskTriggerMode>PUBLISH_ONLY</TaskTriggerMode>\\n <App>liveApp****</App>\\n <DelayTime>60</DelayTime>\\n <Stream>liveStream****</Stream>\\n</DescribeLiveDelayConfigResponse>","errorExample":""}]', + 'title' => '查询直播延播配置', + 'description' => '本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListLiveDelayConfig' => [ + 'summary' => '调用ListLiveDelayConfig查询直播延播配置列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveBP94ZY', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。取值范围：5~30，默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DelayConfigList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DelayConfig' => [ + 'description' => '延播配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'App' => [ + 'description' => '直播流所属应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'DelayTime' => [ + 'description' => '结束时间戳，单位：秒。', + 'type' => 'string', + 'example' => '60', + ], + 'Domain' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Stream' => [ + 'description' => '直播流流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'TaskTriggerMode' => [ + 'description' => '任务触发模式，取值：'."\n" + .'- **PUBLISH_ONLY**：仅支持带延播推流参数触发。'."\n" + ."\n" + .'- **CONFIG_ONLY**：仅支持配置触发，推流参数无效。'."\n" + ."\n" + .'- **PUBLISH_CONFIG**：同时支持推流和配置，并且推流参数高优于配置。', + 'type' => 'string', + 'example' => 'PUBLISH_ONLY', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A3136B58-5876-4168-83CA-B562781981A0', + ], + 'Total' => [ + 'description' => '延播配置数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DelayConfigList\\": {\\n \\"DelayConfig\\": [\\n {\\n \\"App\\": \\"liveApp****\\",\\n \\"DelayTime\\": \\"60\\",\\n \\"Domain\\": \\"example.com\\",\\n \\"Stream\\": \\"liveStream****\\",\\n \\"TaskTriggerMode\\": \\"PUBLISH_ONLY\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"A3136B58-5876-4168-83CA-B562781981A0\\",\\n \\"Total\\": 1\\n}","errorExample":""},{"type":"xml","example":"<ListLiveDelayConfigResponse>\\n <DelayConfigList>\\n <DelayConfig>\\n <App>liveApp****</App>\\n <DelayTime>60</DelayTime>\\n <Domain>example.com</Domain>\\n <Stream>liveStream****</Stream>\\n <TaskTriggerMode>PUBLISH_ONLY</TaskTriggerMode>\\n </DelayConfig>\\n </DelayConfigList>\\n <RequestId>A3136B58-5876-4168-83CA-B562781981A0</RequestId>\\n <Total>1</Total>\\n</ListLiveDelayConfigResponse>","errorExample":""}]', + 'title' => '查询延播配置列表', + 'description' => '本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CreateLiveDelayConfig' => [ + 'summary' => '设置直播延播配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveBP94ZY', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。支持通配符*，代表该域名下所有的AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'Stream', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流流名称。支持通配符*，代表该AppName下所有的StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'DelayTime', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流延迟播放的时长，仅支持整数。取值：16~3600。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '60', + ], + ], + [ + 'name' => 'TaskTriggerMode', + 'in' => 'query', + 'schema' => [ + 'description' => '任务触发模式，取值：'."\n" + ."\n" + .'- **PUBLISH_ONLY** ：仅支持带延播推流参数触发。'."\n" + ."\n" + .'- **CONFIG_ONLY** ：仅支持配置触发，推流参数无效。'."\n" + ."\n" + .'- **PUBLISH_CONFIG** ：同时支持推流和配置，并且推流参数高优于配置。', + 'type' => 'string', + 'required' => true, + 'example' => 'PUBLISH_ONLY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateLiveDelayConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</CreateLiveDelayConfigResponse>","errorExample":""}]', + 'title' => '设置直播延播配置', + 'description' => '延播配置区别于协议本身造成的延迟，指直播流开始后经过云端处理，在播放端进行延时播放。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'SetLiveStreamsNotifyUrlConfig' => [ + 'summary' => '设置推流回调配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107234', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '您的推流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'SwitchNotifyUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '切流信息回调URL地址', + 'type' => 'string', + 'required' => false, + 'example' => 'http://guide.aliyundoc.com/switchnotify', + ], + ], + [ + 'name' => 'NotifyUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流信息推送到的URL地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://guide.aliyundoc.com/notify', + ], + ], + [ + 'name' => 'ExceptionNotifyUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '异常事件回调地址URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://4a7e5f08.r37.cpolar.top/live/Rsssd/call-back/streamStart', + ], + ], + [ + 'name' => 'NotifyReqAuth', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启鉴权。取值：'."\n" + ."\n" + .'- **yes**：开启。如果选择取值为**yes**，必须同时设置请求参数NotifyAuthKey。'."\n" + .'- **no**：不开启。'."\n" + ."\n" + .'> 不填默认为**no**。'."\n" + ."\n" + .'鉴权逻辑请参考下文的**推流回调鉴权说明**。', + 'type' => 'string', + 'required' => false, + 'example' => 'yes', + 'default' => 'no', + 'enum' => [ + 'yes', + 'no', + ], + ], + ], + [ + 'name' => 'NotifyAuthKey', + 'in' => 'query', + 'schema' => [ + 'description' => '鉴权key。'."\n" + ."\n" + .'> 当请求参数NotifyReqAuth取值为**yes**时，本参数必填。'."\n" + ."\n" + .'取值要求：'."\n" + ."\n" + .'- 16~64个字符。'."\n" + ."\n" + .'- 支持大写字母、小写字母、数字。', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => ' 40A4F36D-A7CC-473A-88E7-154F92242566', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + [ + 'errorCode' => 'CodeGetMainPlaybackDomainError', + 'errorMessage' => 'Failed to obtain the main playback domain name.', + ], + [ + 'errorCode' => 'CodeNotPushDomain', + 'errorMessage' => 'The domain name is not a push domain name.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\" 40A4F36D-A7CC-473A-88E7-154F92242566\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<SetLiveStreamsNotifyUrlConfigResponse>\\n\\t<RequestId>4C747C97-7ECD-4C61-8A92-67AD806331FF</RequestId>\\n</SetLiveStreamsNotifyUrlConfigResponse>\\t","errorExample":"{\\n \\"RequestId\\":\\"4C747C97-7ECD-4C61-8A92-67AD806331FF\\"\\n}"}]', + 'title' => '设置推流回调通知地址配置', + 'description' => '- 本接口支持配置推流域名的回调地址及其鉴权信息。'."\n" + ."\n" + .'- 流状态实时信息回调，可以及时通知用户推流或断流操作结果。详细信息，请参见[推流回调格式说明](~~54787~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 回调逻辑说明'."\n" + .'直播推流状态回调中开播（publish）状态回调逻辑：'."\n" + ."\n" + .'RTMP推流在阿里云直播服务收到On Publish消息后2秒内，如果推流端不主动断开，阿里云直播服务就会发推流成功回调。'."\n" + ."\n" + .'假设您有推流域名A和播流域名B，如果您的域名B使用拉流直播（固定拉流和触发回源拉流）需要回调，请在域名A配置推流回调。配置后域名B的拉流回调逻辑与上一条一致，建联后默认2秒无主动断开即认为拉流成功。'."\n" + .'> 建议业务方不仅根据回调通知判断推流、拉流接入正常，同时配合在线流列表查询推流正常后，再下发直播流播放地址给业务方。'."\n" + ."\n" + .'## 推流回调鉴权说明'."\n" + .'推流回调鉴权功能默认关闭，用户可在配置推流回调地址时启用鉴权。启用功能后，鉴权逻辑如下：'."\n" + ."\n" + .'1. 阿里云视频直播发起回调请求时在HTTP(S)请求头中带上`ALI-LIVE-TIMESTAMP`和`ALI-LIVE-SIGNATURE`字段，供回调消息接收服务端进行签名认证。其中，`ALI-LIVE-SIGNATURE`的值由如下计算而得：'."\n" + .'`ALI-LIVE-SIGNATURE=MD5SUM（MD5CONTENT)`'."\n" + .'`MD5CONTENT=<回调域名>|<ALI-LIVE-TIMESTAMP取值>|<鉴权KEY>`'."\n" + ."\n" + .'2. 回调消息接收服务端接收回调消息时，将回调域名、ALI-LIVE-TIMESTAMP取值、鉴权Key进行拼接后计算MD5值，得到加密字符串，再将计算出的加密字符串与视频直播发起的HTTP(S)请求头中的ALI-LIVE-SIGNATURE字段值进行对比。如果不一致，则请求非法。'."\n" + ."\n" + .'## 特殊错误码'."\n" + .'|错误代码 |描述 |HTTP 状态码 |语义 |'."\n" + .'|------------|--------|---------|------|'."\n" + .'|InternalError |The request processing has failed due to some unknown error. |500 |后台发生未知错误。 |'."\n" + .'|InvalidDomain.NotFound | The domain provided does not exist in our records. |404 |当前账户下未查到域名。 |'."\n" + .'|IllegalOperation |Illegal domain operate is not permitted. |403 |不支持当前操作，如：非直播类域名。 |'."\n" + .'|InvalidNotifyUrl.Malformed |Specified parameter NotifyUrl is not valid. |400 |回调地址不是一个合法的HTTP地址。 |'."\n" + .'|InvalidNotifyUrl.Unsafe |Specified NotifyUrl is not safe. |400 |非安全的NotifyUrl值。 |'."\n", + ], + 'DescribeLiveStreamsNotifyUrlConfig' => [ + 'summary' => '查询推流回调配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107102', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '您的推流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => ' 40A4F36D-A7CC-473A-88E7-154F92242566', + ], + 'LiveStreamsNotifyConfig' => [ + 'description' => '回调配置。', + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '您的推流域名。', + 'type' => 'string', + 'example' => 'demo.aliyundoc.com', + ], + 'NotifyUrl' => [ + 'description' => '回调地址。', + 'type' => 'string', + 'example' => 'http://guide.aliyundoc.com/notify', + ], + 'ExceptionNotifyUrl' => [ + 'description' => '异常事件回调URL。', + 'type' => 'string', + 'example' => 'https://4a7e5f08.r37.cpolar.top/live/Record/call-back/streamException', + ], + 'NotifyReqAuth' => [ + 'description' => '是否开启鉴权。取值：'."\n" + ."\n" + .'- **yes**。'."\n" + .'- **no**。', + 'type' => 'string', + 'example' => 'yes', + ], + 'NotifyAuthKey' => [ + 'description' => '鉴权Key。', + 'type' => 'string', + 'example' => '123456', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\" 40A4F36D-A7CC-473A-88E7-154F92242566\\",\\n \\"LiveStreamsNotifyConfig\\": {\\n \\"DomainName\\": \\"demo.aliyundoc.com\\",\\n \\"NotifyUrl\\": \\"http://guide.aliyundoc.com/notify\\",\\n \\"ExceptionNotifyUrl\\": \\"https://4a7e5f08.r37.cpolar.top/live/Record/call-back/streamException\\",\\n \\"NotifyReqAuth\\": \\"yes\\",\\n \\"NotifyAuthKey\\": \\"123456\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamsNotifyUrlConfigResponse>\\n <RequestId> 40A4F36D-A7CC-473A-88E7-154F92242566</RequestId>\\n <LiveStreamsNotifyConfig>\\n <NotifyReqAuth>yes</NotifyReqAuth>\\n <NotifyUrl>http://guide.aliyundoc.com/notify</NotifyUrl>\\n <NotifyAuthKey>123456</NotifyAuthKey>\\n <DomainName>demo.aliyundoc.com</DomainName>\\n </LiveStreamsNotifyConfig>\\n</DescribeLiveStreamsNotifyUrlConfigResponse>","errorExample":""}]', + 'title' => '查询直播推流回调配置', + 'description' => '调用本接口可以查询回调地址和回调鉴权信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特殊错误码'."\n" + .'| 错误代码 | 描述 | HTTP 状态码 | 语义 |'."\n" + .'|------------|--------|---------|------|'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名。 |'."\n" + .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 不支持当前操作，如：非直播类域名。 |'."\n" + .'| InvalidConfig.NotFound| Config does not exist.| 404| 当前域名下未找到回调配置。|', + ], + 'DeleteLiveStreamsNotifyUrlConfig' => [ + 'summary' => '删除推流回调配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => ' 40A4F36D-A7CC-473A-88E7-154F92242566', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\" 40A4F36D-A7CC-473A-88E7-154F92242566\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DeleteLiveStreamsNotifyUrlConfigResponse>\\n\\t<RequestId>4C747C97-7ECD-4C61-8A92-67AD806331FF</RequestId>\\n</DeleteLiveStreamsNotifyUrlConfigResponse>","errorExample":"{\\n \\"RequestId\\":\\"4C747C97-7ECD-4C61-8A92-67AD806331FF\\"\\n}"}]', + 'title' => '删除直播推流回调配置', + 'description' => '先获取推流域名，再调用本接口删除推流回调配置。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamsNotifyRecords' => [ + 'summary' => '查询流回调记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive066BXV', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'push.example1.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => false, + 'example' => 'app', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => false, + 'example' => 'stream', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '回调是否成功。'."\n" + .'- success：成功。'."\n" + .'- failed：失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + 'enum' => [ + 'success', + 'failed', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> 开始时间必须在近7天内。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-10T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。结束时间需晚于起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-10T09:00:00Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，默认20，最大500。取值：1~500之前的任意整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页数，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '推流回调记录。', + 'type' => 'object', + 'properties' => [ + 'NotifyRecordsInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveStreamNotifyRecordsInfo' => [ + 'description' => '推流回调记录。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotifyType' => [ + 'description' => '回调类型。'."\n" + .'- publish：表示推流事件。'."\n" + .'- publish_done：表示断流事件。', + 'type' => 'string', + 'example' => 'publish_done', + ], + 'Description' => [ + 'description' => '结果描述，为success时成功，失败则返回错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'StreamName' => [ + 'description' => '直播流名称。', + 'type' => 'string', + 'example' => 'stream', + ], + 'NotifyTime' => [ + 'description' => '回调发生时间（UTC时间）。', + 'type' => 'string', + 'example' => '2022-10-19T19:09:28Z', + ], + 'DomainName' => [ + 'description' => '推流域名。', + 'type' => 'string', + 'example' => 'push.example1.com', + ], + 'NotifyContent' => [ + 'description' => '回调的具体内容。', + 'type' => 'string', + 'example' => '{\\"action\\":\\"publish_done\\",\\"app\\":\\"push.example1.com\\"}', + ], + 'NotifyUrl' => [ + 'description' => '回调URL。', + 'type' => 'string', + 'example' => 'http://xx.xx.xx.xx/callbacks', + ], + 'NotifyResult' => [ + 'description' => '回调结果。'."\n" + .'- success：成功。'."\n" + .'- failed：失败。', + 'type' => 'string', + 'example' => 'success', + ], + 'AppName' => [ + 'description' => '直播流所属应用名称。', + 'type' => 'string', + 'example' => 'app', + ], + 'NotifyResponse' => [ + 'description' => '用户端接受回调后返回的响应结果。', + 'type' => 'string', + 'example' => '{"Code":0,"Msg":"Success"}', + ], + 'NotifyHeader' => [ + 'description' => '回调请求的请求头。', + 'type' => 'string', + 'example' => 'Host: 123456.cn-shanghai.example1.com'."\n" + .'User-Agent: Go-http-client/1.1'."\n" + .'Accept-Encoding: gzip', + ], + ], + ], + ], + ], + ], + 'PageNum' => [ + 'description' => '分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F675E4B4-125D-1533-901B-11A724644285', + ], + 'TotalNum' => [ + 'description' => '符合条件的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'Duration.Exceed', + 'errorMessage' => 'StartTime needs to be within the last 7 days.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NotifyRecordsInfo\\": {\\n \\"LiveStreamNotifyRecordsInfo\\": [\\n {\\n \\"NotifyType\\": \\"publish_done\\",\\n \\"Description\\": \\"success\\",\\n \\"StreamName\\": \\"stream\\",\\n \\"NotifyTime\\": \\"2022-10-19T19:09:28Z\\",\\n \\"DomainName\\": \\"push.example1.com\\",\\n \\"NotifyContent\\": \\"{\\\\\\\\\\\\\\"action\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"publish_done\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"app\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"push.example1.com\\\\\\\\\\\\\\"}\\",\\n \\"NotifyUrl\\": \\"http://xx.xx.xx.xx/callbacks\\",\\n \\"NotifyResult\\": \\"success\\",\\n \\"AppName\\": \\"app\\",\\n \\"NotifyResponse\\": \\"{\\\\\\"Code\\\\\\":0,\\\\\\"Msg\\\\\\":\\\\\\"Success\\\\\\"}\\",\\n \\"NotifyHeader\\": \\"Host: 123456.cn-shanghai.example1.com\\\\nUser-Agent: Go-http-client/1.1\\\\nAccept-Encoding: gzip\\"\\n }\\n ]\\n },\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"F675E4B4-125D-1533-901B-11A724644285\\",\\n \\"TotalNum\\": 20,\\n \\"TotalPage\\": 20\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamsNotifyRecordsResponse>\\n <NotifyRecordsInfo>\\n <AppName>app</AppName>\\n <Description>success</Description>\\n <DomainName>push.example1.com</DomainName>\\n <NotifyContent>{\\\\\\"action\\\\\\":\\\\\\"publish_done\\\\\\",\\\\\\"app\\\\\\":\\\\\\"push.example1.com\\\\\\"}</NotifyContent>\\n <NotifyResult>success</NotifyResult>\\n <NotifyTime>2022-10-19T19:09:28Z</NotifyTime>\\n <NotifyType>publish_done</NotifyType>\\n <NotifyUrl>http://xx.xx.xx.xx/callbacks</NotifyUrl>\\n <StreamName>stream</StreamName>\\n </NotifyRecordsInfo>\\n <PageNum>1</PageNum>\\n <PageSize>20</PageSize>\\n <RequestId>F675E4B4-125D-1533-901B-11A724644285</RequestId>\\n <TotalNum>20</TotalNum>\\n <TotalPage>20</TotalPage>\\n</DescribeLiveStreamsNotifyRecordsResponse>","errorExample":""}]', + 'title' => '查询流回调记录', + 'description' => '本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteLiveStreamBlock' => [ + 'summary' => '调用DeleteLiveStreamBlock删除直播流粒度封禁。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveOLG5VH', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播放域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '成功：ok，失败：失败详情。', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B908FF89-B03C-4831-B55B-48D2A7DA0A68', + ], + 'Status' => [ + 'description' => '任务状态。取值：'."\n" + .'- ok：成功。'."\n" + .'- fail：失败。'."\n" + ."\n" + .'> 只要有一条任务创建失败即为失败。', + 'type' => 'string', + 'example' => 'ok', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"ok\\",\\n \\"RequestId\\": \\"B908FF89-B03C-4831-B55B-48D2A7DA0A68\\",\\n \\"Status\\": \\"ok\\"\\n}","type":"json"}]', + 'title' => '删除直播流粒度封禁', + 'description' => '调用本接口可删除直播流粒度的封禁配置。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'SetLiveStreamBlock' => [ + 'summary' => '调用SetLiveStreamBlock设置直播流粒度封禁。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveOLG5VH', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播放域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'BlockType', + 'in' => 'query', + 'schema' => [ + 'description' => '封禁方式，blacklist：黑名单，whitelist：白名单。', + 'type' => 'string', + 'required' => true, + 'example' => 'blacklist', + 'enum' => [ + 'blacklist', + 'whitelist', + ], + ], + ], + [ + 'name' => 'LocationList', + 'in' => 'query', + 'schema' => [ + 'description' => '封禁区域，如CN，AS多个以逗号隔开。', + 'type' => 'string', + 'required' => true, + 'example' => 'CN', + ], + ], + [ + 'name' => 'ReleaseTime', + 'in' => 'query', + 'schema' => [ + 'description' => '封禁结束时间，UTC格式，不填默认封禁7天。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-29T19:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '结果描述。'."\n" + .'- 成功：ok。'."\n" + .'- 失败：失败详情。', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3be7ade8-d907-483c-b24a-0dad4595beaf', + ], + 'Status' => [ + 'description' => '任务状态。取值：'."\n" + .'- ok：成功。'."\n" + .'- fail：失败。'."\n" + ."\n" + .'> 只要有一条任务创建失败即为失败。', + 'type' => 'string', + 'example' => 'ok', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidReleaseTime.Malformed', + 'errorMessage' => 'Specified ReleaseTime is malformed.', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"ok\\",\\n \\"RequestId\\": \\"3be7ade8-d907-483c-b24a-0dad4595beaf\\",\\n \\"Status\\": \\"ok\\"\\n}","type":"json"}]', + 'title' => '设置直播流粒度封禁', + 'description' => '一个域名最多支持配置200条直播流区域封禁规则，直播流区域封禁中如果出现重复的AppName和StreamName对应的规则，则以最近的更新时间生效。'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeStreamLocationBlock' => [ + 'summary' => '调用DescribeStreamLocationBlock查询直播流粒度封禁信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播放域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'stream', + ], + ], + [ + 'name' => 'BlockType', + 'in' => 'query', + 'schema' => [ + 'description' => '封禁方式。'."\n" + .'- blacklist：黑名单。'."\n" + .'- whitelist：白名单。', + 'type' => 'string', + 'required' => false, + 'example' => 'blacklist', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小，最大100，取值：1~100之间的任意整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + 'default' => '20', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '取得第几页，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '符合条件的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageNum' => [ + 'description' => '分页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C7C69682-7F88-40DD-A198-10D0309E439B', + ], + 'StreamBlockList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StreamBlock' => [ + 'description' => '详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '详细信息。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '封禁的应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'BlockType' => [ + 'description' => '封禁方式。'."\n" + .'- blacklist：黑名单。'."\n" + .'- whitelist：白名单。', + 'type' => 'string', + 'example' => 'blacklist', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'LocationList' => [ + 'description' => '封禁区域，如CN，AS多个以逗号隔开。', + 'type' => 'string', + 'example' => 'CN', + ], + 'ReleaseTime' => [ + 'description' => '失效时间，UTC时间。', + 'type' => 'string', + 'example' => '2023-08-13T09:27Z', + ], + 'Status' => [ + 'description' => '封禁状态，0：未开始，1：正在封禁，2：成功，3：失败，4：过期，5：删除中。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'StreamName' => [ + 'description' => '封禁的流名称。', + 'type' => 'string', + 'example' => 'stream', + ], + 'UpdateTime' => [ + 'description' => '最后修改时间，UTC时间。', + 'type' => 'string', + 'example' => '2023-08-14T09:27Z', + ], + ], + ], + ], + ], + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Count\\": 2,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 5,\\n \\"RequestId\\": \\"C7C69682-7F88-40DD-A198-10D0309E439B\\",\\n \\"StreamBlockList\\": {\\n \\"StreamBlock\\": [\\n {\\n \\"AppName\\": \\"liveApp****\\",\\n \\"BlockType\\": \\"blacklist\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"LocationList\\": \\"CN\\",\\n \\"ReleaseTime\\": \\"2023-08-13T09:27Z\\",\\n \\"Status\\": 0,\\n \\"StreamName\\": \\"stream\\",\\n \\"UpdateTime\\": \\"2023-08-14T09:27Z\\"\\n }\\n ]\\n },\\n \\"TotalPage\\": 1\\n}","type":"json"}]', + 'title' => '查询直播流粒度封禁', + 'description' => '接口查询直播流粒度封禁信息。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveShiftConfigs' => [ + 'summary' => '查询指定域名的时移配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveGDJYFA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '时移配置信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B49E6DDA-F413-422B-B58E-2FA23F286726', + ], + 'Content' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Config' => [ + 'description' => '配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '配置列表。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '配置的应用。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'Vision' => [ + 'description' => '配置的保存天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'DomainName' => [ + 'description' => '配置的域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'StreamName' => [ + 'description' => '配置的流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'IgnoreTranscode' => [ + 'description' => '是否忽略对应转码流生成时移。取值：'."\n" + ."\n" + .'- **true**：转码流不生成时移。'."\n" + ."\n" + .'- **false**：转码流生成时移。'."\n" + ."\n" + .'默认选择为true。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDataNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 409 => [ + [ + 'errorCode' => 'InvalidStreamNum', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B49E6DDA-F413-422B-B58E-2FA23F286726\\",\\n \\"Content\\": {\\n \\"Config\\": [\\n {\\n \\"AppName\\": \\"liveApp****\\",\\n \\"Vision\\": 7,\\n \\"DomainName\\": \\"example.com\\",\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"IgnoreTranscode\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveShiftConfigsResponse>\\n <RequestId>B49E6DDA-F413-422B-B58E-2FA23F286726</RequestId>\\n <Content>\\n <AppName>liveApp****</AppName>\\n <Vision>7</Vision>\\n <DomainName>example.com</DomainName>\\n <StreamName>liveStream****</StreamName>\\n <IgnoreTranscode>true</IgnoreTranscode>\\n </Content>\\n</DescribeLiveShiftConfigsResponse>","errorExample":""}]', + 'title' => '查询域名时移配置', + 'description' => '先获取播流域名，再调用本接口查询指定域名的时移配置。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 特殊错误码'."\n" + .'| 错误代码 | 描述 | HTTP 状态码 | 语义 |'."\n" + .'|------------|--------|---------|------|'."\n" + .'| InvalidParam | param error | 400 | 用户参数错误。 |'."\n" + .'| InvalidDataNotFound | data not found | 404 | 用户数据未找到。 |'."\n", + ], + 'OpenLiveShift' => [ + 'summary' => '调用OpenLiveShift为指定域名（应用、直播流）开启时移服务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREliveGDJYFA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。支持通配符*，代表该域名下所有的AppName。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流流名称。支持通配符*，代表该AppName下所有的StreamName。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => 'HLS的ts切片的长度。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'Vision', + 'in' => 'query', + 'schema' => [ + 'description' => '表示数据保留时长。默认保留7天，单位：天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'IgnoreTranscode', + 'in' => 'query', + 'schema' => [ + 'description' => '是否忽略对应转码流生成时移。取值：'."\n" + ."\n" + .'- **true**：转码流不生成时移。'."\n" + ."\n" + .'- **false**：转码流生成时移。'."\n" + ."\n" + .'默认选择为true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => '%s Please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDataNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 409 => [ + [ + 'errorCode' => 'InvalidStreamNum', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<OpenLiveShiftResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</OpenLiveShiftResponse>","errorExample":""}]', + 'title' => '开启时移服务', + 'description' => '直播时移和延迟转码目前暂不支持同时配置。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 特殊错误码'."\n" + .'| 错误代码 | 描述 | HTTP 状态码 | 语义 |'."\n" + .'|------------|--------|---------|------|'."\n" + .'| InvalidParam | param error|400| 用户参数错误。|'."\n" + .'| InvalidDataNotFound | data not found |404| 用户数据未找到。|', + ], + 'CloseLiveShift' => [ + 'summary' => '关闭指定域名（应用、直播流）的时移服务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveGDJYFA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。支持通配符*，代表该域名下所有的AppName。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流流名称。支持通配符*，代表该AppName下所有的StreamName。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => '%s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDataNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 409 => [ + [ + 'errorCode' => 'InvalidStreamNum', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<CloseLiveShiftResponse>\\r\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\r\\n</CloseLiveShiftResponse>","errorExample":""}]', + 'title' => '关闭时移服务', + 'description' => '先获取播流域名，再调用本接口关闭指定域名（应用、直播流）的时移服务。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 特殊错误码'."\n" + .'| 错误代码 | 描述 | HTTP 状态码 | 语义 |'."\n" + .'|------------|--------|---------|------|'."\n" + .'| InvalidParam | param error | 400 | 用户参数错误。 |'."\n" + .'| InvalidDataNotFound | data not found | 404 | 用户数据未找到。 |', + ], + 'AddLiveStreamTranscode' => [ + 'summary' => '调用AddLiveStreamTranscode添加转码配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。'."\n" + ."\n" + .'- App取值必须与推流地址中的AppName名称一样，转码模板才能生效。取值不超过256字符，支持数字、大小写字母、短划线（-）、下划线（_）。'."\n" + ."\n" + .'- App也支持取值为单个星号（*）字符，表示匹配任意字符串（包括空字符串）。'."\n" + ."\n" + .'> 如果配置了App为单个星号（\\*）的转码模板：当用户拉流转码时，优先匹配和推流地址中AppName名称一样的转码模板；若不存在和推流地址中AppName名称一样的转码模板，则会匹配App为单个星号（*）的转码模板。 ', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模版。取值：'."\n" + ."\n" + .'- 标准质量模板：'."\n" + ."\n" + .' - **lld**：流畅。'."\n" + ."\n" + .' - **lsd**：标清。'."\n" + ."\n" + .' - **lhd**：高清。'."\n" + ."\n" + .' - **lud** ：超清。'."\n" + .' '."\n" + .'- 窄带高清™转码模板：'."\n" + ."\n" + .' - **ld**：流畅。'."\n" + .' '."\n" + .' - **sd**：标清。'."\n" + .' '."\n" + .' - **hd**：高清。'."\n" + .' '."\n" + .' - **ud**：超清。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsd', + ], + ], + [ + 'name' => 'EncryptParameters', + 'in' => 'query', + 'schema' => [ + 'description' => '加密配置。JSON格式，各字段说明如下：'."\n" + ."\n" + .'- EncryptType：加密类型。固定取值**aliyun**。'."\n" + .'- KmsKeyID：用户KMS主密钥ID。'."\n" + .'- KmsKeyExpireInterval：换Key周期。取值范围：**60~3600**，单位：秒。', + 'type' => 'string', + 'required' => false, + 'example' => '{"EncryptType": "aliyun", "KmsKeyID":"afce5722-81d2-43c3-9930-7601da11****","KmsKeyExpireInterval":"3600"}', + ], + ], + [ + 'name' => 'Lazy', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启触发转码。取值：'."\n" + .'- **yes**：开启触发转码。'."\n" + .'- **no**：不开启触发转码。', + 'type' => 'string', + 'required' => false, + 'example' => 'yes', + 'default' => 'yes', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<AddLiveStreamTranscodeResponse>\\r\\n\\t <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\r\\n</AddLiveStreamTranscodeResponse>","errorExample":""}]', + 'title' => '添加转码配置信息', + 'description' => '- 使用直播转码功能会产生转码费用，按转码标准、分辨率规格及对应总转码时长计费。计费规则详见[直播转码费用](~~90424~~)。'."\n" + ."\n" + .'- 先通过密钥管理服务KMS获取用户KMS主密钥ID，再调用本接口添加通用转码配置信息，目前本接口只支持标准质量模板和窄带高清™转码模板两种转码模板。'."\n" + ."\n" + .'- 阿里云KMS免费提供默认密钥用于云产品服务端加密，无需购买实例。但若您需要构建自建应用密码方案、使用凭据功能或需要管理密钥生命周期等，则需付费购买软件或硬件密钥管理实例。计费详情，请参见[产品计费](~~600418~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddCustomLiveStreamTranscode' => [ + 'summary' => '调用AddCustomLiveStreamTranscode添加自定义转码配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106833', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'KmsKeyID', + 'in' => 'query', + 'schema' => [ + 'description' => '用户KMS主密钥ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'afce5722-81d2-43c3-9930-7601da11****', + ], + ], + [ + 'name' => 'KmsUID', + 'in' => 'query', + 'schema' => [ + 'description' => '用户KMS主账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '25346073170691****', + ], + ], + [ + 'name' => 'KmsKeyExpireInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '换Key周期。取值范围：60~3600，单位：秒。', + 'type' => 'string', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板自定义名称。'."\n" + ."\n" + .'> 支持数字、大小写字母或短横线（-），且字段必须以大小写字母或数字开头，不能与标准的转码模板命名重复。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'LiveCusTranscode****', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义转码模版类型。取值：'."\n" + ."\n" + .'- **h264**：自定义H264标准模版。'."\n" + .'- **h264-nbhd**：自定义H264窄带高清™模版。'."\n" + .'- **h265**：自定义H265标准模版。'."\n" + .'- **h265-nbhd**：自定义H265窄带高清模版。'."\n" + .'- **audio**：纯音频模板。'."\n" + ."\n" + .'>**TemplateType**取值为视频类型时（例如**h264**、**h264-nbhd**、**h265**或 **h265-nbhd**），请求参数**Height**、**Width**、**FPS**和**VideoBitrate**的值必须填写。', + 'type' => 'string', + 'required' => true, + 'example' => 'h264', + ], + ], + [ + 'name' => 'Height', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频高度。单位：像素。取值：'."\n" + .'需要同时满足如下三个条件：'."\n" + .'- **Height ≥ 100**：视频的高需要不小于100像素。'."\n" + .'- **max（Height,Width）≤ 2560**：视频的宽、高中较大的一个最大不能大于2560。'."\n" + .'- **min（Height,Width）≤ 1440**：视频的宽、高中较小的一个最大不能大于1440。'."\n" + ."\n" + .'>265窄带高清模板不得超过1280×720。'."\n" + ."\n\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '720', + ], + ], + [ + 'name' => 'Width', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频宽度。单位：像素。取值：'."\n" + ."\n" + .'需要同时满足如下三个条件：'."\n" + .'- **Width ≥ 100**：视频的宽需要不小于100像素。'."\n" + .'- **max（Height,Width）≤ 2560**：视频的宽、高中较大的一个最大不能大于2560。'."\n" + .'- **min（Height,Width）≤ 1440**：视频的宽、高中较小的一个最大不能大于1440。'."\n" + ."\n" + .'>265窄带高清模板不得超过1280×720。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '576', + ], + ], + [ + 'name' => 'FPS', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频帧率。单位：FPS，取值：**1~60**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'VideoBitrate', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频比特率。单位：kbps，取值：**1~6000**。'."\n" + ."\n" + .'> 转码视频会尽量接近您所设定的比特率，但转码视频的实际比特率不能保证和您所设定的完全一致，尤其是当您设定的比特率过大或过小时。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '720', + ], + ], + [ + 'name' => 'AudioBitrate', + 'in' => 'query', + 'schema' => [ + 'description' => '转码音频比特率。单位：kbps，取值：**1~1000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '512', + ], + ], + [ + 'name' => 'Gop', + 'in' => 'query', + 'schema' => [ + 'description' => '视频GOP（Group of Picture），单位可选帧或者秒。'."\n" + .'- 单位：帧，取值：**1~3000**。例如：设置GOP为2帧，则此参数传入2。'."\n" + .'- 单位：秒，取值：**1s~20s**。例如：设置GOP为1秒，则此参数传入1s。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Profile', + 'in' => 'query', + 'schema' => [ + 'description' => '编码级别。视频支持的一组特定的编码功能，一般值越大得到的画面质量越好，同时编解码消耗的资源也越高。取值：'."\n" + ."\n" + .'- **1**：baseline（适合移动设备）。'."\n" + .'- **2**：main（适合标准分辨率设备）。'."\n" + .'- **3**：high（适合高分辨率设备）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'AudioProfile', + 'in' => 'query', + 'schema' => [ + 'description' => '音频编码。取值：'."\n" + .'- **aac_low**'."\n" + .'- **aac_he**'."\n" + .'- **aac_he_v2**'."\n" + .'- **aac_ld**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'aac_low', + ], + ], + [ + 'name' => 'AudioCodec', + 'in' => 'query', + 'schema' => [ + 'description' => '音频编码格式。取值：'."\n" + ."\n" + .'- **AAC**'."\n" + ."\n" + .'- **MP3**', + 'type' => 'string', + 'required' => false, + 'example' => 'AAC', + ], + ], + [ + 'name' => 'AudioRate', + 'in' => 'query', + 'schema' => [ + 'description' => '音频采样率。取值：**22050~96000**。'."\n" + ."\n" + .'><notice>如果AudioProfile取值为**aac_ld**，则采样率不能超过44100。'."\n" + .'></notice>', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '96000', + ], + ], + [ + 'name' => 'AudioChannelNum', + 'in' => 'query', + 'schema' => [ + 'description' => '音频声道数。取值'."\n" + ."\n" + .'- **1**：单声道。'."\n" + .'- **2**：双声道。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Lazy', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启触发转码。取值：'."\n" + .'- **yes**：开启触发转码。'."\n" + .'- **no**：不开启触发转码。', + 'type' => 'string', + 'required' => false, + 'example' => 'yes', + ], + ], + [ + 'name' => 'EncryptParameters', + 'in' => 'query', + 'schema' => [ + 'description' => '加密配置。JSON格式，各字段说明如下：'."\n" + ."\n" + .'- **EncryptType**：加密类型。固定取值aliyun。'."\n" + ."\n" + .'- **KmsKeyID**：用户KMS主密钥ID。'."\n" + ."\n" + .'- **KmsKeyExpireInterval**：换Key周期。取值范围：60~3600，单位：秒。'."\n" + ."\n" + .'> EncryptParameters参数若配置，则KmsKeyID、KmsUID、KmsKeyExpireInterval参数不能为空', + 'type' => 'string', + 'required' => false, + 'example' => '{"EncryptType": "aliyun", "KmsKeyID":"afce5722-81d2-43c3-9930-7601da11****","KmsKeyExpireInterval":"3600"}', + ], + ], + [ + 'name' => 'ResWithSource', + 'in' => 'query', + 'schema' => [ + 'description' => '分辨率随源配置，若设置了该字段，分辨率以该字段为主。包含的字段如下：'."\n" + .'- **Type string** （必须添加）：只可以传 short （短边自适应）、long（长边自适应） 、screen（横竖屏自适应） 。'."\n" + .'- **Value string**（必须添加）：'."\n" + .' - 短边自适应取值可选：360、480、540、720、1080。'."\n" + .' - 长边自适应取值可选：640、848、960、1280、1920。'."\n" + .' - 横竖屏自适应取值可选：640\\*360、848\\*480、960\\*540、1280\\*720、1920\\*1080。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Type":"short","Value":"1080"}', + ], + ], + [ + 'name' => 'FpsWithSource', + 'in' => 'query', + 'schema' => [ + 'description' => '帧率随源配置，若设置了该字段，帧率以该字段为主。包含的字段如下：'."\n" + .'- **UpLimit int**（必须添加）：帧率上限，输入范围1-60的整数，且大于帧率下限。'."\n" + .'- **LowerLimit int** （必须添加）：帧率下限，输入范围1-60的整数，且小于帧率上限。', + 'type' => 'string', + 'required' => false, + 'example' => '{"UpLimit":60,"LowerLimit":1}', + ], + ], + [ + 'name' => 'BitrateWithSource', + 'in' => 'query', + 'schema' => [ + 'description' => '码率随源配置，若设置了该字段，码率以该字段为主。包含的字段如下：'."\n" + .'- **UpLimit int**（必须添加）：码率上限，输入范围128-10000的整数，且大于码率下限。'."\n" + .'- **LowerLimit int** （必须添加）：码率下限，输入范围128-10000的整数，且小于码率上限。'."\n" + .'- **Factor float** （必须添加）：按源码率输出倍率，输入范围0.1-1，精确至小数点后一位，“1”为按源流输出。', + 'type' => 'string', + 'required' => false, + 'example' => '{"UpLimit":2500,"LowerLimit":800,"Factor":1}', + ], + ], + [ + 'name' => 'ExtWithSource', + 'in' => 'query', + 'schema' => [ + 'description' => '其他随源配置，包含的字段如下：'."\n" + .'- **KeyFrameOpen**：关键帧随源是否开启，开启后，转码输出流关键帧与原始流关键帧一致。取值yes或no。'."\n" + .'- **Copyts string** ：pts随源是否开启，开启后，转码输出流pts与原始流pts一致。取值yes或no。'."\n" + .'- **SeiMode** ：透传sei模式。取值有0（不透传）、 1（全部透传）。', + 'type' => 'string', + 'required' => false, + 'example' => '{"KeyFrameOpen":"yes","Copyts":"yes","SeiMode":1}', + ], + ], + [ + 'name' => 'DeInterlaced', + 'in' => 'query', + 'schema' => [ + 'description' => '转码过程中是否自动检测并去除隔行处理（将隔行扫描内容转换为逐行扫描）：'."\n" + ."\n" + .'- true：开启去隔行处理。'."\n" + ."\n" + .'- false：保持源格式，不做处理（默认）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => '%s Please check and try again later.', + ], + [ + 'errorCode' => 'TemplateLimit', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<AddCustomLiveStreamTranscodeResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</AddCustomLiveStreamTranscodeResponse>","errorExample":"{\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}"}]', + 'title' => '添加自定义转码配置信息', + 'description' => '本接口目前支持以下自定义转码模版类型，取值：'."\n" + ."\n" + .'- h264：自定义H264标准模版。'."\n" + ."\n" + .'- h264-nbhd：自定义H264窄带高清™模版。'."\n" + ."\n" + .'- h265：自定义H265标准模版。'."\n" + ."\n" + .'- h265-nbhd：自定义H265窄带高清模版。'."\n" + ."\n" + .'- audio：纯音频模板。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddRtsLiveStreamTranscode' => [ + 'summary' => '调用AddRtsLiveStreamTranscode添加RTS自定义转码配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。取值要求：'."\n" + ."\n" + .'- 该字段必须由大小写字母、数字、下划线（_）或短横线（-）组成。'."\n" + ."\n" + .'- 这些字符不必全含，建议取值大于3个字符，且字段的开头必须是字母（大小写）或数字。', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyun-test', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板自定义名称。取值要求：'."\n" + ."\n" + .'- 该字段必须由大小写字母、数字、下划线（_）或短横线（-）组成。'."\n" + ."\n" + .'- 这些字符不必全含，建议取值大于3个字符，且字段的开头必须是字母（大小写）或数字。'."\n" + ."\n" + .'>不能与标准的转码模板命名重复。', + 'type' => 'string', + 'required' => true, + 'example' => 'ld', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义转码模版类型。目前支持：'."\n" + ."\n" + .'- **h264**：自定义H264标准模版。'."\n" + .'- **h264-nbhd**：自定义H264窄带高清™模版。'."\n" + .'- **h264-origin**：原画H264标准模版，转码参数尽量保持和片源相同。'."\n" + .'- **audio**：纯音频转码模板，转码出来文件只有声音没有图像。如果选择audio类型，必须同时设置请求参数AudioBitrate。'."\n" + ."\n" + .'> 如果选择h264或h264-nbhd或h264-origin类型，必须同时设置请求参数Height，Width，FPS，VideoBitrate和DeleteBframes。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'h264', + ], + ], + [ + 'name' => 'Height', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频高度。单位：像素。取值：'."\n" + .'><notice>当TemplateType（自定义转码模版类型）设为h264或h264-nbhd或h264-origin时，本参数必填。'."\n" + .'></notice>'."\n" + ."\n" + .'需要**同时**满足如下三个条件：'."\n" + ."\n" + .'- **Height ≥ 100**：视频的高需要不小于100像素。'."\n" + .'- **max（Height,Width）≤ 2560**：视频的宽、高中较大的一个最大不能大于2560。'."\n" + .'- **min（Height,Width）≤ 1440**：视频的宽、高中较小的一个最大不能大于1440。'."\n" + ."\n" + .'例如：1560×1560（正方形视频）是不合法的。'."\n" + ."\n" + .'>原画模板由于需要保持片源的信息，分辨率最高支持到4K。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1280', + ], + ], + [ + 'name' => 'Width', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频宽度。单位：像素。取值：'."\n" + .'><notice>当TemplateType（自定义转码模版类型）设为h264或h264-nbhd或h264-origin时，本参数必填。'."\n" + .'></notice>'."\n" + ."\n" + .'需要同时满足如下三个条件：'."\n" + ."\n" + .'- **Width≥ 100**：视频的宽需要不小于100像素。'."\n" + .'- **max（Height,Width）≤ 2560**：视频的宽、高中较大的一个最大不能大于2560。'."\n" + .'- **min（Height,Width）≤ 1440**：视频的宽、高中较小的一个最大不能大于1440。'."\n" + ."\n" + .'例如：1560×1560（正方形视频）是不合法的。'."\n" + ."\n" + .'>原画模板由于需要保持片源的信息，分辨率最高支持到4K。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '720', + ], + ], + [ + 'name' => 'FPS', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频帧率。单位：FPS。取值：**1**~**60**。'."\n" + ."\n" + .'><notice>当TemplateType（自定义转码模版类型）设为h264或h264-nbhd或h264-origin时，本参数必填。'."\n" + .'></notice>', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'VideoBitrate', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频比特率。单位：kbps。取值：**1**~**6000**。'."\n" + ."\n" + .'><notice>当TemplateType（自定义转码模版类型）设为h264或h264-nbhd或h264-origin时，本参数必填。'."\n" + .'></notice>'."\n" + ."\n" + .'>转码视频会尽量接近您所设定的比特率，但转码视频的实际比特率不能保证和您所设定的完全一致，尤其是当您设定的比特率过大或过小时。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2000', + ], + ], + [ + 'name' => 'AudioBitrate', + 'in' => 'query', + 'schema' => [ + 'description' => '转码音频比特率。'."\n" + .'单位：kbps。取值：**1**~**1000**。'."\n" + ."\n" + .'><notice>当TemplateType（自定义转码模版类型）设为audio时，本参数必填。'."\n" + .'></notice>'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '128', + ], + ], + [ + 'name' => 'Gop', + 'in' => 'query', + 'schema' => [ + 'description' => '视频GOP（Group of Picture）。主要用于控制关键帧间隔。单位：秒。取值：**1**~**3**。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'DeleteBframes', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用B帧进行转码。取值：'."\n" + .'><notice>当TemplateType（自定义转码模版类型）设为h264或h264-nbhd或h264-origin时，本参数必填。'."\n" + .'></notice>'."\n" + ."\n" + .'- **true**：转码后的视频无B帧。'."\n" + ."\n" + .'- **false**：包含B帧，默认包含B帧。'."\n" + ."\n" + .'> 不传参数时默认为**false**。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Opus', + 'in' => 'query', + 'schema' => [ + 'description' => '音频转码是否使用opus进行转码（主要用户兼容原生webrtc问题）。取值：'."\n" + ."\n" + .'- **true**：音频转码为opus格式。'."\n" + ."\n" + .'- **false**：不使用opus格式转码。'."\n" + ."\n" + .'> 不传参数时默认为**false**。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Profile', + 'in' => 'query', + 'schema' => [ + 'description' => '编码级别。视频支持的一组特定的编码功能，一般值越大得到的画面质量越好，同时编解码消耗的资源也越高。取值：'."\n" + .'- **1**：baseline（适合移动设备）。'."\n" + .'- **2**：main（适合标准分辨率设备）。'."\n" + .'- **3**：high（适合高分辨率设备）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'AudioProfile', + 'in' => 'query', + 'schema' => [ + 'description' => '音频编码级别。取值： '."\n" + .'- **aac_low**。'."\n" + .'- **aac_he**。'."\n" + .'- **aac_he_v2**。'."\n" + .'- **aac_ld**。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'aac_low', + ], + ], + [ + 'name' => 'AudioCodec', + 'in' => 'query', + 'schema' => [ + 'description' => '音频编码器。取值：'."\n" + .'- **aac**。'."\n" + .'- **mp3**。'."\n" + ."\n" + .'>如果要使用opus编码，把Opus选项参数置为true即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'aac', + ], + ], + [ + 'name' => 'AudioRate', + 'in' => 'query', + 'schema' => [ + 'description' => '音频采样率。取值：**22050~96000**，其中44100比较常用。单位：Hz。'."\n" + ."\n" + .'>如果音频编码AudioProfile是aac_ld，则采样率不能超过44100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '44100', + ], + ], + [ + 'name' => 'AudioChannelNum', + 'in' => 'query', + 'schema' => [ + 'description' => '音频声道数。取值：'."\n" + .'- **1** ：单声道。'."\n" + .'- **2**：立体声。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Lazy', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启触发转码。取值：'."\n" + .'- **yes**：开启触发转码。'."\n" + .'- **no**：不开启触发转码。', + 'type' => 'string', + 'required' => false, + 'example' => 'no', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => '%s Please check and try again later.', + ], + [ + 'errorCode' => 'TemplateLimit', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<AddLiveStreamTranscodeResponse>\\r\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\r\\n</AddLiveStreamTranscodeResponse>","errorExample":""}]', + 'title' => '添加RTS自定义转码配置信息', + 'description' => '## 使用说明'."\n" + .'调用本接口添加RTS自定义转码配置信息，本接口目前只支持h264、h264-nbhd、h264-origin、audio四种自定义转码模版类型。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 特殊错误码'."\n" + .'|错误代码|描述|HTTP 状态码|语义|'."\n" + .'|--------|--------|----|----|'."\n" + .'|InvalidDomain.NotFound|The domain provided does not exist in our records.|404|域名不存在或不属于当前用户。|'."\n" + .'|IllegalOperation|Illegal domain operate is not permitted.|403|不支持当前操作，如：非直播类域名。|'."\n" + .'|InvalidParameters|Invalid parameters.|400|参数不合法，如高度过大、比特率过大等。|'."\n" + .'|ConfigAlreadyExists|Config has already exist.|400|配置已添加。|'."\n" + .'|InternalError|The request processing has failed due to some unknown error.|500|后台发生未知错误。|', + ], + 'UpdateCustomLiveStreamTranscode' => [ + 'summary' => '更新自定义转码配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206837', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名，不可修改。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称，不可修改。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板自定义名称，不可修改。', + 'type' => 'string', + 'required' => true, + 'example' => 'LiveCusTranscode****', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义转码模版类型，不可修改。', + 'type' => 'string', + 'required' => true, + 'example' => 'h264', + ], + ], + [ + 'name' => 'Height', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频高度。单位：像素。取值：'."\n" + ."\n" + .'需要同时满足如下三个条件：'."\n" + .'- Height ≥ 100：视频的高需要不小于100像素。'."\n" + .'- max（Height,Width）≤ 2560：视频的宽、高中较大的一个最大不能大于2560。'."\n" + .'- min（Height,Width）≤ 1440：视频的宽、高中较小的一个最大不能大于1440。'."\n" + .'> 265窄带高清模板不得超过1280×720。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '720', + ], + ], + [ + 'name' => 'Width', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频宽度。单位：像素。取值：'."\n" + ."\n" + .'需要同时满足如下三个条件：'."\n" + .'- Width ≥ 100：视频的宽需要不小于100像素。'."\n" + .'- max（Height,Width）≤ 2560：视频的宽、高中较大的一个最大不能大于2560。'."\n" + .'- min（Height,Width）≤ 1440：视频的宽、高中较小的一个最大不能大于1440。'."\n" + ."\n" + .'> 265窄带高清模板不得超过1280×720。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '576', + ], + ], + [ + 'name' => 'FPS', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频帧率。单位：FPS，取值：1~60。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'VideoBitrate', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频比特率。单位：kbps，取值：1~6000。'."\n" + ."\n" + .'> 转码视频会尽量接近您所设定的比特率，但转码视频的实际比特率不能保证和您所设定的完全一致，尤其是当您设定的比特率过大或过小时。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '720', + ], + ], + [ + 'name' => 'AudioBitrate', + 'in' => 'query', + 'schema' => [ + 'description' => '转码音频比特率。单位：kbps，取值：1~1000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '512', + ], + ], + [ + 'name' => 'Gop', + 'in' => 'query', + 'schema' => [ + 'description' => '视频GOP（Group of Picture），支持以帧或秒为单位，以帧为单位时，取值为{数字}；以秒为单位时，取值为{数字}s。'."\n" + .'- 单位为帧时，取值：1~3000。'."\n" + .'- 单位为秒时，取值：1~20s。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Profile', + 'in' => 'query', + 'schema' => [ + 'description' => '编码级别。视频支持的一组特定的编码功能，一般值越大得到的画面质量越好，同时编解码消耗的资源也越高。取值：'."\n" + .'- 1：baseline（适合移动设备）。'."\n" + .'- 2：main（适合标准分辨率设备）。'."\n" + .'- 3：high（适合高分辨率设备）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'AudioProfile', + 'in' => 'query', + 'schema' => [ + 'description' => '音频编码。取值：'."\n" + .'- aac_low'."\n" + .'- aac_he'."\n" + .'- aac_he_v2'."\n" + .'- aac_ld', + 'type' => 'string', + 'required' => false, + 'example' => 'aac_low', + ], + ], + [ + 'name' => 'AudioCodec', + 'in' => 'query', + 'schema' => [ + 'description' => '音频编码格式。取值：'."\n" + .'- aac'."\n" + .'- mp3', + 'type' => 'string', + 'required' => false, + 'example' => 'aac', + ], + ], + [ + 'name' => 'AudioRate', + 'in' => 'query', + 'schema' => [ + 'description' => '音频采样率。取值：22050，32000，44100，48000，96000。单位：Hz。'."\n" + ."\n" + .'> 如果**AudioProfile**取值为**aac_ld**，则采样率不能超过44100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '96000', + ], + ], + [ + 'name' => 'AudioChannelNum', + 'in' => 'query', + 'schema' => [ + 'description' => '音频声道数。取值'."\n" + .'- 1：单声道。'."\n" + .'- 2：双声道。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Lazy', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启触发转码。取值：'."\n" + .'- **yes**：开启触发转码。'."\n" + .'- **no**：不开启触发转码。', + 'type' => 'string', + 'required' => false, + 'example' => 'yes', + ], + ], + [ + 'name' => 'EncryptParameters', + 'in' => 'query', + 'schema' => [ + 'description' => '加密配置。JSON格式，各字段说明如下：'."\n" + .'- EncryptType：加密类型。固定取值aliyun。'."\n" + .'- KmsKeyID：用户KMS主密钥ID。'."\n" + .'- KmsKeyExpireInterval：换Key周期。取值范围：60~3600，单位：秒。'."\n" + ."\n" + .'> 当使用DRM加密时，KmsKeyID不可修改。', + 'type' => 'string', + 'required' => false, + 'example' => '{"EncryptType": "aliyun", "KmsKeyID":"afce5722-81d2-43c3-9930-7601da11****","KmsKeyExpireInterval":"3600"}', + ], + ], + [ + 'name' => 'ResWithSource', + 'in' => 'query', + 'schema' => [ + 'description' => '分辨率随源配置，若设置了该字段，分辨率以该字段为主。包含的字段如下：'."\n" + .'- **Type string** （必须添加）：只可以传 short （短边自适应）、long（长边自适应） 、screen（横竖屏自适应） 。'."\n" + .'- **Value string**（必须添加）： '."\n" + .' - 短边自适应取值可选：360、480、540、720、1080。'."\n" + .' - 长边自适应取值可选：640、848、960、1280、1920。'."\n" + .' - 横竖屏自适应取值可选：640\\*360、848\\*480、960\\*540、1280\\*720、1920\\*1080。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Type":"short","Value":"1080"}', + ], + ], + [ + 'name' => 'FpsWithSource', + 'in' => 'query', + 'schema' => [ + 'description' => '帧率随源配置，若设置了该字段，帧率以该字段为主。包含的字段如下：'."\n" + .'- **UpLimit int**（必须添加）：帧率上限，输入范围1-60的整数，且大于帧率下限。'."\n" + .'- **LowerLimit int**（必须添加）：帧率下限，输入范围1-60的整数，且小于帧率上限。', + 'type' => 'string', + 'required' => false, + 'example' => '{"UpLimit":60,"LowerLimit":1}', + ], + ], + [ + 'name' => 'BitrateWithSource', + 'in' => 'query', + 'schema' => [ + 'description' => '码率随源配置，若设置了该字段，码率以该字段为主。包含的字段如下：'."\n" + .'- **UpLimit int**（必须添加）：码率上限，输入范围128-10000的整数，且大于码率下限。'."\n" + .'- **LowerLimit int**（必须添加）：码率下限，输入范围128-10000的整数，且小于码率上限。'."\n" + .'- **Factor float** （必须添加）：按源码率输出倍率，输入范围0.1-1，精确至小数点后一位，“1”为按源流输出。', + 'type' => 'string', + 'required' => false, + 'example' => '{"UpLimit":2500,"LowerLimit":800,"Factor":1}', + ], + ], + [ + 'name' => 'ExtWithSource', + 'in' => 'query', + 'schema' => [ + 'description' => '其他随源配置，包含的字段如下：'."\n" + .'- **KeyFrameOpen**： yes或no。'."\n" + .'- **Copyts string** ：yes或no。'."\n" + .'- **SeiMode** ：取值有0（不透传）、 1（ 透传但不是所有）、 2（ 透传并且所有）。', + 'type' => 'string', + 'required' => false, + 'example' => '{"KeyFrameOpen":"yes","Copyts":"yes","SeiMode":1}', + ], + ], + [ + 'name' => 'DeInterlaced', + 'in' => 'query', + 'schema' => [ + 'description' => '转码过程中是否自动检测并去除隔行处理（将隔行扫描内容转换为逐行扫描）：'."\n" + ."\n" + .'- true：开启去隔行处理。'."\n" + ."\n" + .'- false：保持源格式，不做处理（默认）。', + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => '%s Please check and try again later.', + ], + [ + 'errorCode' => 'TemplateLimit', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateCustomLiveStreamTranscodeResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</UpdateCustomLiveStreamTranscodeResponse>","errorExample":""}]', + 'title' => '更新自定义转码配置', + 'description' => '本接口目前支持以下自定义转码模版类型，取值：'."\n" + .'- h264：自定义H264标准模版。'."\n" + .'- h264-nbhd：自定义H264窄带高清™模版。'."\n" + .'- h265：自定义H265标准模版。 '."\n" + .'- h265-nbhd：自定义H265窄带高清模版。'."\n" + .'- audio：纯音频模板。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。', + ], + 'UpdateLiveStreamTranscode' => [ + 'summary' => '更新通用转码配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206836', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名，不可修改。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称，不可修改。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模版，不可修改。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsd', + ], + ], + [ + 'name' => 'EncryptParameters', + 'in' => 'query', + 'schema' => [ + 'description' => '加密配置。JSON格式，各字段说明如下：'."\n" + .'- **EncryptType**：加密类型。固定取值aliyun。'."\n" + .'- **KmsKeyID**：用户KMS主密钥ID。'."\n" + .'- **KmsKeyExpireInterval**：换Key周期。取值范围：60~3600，单位：秒。'."\n" + .'> 当使用DRM加密时，**KmsKeyID**不可修改。', + 'type' => 'string', + 'required' => false, + 'example' => '{"EncryptType": "aliyun", "KmsKeyID":"afce5722-81d2-43c3-9930-7601da11****","KmsKeyExpireInterval":"3600"}', + ], + ], + [ + 'name' => 'Lazy', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启触发转码。取值：'."\n" + .'- **yes**：开启触发转码。'."\n" + .'- **no**：不开启触发转码。', + 'type' => 'string', + 'required' => false, + 'example' => 'yes', + 'default' => 'yes', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveStreamTranscodeResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</UpdateLiveStreamTranscodeResponse>","errorExample":""}]', + 'title' => '更新通用转码配置', + 'description' => '先通过密钥管理服务KMS获取用户KMS主密钥ID，再调用本接口添加转码配置信息，目前本接口只支持标准质量模板和窄带高清™转码模板两种转码模板。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。', + ], + 'UpdateRtsLiveStreamTranscode' => [ + 'summary' => '更新RTS自定义转码配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名，不可修改。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称，不可修改。', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyun-test', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板自定义名称，不可修改。', + 'type' => 'string', + 'required' => true, + 'example' => 'ld', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义转码模版类型，不可修改。', + 'type' => 'string', + 'required' => true, + 'example' => 'h264', + ], + ], + [ + 'name' => 'Height', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频高度。单位：像素。取值：'."\n" + ."\n" + .'需要同时满足如下三个条件：'."\n" + .'- Height ≥ 100：视频的高需要不小于100像素。'."\n" + .'- max（Height,Width）≤ 2560：视频的宽、高中较大的一个最大不能大于2560。'."\n" + .'- min（Height,Width）≤ 1440：视频的宽、高中较小的一个最大不能大于1440。'."\n" + .'例如：1560×1560（正方形视频）是不合法的。'."\n" + .'> - 当TemplateType（自定义转码模版类型）设为h264或h264-nbhd或h264-origin时，本参数必填。'."\n" + .'>- 原画模板由于需要保持片源的信息，分辨率最高支持到4K。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1280', + ], + ], + [ + 'name' => 'Width', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频宽度。单位：像素。取值：'."\n" + ."\n" + .'需要同时满足如下三个条件：'."\n" + .'- Width≥ 100：视频的宽需要不小于100像素。'."\n" + .'- max（Height,Width）≤ 2560：视频的宽、高中较大的一个最大不能大于2560。'."\n" + .'- min（Height,Width）≤ 1440：视频的宽、高中较小的一个最大不能大于1440。'."\n" + .'例如：1560×1560（正方形视频）是不合法的。'."\n" + ."\n" + .'> - 当TemplateType（自定义转码模版类型）设为h264或h264-nbhd或h264-origin时，本参数必填。'."\n" + .'- 原画模板由于需要保持片源的信息，分辨率最高支持到4K。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '720', + ], + ], + [ + 'name' => 'FPS', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频帧率。单位：FPS。取值：1~60。'."\n" + ."\n" + .'> 当TemplateType（自定义转码模版类型）设为h264或h264-nbhd或h264-origin时，本参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'VideoBitrate', + 'in' => 'query', + 'schema' => [ + 'description' => '转码视频比特率。单位：kbps。取值：1~6000。'."\n" + ."\n" + .'> - 当TemplateType（自定义转码模版类型）设为h264或h264-nbhd或h264-origin时，本参数必填。'."\n" + .'>- 转码视频会尽量接近您所设定的比特率，但转码视频的实际比特率不能保证和您所设定的完全一致，尤其是当您设定的比特率过大或过小时。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2000', + ], + ], + [ + 'name' => 'AudioBitrate', + 'in' => 'query', + 'schema' => [ + 'description' => '转码音频比特率。'."\n" + .'单位：kbps。取值：1~1000。'."\n" + ."\n" + .'> 当TemplateType（自定义转码模版类型）设为audio时，本参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '128', + ], + ], + [ + 'name' => 'Gop', + 'in' => 'query', + 'schema' => [ + 'description' => '视频GOP（Group of Picture）。主要用于控制关键帧间隔。单位：秒。取值：1~3。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'DeleteBframes', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用B帧进行转码。取值：'."\n" + ."\n" + .'- true：转码后的视频无B帧。'."\n" + .'- false：包含B帧，默认包含B帧。'."\n" + ."\n" + .'> - 当TemplateType（自定义转码模版类型）设为h264或h264-nbhd或h264-origin时，本参数必填。'."\n" + .'>- 不传参数时默认为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Opus', + 'in' => 'query', + 'schema' => [ + 'description' => '音频转码是否使用opus进行转码（主要用户兼容原生webrtc问题）。取值：'."\n" + .'- true：音频转码为opus格式。'."\n" + .'- false：不使用opus格式转码。'."\n" + ."\n" + .'> 不传参数时默认为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Profile', + 'in' => 'query', + 'schema' => [ + 'description' => '编码级别。视频支持的一组特定的编码功能，一般值越大得到的画面质量越好，同时编解码消耗的资源也越高。取值：'."\n" + .'- **1**：baseline（适合移动设备）。'."\n" + .'- **2**：main（适合标准分辨率设备）。'."\n" + .'- **3**：high（适合高分辨率设备）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'AudioProfile', + 'in' => 'query', + 'schema' => [ + 'description' => '音频编码级别。取值：'."\n" + .'- aac_low。'."\n" + .'- aac_he。'."\n" + .'- aac_he_v2。'."\n" + .'- aac_ld。', + 'type' => 'string', + 'required' => false, + 'example' => 'aac_low', + ], + ], + [ + 'name' => 'AudioCodec', + 'in' => 'query', + 'schema' => [ + 'description' => '音频编码器。取值：'."\n" + .'- aac。'."\n" + .'- mp3。'."\n" + ."\n" + .'> 如果要使用opus编码，把Opus选项参数置为true即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'aac', + ], + ], + [ + 'name' => 'AudioRate', + 'in' => 'query', + 'schema' => [ + 'description' => '音频采样率。取值：22050，32000，44100，48000，96000。其中44100比较常用。单位：Hz。'."\n" + ."\n" + .'> 如果音频编码AudioProfile是aac_ld，则采样率不能超过44100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '44100', + ], + ], + [ + 'name' => 'AudioChannelNum', + 'in' => 'query', + 'schema' => [ + 'description' => '音频声道数。取值：'."\n" + .'- **1** ：单声道。'."\n" + .'- **2**：立体声。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Lazy', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启触发转码。取值：'."\n" + .'- **yes**：开启触发转码。'."\n" + .'- **no**：不开启触发转码。', + 'type' => 'string', + 'required' => false, + 'example' => 'no', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => '%s Please check and try again later.', + ], + [ + 'errorCode' => 'TemplateLimit', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateRtsLiveStreamTranscodeResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</UpdateRtsLiveStreamTranscodeResponse>","errorExample":""}]', + 'title' => '更新RTS自定义转码配置', + 'description' => '本接口目前只支持h264、h264-nbhd、h264-origin、audio四种自定义转码模版类型。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。', + ], + 'DeleteLiveStreamTranscode' => [ + 'summary' => '删除转码配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模版。取值：'."\n" + ."\n" + .'- 标准质量模板：'."\n" + .' '."\n" + .' - lld：流畅。'."\n" + .' '."\n" + .' - lsd：标清。'."\n" + .' '."\n" + .' - lhd：高清。'."\n" + .' '."\n" + .' - lud ：超清。'."\n" + ."\n" + .'- 窄带高清™转码模板：'."\n" + ."\n" + .' - ld：流畅。'."\n" + .' '."\n" + .' - sd：标清。'."\n" + .' '."\n" + .' - hd：高清。'."\n" + .' '."\n" + .' - ud：超清。 '."\n" + ."\n" + .'- 自定义模板：用户自定义命名。', + 'type' => 'string', + 'required' => true, + 'example' => 'lld', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DeleteLiveStreamTranscodeResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteLiveStreamTranscodeResponse>\\t","errorExample":"{\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}"}]', + 'title' => '删除转码配置', + 'description' => '本接口目前支持的转码模版类型为标准质量模板、窄带高清™转码模板和自定义模板。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamTranscodeInfo' => [ + 'summary' => '查询转码配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainTranscodeName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'myapp', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '转码配置信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '62136AE6-7793-45ED-B14A-60D19A9486D3', + ], + 'DomainTranscodeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DomainTranscodeInfo' => [ + 'description' => '转码配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '转码配置信息。', + 'type' => 'object', + 'properties' => [ + 'TranscodeApp' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'TranscodeTemplate' => [ + 'description' => '转码模版。取值：'."\n" + ."\n" + .'- **标准质量模板**：'."\n" + ."\n" + .' - **lld**：流畅。'."\n" + .' '."\n" + .' - **lsd**：标清。'."\n" + .' '."\n" + .' - **lhd**：高清。'."\n" + .' '."\n" + .' - **lud** ：超清。'."\n" + ."\n" + .'- **窄带高清™转码模板**： '."\n" + ."\n" + .' - **ld**：流畅。'."\n" + .' '."\n" + .' - **sd**：标清。'."\n" + .' '."\n" + .' - **hd**：高清。'."\n" + .' '."\n" + .' - **ud**：超清。', + 'type' => 'string', + 'example' => 'lld', + ], + 'IsLazy' => [ + 'description' => '是否开启强制转码。取值：'."\n" + .'- **true**：延迟转码。'."\n" + .'- **false**：强制转码。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TranscodeName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'CustomTranscodeParameters' => [ + 'description' => '自定义转码配置。', + 'type' => 'object', + 'properties' => [ + 'BitrateWithSource' => [ + 'description' => '码率随源配置。', + 'type' => 'object', + 'example' => '{\\"UpLimit\\":2500,\\"LowerLimit\\":800,\\"Factor\\":1}', + ], + 'VideoProfile' => [ + 'description' => '视频的编码等级。取值：'."\n" + ."\n" + .'- **baseline**：适合移动设备。'."\n" + .'- **main**：适合标准分辨率设备。'."\n" + .'- **high**：适合高分辨率设备。', + 'type' => 'string', + 'example' => 'high', + ], + 'AudioBitrate' => [ + 'description' => '转码音频比特率。单位：kbps，取值范围：**1~1000**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64', + ], + 'Height' => [ + 'description' => '转码视频高度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1200', + ], + 'RtsFlag' => [ + 'description' => '低延时的标签。固定取值**true**。'."\n" + ."\n" + .'> 当转码为低延时转码时，才返回此参数。', + 'type' => 'string', + 'example' => 'true', + ], + 'TemplateType' => [ + 'description' => '自定义转码模版类型。取值：'."\n" + ."\n" + .'- **h264**：自定义H264标准模版。'."\n" + .'- **h264-nbhd**：自定义H264窄带高清™模版。'."\n" + .'- **h265**：自定义H265标准模版。'."\n" + .'- **h265-nbhd**：自定义H265窄带高清模版。'."\n" + .'- **audio**：纯音频模板。', + 'type' => 'string', + 'example' => 'h264', + ], + 'Bframes' => [ + 'description' => '去B帧。固定取值：**0**。', + 'type' => 'string', + 'example' => '0', + ], + 'ExtWithSource' => [ + 'description' => '其他随源配置。', + 'type' => 'object', + 'example' => '{\\"KeyFrameOpen\\":\\"yes\\",\\"Copyts\\":\\"yes\\",\\"SeiMode\\":1}', + ], + 'AudioRate' => [ + 'description' => '音频采样率。取值：**22050~96000**。'."\n" + ."\n" + .'>如果AudioProfile取值为**aac_ld**，则采样率不能超过44100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '44100', + ], + 'FpsWithSource' => [ + 'description' => '帧率随源配置。', + 'type' => 'object', + 'example' => '{\\"UpLimit\\":60,\\"LowerLimit\\":1}', + ], + 'AudioCodec' => [ + 'description' => '音频编码格式。', + 'type' => 'string', + 'example' => 'ACC', + ], + 'FPS' => [ + 'description' => '转码视频帧率。单位：FPS。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'Gop' => [ + 'description' => '视频GOP（Group of Picture）。单位：帧，取值范围：**1~3000**。', + 'type' => 'string', + 'example' => '10', + ], + 'Width' => [ + 'description' => '转码视频宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'VideoBitrate' => [ + 'description' => '转码视频比特率。单位：kbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3000', + ], + 'AudioChannelNum' => [ + 'description' => '音频声道数。取值：'."\n" + ."\n" + .'- **1**：单声道。'."\n" + .'- **2**：双声道。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AudioProfile' => [ + 'description' => '音频编码等级。取值：'."\n" + .'- **aac_low**'."\n" + .'- **aac_he**'."\n" + .'- **aac_he_v2**'."\n" + .'- **aac_ld**'."\n", + 'type' => 'string', + 'example' => 'aac_low', + ], + 'ResWithSource' => [ + 'description' => '分辨率随源配置。', + 'type' => 'object', + 'example' => '{\\"Type\\":\\"short\\",\\"Value\\":\\"1080\\"}', + ], + 'DeInterlaced' => [ + 'description' => '转码过程中是否自动检测并去除隔行处理（将隔行扫描内容转换为逐行扫描）：'."\n" + ."\n" + .'- true：开启去隔行处理。'."\n" + ."\n" + .'- false：保持源格式，不做处理（默认）。', + 'type' => 'boolean', + ], + ], + ], + 'EncryptParameters' => [ + 'description' => '加密配置。', + 'type' => 'object', + 'properties' => [ + 'EncryptType' => [ + 'description' => '加密类型。固定取值**aliyun**。', + 'type' => 'string', + 'example' => 'aliyun', + ], + 'KmsKeyID' => [ + 'description' => '用户KMS主密钥ID。', + 'type' => 'string', + 'example' => 'afce5722-81d2-43c3-9930-7601da11****', + ], + 'KmsKeyExpireInterval' => [ + 'description' => '换Key周期。取值范围：**60~3600**，单位：秒。', + 'type' => 'string', + 'example' => '3600', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"62136AE6-7793-45ED-B14A-60D19A9486D3\\",\\n \\"DomainTranscodeList\\": {\\n \\"DomainTranscodeInfo\\": [\\n {\\n \\"TranscodeApp\\": \\"liveApp****\\",\\n \\"TranscodeTemplate\\": \\"lld\\",\\n \\"IsLazy\\": true,\\n \\"TranscodeName\\": \\"example.com\\",\\n \\"CustomTranscodeParameters\\": {\\n \\"BitrateWithSource\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"VideoProfile\\": \\"high\\",\\n \\"AudioBitrate\\": 64,\\n \\"Height\\": 1200,\\n \\"RtsFlag\\": \\"true\\",\\n \\"TemplateType\\": \\"h264\\",\\n \\"Bframes\\": \\"0\\",\\n \\"ExtWithSource\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"AudioRate\\": 44100,\\n \\"FpsWithSource\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"AudioCodec\\": \\"ACC\\",\\n \\"FPS\\": 15,\\n \\"Gop\\": \\"10\\",\\n \\"Width\\": 1000,\\n \\"VideoBitrate\\": 3000,\\n \\"AudioChannelNum\\": 2,\\n \\"AudioProfile\\": \\"aac_low\\",\\n \\"ResWithSource\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DeInterlaced\\": true\\n },\\n \\"EncryptParameters\\": {\\n \\"EncryptType\\": \\"aliyun\\",\\n \\"KmsKeyID\\": \\"afce5722-81d2-43c3-9930-7601da11****\\",\\n \\"KmsKeyExpireInterval\\": \\"3600\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamTranscodeInfoResponse>\\n <RequestId>62136AE6-7793-45ED-B14A-60D19A9486D3</RequestId>\\n <DomainTranscodeList>\\n <TranscodeApp>liveApp****</TranscodeApp>\\n <TranscodeTemplate>lld</TranscodeTemplate>\\n <IsLazy>true</IsLazy>\\n <TranscodeName>example.com</TranscodeName>\\n <CustomTranscodeParameters>\\n <VideoProfile>high</VideoProfile>\\n <AudioBitrate>64</AudioBitrate>\\n <Height>1200</Height>\\n <RtsFlag>true</RtsFlag>\\n <TemplateType>h264</TemplateType>\\n <Bframes>0</Bframes>\\n <AudioRate>44100</AudioRate>\\n <AudioCodec>ACC</AudioCodec>\\n <FPS>15</FPS>\\n <Gop>10</Gop>\\n <Width>1000</Width>\\n <VideoBitrate>3000</VideoBitrate>\\n <AudioChannelNum>2</AudioChannelNum>\\n <AudioProfile>aac_low</AudioProfile>\\n </CustomTranscodeParameters>\\n <EncryptParameters>\\n <EncryptType>aliyun</EncryptType>\\n <KmsKeyID>afce5722-81d2-43c3-9930-7601da11****</KmsKeyID>\\n <KmsKeyExpireInterval>3600</KmsKeyExpireInterval>\\n </EncryptParameters>\\n </DomainTranscodeList>\\n</DescribeLiveStreamTranscodeInfoResponse>","errorExample":""}]', + 'title' => '查询转码配置信息', + 'description' => '先获取主播流域名，再调用本接口查询转码配置信息。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddTrancodeSEI' => [ + 'summary' => '添加转码SEI信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。'."\n" + ."\n" + .'> 必须为源流名称，所有的转码流都会添加上SEI信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'Text', + 'in' => 'query', + 'schema' => [ + 'description' => 'SEI文本。长度限制：4000字节。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveSei****', + ], + ], + [ + 'name' => 'Pattern', + 'in' => 'query', + 'schema' => [ + 'description' => '追加到每一个关键帧或每一帧。取值：'."\n" + .'- **keyframe**：关键帧。'."\n" + .'- **frame**：每一帧。', + 'type' => 'string', + 'required' => true, + 'example' => 'keyframe', + ], + ], + [ + 'name' => 'Repeat', + 'in' => 'query', + 'schema' => [ + 'description' => '重复次数。-1代表无限。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '-1', + ], + ], + [ + 'name' => 'Delay', + 'in' => 'query', + 'schema' => [ + 'description' => '接收到命令后的延迟时间。单位： 毫秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4E*****43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4E*****43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<AddTrancodeSEIResponse>\\n <RequestId>16A96B9A-F203-4E*****43-CB92E68F4CD8</RequestId>\\n</AddTrancodeSEIResponse>","errorExample":""}]', + 'title' => '添加转码 SEI 信息', + 'description' => '先获取播流域名，再调用本接口添加转码SEI信息。其中播流名称必须为源流名称，所有的转码流都会添加上SEI信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddLiveRecordVodConfig' => [ + 'summary' => '增加直播录制转点播配置，将录制内容保存到点播媒资库。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106854', + 'abilityTreeNodes' => [ + 'FEATUREliveL04ZVK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。'."\n" + .'> 请先确认与此播放域名直播中心相同区域的点播已开通服务。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'testName', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => false, + 'example' => 'stream', + ], + ], + [ + 'name' => 'VodTranscodeGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '点播转码模板组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'e2d796d3bb5fd8049d32bff62f94****', + ], + ], + [ + 'name' => 'CycleDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '周期录制时长。单位：秒。默认值为**3600**，取值范围：**300~21600**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '21600', + 'minimum' => '300', + 'example' => '300', + ], + ], + [ + 'name' => 'AutoCompose', + 'in' => 'query', + 'schema' => [ + 'description' => '设置为**ON**表示开启自动合并，且必须同时设置请求参数ComposeVodTranscodeGroupId。不传入参数值表示关闭自动合并。'."\n" + ."\n" + .'>开启自动合并，会使用视频点播服务剪辑合成功能。该功能计费详情，请参见[剪辑合成计费](~~188310~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + ], + ], + [ + 'name' => 'StorageLocation', + 'in' => 'query', + 'schema' => [ + 'description' => '存储地址。', + 'type' => 'string', + 'required' => false, + 'example' => '****-tjptr2vatm.oss-cn-shanghai.aliyuncs.com', + ], + ], + [ + 'name' => 'ComposeVodTranscodeGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '对自动合成出来的新视频在点播服务中进行一次转码，所使用的点播转码模板组ID。'."\n" + ."\n" + .'> - 当AutoCompose（是否开启自动合并）设为ON时，本参数才必填。'."\n" + .'> - 自动合成和转码常见问题，请参见[直播转点播常见问题FAQ](~~99726~~)。'."\n" + .'> - 点播转码计费详情，请参见[媒资转码计费](~~188308~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '*****', + ], + ], + [ + 'name' => 'OnDemand', + 'in' => 'query', + 'schema' => [ + 'description' => '按需录制，取值：'."\n" + .' '."\n" + .'- **0**（默认值）：关闭。'."\n" + ."\n" + .'- **1**：不支持按需录制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + [ + 'errorCode' => 'CommomLiveRcordConfigExisted', + 'errorMessage' => 'Commom liverecord config has already exist.', + ], + [ + 'errorCode' => 'InvalidAutoCompose.Malformed', + 'errorMessage' => 'Specified parameter AutoCompose is not valid.', + ], + [ + 'errorCode' => 'InvalidAutoComposeAndComposeVodTranscodeGroupId.Malformed', + 'errorMessage' => 'Specified parameter AutoCompose and ComposeVodTranscodeGroupId is not valid, must both empty or input', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidRegion.Conflict', + 'errorMessage' => 'Specified parameter StorageLocation and Region is not match', + ], + ], + [ + [ + 'errorCode' => 'InvalidStorage.NotFound', + 'errorMessage' => 'Specified parameter StorageLocation is not exist', + ], + [ + 'errorCode' => 'InvalidTemplateGroupId.NotFound', + 'errorMessage' => 'Specified parameter vodTranscodeGroupId or composeVodTranscodeGroupId is not exist', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<AddLiveRecordVodConfigResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</AddLiveRecordVodConfigResponse>","errorExample":"{\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n} "}]', + 'title' => '添加直播录制转点播配置', + 'description' => '调用本接口添加直播录制转点播配置，将录制内容保存到点播媒资库。'."\n" + ."\n" + .'> 使用金融云账号不支持视频直播录制到点播。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateLiveRecordVodConfig' => [ + 'summary' => '更新直播录制转点播配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '181113', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'testName', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => false, + 'example' => 'stream', + ], + ], + [ + 'name' => 'VodTranscodeGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '点播转码模板组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'e2d796d3bb5fd8049d32bff62f94****', + ], + ], + [ + 'name' => 'CycleDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '周期录制时长。单位：秒。默认值为**3600**，取值范围：**300~21600**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '21600', + 'minimum' => '300', + 'example' => '300', + ], + ], + [ + 'name' => 'AutoCompose', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动合并。取值：'."\n" + ."\n" + .'- **ON**：开启。如果取值为ON，必须同时设置请求参数ComposeVodTranscodeGroupId。'."\n" + ."\n" + .'- **OFF**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'OFF', + ], + ], + [ + 'name' => 'ComposeVodTranscodeGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '对自动合成出来的新视频在点播服务中进行一次转码，所使用的点播转码模板组ID。'."\n" + ."\n" + .'> 通过 [查询转码配置列表](~~454928~~) 获取', + 'type' => 'string', + 'required' => false, + 'example' => '*****', + ], + ], + [ + 'name' => 'OnDemand', + 'in' => 'query', + 'schema' => [ + 'description' => '按需录制，取值：'."\n" + ."\n" + .'- **0**（默认值）：关闭。'."\n" + ."\n" + .'- **1**：通过HTTP回调方式。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '61C96B9A-F203-4EC5-8E43-CB92E68F67DF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + [ + 'errorCode' => 'CommomLiveRcordConfigExisted', + 'errorMessage' => 'Commom liverecord config has already exist.', + ], + [ + 'errorCode' => 'InvalidAutoCompose.Malformed', + 'errorMessage' => 'Specified parameter AutoCompose is not valid.', + ], + [ + 'errorCode' => 'InvalidAutoComposeAndComposeVodTranscodeGroupId.Malformed', + 'errorMessage' => 'Specified parameter AutoCompose and ComposeVodTranscodeGroupId is not valid, must both empty or input', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidRegion.Conflict', + 'errorMessage' => 'Specified parameter StorageLocation and Region is not match', + ], + ], + [ + [ + 'errorCode' => 'InvalidStorage.NotFound', + 'errorMessage' => 'Specified parameter StorageLocation is not exist', + ], + [ + 'errorCode' => 'InvalidTemplateGroupId.NotFound', + 'errorMessage' => 'Specified parameter vodTranscodeGroupId or composeVodTranscodeGroupId is not exist', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"61C96B9A-F203-4EC5-8E43-CB92E68F67DF\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveRecordVodConfigResponse>\\n <RequestId>61C96B9A-F203-4EC5-8E43-CB92E68F67DF</RequestId>\\n</UpdateLiveRecordVodConfigResponse>","errorExample":""}]', + 'title' => '更新直播录制转点播配置', + 'description' => '本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteLiveRecordVodConfig' => [ + 'summary' => '删除直播录制转点播配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveL04ZVK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => ' 40A4F36D-A7CC-473A-88E7-154F92242566', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\" 40A4F36D-A7CC-473A-88E7-154F92242566\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DeleteLiveRecordVodConfigResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteLiveRecordVodConfigResponse>","errorExample":"{\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}"}]', + 'title' => '删除直播录制转点播配置', + 'description' => '先获取主播流域名，再调用本接口删除直播录制转点播配置。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveRecordVodConfigs' => [ + 'summary' => '查询直播转点播配置列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveL04ZVK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。默认值为**10**，取值范围：**5~100**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '5', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5056369B-D337-499E-B8B7-B761BD37B08A', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Total' => [ + 'description' => '总数。', + 'type' => 'string', + 'example' => '100', + ], + 'LiveRecordVodConfigs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveRecordVodConfig' => [ + 'description' => '配置信息列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StorageLocation' => [ + 'description' => '存储地址。', + 'type' => 'string', + 'example' => '****-tjptr2vatm.oss-cn-shanghai.aliyuncs.com', + ], + 'AppName' => [ + 'description' => '直播流所属应用名称。'."\n", + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'AutoCompose' => [ + 'description' => '是否开启自动合并。取值：'."\n" + ."\n" + .'- **ON**：开启'."\n" + .'- **OFF**：关闭', + 'type' => 'string', + 'example' => 'ON', + ], + 'OnDemand' => [ + 'description' => '按需录制，取值：'."\n" + ."\n" + .'- **0**（默认值）：关闭。'."\n" + ."\n" + .'- **1**：通过HTTP回调方式。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'StreamName' => [ + 'description' => '播流名称。'."\n", + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'CreateTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2015-12-01T17:37:00Z', + ], + 'VodTranscodeGroupId' => [ + 'description' => '点播转码组模板ID。'."\n", + 'type' => 'string', + 'example' => 'e2d796d3bb5fd8049d32bff62f94****', + ], + 'CycleDuration' => [ + 'description' => '周期录制时长。单位：秒。默认值为**3600**，取值范围：**300~21600**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '360', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'ComposeVodTranscodeGroupId' => [ + 'description' => '自动合并点播转码模板组ID。'."\n" + ."\n" + .'> 如果DescribeLiveRecordVodConfigs接口的AutoCompose设置为ON，则返回本参数。', + 'type' => 'string', + 'example' => 'dadfcaadde****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"5056369B-D337-499E-B8B7-B761BD37B08A\\",\\n \\"PageSize\\": 1,\\n \\"Total\\": \\"100\\",\\n \\"LiveRecordVodConfigs\\": {\\n \\"LiveRecordVodConfig\\": [\\n {\\n \\"StorageLocation\\": \\"****-tjptr2vatm.oss-cn-shanghai.aliyuncs.com\\",\\n \\"AppName\\": \\"liveApp****\\",\\n \\"AutoCompose\\": \\"ON\\",\\n \\"OnDemand\\": 0,\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"CreateTime\\": \\"2015-12-01T17:37:00Z\\",\\n \\"VodTranscodeGroupId\\": \\"e2d796d3bb5fd8049d32bff62f94****\\",\\n \\"CycleDuration\\": 360,\\n \\"DomainName\\": \\"example.com\\",\\n \\"ComposeVodTranscodeGroupId\\": \\"dadfcaadde****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveRecordVodConfigsResponse>\\n <PageNum>1</PageNum>\\n <RequestId>5056369B-D337-499E-B8B7-B761BD37B08A</RequestId>\\n <PageSize>1</PageSize>\\n <Total>100</Total>\\n <LiveRecordVodConfigs>\\n <LiveRecordVodConfig>\\n <StorageLocation>****-tjptr2vatm.oss-cn-shanghai.aliyuncs.com</StorageLocation>\\n <AppName>liveApp****</AppName>\\n <AutoCompose>ON</AutoCompose>\\n <OnDemand>0</OnDemand>\\n <StreamName>liveStream****</StreamName>\\n <CreateTime>2015-12-01T17:37:00Z</CreateTime>\\n <VodTranscodeGroupId>e2d796d3bb5fd8049d32bff62f94****</VodTranscodeGroupId>\\n <CycleDuration>360</CycleDuration>\\n <DomainName>example.com</DomainName>\\n <ComposeVodTranscodeGroupId>dadfcaadde****</ComposeVodTranscodeGroupId>\\n </LiveRecordVodConfig>\\n </LiveRecordVodConfigs>\\n</DescribeLiveRecordVodConfigsResponse>","errorExample":""}]', + 'title' => '查询直播录制转点播配置', + 'description' => '先获取播流域名，再调用本接口查询直播转点播配置列表。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddLiveAppRecordConfig' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。AppName名称与推流地址中的AppName名称对应，模板才能生效。若不限制AppName可填*，即可匹配所有AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储的Endpoint名称。'."\n" + ."\n" + .'直播录制文件存储至OSS，需提前创建OSS Bucket，创建方法请参见[配置OSS](~~84932~~) 。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss-cn-beijing.aliyuncs.com', + ], + ], + [ + 'name' => 'OssBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储的Bucket名称。'."\n" + ."\n" + .'直播录制文件存储至OSS，需提前创建OSS Bucket，创建方法请参见[配置OSS](~~84932~~) 。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveBucket****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。StreamName名称与推流地址中的StreamName名称对应，模板才能生效。若不限制StreamName可填*，即可匹配AppName下所有StreamName。', + 'type' => 'string', + 'required' => false, + 'example' => 'teststream', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '录制开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> 设置的时间必须是实际推流时间开始7天之内，只在流级别录制（StreamName不为空）有效。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-04-10T09:57:21Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '录制结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> EndTime与StartTime相差不应超过7天，超过7天将按照7天计算。只在流级别录制（StreamName不为空）有效。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-04-16T09:57:21Z', + ], + ], + [ + 'name' => 'OnDemand', + 'in' => 'query', + 'schema' => [ + 'description' => '按需/手动录制。取值：'."\n" + ."\n" + .'- **0**(默认值)：关闭，即自动录制。'."\n" + .'- **1**：按需录制，通过HTTP回调方式。需要先通过[AddLiveRecordNotifyConfig](~~2847891~~)接口配置OnDemandUrl，否则默认不录制。'."\n" + .'- **2**：按需录制，通过解析推流参数。'."\n" + .'- **7**：手动录制，默认不录制，可以通过[RealTimeRecordCommand](~~2847882~~)接口手动控制录制开启或停止。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DelayTime', + 'in' => 'query', + 'schema' => [ + 'description' => '断流拼接时长。'."\n" + .'直播断流时长超过设定的拼接时长后，将会生成新文件，断流拼接时长支持15~21600秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '180', + ], + ], + [ + 'name' => 'RecordFormat', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '记录详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SliceDuration' => [ + 'description' => '单个切片时长。单位：秒。'."\n" + ."\n" + .'><notice>当RecordFormat.N.Format（格式）设为m3u8或cmaf时，本参数才有效。'."\n" + .'></notice>'."\n" + ."\n" + .'不填则默认为30秒。取值范围：5s~30s。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + 'SliceOssObjectPrefix' => [ + 'description' => '切片名称。'."\n" + ."\n" + .'><notice>当RecordFormat.N.Format（格式）设为m3u8或cmaf时，本参数才需要配置。'."\n" + .'></notice>'."\n" + ."\n" + .'- 默认30秒一片，小于256字节，支持变量匹配，包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}。'."\n" + .'- 参数值必须包含{UnixTimestamp}和{Sequence}变量。', + 'type' => 'string', + 'required' => false, + 'example' => 'record/{AppName}/{StreamName}/{UnixTimestamp}_{Sequence}', + ], + 'CycleDuration' => [ + 'description' => '周期录制时长。单位：秒。'."\n" + ."\n" + .'> - 若不填则取默认值，不同录制格式的默认值不同：m3u8、cmaf 格式默认6小时，flv、mp4格式默认1小时。'."\n" + .'> - 如果在一个录制周期内，直播流发生了断流，但是在断流拼接时长内，该直播流又正常推流，那么仍会在同一个录制文件中继续录制。'."\n" + .'>- 一条直播流必须断流超过断流拼接时长，才会生成录制文件。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'OssObjectPrefix' => [ + 'description' => 'OSS存储的录制文件名。'."\n" + ."\n" + .'- 文件名小于256字节，支持变量匹配，包含 {AppName}、{StreamName}、{Sequence}、{StartTime}、{EndTime}、{EscapedStartTime}、{EscapedEndTime}。'."\n" + .'- 参数值必须要有{StartTime}或{EscapedStartTime}和{EndTime}或{EscapedEndTime}。'."\n" + ."\n\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'record/{AppName}/{StreamName}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}', + ], + 'Format' => [ + 'description' => '格式。目前支持M3U8、FLV、MP4、CMAF。取值：'."\n" + ."\n" + .'><notice>RecordFormat和TranscodeRecordFormat两者至少需要设置一个。如果选择m3u8或cmaf格式，必须同时设置请求参数RecordFormat.N.SliceOssObjectPrefix和RecordFormat.N.SliceDuration。'."\n" + .'></notice>'."\n" + ."\n" + .'- m3u8。'."\n" + .'- flv。'."\n" + .'- mp4。'."\n" + .'- cmaf。', + 'type' => 'string', + 'required' => false, + 'example' => 'm3u8', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'TranscodeRecordFormat', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '转码记录详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SliceDuration' => [ + 'description' => '转码流录制单个切片时长，单位：秒。'."\n" + ."\n" + .'><notice>当TranscodeRecordFormat.N.Format（转码流录制格式）设为m3u8或cmaf时，本参数才生效。'."\n" + .'></notice>'."\n" + ."\n" + .'不填则默认为30秒。取值范围：5s~30s。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + 'SliceOssObjectPrefix' => [ + 'description' => '转码流录制切片名称。'."\n" + ."\n" + .'><notice>当TranscodeRecordFormat.N.Format（转码流录制格式）设为m3u8或cmaf时，本参数才需要配置。'."\n" + .'></notice>'."\n" + ."\n" + .'- 默认30秒一片，小于256字节，支持变量匹配，包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}。'."\n" + .'- 参数值必须包含{UnixTimestamp}和{Sequence}变量。', + 'type' => 'string', + 'required' => false, + 'example' => 'record/{AppName}/{StreamName}/{UnixTimestamp}_{Sequence}', + ], + 'CycleDuration' => [ + 'description' => '转码流录制周期录制时长。单位：秒。'."\n" + .'> 若不填则取默认值，不同录制格式的默认值不同：m3u8、cmaf 格式默认6小时，flv、mp4格式默认1小时。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '21600', + ], + 'OssObjectPrefix' => [ + 'description' => '转码流录制OSS存储的录制文件名。'."\n" + .'- 文件名小于256字节，支持变量匹配，包含 {AppName}、{StreamName}、{Sequence}、{StartTime}、{EndTime}、{EscapedStartTime}、{EscapedEndTime}。'."\n" + .'- 参数值必须要有{StartTime}或{EscapedStartTime}和{EndTime}或{EscapedEndTime}。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'record/{AppName}/{StreamName}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}', + ], + 'Format' => [ + 'description' => '转码流录制格式。目前支持M3U8、FLV、MP4、CMAF。取值：'."\n" + .'><notice>如果选择m3u8或cmaf格式，必须同时设置请求参数TranscodeRecordFormat.N.SliceOssObjectPrefix和TranscodeRecordFormat.N.SliceDuration。'."\n" + .'></notice>'."\n" + ."\n" + .'- m3u8。'."\n" + .'- flv。'."\n" + .'- mp4。'."\n" + .'- cmaf。', + 'type' => 'string', + 'required' => false, + 'example' => 'm3u8', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'TranscodeTemplates', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '转码流录制的转码模板组。', + 'type' => 'array', + 'items' => [ + 'description' => '- 转码流录制的[转码模板](~~45039~~)，可进行多个设置，最多为10个。'."\n" + .'- 当设置TranscodeRecordFormat.N.xxx配置时，至少需要设置一个TranscodeTemplates。'."\n" + .'- 如需录制多个或全部的转码流，可设置TranscodeTemplates.1为*****即可。'."\n" + .'>TranscodeTemplates不允许传入`raw`，属于保留标识。<br>RepeatList表示为TranscodeTemplates.N中的N，可理解为递增进行多个设置，如：TranscodeTemplates.1=sd，TranscodeTemplates.2=hd。', + 'type' => 'string', + 'required' => false, + 'example' => 'sd', + ], + 'required' => false, + 'example' => 'sd', + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOssEndpoint.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidOssBucket.Malformed', + 'errorMessage' => 'Specified parameter OssBucket is not valid.', + ], + [ + 'errorCode' => 'InvalidOssBucket.NotFound', + 'errorMessage' => 'The parameter OssBucket does not exist.', + ], + [ + 'errorCode' => 'InvalidFormat.Malformed', + 'errorMessage' => 'Specified parameter Format is not valid.', + ], + [ + 'errorCode' => 'InvalidCycleDuration.Malformed', + 'errorMessage' => 'Specified CycleDuration Format is not valid.', + ], + [ + 'errorCode' => 'InvalidSliceDuration.Malformed', + 'errorMessage' => 'Specified SliceDuration Format is not valid.', + ], + [ + 'errorCode' => 'InvalidTemplateLength.Malformed', + 'errorMessage' => 'Specified record template length is not valid.', + ], + [ + 'errorCode' => 'InvalidTemplate.ForbidRaw', + 'errorMessage' => 'Template named raw is Forbidden.', + ], + [ + 'errorCode' => 'MissingTemplate', + 'errorMessage' => 'Template is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingOssObjectPrefix', + 'errorMessage' => 'OssObjectPrefix is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingSliceOssObjectPrefix', + 'errorMessage' => 'SliceOssObjectPrefix is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidOssObjectPrefix.Malformed', + 'errorMessage' => 'Specified parameter OssObjectPrefix is not valid.', + ], + [ + 'errorCode' => 'InvalidSliceOssObjectPrefix.Malformed', + 'errorMessage' => 'Specified parameter SliceOssObjectPrefix is not valid.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + [ + 'errorCode' => 'InvalidFormat.IllegalOperation', + 'errorMessage' => 'Specified parameter Format can not be multiple.', + ], + [ + 'errorCode' => 'InvalidDelayTime', + 'errorMessage' => 'Specified Delaytime is invalid.', + ], + [ + 'errorCode' => 'Live2Vod.ConfigAlreadyExists', + 'errorMessage' => 'Had live2vod record config already.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not math the specified StartTime or current time.', + ], + [ + 'errorCode' => 'InvalidStartTime.Mismatch', + 'errorMessage' => 'Specified StartTime does not math the current time.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<AddLiveAppRecordConfigResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</AddLiveAppRecordConfigResponse>","errorExample":"{\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}"}]', + 'title' => '添加录制配置', + 'summary' => '配置APP录制，输出内容保存到OSS中。', + 'description' => '- 请确保在使用该接口前，已充分了解直播录制的收费方式和价格。计费详情，请参见[直播录制费用](~~195287~~)。'."\n" + ."\n" + .'- 若采用录制存储至OSS方式进行直播录制功能配置，需要开通OSS服务以及创建Bucket，具体操作请参见[配置OSS](~~84932~~)。'."\n" + ."\n" + .'- 录制文件存储在OSS中，会产生存储费用，在OSS中计费详情请参见[存储费用](~~173534~~)。'."\n" + ."\n" + .'- 直播录制功能，可以将直播内容进行录制，保存至您指定的位置，在您需要回看直播内容时可以进行回看。存储至OSS的录制内容，支持多种保存格式（TS、MP4、FLV、CMAF），支持自定义录制策略（自动录制、按需录制、手动录制），调用此接口可进行录制模版设置。更多直播录制功能使用可参见[直播录制](~~199357~~)说明文档。'."\n" + .'- (DomainName,'."\n" + .' AppName, StreamName)三元组只能对应一个配置，如果该三元组已经存在一个配置了，再调用本接口添加配置会返回配置已存在错误。'."\n" + .'- 通过该接口设置的各项配置，需要在直播重新推流之后才能生效，并且长期有效。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 注意事项：'."\n" + ."\n" + .'视频直播支持触发拉流，当使用触发拉流域名对应的播放地址进行播放时，会自动触发阿里云视频直播服务进行拉流直播，无人播放时则不会回源站进行拉流。自动录制、按需录制、手动录制功能应用在触发拉流场景时，如果触发拉流无人播放，则不会回源站拉流，自动录制、按需录制、手动录制同样也不会进行录制。', + ], + 'RealTimeRecordCommand' => [ + 'summary' => '按需完成手动录制。例如动态启动录制、动态停止录制。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREliveL04ZVK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Command', + 'in' => 'query', + 'schema' => [ + 'description' => '操作行为。取值：'."\n" + ."\n" + .'- **start**：强制启动录制。必须作为首次操作调用，不可在未停止前重复调用。'."\n" + .'- **stop**：强制暂停录制，断流延迟时间（默认180秒）到达后，生成录制文件。 仅可在 start 或 restart 后调用；调用后如需立即出文件，可以调用 cancel_delay。'."\n" + .'- **cancel_delay**：立即终止等待并生成录制文件，完全停止录制。需要在 stop 后调用以提前生成文件。'."\n" + .'- **restart**：强制重新开始录制。如果restart之前在录制，立即生成文件。仅可在任务启动或停止状态下调用。', + 'type' => 'string', + 'required' => true, + 'example' => 'start', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。请确保StreamName正确，您可在[流管理](~~197397~~)页面查看StreamName。'."\n" + ."\n" + .'> 该接口仅支持单条流操作，不支持通配符。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MalformedParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'CodeConfigNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 409 => [ + [ + 'errorCode' => 'StreamNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'TaskAlreadyStarted', + 'errorMessage' => '%s, please do not start again.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<RealTimeRecordCommandResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</RealTimeRecordCommandResponse>","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}"}]', + 'title' => '实时录制指令', + 'description' => '- 请确保在使用该接口前，已充分了解直播录制的收费方式和价格。计费详情，请参见[直播录制费用](~~195287~~)。'."\n" + .'- 该接口前只能控制录制配置生效的直播流，需要先完成[添加录制配置](~~2847881~~)。'."\n" + ."\n" + .'- 如果某条直播流正在录制（自动录制或手动录制启动），您可以调用此接口停止该直播流的录制；但如果在启动时调用该接口尝试启动录制，则会返回 TaskAlreadyStarted 错误，表示任务已启动。'."\n" + ."\n" + .'- 手动启动录制的直播流如果发生断流，即会停止录制。如果没有配置自动录制，重新推流后不会自动启动录制。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 注意事项： '."\n" + .'- 视频直播支持触发拉流，当使用触发拉流域名对应的播放地址进行播放时，会自动触发阿里云视频直播服务进行拉流直播，无人播放时则不会回源站进行拉流。自动录制、按需录制、手动录制功能应用在触发拉流场景时，如果触发拉流无人播放，则不会回源站拉流，自动录制、按需录制、手动录制同样也不会进行录制。', + ], + 'UpdateLiveAppRecordConfig' => [ + 'summary' => '更新配置APP录制，输出内容保存到OSS中。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveL04ZVK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储的Endpoint名称。'."\n" + ."\n" + .'直播录制文件存储至OSS，需提前创建OSS Bucket，创建方法请参见[配置OSS](~~84932~~) 。', + 'type' => 'string', + 'required' => true, + 'example' => 'learn.developer.aliyundoc.com', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'teststream', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '录制开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> 设置的时间必须是实际推流时间开始7天之内，只在流级别录制（StreamName不为空）有效。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-04-10T09:57:21Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '录制结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> EndTime与StartTime相差不应超过7天，超过7天将按照7天计算。只在流级别录制（StreamName不为空）有效。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-04-16T09:57:21Z', + ], + ], + [ + 'name' => 'OnDemand', + 'in' => 'query', + 'schema' => [ + 'description' => '按需录制。取值：'."\n" + ."\n" + .'- **0**：关闭。'."\n" + .'- **1**：通过HTTP回调方式。'."\n" + .'- **2**：解析推流参数按需录制。'."\n" + .'- **7**：默认不录制，可以通过[RealTimeRecordCommand](~~2847882~~)接口手动控制录制开启或停止。'."\n" + ."\n" + .'>当OnDemand取值为**1**时，需要先通过[AddLiveRecordNotifyConfig](~~2847891~~)接口配置OnDemandUrl，否则默认不录制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DelayTime', + 'in' => 'query', + 'schema' => [ + 'description' => '断流拼接时长。'."\n" + .'直播断流时长超过设定的拼接时长后，将会生成新文件，断流拼接时长支持15~21600秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '180', + ], + ], + [ + 'name' => 'RecordFormat', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '记录详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CycleDuration' => [ + 'description' => '周期录制时长。单位：秒。不填则默认为6小时。'."\n" + ."\n" + .'> - 如果在一个录制周期内，直播流发生了断流，但是在断流拼接时长内，该直播流又正常推流，那么仍会在同一个录制文件中继续录制。'."\n" + .'>- 一条直播流必须断流超过断流拼接时长，才会生成录制文件。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Format' => [ + 'description' => '格式。目前支持M3U8、FLV、MP4、CMAF。取值：'."\n" + ."\n" + .'><notice>RecordFormat和TranscodeRecordFormat两者至少需要设置一个。如果选择m3u8或cmaf格式，必须同时设置请求参数RecordFormat.N.SliceOssObjectPrefix和RecordFormat.N.SliceDuration。'."\n" + .'></notice>'."\n" + ."\n" + .'- m3u8。'."\n" + .'- flv。'."\n" + .'- mp4。'."\n" + .'- cmaf。', + 'type' => 'string', + 'required' => false, + 'example' => 'm3u8', + ], + 'SliceDuration' => [ + 'description' => '单个切片时长。单位：秒。'."\n" + ."\n" + .'><notice>当RecordFormat.N.Format（格式）设为m3u8或cmaf时，本参数才有效。'."\n" + .'></notice>'."\n" + ."\n" + .'不填则默认为30秒。取值范围：5s~30s。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'TranscodeRecordFormat', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '转码记录详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CycleDuration' => [ + 'description' => '转码流录制周期录制时长。单位：秒。不填则默认为6小时。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '21600', + ], + 'Format' => [ + 'description' => '转码流录制格式。目前支持M3U8、FLV、MP4、CMAF。取值：'."\n" + .'><notice>这如果选择m3u8或cmaf格式，必须同时设置请求参数TranscodeRecordFormat.N.SliceOssObjectPrefix和TranscodeRecordFormat.N.SliceDuration。'."\n" + .'></notice>'."\n" + ."\n" + .'- m3u8。'."\n" + .'- flv。'."\n" + .'- mp4。'."\n" + .'- cmaf。', + 'type' => 'string', + 'required' => false, + 'example' => 'm3u8', + ], + 'SliceDuration' => [ + 'description' => '转码流录制单个切片时长，单位：秒。'."\n" + ."\n" + .'><notice>当TranscodeRecordFormat.N.Format（转码流录制格式）设为m3u8或cmaf时，本参数才生效。'."\n" + .'></notice>'."\n" + ."\n" + .'不填则默认为30秒。取值范围：5s~30s。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'TranscodeTemplates', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '转码流录制的转码模板组。', + 'type' => 'array', + 'items' => [ + 'description' => '- 转码流录制的[转码模板](~~45039~~)，可进行多个设置，最多为10个。'."\n" + .'- 当设置TranscodeRecordFormat.N.xxx配置时，至少需要设置一个TranscodeTemplates。'."\n" + .'- 如需录制多个或全部的转码流，可设置TranscodeTemplates.1为*****即可。'."\n" + .'>TranscodeTemplates不允许传入`raw`，属于保留标识。<br>RepeatList表示为TranscodeTemplates.N中的N，可理解为递增进行多个设置，如：'."\n" + .'TranscodeTemplates.1=sd，'."\n" + .'TranscodeTemplates.2=hd。', + 'type' => 'string', + 'required' => false, + 'example' => 'sd', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOssBucket.Malformed', + 'errorMessage' => 'Specified parameter OssBucket is not valid.', + ], + [ + 'errorCode' => 'InvalidOssBucket.NotFound', + 'errorMessage' => 'The parameter OssBucket does not exist.', + ], + [ + 'errorCode' => 'InvalidFormat.Malformed', + 'errorMessage' => 'Specified parameter Format is not valid.', + ], + [ + 'errorCode' => 'InvalidCycleDuration.Malformed', + 'errorMessage' => 'Specified CycleDuration Format is not valid.', + ], + [ + 'errorCode' => 'InvalidSliceDuration.Malformed', + 'errorMessage' => 'Specified SliceDuration Format is not valid.', + ], + [ + 'errorCode' => 'InvalidTemplateLength.Malformed', + 'errorMessage' => 'Specified record template length is not valid.', + ], + [ + 'errorCode' => 'InvalidTemplate.ForbidRaw', + 'errorMessage' => 'Template named raw is Forbidden.', + ], + [ + 'errorCode' => 'MissingTemplate', + 'errorMessage' => 'Template is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingOssObjectPrefix', + 'errorMessage' => 'OssObjectPrefix is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingSliceOssObjectPrefix', + 'errorMessage' => 'SliceOssObjectPrefix is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidOssObjectPrefix.Malformed', + 'errorMessage' => 'Specified parameter OssObjectPrefix is not valid.', + ], + [ + 'errorCode' => 'InvalidSliceOssObjectPrefix.Malformed', + 'errorMessage' => 'Specified parameter SliceOssObjectPrefix is not valid.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + [ + 'errorCode' => 'InvalidFormat.IllegalOperation', + 'errorMessage' => 'Specified parameter Format can not be multiple.', + ], + [ + 'errorCode' => 'InvalidDelayTime', + 'errorMessage' => 'Specified Delaytime is invalid.', + ], + [ + 'errorCode' => 'Live2Vod.ConfigAlreadyExists', + 'errorMessage' => 'Had live2vod record config already.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not math the specified StartTime or current time.', + ], + [ + 'errorCode' => 'InvalidStartTime.Mismatch', + 'errorMessage' => 'Specified StartTime does not math the current time.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'Ram Permission is forbidden.', + ], + [ + 'errorCode' => 'InvalidOssEndpoint.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","type":"json"}]', + 'title' => '更新直播录制', + 'description' => '先获取主播流域名，再调用本接口更新录制配置。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteLiveAppRecordConfig' => [ + 'summary' => '删除App级别录制配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveL04ZVK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6EBD1AC4-C34D-4AE1-963E-B688A228BE31', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidRegion', + 'errorMessage' => 'The current region does not support this operation.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'Ram Permission is forbidden.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DeleteLiveAppRecordConfigResponse>\\n\\t<RequestId>6EBD1AC4-C34D-4AE1-963E-B688A228BE31</RequestId>\\n</DeleteLiveAppRecordConfigResponse>\\t","errorExample":"{\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"}]', + 'title' => '解除录制配置', + 'description' => '先获取主播流域名，再调用本接口删除App级别录制配置。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveStreamRecordIndexFiles' => [ + 'summary' => '删除直播录制文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveL04ZVK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'RecordId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '索引文件ID组。', + 'type' => 'array', + 'items' => [ + 'description' => '索引文件ID。其中N最多支持配置20个。'."\n" + .'> 通过[查询所有录制索引文件](~~2847890~~)接口查询', + 'type' => 'string', + 'required' => false, + 'example' => 'c4d7f0a4-b506-43f9-8de3-07732c3f****', + ], + 'required' => true, + 'example' => 'c4d7f0a4-b506-43f9-8de3-07732c3f****', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'RemoveFile', + 'in' => 'query', + 'schema' => [ + 'description' => '是否同步删除OSS文件。取值：'."\n" + ."\n" + .'- **true**：同步删除OSS文件。'."\n" + ."\n" + .'- **false**：不同步删除OSS文件。', + 'type' => 'string', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '删除文件信息', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态定义码。若状态错误，请参考错误码信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态解释。若状态错误，请参考错误码信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RecordDeleteInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RecordDeleteInfo' => [ + 'description' => '删除信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '删除信息列表。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '对每个FileId的处理结果。取值：'."\n" + ."\n" + .'- **OK**：删除成功。'."\n" + ."\n" + .'- **AccessDenied**：拒绝访问。'."\n" + ."\n" + .'- **FileNotFound**：文件未找到。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RecordId' => [ + 'description' => '请求被删除的索引文件ID 。', + 'type' => 'string', + 'example' => 'c4d7f0a4-b506-43f9-8de3-07732c3f**', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '939D19EE-59A0-18E9-B458-*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'Failed to parse given parameters.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RecordDeleteInfoList\\": {\\n \\"RecordDeleteInfo\\": [\\n {\\n \\"Message\\": \\"OK\\",\\n \\"RecordId\\": \\"c4d7f0a4-b506-43f9-8de3-07732c3f**\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"939D19EE-59A0-18E9-B458-*****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveStreamRecordIndexFilesResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RecordDeleteInfoList>\\n <Message>OK</Message>\\n <RecordId>c4d7f0a4-b506-43f9-8de3-07732c3f**</RecordId>\\n </RecordDeleteInfoList>\\n <RequestId>939D19EE-59A0-18E9-B458-*****</RequestId>\\n</DeleteLiveStreamRecordIndexFilesResponse>","errorExample":""}]', + 'title' => '删除直播录制文件', + 'description' => '本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveRecordConfig' => [ + 'summary' => '查询直播域名下所有APP录制配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveL04ZVK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。默认值：**10**，取值范围：**5~30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '30', + 'minimum' => '5', + 'example' => '5', + 'default' => '10', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '按创建时间排序。取值：'."\n" + .'- **asc**（默认值）：升序。'."\n" + .'- **desc**：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + 'default' => 'asc', + 'enum' => [ + 'asc', + 'desc', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '分页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5056369B-D337-499E-B8B7-B761BD37B08A', + ], + 'Order' => [ + 'description' => '排序。', + 'type' => 'string', + 'example' => 'desc', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalNum' => [ + 'description' => '符合条件的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'LiveAppRecordList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveAppRecord' => [ + 'description' => '录制配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '录制配置列表。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '计划录制结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-11-08T03:49:18Z', + ], + 'StartTime' => [ + 'description' => '计划录制开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-11-08T02:49:18Z', + ], + 'AppName' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'StreamName' => [ + 'description' => '直播流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'DelayTime' => [ + 'description' => '断流拼接时长。'."\n" + .'直播断流时长超过设定的拼接时长后，将会生成新文件，断流拼接时长支持15~21600秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '180', + ], + 'CreateTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2016-05-20T09:33:38Z', + ], + 'OnDemond' => [ + 'description' => '按需录制。取值：'."\n" + ."\n" + .'- **0**：关闭。'."\n" + .'- **1**：通过HTTP回调方式。'."\n" + .'- **2**：通过推流参数方式。'."\n" + .'- **7**：默认不录制，可以通过[RealTimeRecordCommand](~~85907~~)接口手动控制录制开启或停止。'."\n" + ."\n" + .'>当OnDemand取值为**1**时，需要先通过[AddLiveRecordNotifyConfig](~~51831~~)接口配置OnDemandUrl，否则默认不录制。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OssBucket' => [ + 'description' => 'OSS存储Bucket名称。', + 'type' => 'string', + 'example' => 'liveBucket****', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'OssEndpoint' => [ + 'description' => 'OSS存储的Endpoint名称。', + 'type' => 'string', + 'example' => 'cn-oss-****.aliyuncs.com', + ], + 'RecordFormatList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RecordFormat' => [ + 'description' => '格式列表。', + 'type' => 'array', + 'items' => [ + 'description' => '格式列表。', + 'type' => 'object', + 'properties' => [ + 'SliceDuration' => [ + 'description' => '转码流录制单个切片时长。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'CycleDuration' => [ + 'description' => '周期录制时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'SliceOssObjectPrefix' => [ + 'description' => '切片名称。', + 'type' => 'string', + 'example' => 'record/{liveApp****}/{liveStream****}/{UnixTimestamp}', + ], + 'OssObjectPrefix' => [ + 'description' => '录制文件名称。', + 'type' => 'string', + 'example' => 'record/{liveApp****}/{liveStream****}', + ], + 'Format' => [ + 'description' => '格式。', + 'type' => 'string', + 'example' => 'M3U8', + ], + ], + ], + ], + ], + ], + 'TranscodeRecordFormatList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RecordFormat' => [ + 'description' => '转码流录制格式列表。', + 'type' => 'array', + 'items' => [ + 'description' => '录制配置文件格式列表。', + 'type' => 'object', + 'properties' => [ + 'SliceDuration' => [ + 'description' => '转码流录制单个切片时长。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'CycleDuration' => [ + 'description' => '周期录制时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'SliceOssObjectPrefix' => [ + 'description' => '转码流录制切片名称。', + 'type' => 'string', + 'example' => 'record/{liveApp****}/{liveStream****}/{UnixTimestamp}', + ], + 'OssObjectPrefix' => [ + 'description' => '转码流录制文件名称。', + 'type' => 'string', + 'example' => 'record/{liveApp****}/{liveStream****}', + ], + 'Format' => [ + 'description' => '转码流录制格式。', + 'type' => 'string', + 'example' => 'M3U8', + ], + ], + ], + ], + ], + ], + 'TranscodeTemplates' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Templates' => [ + 'description' => '转码模板。', + 'type' => 'array', + 'items' => [ + 'description' => '转码流录制的转码模板。设置了录制所有转码流，则返回为\\["*"]。', + 'type' => 'string', + 'example' => '["sd","hd"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 5,\\n \\"RequestId\\": \\"5056369B-D337-499E-B8B7-B761BD37B08A\\",\\n \\"Order\\": \\"desc\\",\\n \\"TotalPage\\": 20,\\n \\"PageSize\\": 10,\\n \\"TotalNum\\": 12,\\n \\"LiveAppRecordList\\": {\\n \\"LiveAppRecord\\": [\\n {\\n \\"EndTime\\": \\"2018-11-08T03:49:18Z\\",\\n \\"StartTime\\": \\"2018-11-08T02:49:18Z\\",\\n \\"AppName\\": \\"liveApp****\\",\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"DelayTime\\": 180,\\n \\"CreateTime\\": \\"2016-05-20T09:33:38Z\\",\\n \\"OnDemond\\": 0,\\n \\"OssBucket\\": \\"liveBucket****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"OssEndpoint\\": \\"cn-oss-****.aliyuncs.com\\",\\n \\"RecordFormatList\\": {\\n \\"RecordFormat\\": [\\n {\\n \\"SliceDuration\\": 30,\\n \\"CycleDuration\\": 3600,\\n \\"SliceOssObjectPrefix\\": \\"record/{liveApp****}/{liveStream****}/{UnixTimestamp}\\",\\n \\"OssObjectPrefix\\": \\"record/{liveApp****}/{liveStream****}\\",\\n \\"Format\\": \\"M3U8\\"\\n }\\n ]\\n },\\n \\"TranscodeRecordFormatList\\": {\\n \\"RecordFormat\\": [\\n {\\n \\"SliceDuration\\": 30,\\n \\"CycleDuration\\": 3600,\\n \\"SliceOssObjectPrefix\\": \\"record/{liveApp****}/{liveStream****}/{UnixTimestamp}\\",\\n \\"OssObjectPrefix\\": \\"record/{liveApp****}/{liveStream****}\\",\\n \\"Format\\": \\"M3U8\\"\\n }\\n ]\\n },\\n \\"TranscodeTemplates\\": {\\n \\"Templates\\": [\\n \\"[\\\\\\"sd\\\\\\",\\\\\\"hd\\\\\\"]\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveRecordConfigResponse>\\n<Order>desc</Order>\\n<TotalNum>12</TotalNum>\\n<TotalPage>20</TotalPage>\\n<PageSize>10</PageSize>\\n<PageNum>5</PageNum>\\n<RequestId>5056369B-D337-499E-B8B7-B761BD37B08A</RequestId>\\n<LiveAppRecordList>\\n <LiveAppRecord>\\n <StreamName>liveStream****</StreamName>\\n <EndTime>2018-11-08T03:49:18Z</EndTime>\\n <OssEndpoint>cn-oss-****.aliyuncs.com</OssEndpoint>\\n <DomainName>example.com</DomainName>\\n <CreateTime>2016-05-20T09:33:38Z</CreateTime>\\n <StartTime>2018-11-08T02:49:18Z</StartTime>\\n <OssBucket>liveBucket****</OssBucket>\\n <OnDemond>0</OnDemond>\\n <AppName>liveApp****</AppName>\\n <RecordFormatList>\\n <RecordFormat>\\n <Format>M3U8</Format>\\n <SliceOssObjectPrefix>record/{liveApp****}/{liveStream****}/{UnixTimestamp}</SliceOssObjectPrefix>\\n <CycleDuration>3600</CycleDuration>\\n <SliceDuration>30</SliceDuration>\\n <OssObjectPrefix>record/{liveApp****}/{liveStream****}</OssObjectPrefix>\\n </RecordFormat>\\n </RecordFormatList>\\n <TranscodeRecordFormatList>\\n <RecordFormat>\\n <Format>M3U8</Format>\\n <SliceOssObjectPrefix>record/{liveApp****}/{liveStream****}/{UnixTimestamp}</SliceOssObjectPrefix>\\n <CycleDuration>3600</CycleDuration>\\n <SliceDuration>30</SliceDuration>\\n <OssObjectPrefix>record/{liveApp****}/{liveStream****}</OssObjectPrefix>\\n </RecordFormat>\\n </TranscodeRecordFormatList>\\n <TranscodeTemplates>\\n <Templates>[\\"sd\\"，\\"hd\\"]</Templates>\\n </TranscodeTemplates>\\n </LiveAppRecord>\\n</LiveAppRecordList>\\n</DescribeLiveRecordConfigResponse>","errorExample":"{\\n \\"LiveAppRecordList\\":{\\n \\"LiveAppRecord\\":[{\\n \\"AppName\\":\\"aliyuntest\\",\\n \\"CreateTime\\":\\"2016-05-20T09:33:38Z\\",\\n \\"DomainName\\":\\"xxxxx\\",\\n \\"FormatList\\":{\\n \\"Format\\":[{\\n \\"Name\\":\\"m3u8\\",\\n \\"OssObjectPrefix\\":\\"xxx\\",\\n \\"SliceOssObjectPrefix\\":\\"xxx\\"\\n }]\\n },\\n \\"OssBucket\\":\\"chimang.bucket\\",\\n \\"OssEndpoint\\":\\"oss-cn-hangzhou.aliyuncs.com\\"\\n }]\\n },\\n \\"RequestId\\":\\"5056369B-D337-499E-B8B7-B761BD37B08A\\"\\n}"}]', + 'title' => '查询域名下所有App录制配置', + 'description' => '先获取主播流域名，再调用本接口查询直播域名下所有APP录制配置。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamRecordContent' => [ + 'summary' => '查询直播录制内容。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveL04ZVK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。仅能查询6个月内的记录。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。与StartTime的间隔时间不能超过4天。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '62136AE6-7793-45ED-B14A-60D19A9486D3', + ], + 'RecordContentInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RecordContentInfo' => [ + 'description' => '录制内容列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2015-12-01T07:46:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2015-12-01T07:36:00Z', + ], + 'Duration' => [ + 'description' => '录制时长。单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'OssBucket' => [ + 'description' => 'OSS存储的Bucket名称。', + 'type' => 'string', + 'example' => 'liveBucket****', + ], + 'OssObjectPrefix' => [ + 'description' => 'OSS存储的录制文件名的规则。', + 'type' => 'string', + 'example' => 'record/{Date}/{UnixTimestamp}_{Sequence}', + ], + 'OssEndpoint' => [ + 'description' => 'OSS存储的Endpoint名称。', + 'type' => 'string', + 'example' => 'cn-oss-****.aliyuncs.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidStartTime.Mismatch', + 'errorMessage' => 'Specified StartTime does not math the current time.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"62136AE6-7793-45ED-B14A-60D19A9486D3\\",\\n \\"RecordContentInfoList\\": {\\n \\"RecordContentInfo\\": [\\n {\\n \\"EndTime\\": \\"2015-12-01T07:46:00Z\\",\\n \\"StartTime\\": \\"2015-12-01T07:36:00Z\\",\\n \\"Duration\\": 10,\\n \\"OssBucket\\": \\"liveBucket****\\",\\n \\"OssObjectPrefix\\": \\"record/{Date}/{UnixTimestamp}_{Sequence}\\",\\n \\"OssEndpoint\\": \\"cn-oss-****.aliyuncs.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamRecordContentResponse>\\n<RequestId>62136AE6-7793-45ED-B14A-60D19A9486D3</RequestId>\\n<RecordContentInfoList>\\n <RecordContentInfo>\\n <EndTime>2015-12-01T07:46:00Z</EndTime>\\n <OssEndpoint>cn-oss-****.aliyuncs.com</OssEndpoint>\\n <StartTime>2015-12-01T07:36:00Z</StartTime>\\n <OssBucket>liveBucket****</OssBucket>\\n <Duration>10</Duration>\\n <OssObjectPrefix>record/{Date}/{UnixTimestamp}_{Sequence}</OssObjectPrefix>\\n </RecordContentInfo>\\n</RecordContentInfoList>\\n</DescribeLiveStreamRecordContentResponse>","errorExample":"{\\n \\"RecordContentInfoList\\":{\\n \\"RecordContentInfo\\":[{\\n \\"Duration\\":14638.0,\\n \\"EndTime\\":\\"2016-05-25T09:41:09Z\\",\\n \\"OssBucket\\":\\"livevideo-test\\",\\n \\"OssEndpoint\\":\\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"OssObjectPrefix\\":\\"record/{Date}/{UnixTimestamp}_{Sequence}\\",\\n \\"StartTime\\":\\"2016-05-25T05:37:11Z\\"\\n }]\\n },\\n \\"RequestId\\":\\"62136AE6-7793-45ED-B14A-60D19A9486D3\\"\\n}"}]', + 'title' => '查询直播流录制内容', + 'description' => '先获取主播流域名，再调用本接口查询直播录制内容。'."\n" + ."\n" + .'本接口的直播录制内容是以一次录制任务维度的，具体录制文件请使用[查询所有录制索引文件](~~2847890~~)和[查询单个录制索引文件](~~2847889~~)接口查询'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' > 访问OSS资源的URL地址组成，请参见[如何获取单个或多个文件的URL？](~~39607~~)', + 'extraInfo' => ' ', + ], + 'CreateLiveStreamRecordIndexFiles' => [ + 'summary' => '创建某个时间范围的M3U8索引文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106896', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。AppName名称与推流地址中的AppName名称对应，模板才能生效。若不限制AppName可填*，即可匹配所有AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。StreamName名称与推流地址中的StreamName名称对应，模板才能生效。若不限制StreamName可填*，即可匹配所有StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储Endpoint名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-oss-****.aliyuncs.com', + ], + ], + [ + 'name' => 'OssBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储Bucket名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveBucket****', + ], + ], + [ + 'name' => 'OssObject', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储的录制文件名。', + 'type' => 'string', + 'required' => true, + 'example' => '{AppName}/{StreamName}/{Date}/{Hour}/{Minute}_{Second}.m3u8', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '索引文件的开始时间。ts文件的上传时间在此之后则会被包含进索引文件。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '索引文件的结束时间。ts文件的上传时间在此之前则会被包含进索引文件。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + [ + 'name' => 'EndTimeIncluded', + 'in' => 'query', + 'schema' => [ + 'description' => '是否包含结束时间。传true会尝试多包含一个ts文件，创建的索引文件会完整覆盖StartTime和EndTime。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '550439A3-F8EC-4CA2-BB62-B9DB43EEEF30', + ], + 'RecordInfo' => [ + 'description' => '录制配置信息。', + 'type' => 'object', + 'properties' => [ + 'RecordUrl' => [ + 'description' => '索引文件地址。', + 'type' => 'string', + 'example' => 'http://*****/atestObject.m3u8', + ], + 'StreamName' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'CreateTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2016-05-27T09:40:56Z', + ], + 'RecordId' => [ + 'description' => '索引文件ID。', + 'type' => 'string', + 'example' => 'c4d7f0a4-b506-43f9-8de3-07732c3f****', + ], + 'Height' => [ + 'description' => '视频高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '480', + ], + 'OssBucket' => [ + 'description' => 'OSS存储Bucket名称。', + 'type' => 'string', + 'example' => 'liveBucket****', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'OssObject' => [ + 'description' => 'OSS存储的录制文件名。', + 'type' => 'string', + 'example' => 'liveObject****.m3u8', + ], + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-01T07:40:00Z', + ], + 'AppName' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'StartTime' => [ + 'description' => '开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-01T07:36:00Z', + ], + 'Width' => [ + 'description' => '视频宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '640', + ], + 'Duration' => [ + 'description' => '录制时长。单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '20', + ], + 'OssEndpoint' => [ + 'description' => 'OSS存储Endpoint名称。', + 'type' => 'string', + 'example' => 'cn-oss-****.aliyuncs.com', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Mismatch', + 'errorMessage' => 'Specified StartTime does not math the current time.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'invalid params', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidOssEndpoint.Malformed', + 'errorMessage' => 'Specified OssEndpoint is malformed.', + ], + [ + 'errorCode' => 'InvalidOssBucket.Malformed', + 'errorMessage' => 'Specified OssBucket is malformed.', + ], + [ + 'errorCode' => 'InvalidOssObject.Malformed', + 'errorMessage' => 'Specified OssObject is malformed.', + ], + [ + 'errorCode' => 'InvalidStream.NotFound', + 'errorMessage' => 'Speicified stream does not exist.', + ], + [ + 'errorCode' => 'InvalidConfig.Changed', + 'errorMessage' => 'The oss bucket info between StartTime and EndTime has changed.', + ], + [ + 'errorCode' => 'NoRecordContent', + 'errorMessage' => 'The record content between StartTime and EndTime is empty.', + ], + [ + 'errorCode' => 'RecordContentExceed', + 'errorMessage' => 'The record content between StartTime and EndTime is exceeded, please narrow down the range.', + ], + [ + 'errorCode' => 'OperationNotSupport', + 'errorMessage' => 'The Operation is not support for flv/mp4 format or live to vod record.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidBucket.NotFound', + 'errorMessage' => 'The bucket does not belong to you.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"550439A3-F8EC-4CA2-BB62-B9DB43EEEF30\\",\\n \\"RecordInfo\\": {\\n \\"RecordUrl\\": \\"http://*****/atestObject.m3u8\\",\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"CreateTime\\": \\"2016-05-27T09:40:56Z\\",\\n \\"RecordId\\": \\"c4d7f0a4-b506-43f9-8de3-07732c3f****\\",\\n \\"Height\\": 480,\\n \\"OssBucket\\": \\"liveBucket****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"OssObject\\": \\"liveObject****.m3u8\\",\\n \\"EndTime\\": \\"2015-12-01T07:40:00Z\\",\\n \\"AppName\\": \\"liveApp****\\",\\n \\"StartTime\\": \\"2015-12-01T07:36:00Z\\",\\n \\"Width\\": 640,\\n \\"Duration\\": 20,\\n \\"OssEndpoint\\": \\"cn-oss-****.aliyuncs.com\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateLiveStreamRecordIndexFilesResponse>\\n <RequestId>550439A3-F8EC-4CA2-BB62-B9DB43EEEF30</RequestId>\\n <RecordInfo>\\n <EndTime>2015-12-01T07:40:00Z</EndTime>\\n <DomainName>example.com</DomainName>\\n <CreateTime>2016-05-27T09:40:56Z</CreateTime>\\n <StartTime>2015-12-01T07:36:00Z</StartTime>\\n <OssBucket>liveBucket****</OssBucket>\\n <Duration>20</Duration>\\n <AppName>liveApp****</AppName>\\n <StreamName>liveStream****</StreamName>\\n <OssEndpoint>cn-oss-****.aliyuncs.com</OssEndpoint>\\n <RecordUrl>http://*****/atestObject.m3u8</RecordUrl>\\n <OssObject>liveObject****.m3u8</OssObject>\\n <Height>480</Height>\\n <RecordId>c4d7f0a4-b506-43f9-8de3-07732c3f****</RecordId>\\n <Width>640</Width>\\n </RecordInfo>\\n</CreateLiveStreamRecordIndexFilesResponse>","errorExample":""}]', + 'title' => '创建录制索引文件', + 'description' => '您已配置OSS，具体操作，请参见[配置OSS](~~84932~~)。'."\n" + .'直播录制索引是将视频直播流以M3U8的格式进行录制，存储在OSS中后，对已存储的TS分片索引文件进行实时的剪辑处理。 '."\n" + ."\n" + .'> - 创建录制索引必保证直播流发生过推流行为，如果设置的时间内未发生过直播或直播流名称错误等会导致创建录制索引失败。'."\n" + .'> - 请确保DomainName/AppName/StreamName都是正确的，否则会返回InvalidStream.NotFound错误。'."\n" + .'> - StartTime和EndTime的间隔至少是一片TS的时长（默认为30s）。'."\n" + .'> - EndTime要大于StartTime，并且间隔最多不能超过4天。'."\n" + .'> - TS分片信息在视频直播系统中仅保存3个月，创建M3U8文件只能选择最近3个月的录制内容。'."\n" + .'> - TS分片文件存储在OSS中，保存时间由OSS的存储配置决定。详细信息，请参见[设置生命周期规则](~~31904~~)。'."\n" + .'> - 创建好的M3U8索引文件的信息在视频直播系统中仅保存6个月，若要查询仅能查询6个月内创建的索引文件的信息。'."\n" + .'> - M3U8索引文件存储在OSS中，保存时间由OSS的存储配置决定。'."\n" + .'> - 当M3U8和TS的bucket不同时，M3U8里的TS路径将会是 HTTP格式。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为45次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamRecordIndexFile' => [ + 'summary' => '查询单个录制索引文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107095', + 'abilityTreeNodes' => [ + 'FEATUREliveL04ZVK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'description' => '索引文件ID。'."\n" + ."\n" + .'> 通过[查询所有录制索引文件](~~2847890~~)接口查询', + 'type' => 'string', + 'required' => true, + 'example' => 'c4d7f0a4-b506-43f9-8de3-07732c3f****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5EBF2AC3-4B73-40A5-8B32-83F49D5F035E', + ], + 'RecordIndexInfo' => [ + 'description' => '录制配置。', + 'type' => 'object', + 'properties' => [ + 'RecordUrl' => [ + 'description' => '索引文件地址。', + 'type' => 'string', + 'example' => 'http://****/atestObject****.m3u8', + ], + 'StreamName' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'CreateTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2016-05-27T09:40:56Z', + ], + 'RecordId' => [ + 'description' => '索引文件ID。', + 'type' => 'string', + 'example' => 'c4d7f0a4-b506-43f9-8de3-07732c3f****', + ], + 'Height' => [ + 'description' => '视频高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '480', + ], + 'OssBucket' => [ + 'description' => 'OSS存储的Bucket名称。', + 'type' => 'string', + 'example' => 'liveBucket****', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'OssObject' => [ + 'description' => 'OSS存储的录制文件名。', + 'type' => 'string', + 'example' => 'liveObject****', + ], + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2016-05-25T05:47:11Z', + ], + 'AppName' => [ + 'description' => '流所属应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'StartTime' => [ + 'description' => '开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-01T05:36:00Z', + ], + 'Width' => [ + 'description' => '视频宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '640', + ], + 'Duration' => [ + 'description' => '录制时长。单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '588.849', + ], + 'OssEndpoint' => [ + 'description' => 'OSS存储的Endpoint名称。', + 'type' => 'string', + 'example' => 'cn-oss-****.aliyuncs.com', + ], + 'Format' => [ + 'description' => '视频格式。', + 'type' => 'string', + 'example' => 'mp4', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5EBF2AC3-4B73-40A5-8B32-83F49D5F035E\\",\\n \\"RecordIndexInfo\\": {\\n \\"RecordUrl\\": \\"http://****/atestObject****.m3u8\\",\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"CreateTime\\": \\"2016-05-27T09:40:56Z\\",\\n \\"RecordId\\": \\"c4d7f0a4-b506-43f9-8de3-07732c3f****\\",\\n \\"Height\\": 480,\\n \\"OssBucket\\": \\"liveBucket****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"OssObject\\": \\"liveObject****\\",\\n \\"EndTime\\": \\"2016-05-25T05:47:11Z\\",\\n \\"AppName\\": \\"liveApp****\\",\\n \\"StartTime\\": \\"2015-12-01T05:36:00Z\\",\\n \\"Width\\": 640,\\n \\"Duration\\": 588.849,\\n \\"OssEndpoint\\": \\"cn-oss-****.aliyuncs.com\\",\\n \\"Format\\": \\"mp4\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamRecordIndexFileResponse>\\n <RecordIndexInfo>\\n <EndTime>2016-05-25T05:47:11Z</EndTime>\\n <DomainName>example.com</DomainName>\\n <CreateTime>2016-05-27T09:40:56Z</CreateTime>\\n <StartTime>2015-12-01T05:36:00Z</StartTime>\\n <OssBucket>liveBucket****</OssBucket>\\n <Duration>588.849</Duration>\\n <AppName>liveApp****</AppName>\\n <StreamName>liveStream****</StreamName>\\n <OssEndpoint>cn-oss-****.aliyuncs.com</OssEndpoint>\\n <RecordUrl>http://****/atestObject****.m3u8</RecordUrl>\\n <OssObject>liveObject****</OssObject>\\n <Height>480</Height>\\n <RecordId>c4d7f0a4-b506-43f9-8de3-07732c3f****</RecordId>\\n <Width>640</Width>\\n <Format>mp4</Format>\\n </RecordIndexInfo>\\n <RequestId>5EBF2AC3-4B73-40A5-8B32-83F49D5F035E</RequestId>\\n</DescribeLiveStreamRecordIndexFileResponse>","errorExample":""}]', + 'title' => '查询单个录制索引文件', + 'description' => '创建好的M3U8索引文件的信息在视频直播系统中仅保存6个月，若要查询仅能查询6个月内创建的索引文件的信息。M3U8索引文件存储在OSS中，保存时间由OSS的存储配置决定。'."\n" + ."\n\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamRecordIndexFiles' => [ + 'summary' => '查询某个时间段内的所有录制索引文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107096', + 'abilityTreeNodes' => [ + 'FEATUREliveL04ZVK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。与StartTime间隔时间不能超过4天。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。取值范围：**5~30**，默认值为**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '30', + 'minimum' => '5', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '按创建时间排序。取值：'."\n" + ."\n" + .'- **asc**（默认值）：升序。'."\n" + .'- **desc**：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + 'default' => 'asc', + 'enum' => [ + 'asc', + 'desc', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '分页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DE24625C-7C0F-4020-8448-9C31A50C1556', + ], + 'Order' => [ + 'description' => '排序。', + 'type' => 'string', + 'example' => 'asc', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalNum' => [ + 'description' => '符合条件的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'RecordIndexInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RecordIndexInfo' => [ + 'description' => '录制配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RecordUrl' => [ + 'description' => '索引文件地址。', + 'type' => 'string', + 'example' => 'http://****/atestObject****.m3u8', + ], + 'StreamName' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2016-05-27T09:40:56Z', + ], + 'RecordId' => [ + 'description' => '索引文件ID。', + 'type' => 'string', + 'example' => 'c4d7f0a4-b506-43f9-8de3-07732c3f****', + ], + 'Height' => [ + 'description' => '视频高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '480', + ], + 'OssBucket' => [ + 'description' => 'OSS存储Bucket名称。', + 'type' => 'string', + 'example' => 'liveBucket****', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'OssObject' => [ + 'description' => 'OSS存储的录制文件名。', + 'type' => 'string', + 'example' => 'liveObject****', + ], + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2015-12-01T07:46:00Z', + ], + 'AppName' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'StartTime' => [ + 'description' => '开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2015-12-01T07:36:00Z', + ], + 'Width' => [ + 'description' => '视频宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '640', + ], + 'Duration' => [ + 'description' => '录制时长。单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '588.849', + ], + 'OssEndpoint' => [ + 'description' => 'OSS存储的Endpoint名称。', + 'type' => 'string', + 'example' => 'cn-oss-****.aliyuncs.com', + ], + 'Format' => [ + 'description' => '视频格式。', + 'type' => 'string', + 'example' => 'HLS', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidStartTime.Mismatch', + 'errorMessage' => 'Specified StartTime does not math the current time.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'Ram Permission is forbidden.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 10,\\n \\"RequestId\\": \\"DE24625C-7C0F-4020-8448-9C31A50C1556\\",\\n \\"Order\\": \\"asc\\",\\n \\"TotalPage\\": 20,\\n \\"PageSize\\": 5,\\n \\"TotalNum\\": 12,\\n \\"RecordIndexInfoList\\": {\\n \\"RecordIndexInfo\\": [\\n {\\n \\"RecordUrl\\": \\"http://****/atestObject****.m3u8\\",\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"CreateTime\\": \\"2016-05-27T09:40:56Z\\",\\n \\"RecordId\\": \\"c4d7f0a4-b506-43f9-8de3-07732c3f****\\",\\n \\"Height\\": 480,\\n \\"OssBucket\\": \\"liveBucket****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"OssObject\\": \\"liveObject****\\",\\n \\"EndTime\\": \\"2015-12-01T07:46:00Z\\",\\n \\"AppName\\": \\"liveApp****\\",\\n \\"StartTime\\": \\"2015-12-01T07:36:00Z\\",\\n \\"Width\\": 640,\\n \\"Duration\\": 588.849,\\n \\"OssEndpoint\\": \\"cn-oss-****.aliyuncs.com\\",\\n \\"Format\\": \\"HLS\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamRecordIndexFilesResponse>\\n <Order>asc</Order>\\n <TotalNum>12</TotalNum>\\n <TotalPage>20</TotalPage>\\n <PageSize>5</PageSize>\\n <PageNum>10</PageNum>\\n <RequestId>DE24625C-7C0F-4020-8448-9C31A50C1556</RequestId>\\n <RecordIndexInfoList>\\n <RecordIndexInfo>\\n <EndTime>2015-12-01T07:46:00Z</EndTime>\\n <DomainName>example.com</DomainName>\\n <CreateTime>2016-05-27T09:40:56Z</CreateTime>\\n <StartTime>2015-12-01T07:36:00Z</StartTime>\\n <OssBucket>liveBucket****</OssBucket>\\n <Duration>588.849</Duration>\\n <AppName>liveApp****</AppName>\\n <StreamName>liveStream****</StreamName>\\n <OssEndpoint>cn-oss-****.aliyuncs.com</OssEndpoint>\\n <RecordUrl>http://****/atestObject****.m3u8</RecordUrl>\\n <OssObject>liveObject****</OssObject>\\n <Height>480</Height>\\n <RecordId>c4d7f0a4-b506-43f9-8de3-07732c3f****</RecordId>\\n <Width>640</Width>\\n <Format>mp4</Format>\\n </RecordIndexInfo>\\n </RecordIndexInfoList>\\n</DescribeLiveStreamRecordIndexFilesResponse>","errorExample":""}]', + 'title' => '查询某个时间段内的所有录制索引文件', + 'description' => '- 创建好的M3U8索引文件的信息在视频直播系统中仅保存6个月，若要查询仅能查询6个月内创建的索引文件的信息。'."\n" + .' - M3U8索引文件存储在OSS中，保存时间由OSS的存储配置决定。'."\n" + .'- 录制默认返回的是HTTP地址，如需HTTPS可以自行配置证书并将HTTP修改成HTTPS。'."\n" + ."\n\n" + .'## QPS限制'."\n" + ."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddLiveRecordNotifyConfig' => [ + 'summary' => '添加域名级别录制回调配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'NotifyUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '录制回调（包括录制事件和状态回调） URL地址。'."\n" + ."\n" + .'> 必须以`http://`或者`https://`开头。更多详情，请参见 [录制事件回调](~~55016~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://demo.aliyundoc.com/examplecallback.action', + ], + ], + [ + 'name' => 'NeedStatusNotify', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要录制任务状态回调。取值：'."\n" + ."\n" + .'- true：是。如果NeedStatusNotify（是否需要录制任务状态回调）选择为**true**，则返回结果为录制状态回调示例。'."\n" + .'- false（默认值）：否。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'OnDemandUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '按需录制回调URL地址。'."\n" + ."\n" + .'> 必须以`http://`或者`https://`开头。更多详情，请参见[按需录制回调文档](~~85910~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://learn.aliyundoc.com/ondemandcallback.action', + ], + ], + [ + 'name' => 'NotifyReqAuth', + 'in' => 'query', + 'schema' => [ + 'description' => '回调鉴权开关。取值：'."\n" + ."\n" + .'- **yes**：开启。'."\n" + ."\n" + .'- **no**（默认）：关闭。'."\n" + ."\n" + .'>当填yes时NotifyAuthKey必填。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'yes', + 'default' => 'false', + ], + ], + [ + 'name' => 'NotifyAuthKey', + 'in' => 'query', + 'schema' => [ + 'description' => '回调鉴权密钥，长度为16~32个字符，只允许填大小写字母和数字。'."\n" + .'>当NotifyReqAuth参数值为**yes**时该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'chenhuanxin249088', + 'maxLength' => 64, + 'minLength' => 16, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidNotifyUrl.Malformed', + 'errorMessage' => 'Specified NotifyUrl is invalid.', + ], + [ + 'errorCode' => 'InvalidNotifyUrl.Unsafe', + 'errorMessage' => 'Specified NotifyUrl is not safe.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + [ + 'errorCode' => 'InvalidOnDemandUrl.Malformed', + 'errorMessage' => 'Specified OnDemandUrl is invalid.', + ], + [ + 'errorCode' => 'InvalidOnDemandUrl.Unsafe', + 'errorMessage' => 'Specified OnDemandUrl is not safe.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<AddLiveRecordNotifyConfigResponse>\\n\\t<RequestId>394966CA-5940-44D7-A1C5-24211C7B07A9</RequestId>\\n</AddLiveRecordNotifyConfigResponse>\\t","errorExample":"{\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}"}]', + 'title' => '添加域名级别录制回调配置', + 'description' => '先查询直播录制回调配置，才能调用本接口添加域名级别录制回调配置。使用API查询直播录制回调配置，请参见[查询直播录制回调配置](~~2847893~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + ."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveRecordNotifyConfig' => [ + 'summary' => '删除域名级别录制回调配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveL04ZVK', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'Ram Permission is forbidden.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidConfig.NotFound', + 'errorMessage' => 'Config does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DeleteLiveRecordNotifyConfigResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteLiveRecordNotifyConfigResponse>\\t","errorExample":"{\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}"}]', + 'title' => '删除直播录制回调配置', + 'description' => '先获取主播流域名，再调用本接口删除域名级别录制回调配置。'."\n" + ."\n\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveRecordNotifyConfig' => [ + 'summary' => '查询域名级别录制回调配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5056369B-D337-499E-B8B7-B761BD37B08A', + ], + 'LiveRecordNotifyConfig' => [ + 'description' => '域名录制回调配置。', + 'type' => 'object', + 'properties' => [ + 'NotifyReqAuth' => [ + 'description' => '回调鉴权开关。取值：'."\n" + ."\n" + .'- **yes**：开启。'."\n" + ."\n" + .'- **no**：关闭。', + 'type' => 'boolean', + 'example' => 'no', + ], + 'NotifyAuthKey' => [ + 'description' => '回调鉴权密钥。', + 'type' => 'string', + 'example' => 'KbT8mN2pQ9rS4vX7wZ1aB3cE5fG6hJ8kL', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'NotifyUrl' => [ + 'description' => '录制回调地址。', + 'type' => 'string', + 'example' => 'http://learn.aliyundoc.com/examplecallback.action', + ], + 'NeedStatusNotify' => [ + 'description' => '是否需要录制任务状态回调。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + .'- **false**（默认值）：否。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'OnDemandUrl' => [ + 'description' => '按需录制回调URL地址。', + 'type' => 'string', + 'example' => 'http://guide.aliyundoc.com/ondemandcallback.action', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidConfig.NotFound', + 'errorMessage' => 'Config does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5056369B-D337-499E-B8B7-B761BD37B08A\\",\\n \\"LiveRecordNotifyConfig\\": {\\n \\"NotifyReqAuth\\": true,\\n \\"NotifyAuthKey\\": \\"KbT8mN2pQ9rS4vX7wZ1aB3cE5fG6hJ8kL\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"NotifyUrl\\": \\"http://learn.aliyundoc.com/examplecallback.action\\",\\n \\"NeedStatusNotify\\": false,\\n \\"OnDemandUrl\\": \\"http://guide.aliyundoc.com/ondemandcallback.action\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveRecordNotifyConfigResponse>\\n<RequestId>5056369B-D337-499E-B8B7-B761BD37B08A</RequestId>\\n<LiveRecordNotifyConfig>\\n <NeedStatusNotify>false</NeedStatusNotify>\\n <OnDemandUrl>http://guide.aliyundoc.com/ondemandcallback.action</OnDemandUrl>\\n <DomainName>example.com</DomainName>\\n <NotifyUrl>http://learn.aliyundoc.com/examplecallback.action</NotifyUrl>\\n</LiveRecordNotifyConfig>\\n</DescribeLiveRecordNotifyConfigResponse>","errorExample":"{\\n \\"LiveRecordNotifyConfig\\":{\\n \\"DomainName\\":\\"xxxx\\",\\n \\"NeedStatusNotify\\":false,\\n \\"NotifyUrl\\":\\"http://xxx\\"\\n },\\n \\"RequestId\\":\\"5056369B-D337-499E-B8B7-B761BD37B08A\\"\\n}"}]', + 'title' => '查询域名级别录制回调配置', + 'description' => '先获取主播流域名，再调用本接口查询域名级别录制回调配置。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateLiveRecordNotifyConfig' => [ + 'summary' => '更新域名级别录制回调配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107282', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'NotifyUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '录制回调（包括事件回调和状态回调）URL地址。'."\n" + ."\n" + .'> - 必须以`http://`或`https://`开头。'."\n" + .'>- 为了正常识别输入的汉字、空格以及其他特殊字符，需要做URLEncoder编码。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://learn.aliyundoc.com/examplecallback.action', + ], + ], + [ + 'name' => 'OnDemandUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '按需回调URL地址。'."\n" + ."\n" + .'> - 必须以`http://`或`https://`开头。'."\n" + .'>- 为了正常识别输入的汉字、空格以及其他特殊字符，需要做URLEncoder编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://guide.aliyundoc.com/ondemandcallback.action', + ], + ], + [ + 'name' => 'NeedStatusNotify', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要录制任务状态回调。取值：'."\n" + ."\n" + .'- **true**：需要录制任务状态回调。'."\n" + .'- **false**（默认值）：不需要录制任务状态回调。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NotifyReqAuth', + 'in' => 'query', + 'schema' => [ + 'description' => '回调鉴权开关。取值：'."\n" + ."\n" + .'- **yes**：开启。'."\n" + ."\n" + .'- **no**：关闭。'."\n" + ."\n" + .'>默认值为**no**，当填**yes**时NotifyAuthKey必填。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'no', + ], + ], + [ + 'name' => 'NotifyAuthKey', + 'in' => 'query', + 'schema' => [ + 'description' => '回调鉴权密钥，长度为16~32个字符，只允许填大小写字母和数字。'."\n" + .'>当NotifyReqAuth参数值为**yes**时该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'testkeyyourkey12', + 'maxLength' => 64, + 'minLength' => 16, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidNotifyUrl.Malformed', + 'errorMessage' => 'Specified NotifyUrl is invalid.', + ], + [ + 'errorCode' => 'InvalidNotifyUrl.Unsafe', + 'errorMessage' => 'Specified NotifyUrl is not safe.', + ], + [ + 'errorCode' => 'InvalidOnDemandUrl.Malformed', + 'errorMessage' => 'Specified OnDemandUrl is invalid.', + ], + [ + 'errorCode' => 'InvalidOnDemandUrl.Unsafe', + 'errorMessage' => 'Specified OnDemandUrl is not safe.', + ], + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'Specified Domain is invalid.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'Ram Permission is forbidden.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidConfig.NotFound', + 'errorMessage' => 'Config does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<UpdateLiveRecordNotifyConfigResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</UpdateLiveRecordNotifyConfigResponse>\\t\\n","errorExample":"{\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}"}]', + 'title' => '更新域名级别录制回调配置', + 'description' => '更新域名级别录制回调配置时，您可以修改以下内容：'."\n" + .'- 录制回调（包括录制文件生成事件回调、录制任务状态回调）URL地址。更多详情，请参见[录制事件回调](~~55016~~)。'."\n" + .'- 按需录制回调URL地址。更多详情，请参见[按需录制回调](~~85910~~)。'."\n" + .'- 是否需要录制任务状态回调。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveRecordNotifyRecords' => [ + 'summary' => '查询直播录制存储至OSS的回调记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveL04ZVK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。默认20，最大500，取值：1~500之前的任意整数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为1。取值范围为：1~100000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '回调是否成功。'."\n" + .'- success：成功。'."\n" + .'- failed：失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> 支持查询最近7天内的数据。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-02-10T21:03:47Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。结束时间需晚于起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-02-10T21:03:47Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '回调记录。', + 'type' => 'object', + 'properties' => [ + 'CallbackList' => [ + 'description' => '回调记录。', + 'type' => 'array', + 'items' => [ + 'description' => '回调记录。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'Description' => [ + 'description' => '结果描述，为success时成功，失败则返回错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'NotifyContent' => [ + 'description' => '回调的具体内容。', + 'type' => 'string', + 'example' => '7月26日 16:14{"domain":"al.xxxx.com","stream":"livestream01","pull _stream_result":true,"cdn":"al"}', + ], + 'NotifyResult' => [ + 'description' => '回调结果。'."\n" + .'- success：成功。'."\n" + .'- failed：失败。', + 'type' => 'string', + 'example' => 'success', + ], + 'NotifyTime' => [ + 'description' => '回调时间，格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2022-10-19T19:09:28Z', + ], + 'NotifyType' => [ + 'description' => '回调种类。'."\n" + .'- file_created：录制文件创建成功。'."\n" + .'- record_error：录制错误。'."\n" + .'- record_started：录制已经成功开始。'."\n" + .'- record_paused：录制已经成功暂停。'."\n" + .'- record_resumed：录制已经成功恢复继续录制。'."\n" + .'- record_force_transcode_fail：录制任务触发转码失败。'."\n" + .'- transformat_error：直播流内容解析出错。', + 'type' => 'string', + 'example' => 'record_started', + ], + 'NotifyUrl' => [ + 'description' => '录制回调地址。', + 'type' => 'string', + 'example' => 'http://learn.aliyundoc.com/examplecallback.action', + ], + 'NotifyHeader' => [ + 'description' => '回调请求header', + 'type' => 'string', + 'example' => '{'."\n" + .' "Content-Type": ['."\n" + .' "application/json; charset=utf-8"'."\n" + .' ]'."\n" + .'}', + ], + 'StreamName' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'NotifyResponse' => [ + 'description' => '用户端接受回调后返回的响应结果。', + 'type' => 'string', + 'example' => '{"Code":0,"Msg":"Success"}', + ], + ], + ], + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Msg' => [ + 'description' => '提示信息。', + 'type' => 'string', + 'example' => 'ok', + ], + 'PageNum' => [ + 'description' => '分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '180FA0D2-1A02-5158-A36B-115DBF7B218D', + ], + 'TotalNum' => [ + 'description' => '符合条件的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'Invalid JSON', + ], + [ + 'errorCode' => 'MissingParams', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MalformedParams', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CallbackList\\": [\\n {\\n \\"AppName\\": \\"liveApp****\\",\\n \\"Description\\": \\"success\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"NotifyContent\\": \\"7月26日 16:14{\\\\\\"domain\\\\\\":\\\\\\"al.xxxx.com\\\\\\",\\\\\\"stream\\\\\\":\\\\\\"livestream01\\\\\\",\\\\\\"pull _stream_result\\\\\\":true,\\\\\\"cdn\\\\\\":\\\\\\"al\\\\\\"}\\",\\n \\"NotifyResult\\": \\"success\\",\\n \\"NotifyTime\\": \\"2022-10-19T19:09:28Z\\",\\n \\"NotifyType\\": \\"record_started\\",\\n \\"NotifyUrl\\": \\"http://learn.aliyundoc.com/examplecallback.action\\",\\n \\"NotifyHeader\\": \\"{\\\\n \\\\\\"Content-Type\\\\\\": [\\\\n \\\\\\"application/json; charset=utf-8\\\\\\"\\\\n ]\\\\n}\\",\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"NotifyResponse\\": \\"{\\\\\\"Code\\\\\\":0,\\\\\\"Msg\\\\\\":\\\\\\"Success\\\\\\"}\\"\\n }\\n ],\\n \\"Code\\": 0,\\n \\"Msg\\": \\"ok\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"180FA0D2-1A02-5158-A36B-115DBF7B218D\\",\\n \\"TotalNum\\": 20,\\n \\"TotalPage\\": 20\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveRecordNotifyRecordsResponse>\\n <CallbackList>\\n <AppName>liveApp****</AppName>\\n <Description>success</Description>\\n <DomainName>example.com</DomainName>\\n <NotifyContent>7月26日 16:14{\\"domain\\":\\"al.xxxx.com\\",\\"stream\\":\\"livestream01\\",\\"pull _stream_result\\":true,\\"cdn\\":\\"al\\"}</NotifyContent>\\n <NotifyResult>success</NotifyResult>\\n <NotifyTime>2022-10-19T19:09:28Z</NotifyTime>\\n <NotifyType>record_started</NotifyType>\\n <NotifyUrl>http://learn.aliyundoc.com/examplecallback.action</NotifyUrl>\\n <StreamName>liveStream****</StreamName>\\n </CallbackList>\\n <Code>0</Code>\\n <Msg>ok</Msg>\\n <PageNum>1</PageNum>\\n <PageSize>20</PageSize>\\n <RequestId>180FA0D2-1A02-5158-A36B-115DBF7B218D</RequestId>\\n <TotalNum>20</TotalNum>\\n <TotalPage>20</TotalPage>\\n</DescribeLiveRecordNotifyRecordsResponse>","errorExample":""}]', + 'title' => '查询直播录制回调记录', + 'description' => '本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'AddLiveAppSnapshotConfig' => [ + 'summary' => '配置截图信息。输出内容保存到OSS中，重新推流即生效。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveMH1XD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。'."\n" + .'AppName名称与推流地址中的AppName名称对应，模板才能生效。不超过255字符，支持数字、大小写字母、短横线（-）、下划线（_），短横线、下划线不能位于首位。也支持取值为单个星号（*）字符，即可匹配所有AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'TimeInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '截图周期，每个间隔周期截一次图片。单位：秒。取值范围：**5~3600**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '3600', + 'minimum' => '5', + 'example' => '5', + ], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储的Endpoint名称。'."\n" + ."\n" + .'配置完成后，您可以根据配置回调信息，在OSS控制台查找指定的配置内容。OSS Endpoint需要提前创建，创建方法请参考[配置OSS](~~84932~~) 。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-oss-****.aliyuncs.com', + ], + ], + [ + 'name' => 'OssBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储的Bucket名称。'."\n" + ."\n" + .'配置完成后，您可以根据配置回调信息，在OSS控制台查找指定的配置内容。OSS Bucket需要提前创建，创建方法请参考[配置OSS](~~84932~~) 。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveBucket****', + ], + ], + [ + 'name' => 'OverwriteOssObject', + 'in' => 'query', + 'schema' => [ + 'description' => '覆盖截图存储文件名。每次截图都覆盖此文件。'."\n" + ."\n" + .'- 小于256 Byte。'."\n" + .'- 目前仅支持生成JPG图片。'."\n" + .'- 支持变量匹配，包含{AppName}、{StreamName}。', + 'type' => 'string', + 'required' => false, + 'example' => '{AppName}/{StreamName}.jpg', + ], + ], + [ + 'name' => 'SequenceOssObject', + 'in' => 'query', + 'schema' => [ + 'description' => '实时截图存储文件名。'."\n" + ."\n" + .'每次截图都递增存储，调用[DescribeLiveStreamSnapshotInfo](~~2847902~~)接口可以查询某一段时间的截图文件。'."\n" + ."\n" + .'- 小于256 Byte。'."\n" + .'- 目前仅支持生成JPG图片。'."\n" + .'- 支持变量匹配，包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}，其中 {UnixTimestamp}、{Sequence} 必填一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg', + ], + ], + [ + 'name' => 'Callback', + 'in' => 'query', + 'schema' => [ + 'description' => '截图回调地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://learn.aliyundoc.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOverwriteOssObjectOrSequenceOssObject.Malformed', + 'errorMessage' => 'Specified paramters OverwriteOssObject or SequenceOssObject should have one.', + ], + [ + 'errorCode' => 'InvalidOssBucket.Malformed', + 'errorMessage' => 'Specified parameter OssBucket is not valid.', + ], + [ + 'errorCode' => 'InvalidOssEndpoint.Malformed', + 'errorMessage' => 'Specified parameter OssEndpoint is not valid.', + ], + [ + 'errorCode' => 'InvalidOverwriteOssObject.Malformed', + 'errorMessage' => 'Specified parameter OverwriteOssObject is not valid.', + ], + [ + 'errorCode' => 'InvalidSequenceOssObject.Malformed', + 'errorMessage' => 'Specified parameter SequenceOssObject is not valid.', + ], + [ + 'errorCode' => 'InvalidOssBucket.NotFound', + 'errorMessage' => 'The parameter OssBucket does not exist.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<AddLiveAppSnapshotConfigResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</AddLiveAppSnapshotConfigResponse>\\t","errorExample":"{\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}"}]', + 'title' => '添加直播截图配置', + 'description' => '- 请确保在使用该接口前，已充分了解直播截图的收费方式和价格。计费详情，请参见[直播截图费用](~~195286~~)。'."\n" + ."\n" + .'- 视频直播截图功能需要将截图文件存放在Bucket中，因此需要开通OSS服务并且拥有至少一个Bucket用于存储这些截图文件。具体操作请参见[配置OSS](~~84932~~)。'."\n" + ."\n\n" + .'- 直播截图存储在OSS中，会产生存储费用，在OSS中计费详情请参见[存储费用](~~173534~~)。'."\n" + .'- OSS Bucket必须与播流域名的直播中心同地域，不支持跨地域截图。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveAppSnapshotConfig' => [ + 'summary' => '解除直播流下AppName的截图配置，重新推流后生效。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveMH1XD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流应用名称。输入的AppName必须与需要转推的直播流AppName保持一致，方可生效。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":"{\\n\\t\\"RequestId\\": \\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\",\\n\\t\\"HostId\\": \\"live.aliyuncs.com\\",\\n\\t\\"Code\\": \\"InternalError\\",\\n\\t\\"Message\\": \\"The request processing has failed due to some unknown error.\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeleteLiveAppSnapshotConfigResponse>\\r\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\r\\n</DeleteLiveAppSnapshotConfigResponse>\\t","errorExample":""}]', + 'title' => '删除直播截图配置', + 'description' => '调用本接口解除播流下AppName的截图配置，重新推流后才生效。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteSnapshotFiles' => [ + 'summary' => '删除指定截图文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveMH1XD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CreateTimestampList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要删除的截图产生的时间戳列表。', + 'type' => 'array', + 'items' => [ + 'description' => '需要删除的截图产生的毫秒级时间戳。'."\n" + ."\n" + .'通过调用[DescribeLiveStreamSnapshotInfo](~~2847902~~)接口返回的CreateTimestamp参数值即为该参数取值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1653641526637', + ], + 'required' => true, + 'example' => '1653641526637', + 'maxItems' => 200, + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'RemoveFile', + 'in' => 'query', + 'schema' => [ + 'description' => '是否同步删除OSS文件，取值：'."\n" + ."\n" + .'- **true**：同步删除OSS文件。'."\n" + ."\n" + .'- **false**：不同步删除OSS文件。'."\n" + ."\n" + .'> 同步删除OSS文件需要具有OSS文件操作权限。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'FailureCount' => [ + 'description' => '删除截图失败的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90F60327-ABEC-5A93-BF1F-****', + ], + 'SnapshotDeleteInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SnapshotDeleteInfo' => [ + 'description' => '快照删除信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '快照删除信息列表。', + 'type' => 'object', + 'properties' => [ + 'CreateTimestamp' => [ + 'description' => '请求被删除的截图生成毫秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653641526637', + ], + 'Message' => [ + 'description' => '对每个截图的处理结果。取值：'."\n" + ."\n" + .'- **OK**：删除成功。'."\n" + ."\n" + .'- **FileNotFound**：未找到该截图文件。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + ], + 'SuccessCount' => [ + 'description' => '删除截图成功的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'Cannot find task', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParams', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OSSAccessDenied', + 'errorMessage' => 'OSS bucket not authorised', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'Server internal error', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"FailureCount\\": 1,\\n \\"RequestId\\": \\"90F60327-ABEC-5A93-BF1F-****\\",\\n \\"SnapshotDeleteInfoList\\": {\\n \\"SnapshotDeleteInfo\\": [\\n {\\n \\"CreateTimestamp\\": 1653641526637,\\n \\"Message\\": \\"OK\\"\\n }\\n ]\\n },\\n \\"SuccessCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DeleteSnapshotFilesResponse>\\n<FailureCount>1</FailureCount>\\n<SnapshotDeleteInfoList>\\n <SnapshotDeleteInfo>\\n <Message>OK</Message>\\n <CreateTimestamp>1653641526637</CreateTimestamp>\\n </SnapshotDeleteInfo>\\n <SnapshotDeleteInfo>\\n <Message>Not Found</Message>\\n <CreateTimestamp>1656936778524</CreateTimestamp>\\n </SnapshotDeleteInfo>\\n</SnapshotDeleteInfoList>\\n<RequestId>90F60327-ABEC-5A93-BF1F-****</RequestId>\\n<SuccessCount>1</SuccessCount>\\n</DeleteSnapshotFilesResponse>","errorExample":""}]', + 'title' => '删除直播截图文件', + 'description' => '调用本接口仅支持删除一年内的截图文件。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '| HttpCode | 错误码|错误信息| 描述|'."\n" + .'|-------|-------|-------|-------|'."\n" + .'| 400| InvalidParams|invalid JSON| 无法解析请求。|'."\n" + .'| 400| Cannot find task|Stream not found| 请检查截图配置对应的domain app stream和推流情况。|'."\n" + .'| 400| InvalidParams|Invalid request: missing| 缺失必要参数。|'."\n" + .'| 403| OSSAccessDenied|OSS bucket not authorised| 文件对应的OSS bucket未向视频云账号授权。|'."\n" + .'| 500|InternalError|Server internal error| 请检查截图配置对应的domain app stream和推流情况。|', + ], + 'DescribeLiveSnapshotConfig' => [ + 'summary' => '查询播流域名下的截图配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveMH1XD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。取值范围：**5~30**，默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '30', + 'minimum' => '5', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序。取值：'."\n" + ."\n" + .'- **asc**（默认值）：升序。'."\n" + .'- **desc**：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + 'default' => 'asc', + 'enum' => [ + 'asc', + 'desc', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '分页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A3136B58-5876-4168-83CA-B562781981A0', + ], + 'Order' => [ + 'description' => '排序。', + 'type' => 'string', + 'example' => 'asc', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'TotalNum' => [ + 'description' => '符合条件的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'LiveStreamSnapshotConfigList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveStreamSnapshotConfig' => [ + 'description' => '截图配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OverwriteOssObject' => [ + 'description' => '覆盖截图存储文件名。', + 'type' => 'string', + 'example' => '{liveApp****}/{liveStream****}.jpg', + ], + 'TimeInterval' => [ + 'description' => '截图周期。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AppName' => [ + 'description' => '直播流所属的应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'CreateTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2016-05-20T01:33:38Z', + ], + 'OssBucket' => [ + 'description' => 'OSS存储Bucket名称。', + 'type' => 'string', + 'example' => 'liveBucket****', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Callback' => [ + 'description' => '截图回调地址。', + 'type' => 'string', + 'example' => 'https://learn.aliyundoc.com', + ], + 'SequenceOssObject' => [ + 'description' => '实时截图存储文件名。', + 'type' => 'string', + 'example' => 'snapshot/{liveApp****}/{liveStream****}/{UnixTimestamp}.jpg', + ], + 'OssEndpoint' => [ + 'description' => 'OSS存储的Endpoint名称。', + 'type' => 'string', + 'example' => 'cn-oss-****.aliyuncs.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 2,\\n \\"RequestId\\": \\"A3136B58-5876-4168-83CA-B562781981A0\\",\\n \\"Order\\": \\"asc\\",\\n \\"TotalPage\\": 10,\\n \\"PageSize\\": 11,\\n \\"TotalNum\\": 6,\\n \\"LiveStreamSnapshotConfigList\\": {\\n \\"LiveStreamSnapshotConfig\\": [\\n {\\n \\"OverwriteOssObject\\": \\"{liveApp****}/{liveStream****}.jpg\\",\\n \\"TimeInterval\\": 10,\\n \\"AppName\\": \\"liveApp****\\",\\n \\"CreateTime\\": \\"2016-05-20T01:33:38Z\\",\\n \\"OssBucket\\": \\"liveBucket****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"Callback\\": \\"https://learn.aliyundoc.com\\",\\n \\"SequenceOssObject\\": \\"snapshot/{liveApp****}/{liveStream****}/{UnixTimestamp}.jpg\\",\\n \\"OssEndpoint\\": \\"cn-oss-****.aliyuncs.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveSnapshotConfigResponse>\\n<Order>asc</Order>\\n<TotalNum>6</TotalNum>\\n<TotalPage>10</TotalPage>\\n<PageSize>11</PageSize>\\n<PageNum>2</PageNum>\\n<RequestId>A3136B58-5876-4168-83CA-B562781981A0</RequestId>\\n<LiveStreamSnapshotConfigList>\\n <LiveStreamSnapshotConfig>\\n <OverwriteOssObject>{liveApp****}/{liveStream****}.jpg</OverwriteOssObject>\\n <SequenceOssObject>snapshot/{liveApp****}/{liveStream****}/{UnixTimestamp}.jpg</SequenceOssObject>\\n <Callback>https://learn.aliyundoc.com</Callback>\\n <OssEndpoint>cn-oss-****.aliyuncs.com</OssEndpoint>\\n <TimeInterval>10</TimeInterval>\\n <DomainName>example.com</DomainName>\\n <CreateTime>2016-05-20T01:33:38Z</CreateTime>\\n <OssBucket>liveBucket****</OssBucket>\\n <AppName>liveApp****</AppName>\\n </LiveStreamSnapshotConfig>\\n</LiveStreamSnapshotConfigList>\\n</DescribeLiveSnapshotConfigResponse>","errorExample":"{\\n \\"LiveStreamSnapshotConfigList\\":{\\n \\"LiveStreamSnapshotConfig\\":[{\\n \\"AppName\\":\\"xxx\\",\\n \\"CreateTime\\":\\"2016-05-20T01:33:38Z\\",\\n \\"DomainName\\":\\"xxx\\",\\n \\"OssBucket\\":\\"bucket\\",\\n \\"OssEndpoint\\":\\"endpoint\\",\\n \\"OverwriteOssObject\\":\\"object\\",\\n \\"SequenceOssObject\\":\\"object\\",\\n \\"TimeInterval\\":10\\n }]\\n },\\n \\"Order\\":\\"asc\\",\\n \\"PageNum\\":1,\\n \\"PageSize\\":10,\\n \\"RequestId\\":\\"A3136B58-5876-4168-83CA-B562781981A0\\",\\n \\"TotalNum\\":100,\\n \\"TotalPage\\":10\\n}"}]', + 'title' => '查询域名下的截图配置', + 'description' => '先获取主播流域名，再调用本接口查询播流域名下的截图配置。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateLiveAppSnapshotConfig' => [ + 'summary' => '更新直播流下的截图配置。输出内容保存到OSS中，重新推流后生效。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveMH1XD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'TimeInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '截图周期。取值范围：**5~3600**。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '3600', + 'minimum' => '5', + 'example' => '5', + ], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储的Endpoint名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-oss-****.aliyuncs.com', + ], + ], + [ + 'name' => 'OssBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveBucket****', + ], + ], + [ + 'name' => 'OverwriteOssObject', + 'in' => 'query', + 'schema' => [ + 'description' => '覆盖截图存储文件名。每次截图都覆盖此文件。'."\n" + ."\n" + .'- 小于256 Byte。'."\n" + .'- 目前仅支持生成JPG图片。'."\n" + .'- 支持变量匹配，包含 {AppName}、{StreamName}。'."\n" + .'- 传入短划线（-），表示删除此字段。', + 'type' => 'string', + 'required' => false, + 'example' => '{liveApp****}/{liveStream****}.jpg', + ], + ], + [ + 'name' => 'SequenceOssObject', + 'in' => 'query', + 'schema' => [ + 'description' => '实时截图存储文件名。每次截图都递增存储，调用[DescribeLiveStreamSnapshotInfo](~~2847902~~)接口，可以查询某一段时间的文件。'."\n" + ."\n" + .'- 小于256 Byte。'."\n" + .'- 目前仅支持生成JPG图片。'."\n" + .'- 支持变量匹配，包含 {AppName}、{StreamName}、{UnixTimestamp}、{Sequence}，其中 {UnixTimestamp}、{Sequence} 必填一个。'."\n" + .'- 传入短划线（-），表示删除此字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'snapshot/{liveApp****}/{liveStream****}/{UnixTimestamp****}.jpg', + ], + ], + [ + 'name' => 'Callback', + 'in' => 'query', + 'schema' => [ + 'description' => '截图回调地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://learn.aliyundoc.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOverwriteOssObjectOrSequenceOssObject.Malformed', + 'errorMessage' => 'Specified paramters OverwriteOssObject or SequenceOssObject should have one.', + ], + [ + 'errorCode' => 'InvalidOssEndpoint.Malformed', + 'errorMessage' => 'Specified parameter OssEndpoint is not valid.', + ], + [ + 'errorCode' => 'InvalidOssBucket.Malformed', + 'errorMessage' => 'Specified parameter OssBucket is not valid.', + ], + [ + 'errorCode' => 'InvalidOssBucket.NotFound', + 'errorMessage' => 'The parameter OssBucket does not exist.', + ], + [ + 'errorCode' => 'InvalidOverwriteOssObject.Malformed', + 'errorMessage' => 'Specified parameter OverwriteOssObject is not valid.', + ], + [ + 'errorCode' => 'InvalidSequenceOssObject.Malformed', + 'errorMessage' => 'Specified parameter SequenceOssObject is not valid.', + ], + [ + 'errorCode' => 'InvalidConfig.NotFound', + 'errorMessage' => 'The speicified config does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<UpdateLiveAppSnapshotConfigResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</UpdateLiveAppSnapshotConfigResponse>\\t","errorExample":"{\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}"}]', + 'title' => '更新直播截图配置', + 'description' => '调用本接口更新播流下的截图配置。输出内容保存到OSS中，重新推流后生效。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamSnapshotInfo' => [ + 'summary' => '查询某一段时间内截图内容。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveMH1XD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。EndTime和StartTime之间的间隔不能超过**1**天。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '一次调用获取的数量。取值范围：**1~100**， 默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序。取值：'."\n" + ."\n" + .'- **asc**（默认值）：升序。'."\n" + .'- **desc**：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + 'default' => 'asc', + 'enum' => [ + 'asc', + 'desc', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextStartTime' => [ + 'description' => '下一个起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> 当此时间范围内的内容超出了Limit的取值范围，则返回此参数，为下一个文件的创建时间。可以将此时间当做StartTime，重新调用此接口获取下一段内容，不传则表示未超出Limit取值范围。', + 'type' => 'string', + 'example' => '2015-12-01T17:36:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '62136AE6-7793-45ED-B14A-60D19A9486D3', + ], + 'LiveStreamSnapshotInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveStreamSnapshotInfo' => [ + 'description' => '截图内容列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OssObject' => [ + 'description' => 'OSS存储的文件名。', + 'type' => 'string', + 'example' => '{liveApp****}/{liveStream****}.jpg', + ], + 'OssBucket' => [ + 'description' => 'OSS存储Bucket名称。', + 'type' => 'string', + 'example' => 'liveBucket****', + ], + 'CreateTime' => [ + 'description' => '截图产生时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-01T17:36:00Z', + ], + 'OssEndpoint' => [ + 'description' => 'OSS存储的Endpoint名称。', + 'type' => 'string', + 'example' => 'cn-oss-****.aliyuncs.com', + ], + 'IsOverlay' => [ + 'description' => '截图方式。取值：'."\n" + ."\n" + .'- **true**：覆盖截图。'."\n" + ."\n\n" + .'- **false**：序列截图。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CreateTimestamp' => [ + 'description' => '截图文件创建的毫秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653641526637', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidStream.NotFound', + 'errorMessage' => 'Speicified stream does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextStartTime\\": \\"2015-12-01T17:36:00Z\\",\\n \\"RequestId\\": \\"62136AE6-7793-45ED-B14A-60D19A9486D3\\",\\n \\"LiveStreamSnapshotInfoList\\": {\\n \\"LiveStreamSnapshotInfo\\": [\\n {\\n \\"OssObject\\": \\"{liveApp****}/{liveStream****}.jpg\\",\\n \\"OssBucket\\": \\"liveBucket****\\",\\n \\"CreateTime\\": \\"2015-12-01T17:36:00Z\\",\\n \\"OssEndpoint\\": \\"cn-oss-****.aliyuncs.com\\",\\n \\"IsOverlay\\": false,\\n \\"CreateTimestamp\\": 1653641526637\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamSnapshotInfoResponse>\\n <NextStartTime>2015-12-01T17:36:00Z</NextStartTime>\\n <RequestId>62136AE6-7793-45ED-B14A-60D19A9486D3</RequestId>\\n <LiveStreamSnapshotInfoList>\\n <OssObject>{liveApp****}/{liveStream****}.jpg</OssObject>\\n <OssBucket>liveBucket****</OssBucket>\\n <CreateTime>2015-12-01T17:36:00Z</CreateTime>\\n <OssEndpoint>cn-oss-****.aliyuncs.com</OssEndpoint>\\n <IsOverlay>false</IsOverlay>\\n <CreateTimestamp>1653641526637</CreateTimestamp>\\n </LiveStreamSnapshotInfoList>\\n</DescribeLiveStreamSnapshotInfoResponse>","errorExample":""}]', + 'title' => '查询一段时间内截图内容', + 'description' => '调用本接口仅支持查询一年内的截图数据。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveSnapshotNotifyConfig' => [ + 'summary' => '获取截图回调配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveMH1XD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.yourdomain***.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'www.yourdomain***.com', + ], + 'NotifyAuthKey' => [ + 'description' => '回调鉴权密钥。', + 'type' => 'string', + 'example' => 'yourkey', + ], + 'NotifyReqAuth' => [ + 'description' => '回调鉴权开关。取值：'."\n" + ."\n" + .'- **yes**：开启。'."\n" + ."\n" + .'- **no**：关闭。', + 'type' => 'string', + 'example' => 'yes', + ], + 'NotifyUrl' => [ + 'description' => '回调URL', + 'type' => 'string', + 'example' => 'http://callback.yourdomain***.com', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5056369B-D337-499E-B8B7-B761BD37B08A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DomainName\\": \\"www.yourdomain***.com\\",\\n \\"NotifyAuthKey\\": \\"yourkey\\",\\n \\"NotifyReqAuth\\": \\"yes\\",\\n \\"NotifyUrl\\": \\"http://callback.yourdomain***.com\\",\\n \\"RequestId\\": \\"5056369B-D337-499E-B8B7-B761BD37B08A\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveSnapshotNotifyConfigResponse>\\n <NotifyReqAuth>yes</NotifyReqAuth>\\n <RequestId>5056369B-D337-499E-B8B7-B761BD37B08A</RequestId>\\n <NotifyAuthKey>yourkey</NotifyAuthKey>\\n <DomainName>www.yourdomain***.com</DomainName>\\n <NotifyUrl>http://callback.yourdomain***.com</NotifyUrl>\\n</DescribeLiveSnapshotNotifyConfigResponse>","errorExample":""}]', + 'title' => '获取截图回调配置', + 'description' => '本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteLiveSnapshotNotifyConfig' => [ + 'summary' => '删除截图回调配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveMH1XD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.yourdomain***.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '32A96B9A-F203-4EC5-8E43-CB92E68F4I79E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"32A96B9A-F203-4EC5-8E43-CB92E68F4I79E\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveSnapshotNotifyConfigResponse>\\n <RequestId>32A96B9A-F203-4EC5-8E43-CB92E68F4I79E</RequestId>\\n</DeleteLiveSnapshotNotifyConfigResponse>","errorExample":""}]', + 'title' => '删除截图回调配置', + 'description' => '本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'AddLiveSnapshotNotifyConfig' => [ + 'summary' => '添加截图回调配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '160085', + 'abilityTreeNodes' => [ + 'FEATUREliveMH1XD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.yourdomain***.com', + ], + ], + [ + 'name' => 'NotifyUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '回调URL，必须是合法URL，长度不超过500。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://callback.yourdomain***.com', + ], + ], + [ + 'name' => 'NotifyReqAuth', + 'in' => 'query', + 'schema' => [ + 'description' => '回调鉴权开关。取值：'."\n" + ."\n" + .'- **yes**：开启。'."\n" + ."\n" + .'- **no**（默认）：关闭。'."\n" + ."\n" + .'>当填yes时NotifyAuthKey必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'yes', + ], + ], + [ + 'name' => 'NotifyAuthKey', + 'in' => 'query', + 'schema' => [ + 'description' => '回调鉴权密钥，长度为16~32个字符，只允许填大小写字母和数字。'."\n" + .'>当NotifyReqAuth参数值为**yes**时该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourkey', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MalformedParam', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddLiveSnapshotNotifyConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F3EC5</RequestId>\\n</AddLiveSnapshotNotifyConfigResponse>","errorExample":""}]', + 'title' => '添加截图回调配置', + 'description' => '本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateLiveSnapshotNotifyConfig' => [ + 'summary' => '修改截图回调配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveMH1XD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'ww.yourdomain***.com', + ], + ], + [ + 'name' => 'NotifyUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '回调URL，必须是合法URL，长度不超过500。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://callback.yourdomain***.com', + ], + ], + [ + 'name' => 'NotifyReqAuth', + 'in' => 'query', + 'schema' => [ + 'description' => '回调鉴权开关。取值：'."\n" + ."\n" + .'- **yes**：开启。'."\n" + ."\n" + .'- **no**：关闭。'."\n" + ."\n" + .'>默认值为**no**，当填**yes**时NotifyAuthKey必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'yes', + ], + ], + [ + 'name' => 'NotifyAuthKey', + 'in' => 'query', + 'schema' => [ + 'description' => '回调鉴权密钥，长度为16~32个字符，只允许填大小写字母和数字。'."\n" + .'>当NotifyReqAuth参数值为**yes**时该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'testkeyyourkey12', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A3136B58-5876-5A93-83CA-B562781981A0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MalformedParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A3136B58-5876-5A93-83CA-B562781981A0\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveSnapshotNotifyConfigResponse>\\n <RequestId>A3136B58-5876-5A93-83CA-B562781981A0</RequestId>\\n</UpdateLiveSnapshotNotifyConfigResponse>","errorExample":""}]', + 'title' => '修改截图回调配置', + 'description' => '本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'SetSnapshotCallbackAuth' => [ + 'summary' => '设置截图回调鉴权配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveMH1XD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.aliyundoc.com', + ], + ], + [ + 'name' => 'CallbackReqAuth', + 'in' => 'query', + 'schema' => [ + 'description' => '回调鉴权开关。取值：'."\n" + ."\n" + .'- **yes**：开启。'."\n" + ."\n" + .'- **no**：关闭。', + 'type' => 'string', + 'required' => true, + 'example' => 'yes', + ], + ], + [ + 'name' => 'CallbackAuthKey', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义回调鉴权密钥。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourkey', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MalformedParam', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD5\\"\\n}","errorExample":""},{"type":"xml","example":"<SetSnapshotCallbackAuthResponse> \\r\\n<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD5</RequestId>\\r\\n</SetSnapshotCallbackAuthResponse> ","errorExample":""}]', + 'title' => '设置截图回调鉴权配置', + 'description' => '- 设置截图回调鉴权前，需要配置截图回调URL，回调URL配置，请参见[添加直播截图配置](~~2847897~~)。'."\n" + .'- 本接口支持主播流域名配置截图回调鉴权，调用时请保证参数设置符合要求。'."\n" + .'- 直播截图服务支持在HTTP（含HTTPS）回调时增加特定签名头，供回调消息接收服务端进行签名认证，以防止非法或无效请求。更多信息，请参见[截图回调鉴权说明](~~417349~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySnapshotCallbackAuth' => [ + 'summary' => '查询截图回调鉴权配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveMH1XD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.aliyundoc.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD5', + ], + 'CallbackAuthKey' => [ + 'description' => '回调鉴权密钥。', + 'type' => 'string', + 'example' => 'yourkey', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.aliyundoc.com', + ], + 'CallbackReqAuth' => [ + 'description' => '回调鉴权开关。取值：'."\n" + ."\n" + .'- **yes**：开启。'."\n" + ."\n" + .'- **no**：关闭。', + 'type' => 'string', + 'example' => 'yes', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD5\\",\\n \\"CallbackAuthKey\\": \\"yourkey\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"CallbackReqAuth\\": \\"yes\\"\\n}","errorExample":""},{"type":"xml","example":"<QuerySnapshotCallbackAuthResponse> \\n<CallbackAuthKey>yourkey</CallbackAuthKey>\\n<CallbackReqAuth>yes</CallbackReqAuth>\\n<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD5</RequestId>\\n<DomainName>example.aliyundoc.com</DomainName>\\n</QuerySnapshotCallbackAuthResponse>","errorExample":""}]', + 'title' => '查询截图回调鉴权配置', + 'description' => '您已完成配置截图回调鉴权，配置接口请参见[设置截图回调鉴权配置](~~2847907~~)。'."\n" + .'本接口支持查询主播流域名已配置的截图回调鉴权信息，调用时请保证参数设置符合要求。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteSnapshotCallbackAuth' => [ + 'summary' => '删除截图回调鉴权配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveMH1XD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.aliyundoc.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD5\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSnapshotCallbackAuthResponse> \\r\\n<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD5</RequestId>\\r\\n</DeleteSnapshotCallbackAuthResponse>","errorExample":""}]', + 'title' => '删除截图回调鉴权配置', + 'description' => '本接口支持删除主播流域名已配置的截图回调鉴权配置。注意删除配置后重新推流可生效（截图回调不再进行鉴权）。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddLivePackageConfig' => [ + 'summary' => '调用AddLivePackageConfig添加直播封装配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191929', + 'abilityTreeNodes' => [ + 'FEATUREliveJAENGU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播域名（主播放域名）。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'AppName 名称与推流地址中的 AppName 名称对应，模板才能生效。不超过255字符，支持数字、大小写字母、短横线（-）、下划线（_），短横线、下划线不能位于首位。也支持取值为单个星号（*）字符，即可匹配所有AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'AppName', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => 'StreamName 名称与推流地址中的 StreamName 名称对应，模板才能生效。不超过255字符，支持数字、大小写字母、短横线（-）、下划线（_），短横线、下划线不能位于首位。也支持取值为单个星号（*）字符，即可匹配所有StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'StreamName', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => '直播协议与封装格式。取值：'."\n" + ."\n" + .'- **HLS_CMAF**'."\n" + ."\n" + .'- **LLHLS_TS**'."\n" + .'（低延迟）'."\n" + ."\n" + .'- **LLHLS_CMAF**（低延迟）'."\n" + .'- **DASH_CMAF**'."\n" + .'- **HLSDASH_CMAF**', + 'type' => 'string', + 'required' => true, + 'example' => 'HLS_CMAF', + ], + ], + [ + 'name' => 'SegmentNum', + 'in' => 'query', + 'schema' => [ + 'description' => '直播M3U8切片个数。'."\n" + ."\n" + .'- 取值范围：3～10。'."\n" + ."\n" + .'- 默认值：3。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'SegmentDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '切片时长，单位：秒。'."\n" + ."\n" + .'- 如Protocol为HLS_CMAF，取值范围1～10，默认5秒；'."\n" + ."\n" + .'- 如Protocol为LLHLS_*，取值范围1～2，默认1秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'PartDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'Part切片时长，单位：毫秒。'."\n" + ."\n" + .'- SegmentDuration为1s时，取值范围100～500ms，默认350ms。'."\n" + ."\n" + .'- SegmentDuration为2s时，取值范围100～1000ms，默认700ms。'."\n" + ."\n" + .'- 仅当Protocol为LLHLS_*时有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '350', + ], + ], + [ + 'name' => 'IgnoreTranscode', + 'in' => 'query', + 'schema' => [ + 'description' => '是否忽略转码流，取值：'."\n" + ."\n" + .'- **true**（默认值）：忽略。'."\n" + ."\n" + .'- **false**：不忽略。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '05D00B48-DF50-5DC0-A07D-A250DFAE****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => '%s Please check and try again later.', + ], + [ + 'errorCode' => 'InvalidProtocol', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidSegmentNum', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidSegmentDuration', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidPartDuration', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalErr', + 'errorMessage' => '%s, please try again.', + ], + [ + 'errorCode' => 'DomainConfigFailed', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"05D00B48-DF50-5DC0-A07D-A250DFAE****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddLivePackageConfigResponse>\\n <RequestId>05D00B48-DF50-5DC0-A07D-A250DFAE4258</RequestId>\\n</AddLivePackageConfigResponse>","errorExample":""}]', + 'title' => '添加直播封装配置', + 'description' => '- 域名第一次添加封装配置时，会同步下发播放域名加速相关配置，3～5分钟后可生效。'."\n" + ."\n" + .'- 若播放域名对应的区域为海外区域时（新加坡、德国、日本、印尼），可能会存在延迟较大的问题，建议配置完成后请先测试验证是否符合预期。'."\n" + ."\n" + .'- 调用本接口增加直播封装配置，需要重新推流后才生效。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为300次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateLivePackageConfig' => [ + 'summary' => '调用UpdateLivePackageConfig更新直播封装配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveJAENGU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播域名（主播放域名）。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'AppName 名称与推流地址中的 AppName 名称对应，模板才能生效。不超过255字符，支持数字、大小写字母、短横线（-）、下划线（_），短横线、下划线不能位于首位。也支持取值为单个星号（*）字符，即可匹配所有AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'AppName', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => 'StreamName 名称与推流地址中的 StreamName 名称对应，模板才能生效。不超过255字符，支持数字、大小写字母、短横线（-）、下划线（_），短横线、下划线不能位于首位。也支持取值为单个星号（*）字符，即可匹配所有StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'StreamName', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => '直播协议与封装格式。取值：'."\n" + ."\n" + .'- **HLS_CMAF**'."\n" + ."\n" + .'- **LLHLS_TS**'."\n" + .'（低延迟）'."\n" + ."\n" + .'- **LLHLS_CMAF**（低延迟）'."\n" + .'- **DASH_CMAF**'."\n" + .'- **HLSDASH_CMAF**', + 'type' => 'string', + 'required' => true, + 'example' => 'HLS_CMAF', + ], + ], + [ + 'name' => 'SegmentNum', + 'in' => 'query', + 'schema' => [ + 'description' => '直播M3U8切片个数。取值范围：3～10。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'SegmentDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '切片时长，单位：秒。'."\n" + ."\n" + .'- 如Protocol为HLS_CMAF，取值范围1～10s。'."\n" + ."\n" + .'- 如Protocol为LLHLS_*，取值范围1～2s。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '5', + ], + ], + [ + 'name' => 'PartDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'Part切片时长，单位：毫秒。'."\n" + ."\n" + .'> 当Protocol为LLHLS_*时，该参数为必填项。'."\n" + .'- SegmentDuration为1s时，取值范围100～500ms。'."\n" + .'- SegmentDuration为2s时，取值范围100～1000ms。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '350', + ], + ], + [ + 'name' => 'IgnoreTranscode', + 'in' => 'query', + 'schema' => [ + 'description' => '是否忽略转码流，取值：'."\n" + ."\n" + .'- **true**（默认值）：忽略。'."\n" + ."\n" + .'- **false**：不忽略。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidProtocol', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidSegmentNum', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidSegmentDuration', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidPartDuration', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => '%s, please check and try again.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ConfigConflicts', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalErr', + 'errorMessage' => '%s, please try again.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLivePackageConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</UpdateLivePackageConfigResponse>","errorExample":""}]', + 'title' => '更新直播封装配置', + 'description' => '调用本接口更新直播封装配置，重新推流后生效。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为300次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLivePackageConfig' => [ + 'summary' => '查询播流域名下的直播封装配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveJAENGU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播域名（主播放域名）。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'App名，置空表示匹配所有名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'AppName', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名，置空表示匹配所有流名。', + 'type' => 'string', + 'required' => false, + 'example' => 'StreamName', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。默认值：10，取值范围：5~30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '30', + 'minimum' => '5', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序。取值：'."\n" + ."\n" + .'- **asc**（默认值）：升序。'."\n" + ."\n" + .'- **desc**：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + 'default' => 'asc', + 'enum' => [ + 'asc', + 'desc', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '封装配置信息。', + 'type' => 'object', + 'properties' => [ + 'LivePackageConfigList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LivePackageConfig' => [ + 'description' => '封装配置列表', + 'type' => 'array', + 'items' => [ + 'description' => '封装配置列表', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => 'App名。', + 'type' => 'string', + 'example' => 'AppName', + ], + 'DomainName' => [ + 'description' => '直播域名（主播放域名）。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'IgnoreTranscode' => [ + 'description' => '是否忽略转码流，取值：'."\n" + ."\n" + .'- **true**（默认值）：忽略。'."\n" + ."\n" + .'- **false**：不忽略。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PartDuration' => [ + 'description' => 'Part切片时长，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Protocol' => [ + 'description' => '直播协议与封装格式。', + 'type' => 'string', + 'example' => 'HLS_CMAF', + ], + 'SegmentDuration' => [ + 'description' => '切片时长，单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SegmentNum' => [ + 'description' => '直播M3U8切片个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'StreamName' => [ + 'description' => '直播流名。', + 'type' => 'string', + 'example' => 'StreamName', + ], + ], + ], + ], + ], + ], + 'Order' => [ + 'description' => '排序。取值：'."\n" + ."\n" + .'- **asc**（默认值）：升序。'."\n" + ."\n" + .'- **desc**：降序。', + 'type' => 'string', + 'example' => 'asc', + ], + 'PageNum' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1FEDCFD8-4C5D-5CB3-A5A1-0B59E5AE57B0', + ], + 'TotalNum' => [ + 'description' => '总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => '%s Please check and try again later.', + ], + [ + 'errorCode' => 'InvalidProtocol', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidSegmentNum', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidSegmentDuration', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidPartDuration', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalErr', + 'errorMessage' => '%s, please try again.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LivePackageConfigList\\": {\\n \\"LivePackageConfig\\": [\\n {\\n \\"AppName\\": \\"AppName\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"IgnoreTranscode\\": true,\\n \\"PartDuration\\": 0,\\n \\"Protocol\\": \\"HLS_CMAF\\",\\n \\"SegmentDuration\\": 5,\\n \\"SegmentNum\\": 3,\\n \\"StreamName\\": \\"StreamName\\"\\n }\\n ]\\n },\\n \\"Order\\": \\"asc\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"1FEDCFD8-4C5D-5CB3-A5A1-0B59E5AE57B0\\",\\n \\"TotalNum\\": 1,\\n \\"TotalPage\\": 10\\n}","errorExample":""},{"type":"xml","example":"<DescribeLivePackageConfigResponse>\\n <PageNum>1</PageNum>\\n <RequestId>1FEDCFD8-4C5D-5CB3-A5A1-0B59E5AE57B0</RequestId>\\n <Order>asc</Order>\\n <TotalPage>10</TotalPage>\\n <PageSize>10</PageSize>\\n <TotalNum>1</TotalNum>\\n <LivePackageConfigList>\\n <AppName>AppName</AppName>\\n <SegmentNum>3</SegmentNum>\\n <StreamName>StreamName</StreamName>\\n <Protocol>HLS_CMAF</Protocol>\\n <IgnoreTranscode>true</IgnoreTranscode>\\n <PartDuration>0</PartDuration>\\n <SegmentDuration>5</SegmentDuration>\\n <DomainName>example.com</DomainName>\\n </LivePackageConfigList>\\n</DescribeLivePackageConfigResponse>","errorExample":""}]', + 'title' => '查询直播封装配置', + 'description' => '先获取主播流域名，再调用本接口查询播流域名下的直播封装配置。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为300次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteLivePackageConfig' => [ + 'summary' => '删除直播封装配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveJAENGU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播域名（主播放域名）。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'App名，`*`表示匹配所有名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'AppName', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名，`*`表示匹配AppName下所有流。', + 'type' => 'string', + 'required' => true, + 'example' => 'StreamName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '72ABAD7B-B14C-52DE-B6C6-C639FECAF5AD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidProtocol', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidSegmentNum', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidSegmentDuration', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidPartDuration', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => '%s, please check and try again.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalErr', + 'errorMessage' => '%s, please try again.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"72ABAD7B-B14C-52DE-B6C6-C639FECAF5AD\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLivePackageConfigResponse>\\n <RequestId>72ABAD7B-B14C-52DE-B6C6-C639FECAF5AD</RequestId>\\n</DeleteLivePackageConfigResponse>","errorExample":""}]', + 'title' => '删除直播封装配置', + 'description' => '调用本接口删除直播封装配置，重新推流后才生效。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为300次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'AddLiveSnapshotDetectPornConfig' => [ + 'summary' => '可按照域名和App级别配置播流审核服务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveUTGSNT', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。'."\n" + .' '."\n" + .'AppName名称与推流地址中的AppName名称对应，模板才能生效。不超过255字符，支持数字、大小写字母、短横线（-）、下划线（_），短横线、下划线不能位于首位。也支持取值为单个星号（*）字符，即可匹配所有AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储Endpoint名称。'."\n" + ."\n" + .'审核完成后，您可以根据审核回调信息，在OSS控制台查找指定的审核内容。OSS Endpoint需要提前创建，创建方法请参考[配置审核](~~199449~~) 。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-oss-****.aliyuncs.com', + ], + ], + [ + 'name' => 'OssBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储Bucket名称。'."\n" + ."\n" + .'审核完成后，您可以根据审核回调信息，在OSS控制台查找指定的审核内容。OSS Bucket需要提前创建，创建方法请参考[配置审核](~~199449~~) 。', + 'type' => 'string', + 'required' => true, + 'example' => 'livebucket', + ], + ], + [ + 'name' => 'OssObject', + 'in' => 'query', + 'schema' => [ + 'description' => '保存涉黄涉政等违规图片名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'record/{AppName}/{StreamName}/{Sequence}.jpg', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '采样间隔。取值范围：**5~3600**。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '3600', + 'minimum' => '5', + 'example' => '10', + ], + ], + [ + 'name' => 'Scene', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检测场景列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测场景。取值：'."\n" + .'- **porn**（默认值）：鉴黄。'."\n" + .'- **terrorism**：暴恐涉政。'."\n" + .'- **ad**：图文违规。'."\n" + .'- **live**：不良直播场景。'."\n" + .'- **logo**：logo检测。', + 'type' => 'string', + 'required' => false, + 'example' => 'live', + ], + 'required' => false, + 'example' => 'live', + 'maxItems' => 5, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOssEndpoint.Malformed', + 'errorMessage' => 'Specified parameter OssEndpoint is not valid.', + ], + [ + 'errorCode' => 'InvalidOssBucket.Malformed', + 'errorMessage' => 'Specified parameter OssBucket is not valid.', + ], + [ + 'errorCode' => 'InvalidOssObject.Malformed', + 'errorMessage' => 'Specified parameter OssObject is not valid.', + ], + [ + 'errorCode' => 'InvalidOssBucket.NotFound', + 'errorMessage' => 'The parameter OssBucket does not exist.', + ], + [ + 'errorCode' => 'InvalidScenes', + 'errorMessage' => 'Specified parameter Scene is not valid.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<AddLiveSnapshotDetectPornConfigResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</AddLiveSnapshotDetectPornConfigResponse>\\t","errorExample":"{\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}"}]', + 'title' => '按照域名和App级别配置直播流审核服务', + 'description' => '- 直播审核按照域名和App级别对于其中违规敏感内容进行识别审查，并通过回调的方式实时将违规内容通知到用户，用户可以对内容进行复审并进行相应处置。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddLiveDetectNotifyConfig' => [ + 'summary' => '添加直播审核回调通知地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveUTGSNT', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'NotifyUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '发现涉黄、涉政等违规内容的回调地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://demo.aliyundoc.com/examplecallback.action', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidNotifyUrl.Malformed', + 'errorMessage' => 'Specified NotifyUrl is invalid.', + ], + [ + 'errorCode' => 'InvalidNotifyUrl.Unsafe', + 'errorMessage' => 'Specified NotifyUrl is not safe.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'Invalid Params.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InternalError\\",\\n \\"HostId\\":\\"live.aliyuncs.com\\",\\n \\"Message\\":\\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\":\\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<AddLiveDetectNotifyConfigResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</AddLiveDetectNotifyConfigResponse>","errorExample":"{\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}"}]', + 'title' => '添加回调通知URL', + 'description' => '- 直播审核服务会根据回调地址实时将违规内容通知到用户，用户可以对内容进行复审并进行相应处置。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveSnapshotDetectPornConfig' => [ + 'summary' => '查询直播审核配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveUTGSNT', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => ' '."\n" + .'每页大小。默认值：**10**，取值范围：**5~30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '30', + 'minimum' => '5', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '按创建时间排序。取值：'."\n" + ."\n" + .'- **Asc**（默认值）：升序。'."\n" + .'- **Desc**：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'Asc', + 'default' => 'asc', + 'enum' => [ + 'asc', + 'desc', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '分页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'Order' => [ + 'description' => '排序。', + 'type' => 'string', + 'example' => 'Asc', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalNum' => [ + 'description' => '符合条件的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'LiveSnapshotDetectPornConfigList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveSnapshotDetectPornConfig' => [ + 'description' => '审核配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OssObject' => [ + 'description' => 'OSS存储的文件名。', + 'type' => 'string', + 'example' => ' {liveApp****}/{liveStream****}/{Date}/{Hour}/{Minute}_{Second}.jpg', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'Interval' => [ + 'description' => '采样间隔。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'OssBucket' => [ + 'description' => 'OSS存储Bucket名称。', + 'type' => 'string', + 'example' => 'liveBucket****', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'OssEndpoint' => [ + 'description' => 'OSS存储Endpoint名称。', + 'type' => 'string', + 'example' => 'cn-oss-****.aliyuncs.com', + ], + 'Scenes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'scene' => [ + 'description' => '检测场数组', + 'type' => 'array', + 'items' => [ + 'description' => '检测场景。取值：'."\n" + ."\n" + .'- **porn**（默认值）：鉴黄。'."\n" + .'- **terrorism**：暴恐涉政。'."\n" + .'- **ad**：图文违规。'."\n" + .'- **live**：不良直播场景。'."\n" + .'- **logo**：logo检测。', + 'type' => 'string', + 'example' => 'porn', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"Order\\": \\"Asc\\",\\n \\"TotalPage\\": 11,\\n \\"PageSize\\": 2,\\n \\"TotalNum\\": 6,\\n \\"LiveSnapshotDetectPornConfigList\\": {\\n \\"LiveSnapshotDetectPornConfig\\": [\\n {\\n \\"OssObject\\": \\" {liveApp****}/{liveStream****}/{Date}/{Hour}/{Minute}_{Second}.jpg\\",\\n \\"AppName\\": \\"liveApp****\\",\\n \\"Interval\\": 80,\\n \\"OssBucket\\": \\"liveBucket****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"OssEndpoint\\": \\"cn-oss-****.aliyuncs.com\\",\\n \\"Scenes\\": {\\n \\"scene\\": [\\n \\"porn\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveSnapshotDetectPornConfigResponse>\\n <PageNum>1</PageNum>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n <Order>Asc</Order>\\n <TotalPage>11</TotalPage>\\n <PageSize>2</PageSize>\\n <TotalNum>6</TotalNum>\\n <LiveSnapshotDetectPornConfigList>\\n <LiveSnapshotDetectPornConfig>\\n <OssObject> {liveApp****}/{liveStream****}/{Date}/{Hour}/{Minute}_{Second}.jpg</OssObject>\\n <AppName>liveApp****</AppName>\\n <Interval>80</Interval>\\n <OssBucket>liveBucket****</OssBucket>\\n <DomainName>example.com</DomainName>\\n <OssEndpoint>cn-oss-****.aliyuncs.com</OssEndpoint>\\n <Scenes>porn</Scenes>\\n </LiveSnapshotDetectPornConfig>\\n </LiveSnapshotDetectPornConfigList>\\n</DescribeLiveSnapshotDetectPornConfigResponse>","errorExample":""}]', + 'title' => '查询直播审核配置', + 'description' => '- 先获取主播流域名，再调用本接口查询直播审核配置。本接口目前支持的排序方式为升序和降序。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveDetectNotifyConfig' => [ + 'summary' => '查询直播审核回调通知地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveUTGSNT', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E6******', + ], + 'LiveDetectNotifyConfig' => [ + 'description' => '回调配置。', + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'NotifyUrl' => [ + 'description' => '通知回调地址。', + 'type' => 'string', + 'example' => 'http://aliyundoc.com', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidConfig.NotFound', + 'errorMessage' => 'Config does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E6******\\",\\n \\"LiveDetectNotifyConfig\\": {\\n \\"DomainName\\": \\"example.com\\",\\n \\"NotifyUrl\\": \\"http://aliyundoc.com\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDetectNotifyConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n <LiveDetectNotifyConfig>\\n <DomainName>example.com</DomainName>\\n <NotifyUrl>http://aliyundoc.com</NotifyUrl>\\n </LiveDetectNotifyConfig>\\n</DescribeLiveDetectNotifyConfigResponse>","errorExample":""}]', + 'title' => '查询审核回调URL', + 'description' => '- 先获取主播流域名，再调用本接口查询直播审核回调通知地址。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateLiveSnapshotDetectPornConfig' => [ + 'summary' => '更新直播审核配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107283', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属的应用名称。AppName名称与推流地址中的AppName名称对应，模板才能生效。不超过255字符，支持数字、大小写字母、短横线（-）、下划线（_），短横线、下划线不能位于首位。也支持取值为单个星号（*）字符，即可匹配所有AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储Endpoint名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-oss-****.aliyuncs.com', + ], + ], + [ + 'name' => 'OssBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveBucket****', + ], + ], + [ + 'name' => 'OssObject', + 'in' => 'query', + 'schema' => [ + 'description' => '保存涉黄涉政等违规图片名称。', + 'type' => 'string', + 'required' => false, + 'example' => '{liveApp****}/{liveStream****}/{Date}/{Hour}/{Minute}_{Second}.jpg', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '采样间隔。取值范围：**5-3600**。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '3600', + 'minimum' => '5', + 'example' => '5', + ], + ], + [ + 'name' => 'Scene', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检测场景数组', + 'type' => 'array', + 'items' => [ + 'description' => '检测场景。取值：'."\n" + .'- **porn**（默认值）: 鉴黄。'."\n" + .'- **terrorism**：暴恐涉政。'."\n" + .'- **ad**：图文违规。'."\n" + .'- **live**：不良直播场景。'."\n" + .'- **logo**：logo检测。', + 'type' => 'string', + 'required' => false, + 'example' => 'live', + ], + 'required' => false, + 'example' => 'porn', + 'maxItems' => 5, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidOssEndpoint.Malformed', + 'errorMessage' => 'Specified parameter OssEndpoint is not valid.', + ], + [ + 'errorCode' => 'InvalidOssBucket.Malformed', + 'errorMessage' => 'Specified parameter OssBucket is not valid.', + ], + [ + 'errorCode' => 'InvalidOssObject.Malformed', + 'errorMessage' => 'Specified parameter OssObject is not valid.', + ], + [ + 'errorCode' => 'InvalidOssBucket.NotFound', + 'errorMessage' => 'The parameter OssBucket does not exist.', + ], + [ + 'errorCode' => 'InvalidScenes', + 'errorMessage' => 'Specified parameter Scene is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidConfig.NotFound', + 'errorMessage' => 'Config does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveSnapshotDetectPornConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</UpdateLiveSnapshotDetectPornConfigResponse>","errorExample":""}]', + 'title' => '更新直播审核配置', + 'description' => '- 先获取主播流域名，再调用本接口更新直播审核配置。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateLiveDetectNotifyConfig' => [ + 'summary' => '更新直播审核回调通知地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveUTGSNT', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'NotifyUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '发现涉黄等违规内容的回调地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://guide.aliyundoc.com/examplecallback.action', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidNotifyUrl.Malformed', + 'errorMessage' => 'Specified NotifyUrl is invalid.', + ], + [ + 'errorCode' => 'InvalidNotifyUrl.Unsafe', + 'errorMessage' => 'Specified NotifyUrl is not safe.', + ], + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'Invalid Params.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidConfig.NotFound', + 'errorMessage' => 'Config does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveDetectNotifyConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</UpdateLiveDetectNotifyConfigResponse>","errorExample":""}]', + 'title' => '更新直播审核回调配置', + 'description' => '- 先获取主播流域名，再调用本接口更新直播审核回调通知地址。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveSnapshotDetectPornConfig' => [ + 'summary' => '删除直播审核的配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveUTGSNT', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属的应用名称。您可通过[DescribeLiveSnapshotDetectPornConfig](~~2847918~~)接口查询AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E6*******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E6*******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveSnapshotDetectPornConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteLiveSnapshotDetectPornConfigResponse>","errorExample":""}]', + 'title' => '删除直播审核配置', + 'description' => '- 先获取主播流域名，再调用本接口删除直播审核的配置。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveDetectNotifyConfig' => [ + 'summary' => '删除直播审核回调配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveUTGSNT', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveDetectNotifyConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteLiveDetectNotifyConfigResponse>","errorExample":""}]', + 'title' => '删除回调通知URL', + 'description' => '## 使用说明'."\n" + ."\n" + .'- 先获取主播流域名，再调用本接口删除直播审核回调配置。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddLiveAudioAuditConfig' => [ + 'summary' => '添加直播语音审核配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveUTGSNT', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。AppName名称与推流地址中的AppName名称对应，模板才能生效。区分大小写。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。StreamName名称与推流地址中的StreamName名称对应，模板才能生效。区分大小写。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'OssBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储的Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveBucket****', + ], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储的Endpoint名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-oss-****.aliyuncs.com', + ], + ], + [ + 'name' => 'OssObject', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储的录制文件名。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveObject****', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '业务类型。可用于选择模型，默认值为域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.edu', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7BF95F2A-3B24-4CDE-9346-7F6FA86697A1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MalformedParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigExisted', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7BF95F2A-3B24-4CDE-9346-7F6FA86697A1\\"\\n}","errorExample":""},{"type":"xml","example":"<AddLiveAudioAuditConfigResponse>\\n <RequestId>7BF95F2A-3B24-4CDE-9346-7F6FA86697A1</RequestId>\\n</AddLiveAudioAuditConfigResponse>","errorExample":""}]', + 'title' => '添加直播语音审核配置', + 'description' => '- 直播语音审核通过拾取语音流对于其中违规敏感内容进行识别审查，并通过回调的方式实时将违规内容通知到用户，用户可以对内容进行复审并进行相应处置。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n" + .'<props="china"> 请确保在使用该接口前，已充分了解直播语音审核产品的收费方式和价格。详情请参见[智能审核费用](~~195288~~)。</props>'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddLiveAudioAuditNotifyConfig' => [ + 'summary' => '添加音频审核回调信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveUTGSNT', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Callback', + 'in' => 'query', + 'schema' => [ + 'description' => '回调地址。用于接收问题语音内容的回调。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://demo.aliyundoc.com/callback', + ], + ], + [ + 'name' => 'CallbackTemplate', + 'in' => 'query', + 'schema' => [ + 'description' => '审核回调模板。取值：'."\n" + ."\n" + .'- **{DomainName}**：播流域名。'."\n" + .'- **{AppName}**：播流所属的应用名称。'."\n" + .'- **{StreamName}**：播流名称。'."\n" + .'- **{Timestamp}**：Unix时间戳，返回的回调时间。单位：秒。'."\n" + .'- **{Result}**：检测结果。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"domain":{DomainName},"app":{AppName},"stream":{StreamName},"timestamp":{Timestamp},"result":{Result}}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7BF95F2A-3B24-4CDE-9346-7F6FA86697A1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MalformedParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigExisted', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'UnsafeCallback', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7BF95F2A-3B24-4CDE-9346-7F6FA86697A1\\"\\n}","errorExample":""},{"type":"xml","example":"<AddLiveAudioAuditNotifyConfigResponse>\\n <RequestId>7BF95F2A-3B24-4CDE-9346-7F6FA86697A1</RequestId>\\n</AddLiveAudioAuditNotifyConfigResponse>","errorExample":""}]', + 'title' => '添加音频审核回调信息', + 'description' => '- 直播语音审核服务会根据回调模板的配置来返回检测结果。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + ."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '## 检测结果格式'."\n" + ."\n" + .'Result示例：'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' {'."\n" + .' "scene": "antispam",'."\n" + .' "label": "ad",'."\n" + .' "suggestion": "block",'."\n" + .' "rate": 99.91,'."\n" + .' "details": ['."\n" + .' {'."\n" + .' "startTime": 1571989513,'."\n" + .' "endTime": 1571989515,'."\n" + .' "text": "三楼香巴拉队主携手5楼了。",'."\n" + .' "label": "normal"'."\n" + .' },'."\n" + .' {'."\n" + .' "startTime": 1571989515,'."\n" + .' "endTime": 1571989518,'."\n" + .' "text": "上，烤鱼火锅节日期两个腾庆大款。",'."\n" + .' "label": "normal"'."\n" + .' },'."\n" + .' {'."\n" + .' "startTime": 1571989520,'."\n" + .' "endTime": 1571989522,'."\n" + .' "text": "多少香巴拉会员均享39",'."\n" + .' "label": "normal"'."\n" + .' },'."\n" + .' {'."\n" + .' "startTime": 1571989523,'."\n" + .' "endTime": 1571989526,'."\n" + .' "text": "皇上现金单次消费立减66元。",'."\n" + .' "label": "normal"'."\n" + .' },'."\n" + .' {'."\n" + .' "startTime": 1571989530,'."\n" + .' "endTime": 1571989533,'."\n" + .' "text": "元大奖详询3398787",'."\n" + .' "label": "ad"'."\n" + .' },'."\n" + .' {'."\n" + .' "startTime": 1571989533,'."\n" + .' "endTime": 1571989534,'."\n" + .' "text": "好消息，好像。",'."\n" + .' "label": "normal"'."\n" + .' },'."\n" + .' {'."\n" + .' "startTime": 1571989538,'."\n" + .' "endTime": 1571989539,'."\n" + .' "text": "携带行车证4人。",'."\n" + .' "label": "normal"'."\n" + .' },'."\n" + .' {'."\n" + .' "startTime": 1571989542,'."\n" + .' "endTime": 1571989543,'."\n" + .' "text": "代理现在还有10分钟。",'."\n" + .' "label": "normal"'."\n" + .' },'."\n" + .' {'."\n" + .' "startTime": 1571989545,'."\n" + .' "endTime": 1571989547,'."\n" + .' "text": "建行etc见证没",'."\n" + .' "label": "normal"'."\n" + .' },'."\n" + .' {'."\n" + .' "startTime": 1571989550,'."\n" + .' "endTime": 1571989552,'."\n" + .' "text": "赵信元、吕梁市国投集团旗下。",'."\n" + .' "label": "normal"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .']'."\n" + ."\n" + .'```'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveAudioAuditConfig' => [ + 'summary' => '删除直播语音审核配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveUTGSNT', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属的应用名称。'."\n" + ."\n" + .'> AppName取值为星号（*）时，代表该域名下所有的AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。'."\n" + ."\n" + .'> StreamName取值为星号（*）时，代表该App下所有的StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MalformedParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigExisted', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveAudioAuditConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteLiveAudioAuditConfigResponse>","errorExample":""}]', + 'title' => '删除直播语音审核配置', + 'description' => '- 先获取主播流域名，再调用本接口删除直播语音审核配置信息。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveAudioAuditNotifyConfig' => [ + 'summary' => '删除直播语音审核回调配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106923', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + 'FEATUREliveUTGSNT', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7BF95F2A-3B24-4CDE-9346-7F6FA86697A1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MalformedParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigExisted', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7BF95F2A-3B24-4CDE-9346-7F6FA86697A1\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveAudioAuditNotifyConfigResponse>\\n <RequestId>7BF95F2A-3B24-4CDE-9346-7F6FA86697A1</RequestId>\\n</DeleteLiveAudioAuditNotifyConfigResponse>","errorExample":""}]', + 'title' => '删除直播语音审核回调配置', + 'description' => '- 先获取主播流域名，再调用本接口删除直播语音审核回调配置信息。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateLiveAudioAuditNotifyConfig' => [ + 'summary' => '更新直播语音审核回调配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveUTGSNT', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Callback', + 'in' => 'query', + 'schema' => [ + 'description' => '回调地址。用于接收问题语音内容的回调', + 'type' => 'string', + 'required' => false, + 'example' => 'http://guide.aliyundoc.com/callback', + ], + ], + [ + 'name' => 'CallbackTemplate', + 'in' => 'query', + 'schema' => [ + 'description' => '审核回调模板。取值：'."\n" + ."\n" + .'- **{DomainName}**：播流域名。'."\n" + .'- **{AppName}**：播流所属应用名称。'."\n" + .'- **{StreamName}**：播流名称。'."\n" + .'- **{Timestamp}**：Unix时间戳，返回回调时间。单位：秒。'."\n" + .'- **{Result}**：检测结果。', + 'type' => 'string', + 'required' => false, + 'example' => '{"domain":{DomainName},"app":{AppName},"stream":{StreamName},"timestamp":{Timestamp},"result":{Result}}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7BF95F2A-3B24-4CDE-9346-7F6FA86697A1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MalformedParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigExisted', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'UnsafeCallback', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7BF95F2A-3B24-4CDE-9346-7F6FA86697A1\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveAudioAuditNotifyConfigResponse>\\n <RequestId>7BF95F2A-3B24-4CDE-9346-7F6FA86697A1</RequestId>\\n</UpdateLiveAudioAuditNotifyConfigResponse>","errorExample":""}]', + 'title' => '更新直播语音审核回调配置', + 'description' => '- 先获取主播流域名，再调用本接口更新直播语音审核回调配置信息。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateLiveAudioAuditConfig' => [ + 'summary' => '更新直播语音审核配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveUTGSNT', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属的应用名称。AppName名称与推流地址中的AppName名称对应，模板才能生效。区分大小写。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。StreamName名称与推流地址中的StreamName名称对应，模板才能生效。区分大小写。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'OssBucket', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveBucket****', + ], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储Endpoint名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-oss-****.aliyuncs.com', + ], + ], + [ + 'name' => 'OssObject', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储的录制文件名。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveObject****', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '业务类型。可用于选择模型，默认值为域名。', + 'type' => 'string', + 'required' => false, + 'example' => ' example.edu', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7BF95F2A-3B24-4CDE-9346-7F6FA86697A1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MalformedParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigExisted', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7BF95F2A-3B24-4CDE-9346-7F6FA86697A1\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveAudioAuditConfigResponse>\\n <RequestId>7BF95F2A-3B24-4CDE-9346-7F6FA86697A1</RequestId>\\n</UpdateLiveAudioAuditConfigResponse>","errorExample":""}]', + 'title' => '更新直播语音审核配置', + 'description' => '- 先获取主播流域名，再调用本接口更新直播语音审核配置。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveAudioAuditConfig' => [ + 'summary' => '查询直播语音审核配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveUTGSNT', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属的应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7BF95F2A-3B24-4CDE-9346-7F6FA86697A1', + ], + 'LiveAudioAuditConfigList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveAudioAuditConfig' => [ + 'description' => '直播语音审核配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '播流所属的应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'StreamName' => [ + 'description' => '流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'BizType' => [ + 'description' => '业务类型。可用于选择模型，默认值为域名。', + 'type' => 'string', + 'example' => 'example.edu', + ], + 'Scenes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'scene' => [ + 'description' => '检测场景。', + 'type' => 'array', + 'items' => [ + 'description' => '检测场景。', + 'type' => 'string', + 'example' => 'antispam', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MalformedParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigExisted', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7BF95F2A-3B24-4CDE-9346-7F6FA86697A1\\",\\n \\"LiveAudioAuditConfigList\\": {\\n \\"LiveAudioAuditConfig\\": [\\n {\\n \\"AppName\\": \\"liveApp****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"BizType\\": \\"example.edu\\",\\n \\"Scenes\\": {\\n \\"scene\\": [\\n \\"antispam\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveAudioAuditConfigResponse>\\n <RequestId>7BF95F2A-3B24-4CDE-9346-7F6FA86697A1</RequestId>\\n <LiveAudioAuditConfigList>\\n <AppName>liveApp****</AppName>\\n <DomainName>example.com</DomainName>\\n <StreamName>liveStream****</StreamName>\\n <BizType>example.edu</BizType>\\n <Scenes>[\\"antispam\\"]</Scenes>\\n </LiveAudioAuditConfigList>\\n</DescribeLiveAudioAuditConfigResponse>","errorExample":""}]', + 'title' => '查询直播语音审核配置', + 'description' => '- 先获取主播流域名，调用本接口查询直播语音审核配置。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveAudioAuditNotifyConfig' => [ + 'summary' => '查询直播语音审核回调配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveUTGSNT', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B908FF89-B03C-4831-B55B-48D2A******', + ], + 'LiveAudioAuditNotifyConfigList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveAudioAuditNotifyConfig' => [ + 'description' => '直播语音审核回调配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CallbackTemplate' => [ + 'description' => '审核回调模板。取值：'."\n" + ."\n" + .'- **{DomainName}**：播流域名。'."\n" + .'- **{AppName}**：播流所属应用名称。'."\n" + .'- **{StreamName}**：播流名称。'."\n" + .'- **{Timestamp}**：Unix时间戳，返回回调时间。单位：秒。'."\n" + .'- **{Result}**：检测结果。', + 'type' => 'string', + 'example' => '{\\"domain\\":{DomainName},\\"app\\":{AppName},\\"stream\\":{StreamName},\\"timestamp\\":{Timestamp},\\"result\\":{Result}}', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Callback' => [ + 'description' => '回调地址。', + 'type' => 'string', + 'example' => 'http://guide.aliyundoc.com/callback', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MalformedParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigExisted', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B908FF89-B03C-4831-B55B-48D2A******\\",\\n \\"LiveAudioAuditNotifyConfigList\\": {\\n \\"LiveAudioAuditNotifyConfig\\": [\\n {\\n \\"CallbackTemplate\\": \\"{\\\\\\\\\\\\\\"domain\\\\\\\\\\\\\\":{DomainName},\\\\\\\\\\\\\\"app\\\\\\\\\\\\\\":{AppName},\\\\\\\\\\\\\\"stream\\\\\\\\\\\\\\":{StreamName},\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":{Timestamp},\\\\\\\\\\\\\\"result\\\\\\\\\\\\\\":{Result}}\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"Callback\\": \\"http://guide.aliyundoc.com/callback\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveAudioAuditNotifyConfigResponse>\\n <RequestId>B908FF89-B03C-4831-B55B-48D2A7DA0A68</RequestId>\\n <LiveAudioAuditNotifyConfigList>\\n <LiveAudioAuditNotifyConfig>\\n <CallbackTemplate>{\\\\\\"domain\\\\\\":{DomainName},\\\\\\"app\\\\\\":{AppName},\\\\\\"stream\\\\\\":{StreamName},\\\\\\"timestamp\\\\\\":{Timestamp},\\\\\\"result\\\\\\":{Result}}</CallbackTemplate>\\n <DomainName>example.com</DomainName>\\n <Callback>http://guide.aliyundoc.com/callback</Callback>\\n </LiveAudioAuditNotifyConfig>\\n </LiveAudioAuditNotifyConfigList>\\n</DescribeLiveAudioAuditNotifyConfigResponse>","errorExample":""}]', + 'title' => '查询直播语音审核回调配置', + 'description' => '- 先获取主播流域名，再调用本接口查询直播语音审核回调配置。'."\n" + ."\n" + .'- 目前仅部分直播中心支持直播智能审核，具体支持该功能的直播中心，请参见[服务地域](~~193730~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateLivePrivateLine' => [ + 'summary' => '创建全球加速实例并绑定到直播链路。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'live', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testStream', + ], + ], + [ + 'name' => 'VideoCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '直播中心，取值：cn-beijing、cn-shanghai、cn-shenzhen、cn-qingdao、ap-northeast-1、ap-southeast-5、eu-central-1、ap-southeast-1、ap-south-1，分别表示位于北京、上海、深圳、青岛、日本、印尼、德国、新加坡的直播中心。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'AccelerationType', + 'in' => 'query', + 'schema' => [ + 'description' => '加速类型，取值：'."\n" + ."\n" + .'- play：播流加速。'."\n" + .'- publish：推流加速。', + 'type' => 'string', + 'required' => true, + 'example' => 'play', + 'enum' => [ + 'play', + 'publish', + ], + ], + ], + [ + 'name' => 'AccelerationArea', + 'in' => 'query', + 'schema' => [ + 'description' => '加速通道。', + 'type' => 'string', + 'required' => true, + 'example' => 'ap-southeast-1', + ], + ], + [ + 'name' => 'Reuse', + 'in' => 'query', + 'schema' => [ + 'description' => '是否复用已有加速通道，取值：'."\n" + .'- yes：复用已有加速通道。'."\n" + .'- no：新建加速通道。', + 'type' => 'string', + 'required' => true, + 'example' => 'no', + 'enum' => [ + 'yes', + 'no', + ], + ], + ], + [ + 'name' => 'MaxBandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => '加速带宽，单位：Mbps。当Reuse为no时必填。', + 'type' => 'string', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '复用的加速通道。当Reuse为yes时必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp1iovsdpf01ym9su****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7908F2FF-44F8-120F-9FD6-85AE4B6C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + [ + 'errorCode' => 'NoSpecialConfiguration', + 'errorMessage' => 'no special configuration for acceleration_area.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + [ + 'errorCode' => 'HasNoPermission', + 'errorMessage' => 'You do not have permission to create accelerator.', + ], + [ + 'errorCode' => 'PostPayNotOpen', + 'errorMessage' => 'The Accelerator PostPay service is not open.', + ], + [ + 'errorCode' => 'TryAgain', + 'errorMessage' => 'Create SLR first and please try again.', + ], + [ + 'errorCode' => 'HasNoPermisionToCreateSLR', + 'errorMessage' => 'You do not have ram:CreateServiceLinkedRole to create SLR.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7908F2FF-44F8-120F-9FD6-85AE4B6C****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateLivePrivateLineResponse>\\n <RequestId>7908F2FF-44F8-120F-9FD6-85AE4B6C19EC</RequestId>\\n</CreateLivePrivateLineResponse>","errorExample":""}]', + 'title' => '创建全球加速实例并绑定到直播链路', + 'description' => '- 本接口用于创建全球加速实例并绑定到直播链路，需要精确到流粒度，并指明加速的起点和终点。'."\n" + ."\n" + .'- AppName与StreamName的名称与播流地址中的AppName与StreamName的名称对应模板才能生效。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteLivePrivateLine' => [ + 'summary' => '解绑全球加速实例与直播链路。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'live', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testStream', + ], + ], + [ + 'name' => 'AccelerationType', + 'in' => 'query', + 'schema' => [ + 'description' => '加速类型，取值：'."\n" + .'- play：播流加速。'."\n" + .'- publish：推流加速。', + 'type' => 'string', + 'required' => true, + 'example' => 'play', + 'enum' => [ + 'play', + 'publish', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7908F2FF-44F8-120F-9FD6-85AE4******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7908F2FF-44F8-120F-9FD6-85AE4******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLivePrivateLineResponse>\\n <RequestId>7908F2FF-44F8-120F-9FD6-85AE4B6C19EC</RequestId>\\n</DeleteLivePrivateLineResponse>","errorExample":""}]', + 'title' => '删除全球加速实例和直播链路的绑定关系', + 'description' => '解绑后，您的直播推拉流链路不再借助GA回源。解绑后加速实例仍然存在，如需释放加速实例需要在全球加速控制台上进行删除。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLivePrivateLineAreas' => [ + 'summary' => '查询可选的全球加速链路起点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'LiveAreasList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveArea' => [ + 'description' => '区域详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '区域详情。', + 'type' => 'object', + 'properties' => [ + 'RegionType' => [ + 'description' => '区域类型，取值：'."\n" + .'- domestic：中国大陆。'."\n" + .'- overseas：除中国大陆以外的国家和地区。', + 'type' => 'string', + 'example' => 'domestic', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => '区域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '区域信息。', + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => '区域名。', + 'type' => 'string', + 'example' => '深圳', + ], + 'RegionId' => [ + 'description' => '区域ID。', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C4865B85-664B-19D3-BB16-C62FB83C8226', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LiveAreasList\\": {\\n \\"LiveArea\\": [\\n {\\n \\"RegionType\\": \\"domestic\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"LocalName\\": \\"深圳\\",\\n \\"RegionId\\": \\"cn-shenzhen\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"C4865B85-664B-19D3-BB16-C62FB83C8226\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLivePrivateLineAreasResponse>\\n <RequestId>C4865B85-664B-19D3-BB16-C62FB83C8226</RequestId>\\n <LiveAreasList>\\n <LiveArea>\\n <RegionType>domestic</RegionType>\\n <Regions>\\n <Region>\\n <LocalName>深圳</LocalName>\\n <RegionId>cn-shenzhen</RegionId>\\n </Region>\\n </Regions>\\n </LiveArea>\\n <LiveArea>\\n <RegionType>overseas</RegionType>\\n <Regions>\\n <Region>\\n <LocalName>新加坡</LocalName>\\n <RegionId>ap-southeast-1</RegionId>\\n </Region>\\n </Regions>\\n </LiveArea>\\n </LiveAreasList>\\n</DescribeLivePrivateLineAreasResponse>","errorExample":""}]', + 'title' => '查询可选的全球加速链路起点', + 'description' => '在调用CreateLivePrivateLine前，您可以调用该接口查询可选的全球加速区域，即加速链路起点。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'extraInfo' => '### 特殊错误码'."\n" + .'| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" + .'| ----- | --------- | ----------- | ------- |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名。 |'."\n" + .'| InvalidParam | Parameter invalid. | 400 | 参数错误。 |'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |', + ], + 'DescribeLivePrivateLineAvailGA' => [ + 'summary' => '查询全球加速实例和直播链路的绑定信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'live', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testStream', + ], + ], + [ + 'name' => 'AccelerationArea', + 'in' => 'query', + 'schema' => [ + 'description' => '加速通道。', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-southeast-1', + ], + ], + [ + 'name' => 'VideoCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '直播中心，取值：cn-beijing、cn-shanghai、cn-shenzhen、cn-qingdao、ap-northeast-1、ap-southeast-5、eu-central-1、ap-southeast-1、ap-south-1，分别表示位于北京、上海、深圳、青岛、日本、印尼、德国、新加坡的直播中心。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'IsGaInstance', + 'in' => 'query', + 'schema' => [ + 'description' => '查询全球加速实例，取值：'."\n" + .'- yes：查询全球加速实例状态。'."\n" + .'- no：查询全球加速实例和直播链路的绑定详情。', + 'type' => 'string', + 'required' => true, + 'example' => 'no', + 'enum' => [ + 'yes', + 'no', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'LivePrivateLineAvailGAs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LivePrivateLineAvailGA' => [ + 'description' => '全球加速实例配置详情。', + 'type' => 'array', + 'items' => [ + 'description' => '全球加速实例配置详情。', + 'type' => 'object', + 'properties' => [ + 'AccelerationArea' => [ + 'description' => '加速通道。', + 'type' => 'string', + 'example' => 'ap-southeast-1', + ], + 'AccelerationType' => [ + 'description' => '加速类型，取值：'."\n" + .'- play：播流加速。'."\n" + .'- publish：推流加速。', + 'type' => 'string', + 'example' => 'play', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'live', + ], + 'BindingStatus' => [ + 'description' => '是否绑定到直播链路，取值：'."\n" + .'- yes：已绑定。'."\n" + .'- no：未绑定。', + 'type' => 'string', + 'example' => 'yes', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'demo.aliyundoc.com', + ], + 'IP' => [ + 'description' => '加速IP地址。', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'InstanceId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1iovsdpf01ym9su****', + ], + 'Status' => [ + 'description' => '实例状态，取值：'."\n" + .'- active：可用。'."\n" + .'- inactive：不可用。', + 'type' => 'string', + 'example' => 'active', + ], + 'StreamName' => [ + 'description' => '直播流名称。', + 'type' => 'string', + 'example' => 'testStream', + ], + 'Uid' => [ + 'description' => 'UID。', + 'type' => 'string', + 'example' => '1833220971116****', + ], + 'VideoCenter' => [ + 'description' => '直播中心。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C4865B85-664B-19D3-BB16-C62FB83C8226', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LivePrivateLineAvailGAs\\": {\\n \\"LivePrivateLineAvailGA\\": [\\n {\\n \\"AccelerationArea\\": \\"ap-southeast-1\\",\\n \\"AccelerationType\\": \\"play\\",\\n \\"AppName\\": \\"live\\",\\n \\"BindingStatus\\": \\"yes\\",\\n \\"DomainName\\": \\"demo.aliyundoc.com\\",\\n \\"IP\\": \\"127.0.0.1\\",\\n \\"InstanceId\\": \\"ga-bp1iovsdpf01ym9su****\\",\\n \\"Status\\": \\"active\\",\\n \\"StreamName\\": \\"testStream\\",\\n \\"Uid\\": \\"1833220971116****\\",\\n \\"VideoCenter\\": \\"cn-shanghai\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"C4865B85-664B-19D3-BB16-C62FB83C8226\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLivePrivateLineAvailGAResponse>\\n <RequestId>C4865B85-664B-19D3-BB16-C62FB83C8226</RequestId>\\n <LivePrivateLineAvailGAs>\\n <LivePrivateLineAvailGA>\\n <DomainName>xxx.example1.com</DomainName>\\n <AppName>test</AppName>\\n <StreamName>test</StreamName>\\n <InstanceId>ga-bp1iovsdpf01ym9sulesm</InstanceId>\\n <Uid>18332209711160785</Uid>\\n <IP>127.0.0.1</IP>\\n <VideoCenter>cn-shanghai</VideoCenter>\\n <AccelerationArea>ap-southeast-1</AccelerationArea>\\n <Status>active</Status>\\n <AccelerationType>play</AccelerationType>\\n <BindingStatus>yes</BindingStatus>\\n </LivePrivateLineAvailGA>\\n </LivePrivateLineAvailGAs>\\n</DescribeLivePrivateLineAvailGAResponse>","errorExample":""}]', + 'title' => '查询全球加速配置', + 'description' => '请求参数IsGaInstance为yes时，表示查询全球加速实例状态，为no时，表示查询全球加速实例和直播链路的绑定详情。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'extraInfo' => '### 特殊错误码'."\n" + .'| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" + .'| ----- | --------- | ----------- | ------- |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名。 |'."\n" + .'| InvalidParam | Parameter invalid. | 400 | 参数错误。 |'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |'."\n", + ], + 'DescribeLiveStreamDelayConfig' => [ + 'summary' => '调用DescribeLiveStreamDelayConfig查询直播延迟时间。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '您的播放域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '785C9CB0-EB8A-4912-BBF2-966BEFD32DC3', + ], + 'LiveStreamHlsDelayConfig' => [ + 'description' => 'HLS延迟。', + 'type' => 'object', + 'properties' => [ + 'Delay' => [ + 'description' => '播放延迟时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Level' => [ + 'description' => '延迟级别。取值：'."\n" + ."\n" + .'- **short**：Delay小于等于2秒。'."\n" + ."\n" + .'- **medium**：Delay大于2秒，且小于等于4秒。'."\n" + ."\n" + .'- **long**：Delay大于4秒。', + 'type' => 'string', + 'example' => 'short', + ], + ], + ], + 'LiveStreamFlvDelayConfig' => [ + 'description' => 'FLV延迟。', + 'type' => 'object', + 'properties' => [ + 'Delay' => [ + 'description' => '播放延迟时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Level' => [ + 'description' => '延迟级别。取值：'."\n" + ."\n" + .'- **short**：Delay小于等于2秒。'."\n" + ."\n" + .'- **medium**：Delay大于2秒，且小于等于4秒。'."\n" + ."\n" + .'- **long**：Delay大于4秒。', + 'type' => 'string', + 'example' => 'medium', + ], + ], + ], + 'LiveStreamRtmpDelayConfig' => [ + 'description' => 'RTMP延迟。', + 'type' => 'object', + 'properties' => [ + 'Delay' => [ + 'description' => '播放延迟时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'Level' => [ + 'description' => '延迟级别。取值：'."\n" + ."\n" + .'- **short**：Delay小于等于2秒。'."\n" + ."\n" + .'- **medium**：Delay大于2秒，且小于等于4秒。'."\n" + ."\n" + .'- **long**：Delay大于4秒。', + 'type' => 'string', + 'example' => 'short', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"785C9CB0-EB8A-4912-BBF2-966BEFD32DC3\\",\\n \\"LiveStreamHlsDelayConfig\\": {\\n \\"Delay\\": 3,\\n \\"Level\\": \\"short\\"\\n },\\n \\"LiveStreamFlvDelayConfig\\": {\\n \\"Delay\\": 5,\\n \\"Level\\": \\"medium\\"\\n },\\n \\"LiveStreamRtmpDelayConfig\\": {\\n \\"Delay\\": 4,\\n \\"Level\\": \\"short\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamDelayConfigResponse>\\n <RequestId>785C9CB0-EB8A-4912-BBF2-966BEFD32DC3</RequestId>\\n <LiveStreamHlsDelayConfig>\\n <Delay>3</Delay>\\n <Level>short</Level>\\n </LiveStreamHlsDelayConfig>\\n <LiveStreamRtmpDelayConfig>\\n <Delay>4</Delay>\\n <Level>short</Level>\\n </LiveStreamRtmpDelayConfig>\\n <LiveStreamFlvDelayConfig>\\n <Delay>5</Delay>\\n <Level>medium</Level>\\n </LiveStreamFlvDelayConfig>\\n</DescribeLiveStreamDelayConfigResponse>","errorExample":""}]', + 'title' => '查询直播延迟时间', + 'description' => '先获取播流域名，再调用本接口查询直播延迟时间。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'extraInfo' => '| HttpCode | 错误码|错误信息| 描述|'."\n" + .'|---------------|--------|'."\n" + .'| 500| Internal|The request processing has failed due to some unknown error.| 后台发生未知错误。|'."\n" + .'| 404| InvalidDomain.NotFound|The domain provided does not exist in our records.| 当前账户下未查到域名。|'."\n" + .'| 403| IllegalOperation|Illegal domain operate is not permitted.| 不支持当前操作，如：非直播类域名。|'."\n" + ."\n", + ], + 'SetLiveStreamDelayConfig' => [ + 'summary' => '调用SetLiveStreamDelayConfig配置直播延迟。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'HlsDelay', + 'in' => 'query', + 'schema' => [ + 'description' => 'HLS播放延迟时间。单位：秒。'."\n" + ."\n" + .'>该参数为空时，按照HlsLevel延迟级别对应的时间设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'HlsLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'HLS延迟级别。配置了HlsDelay情况下忽略该参数。'."\n" + ."\n" + .'取值如下：'."\n" + ."\n" + .'- **short**（默认）：表示延迟时间为3秒。'."\n" + ."\n" + .'- **medium**：表示延迟时间为6秒。'."\n" + ."\n" + .'- **long**：表示延迟时间为15秒。'."\n" + ."\n" + .'>如果HlsDelay和HlsLevel参数都为空，则按照默认值**short**进行配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'short', + ], + ], + [ + 'name' => 'FlvDelay', + 'in' => 'query', + 'schema' => [ + 'description' => 'FLV播放延迟时间。单位：秒。'."\n" + ."\n" + .'>该参数为空时，按照FlvLevel延迟级别对应的时间设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8', + ], + ], + [ + 'name' => 'FlvLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'FLV延迟级别。配置了FlvDelay情况下忽略该参数。'."\n" + ."\n" + .'取值如下：'."\n" + ."\n" + .'- **short**（默认）：表示延迟时间为2秒。'."\n" + ."\n" + .'- **medium**：表示延迟时间为4秒。'."\n" + ."\n" + .'- **long**：表示延迟时间大于4秒。'."\n" + ."\n" + .'>如果FlvDelay和FlvLevel参数都为空，则按照默认值**short**进行配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'medium', + ], + ], + [ + 'name' => 'RtmpDelay', + 'in' => 'query', + 'schema' => [ + 'description' => 'RTMP播放延迟时间。单位：秒。'."\n" + ."\n" + .'>该参数为空时，按照RtmpLevel延迟级别对应的时间设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'RtmpLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'RTMP延迟级别。配置了RtmpDelay情况下忽略该参数。'."\n" + ."\n" + .'取值如下：'."\n" + ."\n" + .'- **short**（默认）：表示延迟时间为2秒。'."\n" + ."\n" + .'- **medium**：表示延迟时间为4秒。'."\n" + ."\n" + .'- **long**：表示延迟时间大于4秒。'."\n" + ."\n" + .'>如果RtmpDelay和RtmpLevel参数都为空，则按照默认值**short**进行配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'short', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4C747C97-7ECD-4C61-8A92-67AD806331FF', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4C747C97-7ECD-4C61-8A92-67AD806331FF\\"\\n}","errorExample":""},{"type":"xml","example":"<SetLiveStreamDelayConfigResponse>\\n <RequestId>4C747C97-7ECD-4C61-8A92-67AD806331FF</RequestId>\\n</SetLiveStreamDelayConfigResponse>","errorExample":""}]', + 'title' => '配置直播延迟', + 'description' => '- 本接口支持配置播流域名的延迟配置。'."\n" + ."\n" + .'- 因为服务端缓存内是整数个关键帧间隔（GOP），所以延迟不会小于GOP大小，真实的延迟需要按照GOP大小估算。例如RTMP配置RtmpDelay为4秒，GOP大小为2秒，则真实延迟最小为2秒（4秒减去2秒），最大为6秒（4秒加上2秒）。 如果GOP大于RtmpDelay延迟配置，比如GOP=5秒,，RtmpDelay=4秒，则延迟在0～9秒之间波动。'."\n" + ."\n" + .'- 纯音频延迟配置无效，默认延迟接近0。'."\n" + ."\n" + .'- HLS配置方式为：先计算切片大小=Delay/3，向下取整，最小不能小于1秒。然后计算切片最大个数，当切片大小大于等于3秒时为4个，其余情况为6个。'."\n" + ."\n" + .'- HLS实际切片大小不会小于GOP大小。'."\n" + ."\n" + .'- HLS延迟计算方式为配置的切片大小*3。'."\n" + ."\n" + .'- 不调用该接口配置时，默认延迟时间为：RTMP为2秒；FLV为4秒；HLS一个切片大小为5秒，即延迟时间为15秒，最多6个切片。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'extraInfo' => '| HttpCode | 错误码|错误信息| 描述|'."\n" + .'|---------------|--------|'."\n" + .'| 500| Internal|The request processing has failed due to some unknown error.| 后台发生未知错误。|'."\n" + .'| 404| InvalidDomain.NotFound|The domain provided does not exist in our records.| 当前账户下未查到域名。|'."\n" + .'| 403| IllegalOperation|Illegal domain operate is not permitted.| 不支持当前操作，如：非直播类域名。|'."\n" + .'| 400| InvalidNotifyUrl.Malformedl|Specified parameter NotifyUrl is not valid.| 不是一个合法的HTTP地址。|'."\n" + .'| 400| InvalidNotifyUrl.Unsafel| Specified NotifyUrl is not safe.| 非安全的NotifyUrl值。|', + ], + 'DescribeLiveDomainBpsData' => [ + 'summary' => '调用DescribeLiveDomainBpsData查询直播域名的网络带宽监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107009', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。'."\n" + .'若参数为空，默认返回所有直播域名合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-10T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。结束时间需晚于起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-10T09:00:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度。单位：秒。取值：'."\n" + .'- **300**（默认值）'."\n" + .'- **3600**'."\n" + .'- **86400**'."\n" + ."\n" + .'> - 不传或传值不支持时，取默认值**300**。'."\n" + .'- 查询时间粒度为**300**时，返回的bps数据值为300秒内平均每秒传输的bit。'."\n" + .'- 查询时间粒度为**3600**和**86400**时，返回的bps数据值为查询时间内所有300秒取值点的峰值。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得。', + 'type' => 'string', + 'required' => false, + 'example' => 'alibaba', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '区域英文名。通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得。', + 'type' => 'string', + 'required' => false, + 'example' => 'tianjin', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-12-10T09:00:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-12-10T08:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B955107D-E658-4E77-B913-E0AC3D31693E', + ], + 'DomainName' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '查询数据的时间粒度，单位是秒。', + 'type' => 'string', + 'example' => '300', + ], + 'BpsDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的网络带宽数据。', + 'type' => 'array', + 'items' => [ + 'description' => '每个时间间隔的网络带宽数据。', + 'type' => 'object', + 'properties' => [ + 'BpsValue' => [ + 'description' => 'bps数据值，单位：bit/second。', + 'type' => 'string', + 'example' => '11288111', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2017-12-10T08:00:05Z', + ], + 'HttpsBpsValue' => [ + 'description' => 'HTTPS的bps数据值，单位：bit/second。', + 'type' => 'string', + 'example' => '2000', + ], + 'HttpBpsValue' => [ + 'description' => 'HTTP的bps数据值，单位：bit/second。', + 'type' => 'string', + 'example' => '11286111', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2017-12-10T09:00:00Z\\",\\n \\"StartTime\\": \\"2017-12-10T08:00:00Z\\",\\n \\"RequestId\\": \\"B955107D-E658-4E77-B913-E0AC3D31693E\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"BpsDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"BpsValue\\": \\"11288111\\",\\n \\"TimeStamp\\": \\"2017-12-10T08:00:05Z\\",\\n \\"HttpsBpsValue\\": \\"2000\\",\\n \\"HttpBpsValue\\": \\"11286111\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDomainBpsDataResponse>\\n <EndTime>2017-12-10T09:00:00Z</EndTime>\\n <StartTime>2017-12-10T08:00:00Z</StartTime>\\n <RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>\\n <DomainName>example.com</DomainName>\\n <DataInterval>300</DataInterval>\\n <BpsDataPerInterval>\\n <BpsValue>11288111</BpsValue>\\n <TimeStamp>2017-12-10T08:00:05Z</TimeStamp>\\n <HttpsBpsValue>2000</HttpsBpsValue>\\n <HttpBpsValue>11286111</HttpBpsValue>\\n </BpsDataPerInterval>\\n</DescribeLiveDomainBpsDataResponse>","errorExample":""}]', + 'title' => '查询域名网络带宽监控数据', + 'description' => '- 不指定StartTime和EndTime时，默认读取过去24小时的数据，同时支持按指定的起止时间查询，两者需要同时指定。'."\n" + .'- 仅指定StartTime，未指定EndTime时，读取从StartTime开始1小时之内的数据。'."\n" + .'- 仅指定EndTime，未指定StartTime时，读取从EndTime向前1小时之内的数据。'."\n" + .'- 支持最长可查询最近90天的数据。'."\n" + .'- 本接口为监控数据接口，数据采集处理方式不同于计费，不能用于计算用量进行对账参考。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveDomainTrafficData' => [ + 'summary' => '查询直播域名网络流量监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。若参数为空，默认返回所有直播域名合并后的数据。'."\n" + .'> - 传入DomainName时，请保证传入域名为直播域名，同时调用本接口的用户拥有传入域名的操作权限。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'>支持查询最近**90**天的数据。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-10T14:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。需晚于起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-10T15:00:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度。单位：秒。取值：'."\n" + .'- **300**（默认值）。'."\n" + .'- **3600**。'."\n" + .'- **86400**。'."\n" + ."\n" + .'> 不传或传值不支持时，使用默认值**300**秒。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。通过[DescribeCdnRegionAndIsp](~~91077~~)获得，不传为所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'alibaba', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '区域英文名。通过[DescribeCdnRegionAndIsp](~~91077~~)获得，不传为所有区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'tianjin', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-12-10T15:00:00Z', + ], + 'StartTime' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-12-10T14:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B955107D-E658-4E77-B913-E0AC3D31693E', + ], + 'DomainName' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '查询数据的时间粒度。', + 'type' => 'string', + 'example' => '300', + ], + 'TrafficDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的流量数据。', + 'type' => 'array', + 'items' => [ + 'description' => '每个时间间隔的流量数据。', + 'type' => 'object', + 'properties' => [ + 'TrafficValue' => [ + 'description' => '总流量。单位：Byte。', + 'type' => 'string', + 'example' => '454680793', + ], + 'HttpTrafficValue' => [ + 'description' => 'HTTP流量。单位：Byte。', + 'type' => 'string', + 'example' => '0', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2017-12-10T15:00:05Z', + ], + 'HttpsTrafficValue' => [ + 'description' => 'HTTPS流量。单位：Byte。', + 'type' => 'string', + 'example' => '454680793', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2017-12-10T15:00:00Z\\",\\n \\"StartTime\\": \\"2017-12-10T14:00:00Z\\",\\n \\"RequestId\\": \\"B955107D-E658-4E77-B913-E0AC3D31693E\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"TrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TrafficValue\\": \\"454680793\\",\\n \\"HttpTrafficValue\\": \\"0\\",\\n \\"TimeStamp\\": \\"2017-12-10T15:00:05Z\\",\\n \\"HttpsTrafficValue\\": \\"454680793\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveDomainTrafficDataResponse>\\n<EndTime>2017-12-10T15:00:00Z</EndTime>\\n<RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>\\n<DomainName>example.com</DomainName>\\n<TrafficDataPerInterval>\\n <DataModule>\\n <HttpTrafficValue>0</HttpTrafficValue>\\n <HttpsTrafficValue>454680793</HttpsTrafficValue>\\n <TrafficValue>454680793</TrafficValue>\\n <TimeStamp>2017-12-10T15:00:05Z</TimeStamp>\\n </DataModule>\\n</TrafficDataPerInterval>\\n<DataInterval>300</DataInterval>\\n<StartTime>2017-12-10T14:00:00Z</StartTime>\\n</DescribeLiveDomainTrafficDataResponse>","errorExample":"{\\n \\"DataInterval\\":\\"300\\",\\n \\"DomainName\\":\\"test.com\\",\\n \\"EndTime\\":\\"2017-12-10T21:00:00Z\\",\\n \\"RequestId\\":\\"B955107D-E658-4E77-B913-E0AC3D31693E\\",\\n \\"StartTime\\":\\"2017-12-10T20:00:00Z\\",\\n \\"TrafficDataPerInterval\\":{\\n \\"DataModule\\":[\\n {\\n \\"HttpTrafficValue\\":\\"0\\",\\n \\"HttpsTrafficValue\\":\\"423304182\\",\\n \\"TimeStamp\\":\\"2017-12-10T20:00:00Z\\",\\n \\"TrafficValue\\":\\"423304182\\"\\n },\\n {\\n \\"HttpTrafficValue\\":\\"0\\",\\n \\"HttpsTrafficValue\\":\\"454680793\\",\\n \\"TimeStamp\\":\\"2017-12-10T20:00:05Z\\",\\n \\"TrafficValue\\":\\"454680793\\"\\n }\\n ]\\n }\\n}"}]', + 'title' => '查询直播域名流量数据', + 'description' => '- 不指定StartTime和EndTime时，默认读取过去24小时的数据。'."\n" + .'- 本接口为监控数据接口，数据采集处理方式不同于计费，不能用于计算用量进行对账参考。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamTranscodeMetricData' => [ + 'summary' => '查询指定域名app及流粒度转码数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '域名名称。仅支持单个域名查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-06-11T02:46:40Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。需晚于开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-06-11T03:46:40Z', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'app', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '流的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'stream', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询token，每次查询最多返回5000行数据，当要查询的数据超过5000行时，响应数据会提供下次查询数据的起始索引。'."\n" + ."\n" + .'请求时传入该token，将从上一次查询结束的下一行继续查询未获取的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '域名名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2023-06-11T02:46:40Z', + ], + 'NextPageToken' => [ + 'description' => '分页查询token，每次查询最多返回5000行数据，当要查询的数据超过5000行时，响应数据会提供下次查询数据的起始索引。'."\n" + ."\n" + .'请求时传入该token，将从上一次查询结束的下一行继续查询未获取的数据。', + 'type' => 'string', + 'example' => 'UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=', + ], + 'PageSize' => [ + 'description' => '返回数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5000', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'StartTime' => [ + 'description' => '起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2023-06-11T03:46:40Z'."\n", + ], + 'StreamDetailData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StreamData' => [ + 'description' => '返回数据组。', + 'type' => 'array', + 'items' => [ + 'description' => '流数据。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'app', + ], + 'Duration' => [ + 'description' => '时长。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'Fps' => [ + 'description' => '帧率。', + 'type' => 'string', + 'enumValueTitles' => [ + 'normal' => 'normal', + 'high' => 'high', + 'def' => 'def', + ], + 'example' => 'high', + ], + 'Region' => [ + 'description' => '地区。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'Resolution' => [ + 'description' => '分辨率。取值：'."\n" + ."\n" + .'- 2K：2K。'."\n" + .'- 4K：4K。'."\n" + .'- LD：流畅。'."\n" + .'- SD：标清。'."\n" + .'- HD：高清。'."\n" + .'- def：音频。', + 'type' => 'string', + 'enumValueTitles' => [ + 'SD' => 'SD', + 'def' => 'def', + '4K' => '4K', + 'LD' => 'LD', + '2K' => '2K', + 'HD' => 'HD', + ], + 'example' => '4K', + ], + 'StreamName' => [ + 'description' => '流名称。', + 'type' => 'string', + 'example' => 'stream', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2023-06-11T02:45:00Z', + ], + 'TranscodeType' => [ + 'description' => '转码类型。取值：'."\n" + ."\n" + .'- H264STD：H.264普通转码。'."\n" + .'- H264NBHD：H.264窄带高清转码。'."\n" + .'- H265STD：H.265普通转码。'."\n" + .'- AUDIO：音频转码。', + 'type' => 'string', + 'enumValueTitles' => [ + 'H264NBHD' => 'H264NBHD', + 'AUDIO' => 'AUDIO', + 'H264STD' => 'H264STD', + 'H265STD' => 'H265STD', + ], + 'example' => 'H264STD', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidPageToken', + 'errorMessage' => 'The token of page is invalid.', + ], + [ + 'errorCode' => 'InvalidAppName.Mismatch', + 'errorMessage' => 'The AppName param must be passed.', + ], + [ + 'errorCode' => 'InvalidStreamProtocol.NotSupport', + 'errorMessage' => 'The specified stream protocol is not support.', + ], + [ + 'errorCode' => 'InvalidStreamName.LengthTooLong', + 'errorMessage' => 'The specified stream name is too long.', + ], + [ + 'errorCode' => 'InvalidAppName.LengthTooLong', + 'errorMessage' => 'The specified app name is too long.', + ], + [ + 'errorCode' => 'InvalidTime.ValueNotSupported', + 'errorMessage' => 'Specified Time is malformed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DomainName\\": \\"example.com\\",\\n \\"EndTime\\": \\"2023-06-11T02:46:40Z\\",\\n \\"NextPageToken\\": \\"UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=\\",\\n \\"PageSize\\": 5000,\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"StartTime\\": \\"2023-06-11T03:46:40Z\\\\n\\",\\n \\"StreamDetailData\\": {\\n \\"StreamData\\": [\\n {\\n \\"AppName\\": \\"app\\",\\n \\"Duration\\": 300,\\n \\"Fps\\": \\"high\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"Resolution\\": \\"4K\\",\\n \\"StreamName\\": \\"stream\\",\\n \\"TimeStamp\\": \\"2023-06-11T02:45:00Z\\",\\n \\"TranscodeType\\": \\"H264STD\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamTranscodeMetricDataResponse>\\n <EndTime>2023-06-11T02:46:40Z</EndTime>\\n <StartTime>2023-06-11T03:46:40Z\\n</StartTime>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n <NextPageToken>UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=</NextPageToken>\\n <PageSize>5000</PageSize>\\n <DomainName>example.com</DomainName>\\n <StreamDetailData>\\n <AppName>app</AppName>\\n <StreamName>stream</StreamName>\\n <Region>cn-shanghai</Region>\\n <Duration>300</Duration>\\n <Fps>high</Fps>\\n <TimeStamp>2023-06-11T02:45:00Z</TimeStamp>\\n <TranscodeType>H264STD</TranscodeType>\\n <Resolution>4K</Resolution>\\n </StreamDetailData>\\n</DescribeLiveStreamTranscodeMetricDataResponse>","errorExample":""}]', + 'title' => '按流粒度查询视频流的转码用量', + 'description' => '- 最大查询跨度：24小时。'."\n" + .'- 最小查询粒度：5分钟。'."\n" + .'- 最大查询范围：最近31天的数据。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveCenterStreamRateData' => [ + 'summary' => '查询直播中心流的音视频帧率、码率。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214643', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '流的名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-03-05T18:00:53Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-03-05T18:01:03Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RateDatas' => [ + 'description' => '帧率码率列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AudioFps' => [ + 'description' => '音频帧率。', + 'type' => 'string', + 'example' => '47', + ], + 'AudioRate' => [ + 'description' => '音频码率。', + 'type' => 'string', + 'example' => '600', + ], + 'Time' => [ + 'description' => '统计时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2024-03-05T18:00:53Z', + ], + 'VideoFps' => [ + 'description' => '视频帧率。', + 'type' => 'string', + 'example' => '30', + ], + 'VideoRate' => [ + 'description' => '视频码率。', + 'type' => 'string', + 'example' => '1953584', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B6E125BE-E9B8-1103-8684-A35*******', + ], + ], + ], + ], + ], + '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' => '[{"type":"json","example":"{\\n \\"RateDatas\\": [\\n {\\n \\"AudioFps\\": \\"47\\",\\n \\"AudioRate\\": \\"600\\",\\n \\"Time\\": \\"2024-03-05T18:00:53Z\\",\\n \\"VideoFps\\": \\"30\\",\\n \\"VideoRate\\": \\"1953584\\"\\n }\\n ],\\n \\"RequestId\\": \\"B6E125BE-E9B8-1103-8684-A35*******\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveCenterStreamRateDataResponse>\\n <RequestId>B6E125BE-E9B8-1103-8684-A3585CB632F1</RequestId>\\n <RateDatas>\\n <VideoFps>30</VideoFps>\\n <VideoRate>1953584</VideoRate>\\n <AudioFps>47</AudioFps>\\n <AudioRate>600</AudioRate>\\n <Time>2024-03-05T18:00:53Z</Time>\\n </RateDatas>\\n</DescribeLiveCenterStreamRateDataResponse>","errorExample":""}]', + 'title' => '查询直播中心收录的流音视频帧率和码率', + 'description' => '返回时间粒度为5秒一个点位，单次查询不能超过3个小时的范围，可以查询30天内的数据。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveDomainBpsDataByLayer' => [ + 'summary' => '调用DescribeLiveDomainBpsDataByLayer按协议分类获取域名带宽及流量信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。支持批量域名查询，多个域名用英文逗号（,）分隔。若参数为空，默认返回所有域名合并后数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'pull.aliyundoc.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间，格式为：<i>yyyy-MM-ddTHH:mm:ssZ</i>（UTC时间）。'."\n" + .'>不填默认读取过去24小时数据，最小数据粒度为5分钟。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-03-15T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间需大于起始时间，格式为：<i>yyyy-MM-ddTHH:mm:ssZ</i>（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-03-16T16:59:59Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度，单位：秒（s）。取值：'."\n" + ."\n" + .'- **300**'."\n" + ."\n" + .'- **3600**'."\n" + ."\n" + .'- **86400**'."\n" + .'> - 数据间隔≤3天，支持数据时间粒度300、3600、86400。'."\n" + .'> - 3天＜数据间隔≤31天，支持数据时间粒度3600和86400。'."\n" + .'> - 数据间隔＞31天，支持数据时间粒度86400。'."\n" + .'> - 不传和传的值不支持时，使用默认值300。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名，不传为所有运营商。'."\n" + .'>您可调用[DescribeLiveRegionAndIsp](~~91077~~)接口获取区域英文名和运营商英文名。', + 'type' => 'string', + 'required' => false, + 'example' => 'tele***', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '区域英文名，不传为所有区域 。'."\n" + .'>您可调用[DescribeLiveRegionAndIsp](~~91077~~)接口获取区域英文名和运营商英文名。', + 'type' => 'string', + 'required' => false, + 'example' => 'hangzhou', + ], + ], + [ + 'name' => 'Layer', + 'in' => 'query', + 'schema' => [ + 'description' => '查询维度。可选：'."\n" + ."\n" + .'- 网络层（IPv4、IPv6）'."\n" + ."\n" + .'- 应用层（http、https、quic）'."\n" + ."\n" + .'- all（默认为all）', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BpsDataInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的每秒访问次数Bps。', + 'type' => 'array', + 'items' => [ + 'description' => '每个时间间隔的每秒访问次数Bps。', + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2022-03-15T16:00:00Z', + ], + 'TrafficValue' => [ + 'description' => '总流量，单位：Byte。', + 'type' => 'string', + 'example' => '331', + ], + 'Value' => [ + 'description' => '峰值带宽，单位：bps。', + 'type' => 'string', + 'example' => '0.56', + ], + ], + ], + ], + ], + ], + 'DataInterval' => [ + 'description' => '每条数据记录的时间间隔，以秒为单位。', + 'type' => 'string', + 'example' => '300', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BEA5625F-8FCF-48F4-851B-2A48566EA967', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'Specified end time does not math the specified start time,And the time range does not exceed 90 days.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"BpsDataInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TimeStamp\\": \\"2022-03-15T16:00:00Z\\",\\n \\"TrafficValue\\": \\"331\\",\\n \\"Value\\": \\"0.56\\"\\n }\\n ]\\n },\\n \\"DataInterval\\": \\"300\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-2A48566EA967\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDomainBpsDataByLayerResponse>\\n<RequestId>BEA5625F-8FCF-48F4-851B-2A48566EA967</RequestId>\\n<DataInterval>300</DataInterval>\\n<BpsDataInterval>\\n <DataModule>\\n <Value>0.56</Value>\\n <TrafficValue>331</TrafficValue>\\n <TimeStamp>2022-03-15T16:00:00Z</TimeStamp>\\n </DataModule>\\n</BpsDataInterval>\\n</DescribeLiveDomainBpsDataByLayerResponse>","errorExample":""}]', + 'title' => '按协议分类查询域名带宽及流量数据', + 'description' => '支持数据存储时长90天。'."\n" + .'支持批量域名查询，多个域名之间用英文逗号（,）分隔，最多支持500个域名。多个域名会按照聚合结果输出。'."\n" + .'**StartTime**和**EndTime**数据间隔跨度不同返回时间粒度也不同，具体如下：'."\n" + ."\n" + .'- 数据间隔≤3天，返回时间粒度五分钟。'."\n" + ."\n" + .'- 3天＜数据间隔≤31天，返回时间粒度1小时。'."\n" + ."\n" + .'- 数据间隔＞31天，返回时间粒度1天。'."\n" + ."\n" + .'>如果**StartTime**和**EndTime**均未指定数值，默认返回当前时间起24小时内数据。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveDomainPushBpsData' => [ + 'summary' => '调用DescribeLiveDomainPushBpsData获取推流域名的推流网络带宽监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名。'."\n" + .'支持批量域名查询，多个域名用英文逗号（,）分隔。'."\n" + .'若参数为空，默认返回所有推流域名合并后数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'不写默认读取过去24小时数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-10T21:00:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度。单位：秒。取值：'."\n" + ."\n" + .'- **300**。'."\n" + .'- **3600**。'."\n" + .'- **86400**。'."\n" + ."\n" + .'不传和传的值不支持时，使用默认值300秒。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名.'."\n" + .'可通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得，不传默认为所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'alibaba', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '区域英文名。'."\n" + .'可通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得，不传默认为所有区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'tianjin', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2017-12-10T21:00:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2017-12-10T20:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F', + ], + 'DomainName' => [ + 'description' => '查询的推流域名。', + 'type' => 'string', + 'example' => 'demo.aliyundoc.com', + ], + 'DataInterval' => [ + 'description' => '所查询数据的时间粒度。', + 'type' => 'string', + 'example' => '300', + ], + 'BpsDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的网络带宽数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BpsValue' => [ + 'description' => 'bps数据值。单位：bit/s。', + 'type' => 'string', + 'example' => '11288111', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2017-12-10T20:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2017-12-10T21:00:00Z\\",\\n \\"StartTime\\": \\"2017-12-10T20:00:00Z\\",\\n \\"RequestId\\": \\"3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F\\",\\n \\"DomainName\\": \\"demo.aliyundoc.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"BpsDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"BpsValue\\": \\"11288111\\",\\n \\"TimeStamp\\": \\"2017-12-10T20:00:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDomainPushBpsDataResponse>\\n <EndTime>2017-12-10T21:00:00Z</EndTime>\\n <StartTime>2017-12-10T20:00:00Z</StartTime>\\n <RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>\\n <DomainName>demo.aliyundoc.com</DomainName>\\n <DataInterval>300</DataInterval>\\n <BpsDataPerInterval>\\n <BpsValue>11288111</BpsValue>\\n <TimeStamp>2017-12-10T20:00:00Z</TimeStamp>\\n </BpsDataPerInterval>\\n</DescribeLiveDomainPushBpsDataResponse>","errorExample":""}]', + 'title' => '查询推流域名推流网络带宽监控数据', + 'description' => '- 获取的带宽数据单位为bit/s。'."\n" + .'- 支持批量域名查询，多个域名用英文逗号（,）分隔。'."\n" + .'- 不指定StartTime和EndTime时，默认读取过去24小时的数据，同时支持按指定的起止时间查询，两者需要同时指定。'."\n" + .'- 最多可获取最近90天的数据。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveDomainPushTrafficData' => [ + 'summary' => '调用DescribeLiveDomainPushTrafficData获取推流域名推流流量监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名。'."\n" + .'支持批量域名查询，多个域名用英文逗号（,）分隔。'."\n" + .'若参数为空，默认返回所有推流域名合并后数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'不填默认读取过去24小时数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-10T21:00:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度。单位：秒。取值：'."\n" + ."\n" + .'- **300**。'."\n" + .'- **3600**。'."\n" + .'- **86400**。'."\n" + ."\n" + .'不传和传的值不支持时，使用默认值300秒。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。'."\n" + .'可通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得，不传默认为所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'alibaba', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '区域英文名。'."\n" + .'可通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得，不传默认为所有区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'tianjin', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2017-12-10T21:00:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2017-12-10T20:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F', + ], + 'DomainName' => [ + 'description' => '推流域名。', + 'type' => 'string', + 'example' => 'demo.aliyundoc.com', + ], + 'DataInterval' => [ + 'description' => '数据时间粒度。', + 'type' => 'string', + 'example' => '300', + ], + 'TrafficDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的流量数据。', + 'type' => 'array', + 'items' => [ + 'description' => '流量数据时间粒度。', + 'type' => 'object', + 'properties' => [ + 'TrafficValue' => [ + 'description' => '流量数据值。单位：Byte。', + 'type' => 'string', + 'example' => '1288111', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2017-12-10T20:05:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2017-12-10T21:00:00Z\\",\\n \\"StartTime\\": \\"2017-12-10T20:00:00Z\\",\\n \\"RequestId\\": \\"3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F\\",\\n \\"DomainName\\": \\"demo.aliyundoc.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"TrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TrafficValue\\": \\"1288111\\",\\n \\"TimeStamp\\": \\"2017-12-10T20:05:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveDomainPushTrafficDataResponse>\\n<EndTime>2017-12-10T21:00:00Z</EndTime>\\n<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>\\n<DomainName>demo.aliyundoc.com</DomainName>\\n<TrafficDataPerInterval>\\n <DataModule>\\n <TrafficValue>1288111</TrafficValue>\\n <TimeStamp>2017-12-10T20:05:00Z</TimeStamp>\\n </DataModule>\\n</TrafficDataPerInterval>\\n<DataInterval>300</DataInterval>\\n<StartTime>2017-12-10T20:00:00Z</StartTime>\\n</DescribeLiveDomainPushTrafficDataResponse>","errorExample":""}]', + 'title' => '查询推流域名推流流量监控数据', + 'description' => '- 获取的流量监控数据单位为Byte。'."\n" + .'- 支持批量域名查询，多个域名用英文逗号（,）分隔。'."\n" + .'- 不指定StartTime和EndTime时，默认读取过去24小时的数据，同时支持按指定的起止时间查询，两者需要同时指定。'."\n" + .'- 最多可获取最近90天的数据。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamPushMetricDetailData' => [ + 'summary' => '查询指定域名推流app及流粒度数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '- 需要查询的加速域名。仅支持单个域名查询，传多个域名将报错。'."\n" + .'- 不指定AppName和StreamName时，按指定加速域名返回此域名下所有流粒度的数据，所有查询数据不聚合。'."\n" + .'- DomainName不为空且AppName为all和StreamName为all时，返回指定加速域名下所有流粒度的聚合数据。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。'."\n" + ."\n" + .'格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-09-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点，日期格式按照ISO8601表示法，并使用UTC时间，结束时间需大于起始时间，且不能相差超过1天。'."\n" + ."\n" + .'格式为：YYYY-MM-DDThh:mm:ssZ。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2022-09-10T21:00:00Z', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。指定应用名称，查询对应应用流粒度的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。指定StreamName时，按指定AppName的指定StreamName，返回流粒度的数据（指定StreamName时，必须指定AppName）。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询token，每次查询最多返回5000行数据，当要查询的数据超过5000行时，响应数据会提供下次查询数据的起始索引。'."\n" + ."\n" + .'请求时传入该token，将从上一次查询结束的下一行继续查询未获取的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'EndTime' => [ + 'description' => '获取数据结束时间点，日期格式按照ISO8601表示法，并使用UTC时间。'."\n" + ."\n" + .'格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'example' => '2022-09-10T21:00:00Z', + ], + 'NextPageToken' => [ + 'description' => '分页查询token，每次查询最多返回5000行数据，当要查询的数据超过5000行时，响应数据会提供下次查询数据的起始索引。'."\n" + ."\n" + .'请求时传入该token，将从上一次查询结束的下一行继续查询未获取的数据。', + 'type' => 'string', + 'example' => 'UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=', + ], + 'PageSize' => [ + 'description' => '返回数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5000', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5EBF2AC3-4B73-40A5-8B32-83F49D5F035E', + ], + 'StartTime' => [ + 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。'."\n" + ."\n" + .'格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'example' => '2022-09-10T20:00:00Z', + ], + 'StreamDetailData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StreamData' => [ + 'description' => '返回数据组。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据组。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'ReqBps' => [ + 'description' => '流每分钟总带宽，单位：Bps。', + 'type' => 'number', + 'format' => 'float', + 'example' => '133.33', + ], + 'ReqTraffic' => [ + 'description' => '流每分钟总流量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'StreamName' => [ + 'description' => '流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2022-09-10T20:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidPageToken', + 'errorMessage' => 'The token of page is invalid.', + ], + [ + 'errorCode' => 'InvalidAppName.Mismatch', + 'errorMessage' => 'The AppName param must be passed.', + ], + [ + 'errorCode' => 'InvalidStreamProtocol.NotSupport', + 'errorMessage' => 'The specified stream protocol is not support.', + ], + [ + 'errorCode' => 'InvalidStreamName.LengthTooLong', + 'errorMessage' => 'The specified stream name is too long.', + ], + [ + 'errorCode' => 'InvalidAppName.LengthTooLong', + 'errorMessage' => 'The specified app name is too long.', + ], + [ + 'errorCode' => 'InvalidTime.ValueNotSupported', + 'errorMessage' => 'Specified Time is malformed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DomainName\\": \\"example.com\\",\\n \\"EndTime\\": \\"2022-09-10T21:00:00Z\\",\\n \\"NextPageToken\\": \\"UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=\\",\\n \\"PageSize\\": 5000,\\n \\"RequestId\\": \\"5EBF2AC3-4B73-40A5-8B32-83F49D5F035E\\",\\n \\"StartTime\\": \\"2022-09-10T20:00:00Z\\",\\n \\"StreamDetailData\\": {\\n \\"StreamData\\": [\\n {\\n \\"AppName\\": \\"liveApp****\\",\\n \\"ReqBps\\": 133.33,\\n \\"ReqTraffic\\": 1000,\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"TimeStamp\\": \\"2022-09-10T20:00:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamPushMetricDetailDataResponse>\\n <DomainName>example.com</DomainName>\\n <EndTime>2022-09-10T21:00:00Z</EndTime>\\n <NextPageToken>UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=</NextPageToken>\\n <PageSize>5000</PageSize>\\n <RequestId>5EBF2AC3-4B73-40A5-8B32-83F49D5F035E</RequestId>\\n <StartTime>2022-09-10T20:00:00Z</StartTime>\\n <StreamDetailData>\\n <AppName>liveApp****</AppName>\\n <ReqBps>133.33</ReqBps>\\n <ReqTraffic>1000</ReqTraffic>\\n <StreamName>liveStream****</StreamName>\\n <TimeStamp>2022-09-10T20:00:00Z</TimeStamp>\\n </StreamDetailData>\\n</DescribeLiveStreamPushMetricDetailDataResponse>","errorExample":""}]', + 'title' => '查询指定域名推流流粒度批量数据', + 'description' => '- 仅支持单个域名查询，多个域名会报错。'."\n" + .'- 数据最大查询跨度：24小时。'."\n" + .'- 数据最小查询粒度：1分钟。'."\n" + .'- 数据最大查询范围：31天。'."\n" + .'- 本接口为监控数据接口，数据采集处理方式不同于计费，不能用于计算用量进行对账参考。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveDomainPublishErrorCode' => [ + 'summary' => '查询推流域名下某个时间段内的推流状态码。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '204356', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名，允许传入多个推流域名，多个域名之间用英文逗号（,）分隔。'."\n" + ."\n" + .'> 该参数为必填参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'example1.aliyundoc.com,example2.aliyundoc.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '按照AppName进行过滤汇聚，若指定了AppName，则DomainName必须指定一个特定的推流域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'AppName', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> 不写默认查询过去1小时的数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-29T09:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> 不写默认查询过去1小时的数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-29T09:10:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DataInterval' => [ + 'description' => '查询数据的时间粒度，单位是秒。默认值为60。', + 'type' => 'string', + 'example' => '60', + ], + 'DomainName' => [ + 'description' => '推流域名。', + 'type' => 'string', + 'example' => 'example1.aliyundoc.com,example2.aliyundoc.com', + ], + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2016-06-29T09:10:00Z', + ], + 'RealTimeCodeData' => [ + 'description' => '每个时间间隔的错误码占比数据。', + 'type' => 'array', + 'items' => [ + 'description' => '每个时间间隔的错误码占比数据。', + 'type' => 'object', + 'properties' => [ + 'CodeData' => [ + 'description' => '各返回码占比使用数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '各返回码占比使用数据列表。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '响应码。响应码取值：'."\n" + .'- 3：读数据超时 。'."\n" + .'- 4：写数据错误 。'."\n" + .'- 6：写数据超时 。'."\n" + .'- 200：成功。'."\n" + .'- 500：内部系统未知错误 。'."\n" + .'- 501：推流异常。'."\n" + .'- 502：信令耗时过长 。'."\n" + .'- 401：推流参数异常 。'."\n" + .'- 403：推流鉴权失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Count' => [ + 'description' => '响应数量。', + 'type' => 'string', + 'example' => '20', + ], + 'Proportion' => [ + 'description' => '响应数量占比。', + 'type' => 'string', + 'example' => '66.04', + ], + ], + ], + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2016-06-29T09:01:00Z', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC858082-736F-4A25-867B-E5B67C******', + ], + 'StartTime' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2016-06-29T09:00:00Z', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DataInterval\\": \\"60\\",\\n \\"DomainName\\": \\"example1.aliyundoc.com,example2.aliyundoc.com\\",\\n \\"EndTime\\": \\"2016-06-29T09:10:00Z\\",\\n \\"RealTimeCodeData\\": [\\n {\\n \\"CodeData\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Count\\": \\"20\\",\\n \\"Proportion\\": \\"66.04\\"\\n }\\n ],\\n \\"TimeStamp\\": \\"2016-06-29T09:01:00Z\\"\\n }\\n ],\\n \\"RequestId\\": \\"BC858082-736F-4A25-867B-E5B67C******\\",\\n \\"StartTime\\": \\"2016-06-29T09:00:00Z\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDomainPublishErrorCodeResponse>\\n <RequestId>BC858082-736F-4A25-867B-E5B67C85ACF7</RequestId>\\n <DataInterval>60</DataInterval>\\n <DomainName>example.com,example.aliyundoc.com</DomainName>\\n <StartTime>2016-06-29T09:00:00Z</StartTime>\\n <EndTime>2016-06-29T09:10:00Z</EndTime>\\n <RealTimeCodeData>\\n <TimeStamp>2016-06-29T09:01:00Z</TimeStamp>\\n <CodeData>\\n <Code>200</Code>\\n <Count>20</Count>\\n <Proportion>66.04</Proportion>\\n </CodeData>\\n </RealTimeCodeData>\\n</DescribeLiveDomainPublishErrorCodeResponse>","errorExample":""}]', + 'title' => '查询域名推流状态码', + 'description' => '- 本接口为监控数据接口，数据采集处理方式不同于计费，不能用于计算用量进行对账参考。'."\n" + .'- 最多可获取最近90天的数据。'."\n" + .'- 接口数据延时在3-5分钟。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveUpVideoAudioInfo' => [ + 'summary' => '查询一段时间内的流的上行推流的音视频参数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107116', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Stream', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的流名，需要完整填写，格式为：`rtmp://推流域名/app名/流名`', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp://example.com/AppName/StreamName', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-10T15:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-10T15:10:00Z ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '视频音频信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC858082-736F-4A25-867B-E5B67C85ACF7', + ], + 'UpItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PublishItem' => [ + 'description' => '返回信息中聚合推流数总计。', + 'type' => 'array', + 'items' => [ + 'description' => '信息。', + 'type' => 'object', + 'properties' => [ + 'AacHeaders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AacHeaders' => [ + 'description' => '秒级音频AAC头，单位：次数。', + 'type' => 'array', + 'items' => [ + 'description' => '秒级音频AAC头。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '查询时间，用UNIX毫秒时间戳表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1538134750408', + ], + 'Value' => [ + 'description' => '对应质量数据在查询时间的秒级指标值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + ], + 'AppName' => [ + 'description' => '推流App名称。', + 'type' => 'string', + 'example' => 'AppName', + ], + 'AudioBitRate' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AudioBitRate' => [ + 'description' => '秒级音频码率，单位：bit/s。', + 'type' => 'array', + 'items' => [ + 'description' => '秒级音频码率。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '查询时间，用UNIX毫秒时间戳表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1538134750408', + ], + 'Value' => [ + 'description' => '对应质量数据在查询时间的秒级指标值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24552', + ], + ], + ], + ], + ], + ], + 'AudioFrames' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AudioFrames' => [ + 'description' => '秒级音频帧率，单位：帧。', + 'type' => 'array', + 'items' => [ + 'description' => '秒级音频帧率。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '查询时间，用UNIX毫秒时间戳表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1538134750408', + ], + 'Value' => [ + 'description' => '对应质量数据在查询时间的秒级指标值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + ], + ], + ], + ], + ], + 'AudioInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AudioInterval' => [ + 'description' => '秒级最大音频帧间隔，单位：毫秒。', + 'type' => 'array', + 'items' => [ + 'description' => '秒级最大音频帧间隔。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '查询时间，用UNIX毫秒时间戳表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1538134750408', + ], + 'Value' => [ + 'description' => '对应质量数据在查询时间的秒级指标值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '254', + ], + ], + ], + ], + ], + ], + 'AudioStamps' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AudioStamps' => [ + 'description' => '秒级音频时间戳，单位：毫秒。', + 'type' => 'array', + 'items' => [ + 'description' => '秒级音频时间戳。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '查询时间，用UNIX毫秒时间戳表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1538134750408', + ], + 'Value' => [ + 'description' => '对应质量数据在查询时间的秒级指标值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '725053422', + ], + ], + ], + ], + ], + ], + 'AvcHeaders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AvcHeaders' => [ + 'description' => '秒级音频AVC头，单位：次数。', + 'type' => 'array', + 'items' => [ + 'description' => '秒级音频AVC头。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '查询时间，用UNIX毫秒时间戳表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1538134750408', + ], + 'Value' => [ + 'description' => '对应质量数据在查询时间的秒级指标值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + ], + ], + ], + ], + ], + 'CodecInfo' => [ + 'description' => '音视频编码信息。', + 'type' => 'string', + 'example' => 'H264/AAC', + ], + 'DomainName' => [ + 'description' => '推流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'ErrorFlags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ErrorFlags' => [ + 'description' => '推流断开错误码。', + 'type' => 'array', + 'items' => [ + 'description' => '推流断开错误码。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '查询时间，用UNIX毫秒时间戳表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1538134750408', + ], + 'Value' => [ + 'description' => '对应质量数据在查询时间的秒级指标值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + 'PublishInterval' => [ + 'description' => '推流时长，单位为秒；"-"表示正在推流，暂无推流时长。', + 'type' => 'string', + 'example' => '-', + ], + 'PublishIp' => [ + 'description' => '推流端IP。', + 'type' => 'string', + 'example' => 'cn397', + ], + 'PublishStatus' => [ + 'description' => '推流状态，分为 “1”: “正在推流” 或 “0”: “过去推流” 两种', + 'type' => 'string', + 'example' => '1', + ], + 'PublishTime' => [ + 'description' => '推流开始时间，UTC格式。', + 'type' => 'string', + 'example' => '2015-12-10T15:00:00Z', + ], + 'StopTime' => [ + 'description' => '推流结束时间，UTC格式。', + 'type' => 'string', + 'example' => '2015-12-10T15:10:00Z', + ], + 'StreamName' => [ + 'description' => '流的名称。', + 'type' => 'string', + 'example' => 'StreamName', + ], + 'UniqueId' => [ + 'description' => '每次推流的唯一ID。', + 'type' => 'string', + 'example' => '2.-395_37261_9848098_1538080899396', + ], + 'VideoAndAudioStamp' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'V_AStamp' => [ + 'description' => '秒级音视频时间戳差值，单位：毫秒。', + 'type' => 'array', + 'items' => [ + 'description' => '秒级音视频时间戳差值。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '查询时间，用UNIX毫秒时间戳表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1538134750408', + ], + 'Value' => [ + 'description' => '对应质量数据在查询时间的秒级指标值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '359', + ], + ], + ], + ], + ], + ], + 'VideoBitRate' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoBitRate' => [ + 'description' => '秒级视频码率，单位：bit/s。', + 'type' => 'array', + 'items' => [ + 'description' => '秒级视频码率。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '查询时间，用UNIX毫秒时间戳表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1538134750408', + ], + 'Value' => [ + 'description' => '对应质量数据在查询时间的秒级指标值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3970160', + ], + ], + ], + ], + ], + ], + 'VideoFrames' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoFrames' => [ + 'description' => '秒级视频帧率，单位：帧。', + 'type' => 'array', + 'items' => [ + 'description' => '秒级视频帧率。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '查询时间，用UNIX毫秒时间戳表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1538134750408', + ], + 'Value' => [ + 'description' => '对应质量数据在查询时间的秒级指标值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '29', + ], + ], + ], + ], + ], + ], + 'VideoInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoInterval' => [ + 'description' => '秒级最大视频帧间隔，单位：毫秒。', + 'type' => 'array', + 'items' => [ + 'description' => '秒级最大视频帧间隔。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '查询时间，用UNIX毫秒时间戳表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1538134750408', + ], + 'Value' => [ + 'description' => '对应质量数据在查询时间的秒级指标值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '278', + ], + ], + ], + ], + ], + ], + 'VideoStamps' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoStamps' => [ + 'description' => '秒级视频时间戳，单位：毫秒。', + 'type' => 'array', + 'items' => [ + 'description' => '秒级视频时间戳。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '查询时间，用UNIX毫秒时间戳表示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1538134750408', + ], + 'Value' => [ + 'description' => '对应质量数据在查询时间的秒级指标值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '725053781', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'InvalidDuration.ExceedOneDay', + 'errorMessage' => 'StartTime and EndTime Duration Exceeds One Day', + ], + [ + 'errorCode' => 'InvalidDuration.StratTimeBiggerEndTime', + 'errorMessage' => 'StartTime Bigger Than EndTime', + ], + ], + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter Stream invalid.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC858082-736F-4A25-867B-E5B67C85ACF7\\",\\n \\"UpItems\\": {\\n \\"PublishItem\\": [\\n {\\n \\"AacHeaders\\": {\\n \\"AacHeaders\\": [\\n {\\n \\"Time\\": 1538134750408,\\n \\"Value\\": 20\\n }\\n ]\\n },\\n \\"AppName\\": \\"AppName\\",\\n \\"AudioBitRate\\": {\\n \\"AudioBitRate\\": [\\n {\\n \\"Time\\": 1538134750408,\\n \\"Value\\": 24552\\n }\\n ]\\n },\\n \\"AudioFrames\\": {\\n \\"AudioFrames\\": [\\n {\\n \\"Time\\": 1538134750408,\\n \\"Value\\": 23\\n }\\n ]\\n },\\n \\"AudioInterval\\": {\\n \\"AudioInterval\\": [\\n {\\n \\"Time\\": 1538134750408,\\n \\"Value\\": 254\\n }\\n ]\\n },\\n \\"AudioStamps\\": {\\n \\"AudioStamps\\": [\\n {\\n \\"Time\\": 1538134750408,\\n \\"Value\\": 725053422\\n }\\n ]\\n },\\n \\"AvcHeaders\\": {\\n \\"AvcHeaders\\": [\\n {\\n \\"Time\\": 1538134750408,\\n \\"Value\\": 11\\n }\\n ]\\n },\\n \\"CodecInfo\\": \\"H264/AAC\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"ErrorFlags\\": {\\n \\"ErrorFlags\\": [\\n {\\n \\"Time\\": 1538134750408,\\n \\"Value\\": 0\\n }\\n ]\\n },\\n \\"PublishInterval\\": \\"-\\",\\n \\"PublishIp\\": \\"cn397\\",\\n \\"PublishStatus\\": \\"1\\",\\n \\"PublishTime\\": \\"2015-12-10T15:00:00Z\\",\\n \\"StopTime\\": \\"2015-12-10T15:10:00Z\\",\\n \\"StreamName\\": \\"StreamName\\",\\n \\"UniqueId\\": \\"2.-395_37261_9848098_1538080899396\\",\\n \\"VideoAndAudioStamp\\": {\\n \\"V_AStamp\\": [\\n {\\n \\"Time\\": 1538134750408,\\n \\"Value\\": 359\\n }\\n ]\\n },\\n \\"VideoBitRate\\": {\\n \\"VideoBitRate\\": [\\n {\\n \\"Time\\": 1538134750408,\\n \\"Value\\": 3970160\\n }\\n ]\\n },\\n \\"VideoFrames\\": {\\n \\"VideoFrames\\": [\\n {\\n \\"Time\\": 1538134750408,\\n \\"Value\\": 29\\n }\\n ]\\n },\\n \\"VideoInterval\\": {\\n \\"VideoInterval\\": [\\n {\\n \\"Time\\": 1538134750408,\\n \\"Value\\": 278\\n }\\n ]\\n },\\n \\"VideoStamps\\": {\\n \\"VideoStamps\\": [\\n {\\n \\"Time\\": 1538134750408,\\n \\"Value\\": 725053781\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveUpVideoAudioInfoResponse>\\n <RequestId>BC858082-736F-4A25-867B-E5B67C85ACF7</RequestId>\\n <UpItems>\\n <PublishTime>2015-12-10T15:00:00Z</PublishTime>\\n <AppName>AppName</AppName>\\n <CodecInfo>H264/AAC</CodecInfo>\\n <PublishIp>cn397</PublishIp>\\n <StreamName>StreamName</StreamName>\\n <PublishStatus>1</PublishStatus>\\n <UniqueId>2.-395_37261_9848098_1538080899396</UniqueId>\\n <PublishInterval>-</PublishInterval>\\n <StopTime>2015-12-10T15:10:00Z</StopTime>\\n <DomainName>example.com</DomainName>\\n <VideoFrames>\\n <Value>29</Value>\\n <Time>1538134750408</Time>\\n </VideoFrames>\\n <AudioFrames>\\n <Value>23</Value>\\n <Time>1538134750408</Time>\\n </AudioFrames>\\n <VideoStamps>\\n <Value>725053781</Value>\\n <Time>1538134750408</Time>\\n </VideoStamps>\\n <AudioStamps>\\n <Value>725053422</Value>\\n <Time>1538134750408</Time>\\n </AudioStamps>\\n <VideoAndAudioStamp>\\n <Value>359</Value>\\n <Time>1538134750408</Time>\\n </VideoAndAudioStamp>\\n <AvcHeaders>\\n <Value>11</Value>\\n <Time>1538134750408</Time>\\n </AvcHeaders>\\n <AacHeaders>\\n <Value>20</Value>\\n <Time>1538134750408</Time>\\n </AacHeaders>\\n <VideoBitRate>\\n <Value>3970160</Value>\\n <Time>1538134750408</Time>\\n </VideoBitRate>\\n <AudioBitRate>\\n <Value>24552</Value>\\n <Time>1538134750408</Time>\\n </AudioBitRate>\\n <VideoInterval>\\n <Value>278</Value>\\n <Time>1538134750408</Time>\\n </VideoInterval>\\n <AudioInterval>\\n <Value>254</Value>\\n <Time>1538134750408</Time>\\n </AudioInterval>\\n <ErrorFlags>\\n <Value>0</Value>\\n <Time>1538134750408</Time>\\n </ErrorFlags>\\n </UpItems>\\n</DescribeLiveUpVideoAudioInfoResponse>","errorExample":""}]', + 'title' => '获取直播视频音频信息', + 'description' => '- 数据最大查询跨度为24小时。'."\n" + .'- 数据最小查询跨度为1分钟。'."\n" + .'- 数据最大查询范围为31天。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'responseParamsDescription' => '部分参数不存在时，返回空字符串。', + ], + 'DescribeLiveDomainRealTimeBpsData' => [ + 'summary' => '调用DescribeLiveDomainRealTimeBpsData获取域名1分钟粒度带宽数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107032', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。'."\n" + ."\n" + .'多个域名之间用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example1.aliyundoc.com,example2.aliyundoc.com', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。'."\n" + ."\n" + .'通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得。', + 'type' => 'string', + 'required' => false, + 'example' => 'alibaba', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '区域英文名。'."\n" + ."\n" + .'通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得。', + 'type' => 'string', + 'required' => false, + 'example' => 'tianjin', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-11-30T05:39:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。需晚于起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> 不填默认查询从StartTime起一小时内的数据。 ', + 'type' => 'string', + 'required' => false, + 'example' => '2015-11-30T05:40:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-11-30T05:40:00Z', + ], + 'StartTime' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-11-30T05:33:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC858082-736F-4A25-867B-E5B6******', + ], + 'DomainName' => [ + 'description' => '播流域名信息。', + 'type' => 'string', + 'example' => 'example1.aliyundoc.com,example2.aliyundoc.com', + ], + 'DataInterval' => [ + 'description' => '查询数据的时间粒度。', + 'type' => 'string', + 'example' => '60', + ], + 'RealTimeBpsDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '域名1分钟粒度带宽数据。', + 'type' => 'array', + 'items' => [ + 'description' => '域名1分钟粒度带宽数据。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '带宽数据，单位：bit/second。', + 'type' => 'string', + 'example' => '59392614.8', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳。', + 'type' => 'string', + 'example' => '2015-11-30T05:39:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'Specified domain name is malformed.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2015-11-30T05:40:00Z\\",\\n \\"StartTime\\": \\"2015-11-30T05:33:00Z\\",\\n \\"RequestId\\": \\"BC858082-736F-4A25-867B-E5B6******\\",\\n \\"DomainName\\": \\"example1.aliyundoc.com,example2.aliyundoc.com\\",\\n \\"DataInterval\\": \\"60\\",\\n \\"RealTimeBpsDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"59392614.8\\",\\n \\"TimeStamp\\": \\"2015-11-30T05:39:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveDomainRealTimeBpsDataResponse>\\n<EndTime>2015-11-30T05:40:00Z</EndTime>\\n<RequestId>BC858082-736F-4A25-867B-E5B67C85ACF7</RequestId>\\n<DomainName>example.com,example.aliyundoc.com</DomainName>\\n<DataInterval>60</DataInterval>\\n<StartTime>2015-11-30T05:33:00Z</StartTime>\\n<RealTimeBpsDataPerInterval>\\n <DataModule>\\n <Value>59392614.8</Value>\\n <TimeStamp>2015-11-30T05:39:00Z</TimeStamp>\\n </DataModule>\\n</RealTimeBpsDataPerInterval>\\n</DescribeLiveDomainRealTimeBpsDataResponse>","errorExample":"{\\n \\"RealTimeBpsDataPerInterval\\":{\\n \\"DataModule\\":[\\n {\\n \\"TimeStamp\\":\\"2018-01-02T11:05:00Z\\",\\n \\"Value\\":16710625.733333332\\n },\\n {\\n \\"TimeStamp\\":\\"2018-01-02T11:04:00Z\\",\\n \\"Value\\":59392614.8\\n }\\n ]\\n },\\n \\"RequestId\\":\\"B49E6DDA-F413-422B-B58E-2FA23F286726\\"\\n}"}]', + 'title' => '获取域名1分钟粒度带宽数据', + 'description' => '- 调用本接口查询指定域名的流量和带宽使用情况。'."\n" + .'- 可以查询最近7天内的数据，单次查询StartTime和EndTime跨度不能超过24小时。'."\n" + .'- 如果StartTime和EndTime均未指定，默认返回当前时间起1小时内的数据。'."\n" + .'- 本接口为监控数据接口，数据采集处理方式不同于计费，不能用于计算用量进行对账参考。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveDomainRealTimeTrafficData' => [ + 'summary' => '调用DescribeLiveDomainRealTimeTrafficData查询直播域名的实时流量监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107036', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。'."\n" + ."\n" + .'多个域名之间用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com,example.aliyundoc.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> 不写默认读取过去1小时数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-10T15:00:00Z', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。'."\n" + ."\n" + .'通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得。', + 'type' => 'string', + 'required' => false, + 'example' => 'alibaba', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '区域英文名。'."\n" + ."\n" + .'通过[DescribeCdnRegionAndIsp](~~91077~~)接口获得。', + 'type' => 'string', + 'required' => false, + 'example' => 'tianjin', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。需晚于起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-10T15:01:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-10T15:01:00Z', + ], + 'StartTime' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-10T15:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A666D44F-19D6-490E-97CF-1A64AB962C57', + ], + 'DomainName' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'example' => 'example.com,example.aliyundoc.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔。单位：秒。', + 'type' => 'string', + 'example' => '60', + ], + 'RealTimeTrafficDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的流量数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '流量数据。单位：字节。', + 'type' => 'string', + 'example' => '0', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-10T15:01:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'StartTime and EndTime can not be single.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'Abs.DomainName.Malformed', + 'errorMessage' => 'The size of DomainName is too big.', + ], + [ + 'errorCode' => 'InvalidInterval.Malformed', + 'errorMessage' => 'Specified Interval is malformed.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2015-12-10T15:01:00Z\\",\\n \\"StartTime\\": \\"2015-12-10T15:00:00Z\\",\\n \\"RequestId\\": \\"A666D44F-19D6-490E-97CF-1A64AB962C57\\",\\n \\"DomainName\\": \\"example.com,example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"60\\",\\n \\"RealTimeTrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"0\\",\\n \\"TimeStamp\\": \\"2015-12-10T15:01:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDomainRealTimeTrafficDataResponse>\\n <EndTime>2015-12-10T15:01:00Z</EndTime>\\n <StartTime>2015-12-10T15:00:00Z</StartTime>\\n <RequestId>A666D44F-19D6-490E-97CF-1A64AB962C57</RequestId>\\n <DomainName>example.com,example.aliyundoc.com</DomainName>\\n <DataInterval>60</DataInterval>\\n <RealTimeTrafficDataPerInterval>\\n <Value>0</Value>\\n <TimeStamp>2015-12-10T15:01:00Z</TimeStamp>\\n </RealTimeTrafficDataPerInterval>\\n</DescribeLiveDomainRealTimeTrafficDataResponse>","errorExample":""}]', + 'title' => '获取加速域名的1分钟流量监控数据', + 'description' => '- 调用本接口查询播流域名下某个区域、运营商、时间段内的实时带宽流量。'."\n" + .'- 不指定StartTime和EndTime时，默认读取过去1小时的数据，同时支持按指定的起止时间查询，两者需要同时指定。'."\n" + .'- 本接口为监控数据接口，数据采集处理方式不同于计费，不能用于计算用量进行对账参考。'."\n" + .'- 最多可获取最近90天的数据。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口无单用户QPS限制，请您根据实际需要合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveDomainRealTimeHttpCodeData' => [ + 'summary' => '获取加速域名1分钟粒度的HTTP返回码占比。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107034', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。'."\n" + .'> - 传入DomainName时，请保证传入域名为直播域名，同时调用本接口的用户拥有传入域名的操作权限。'."\n" + .'> - 多个域名之间用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com,example.aliyundoc.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> 若StartTime和EndTime参数都为空，默认返回当前时间起**1**小时内的数据。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2015-11-30T05:39:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。需晚于起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'> 若StartTime和EndTime参数都为空，默认返回当前时间起**1**小时内的数据。'."\n" + .' ', + 'type' => 'string', + 'required' => false, + 'example' => '2015-11-30T05:40:00Z', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。'."\n" + ."\n" + .'通过[DescribeCdnRegionAndIsp](~~448109~~)接口获得。', + 'type' => 'string', + 'required' => false, + 'example' => 'alibaba', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '区域英文名。'."\n" + ."\n" + .'通过[DescribeCdnRegionAndIsp](~~448109~~)接口获得。', + 'type' => 'string', + 'required' => false, + 'example' => 'tianjin', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-11-30T05:40:00Z', + ], + 'StartTime' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-11-30T05:33:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC858082-736F-4A25-867B-E5B67C85ACF7', + ], + 'DomainName' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'example' => 'example.com,example.aliyundoc.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔。单位：秒。默认值为60。', + 'type' => 'string', + 'example' => '60', + ], + 'RealTimeHttpCodeData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UsageData' => [ + 'description' => '每个时间间隔的HTTP返回码占比数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2015-11-30T05:39:00Z', + ], + 'Value' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RealTimeCodeProportionData' => [ + 'description' => '各返回码占比使用数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'Http返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'Proportion' => [ + 'description' => '响应数量占比。', + 'type' => 'string', + 'example' => '66.046511627907', + ], + 'Count' => [ + 'description' => '响应数量。', + 'type' => 'string', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified StartTime is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified EndTime is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified StartTime is invalid.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2015-11-30T05:40:00Z\\",\\n \\"StartTime\\": \\"2015-11-30T05:33:00Z\\",\\n \\"RequestId\\": \\"BC858082-736F-4A25-867B-E5B67C85ACF7\\",\\n \\"DomainName\\": \\"example.com,example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"60\\",\\n \\"RealTimeHttpCodeData\\": {\\n \\"UsageData\\": [\\n {\\n \\"TimeStamp\\": \\"2015-11-30T05:39:00Z\\",\\n \\"Value\\": {\\n \\"RealTimeCodeProportionData\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Proportion\\": \\"66.046511627907\\",\\n \\"Count\\": \\"20\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveDomainRealTimeHttpCodeDataResponse>\\n<EndTime>2015-11-30T05:40:00Z</EndTime>\\n<RequestId>BC858082-736F-4A25-867B-E5B67C85ACF7</RequestId>\\n<DomainName>example.com,example.aliyundoc.com</DomainName>\\n<DataInterval>60</DataInterval>\\n<StartTime>2015-11-30T05:33:00Z</StartTime>\\n<RealTimeHttpCodeData>\\n <UsageData>\\n <TimeStamp>2015-11-30T05:39:00Z</TimeStamp>\\n <Value>\\n <RealTimeCodeProportionData>\\n <Proportion>66.046511627907</Proportion>\\n <Count>20</Count>\\n <Code>200</Code>\\n </RealTimeCodeProportionData>\\n </Value>\\n </UsageData>\\n</RealTimeHttpCodeData>\\n</DescribeLiveDomainRealTimeHttpCodeDataResponse>","errorExample":"{\\n \\"RealTimeHttpCodeData\\": {\\n \\"UsageData\\": [\\n {\\n \\"TimeStamp\\": \\"2015-11-30T05:40:00Z\\",\\n \\"Value\\": {\\n \\"RealTimeCodeProportionData\\": [\\n {\\n \\"Proportion\\": \\"66.046511627907\\",\\n \\"Code\\": \\"200\\"\\n },\\n {\\n \\"Proportion\\": \\"4.72868217054264\\",\\n \\"Code\\": \\"206\\"\\n },\\n {\\n \\"Proportion\\": \\"0.155038759689922\\",\\n \\"Code\\": \\"302\\"\\n },\\n {\\n \\"Proportion\\": \\"0.62015503875969\\",\\n \\"Code\\": \\"304\\"\\n },\\n {\\n \\"Proportion\\": \\"28.4496124031008\\",\\n \\"Code\\": \\"500\\"\\n }\\n ]\\n }\\n },\\n {\\n \\"TimeStamp\\": \\"2015-11-30T05:39:00Z\\",\\n \\"Value\\": {\\n \\"RealTimeCodeProportionData\\": [\\n {\\n \\"Proportion\\": \\"66.046511627907\\",\\n \\"Code\\": \\"200\\"\\n },\\n {\\n \\"Proportion\\": \\"4.72868217054264\\",\\n \\"Code\\": \\"206\\"\\n },\\n {\\n \\"Proportion\\": \\"0.155038759689922\\",\\n \\"Code\\": \\"302\\"\\n },\\n {\\n \\"Proportion\\": \\"0.62015503875969\\",\\n \\"Code\\": \\"304\\"\\n },\\n {\\n \\"Proportion\\": \\"28.4496124031008\\",\\n \\"Code\\": \\"500\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"DataInterval\\": \\"60\\",\\n \\"RequestId\\": \\"BC858082-736F-4A25-867B-E5B67C85ACF7\\",\\n \\"DomainName\\": \\"test.com,abc.com\\",\\n \\"EndTime\\": \\"2015-11-30T05:40:00Z\\",\\n \\"StartTime\\": \\"2015-11-30T05:33:00Z\\"\\n}"}]', + 'title' => '查询直播域名实时HTTP返回码占比', + 'description' => '本接口支持查询的数据时间粒度：'."\n" + .'|时间粒度|单次查询的最大时间跨度|可查询历史时间范围|数据延迟|'."\n" + .'|-----|------|-------|-------|'."\n" + .'|1分钟|1小时|7天|5分钟|'."\n" + .'|5分钟|3天|93天|15分钟|'."\n" + .'|1小时|31天|186天|通常4小时|'."\n" + .'|1天|无限制|366天|次日4点以后|'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamHistoryUserNum' => [ + 'summary' => '调用DescribeLiveStreamHistoryUserNum查询直播流历史在线人数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> 支持最大的查询范围是最近**30**天。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。需晚于开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> StartTime和EndTime时间间隔在一天内，且EndTime不超过当前时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F5FF8', + ], + 'LiveStreamUserNumInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveStreamUserNumInfo' => [ + 'description' => '直播流历史在线人数信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserNum' => [ + 'description' => '当前时间点人数。', + 'type' => 'string', + 'example' => '1', + ], + 'StreamTime' => [ + 'description' => '流时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-10-20T06:20:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time or current time.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F5FF8\\",\\n \\"LiveStreamUserNumInfos\\": {\\n \\"LiveStreamUserNumInfo\\": [\\n {\\n \\"UserNum\\": \\"1\\",\\n \\"StreamTime\\": \\"2017-10-20T06:20:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveStreamHistoryUserNumResponse>\\n<LiveStreamUserNumInfos>\\n <LiveStreamUserNumInfo>\\n <StreamTime>2017-10-20T06:20:00Z</StreamTime>\\n <UserNum>1</UserNum>\\n </LiveStreamUserNumInfo>\\n</LiveStreamUserNumInfos>\\n<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F5FF8</RequestId>\\n</DescribeLiveStreamHistoryUserNumResponse>","errorExample":"{\\n \\"LiveStreamUserNumInfos\\":{\\n \\"LiveStreamUserNumInfo\\":[\\n {\\n \\"StreamTime\\":\\"2017-10-20T06:20:00Z\\",\\n \\"UserNum\\":0\\n },\\n {\\n \\"StreamTime\\":\\"2017-10-20T06:19:00Z\\",\\n \\"UserNum\\":0\\n },\\n {\\n \\"StreamTime\\":\\"2017-10-20T06:18:00Z\\",\\n \\"UserNum\\":15\\n },\\n {\\n \\"StreamTime\\":\\"2017-10-20T06:17:00Z\\",\\n \\"UserNum\\":0\\n },\\n {\\n \\"StreamTime\\":\\"2017-10-20T06:16:00Z\\",\\n \\"UserNum\\":0\\n },\\n {\\n \\"StreamTime\\":\\"2017-10-20T06:15:00Z\\",\\n \\"UserNum\\":6\\n },\\n {\\n \\"StreamTime\\":\\"2017-10-20T06:14:00Z\\",\\n \\"UserNum\\":0\\n }\\n ]\\n },\\n \\"RequestId\\":\\"16A96B9A-F203-4EC5-8E43-CB92E68F5FF8\\"\\n}"}]', + 'title' => '查询直播流历史在线人数', + 'description' => '- 调用本接口查询直播流历史在线人数，整体数据延时2~5分钟。'."\n" + ."\n" + .'- 该接口仅支持查询FLV和RTMP流的历史在线人数。'."\n" + ."\n" + .'- 该接口不支持查询转码流的播放人数。'."\n" + ."\n\n" + .'## QPS限制'."\n" + ."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamCount' => [ + 'summary' => '获取直播流的实时在线原始流和转码流流数信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。'."\n" + .'> - 传入DomainName时，请保证传入域名为直播域名，同时调用本接口的用户拥有传入域名的操作权限。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FCFFE4A4-F34F-4EEF-B401-36A01689AFBC', + ], + 'StreamCountInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StreamCountInfo' => [ + 'description' => '流信息统计内容。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => ' 实时流类型。取值：'."\n" + ."\n" + .'- **raw**：原始流。'."\n" + .'- **trans**：转码流。', + 'type' => 'string', + 'example' => 'raw', + ], + 'Count' => [ + 'description' => '在线流数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'Limit' => [ + 'description' => '并发推流数量限制，只有白名单用户才显示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'StreamCountDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StreamCountDetail' => [ + 'description' => '流统计信息详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VideoDataRate' => [ + 'description' => '视频码率，该字段只有转码流数量统计时才有。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '390', + ], + 'Format' => [ + 'description' => '视频编码格式。取值：'."\n" + ."\n" + .'- **h264**。'."\n" + .'- **h265**。', + 'type' => 'string', + 'example' => 'h264', + ], + 'Count' => [ + 'description' => '在线流数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FCFFE4A4-F34F-4EEF-B401-36A01689AFBC\\",\\n \\"StreamCountInfos\\": {\\n \\"StreamCountInfo\\": [\\n {\\n \\"Type\\": \\"raw\\",\\n \\"Count\\": 3,\\n \\"Limit\\": 10,\\n \\"StreamCountDetails\\": {\\n \\"StreamCountDetail\\": [\\n {\\n \\"VideoDataRate\\": 390,\\n \\"Format\\": \\"h264\\",\\n \\"Count\\": 2\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamCountResponse>\\n <RequestId>FCFFE4A4-F34F-4EEF-B401-36A01689AFBC</RequestId>\\n <StreamCountInfos>\\n <Type>raw</Type>\\n <Count>3</Count>\\n <Limit>10</Limit>\\n <StreamCountDetails>\\n <VideoDataRate>390</VideoDataRate>\\n <Format>h264</Format>\\n <Count>2</Count>\\n </StreamCountDetails>\\n </StreamCountInfos>\\n</DescribeLiveStreamCountResponse>","errorExample":""}]', + 'title' => '查询在线直播流数量', + 'description' => '先获取主播流域名，再调用本接口获取直播流的实时在线原始流和转码流流数信息。调用接口返回的视频编码格式为h264和h265。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为1次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamTranscodeStreamNum' => [ + 'summary' => '调用DescribeLiveStreamTranscodeStreamNum实时查询转码流路数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107109', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'SplitType', + 'in' => 'query', + 'schema' => [ + 'description' => '分组类型。'."\n" + .'* 域名（默认）'."\n" + .'* 模板', + 'type' => 'string', + 'required' => false, + 'example' => 'template', + 'default' => 'domain', + 'enum' => [ + 'domain', + 'template', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'UntranscodeNumber' => [ + 'description' => '未转码流数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '27', + ], + 'LazyTranscodedNumber' => [ + 'description' => '触发转码流数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TranscodedNumber' => [ + 'description' => '转码流数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '150191A4-DD88-5941-B48C-9DF59E0A8B1F', + ], + 'Total' => [ + 'description' => '转码流数量总和。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '57', + ], + 'TranscodeStreamCountDetails' => [ + 'description' => '转码模板数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Template' => [ + 'description' => '转码模板名。', + 'type' => 'string', + 'example' => 'template_name', + ], + 'Count' => [ + 'description' => '转码模板流数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"UntranscodeNumber\\": 27,\\n \\"LazyTranscodedNumber\\": 10,\\n \\"TranscodedNumber\\": 30,\\n \\"RequestId\\": \\"150191A4-DD88-5941-B48C-9DF59E0A8B1F\\",\\n \\"Total\\": 57,\\n \\"TranscodeStreamCountDetails\\": [\\n {\\n \\"Template\\": \\"template_name\\",\\n \\"Count\\": 30\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamTranscodeStreamNumResponse>\\n <UntranscodeNumber>27</UntranscodeNumber>\\n <LazyTranscodedNumber>10</LazyTranscodedNumber>\\n <TranscodedNumber>30</TranscodedNumber>\\n <RequestId>150191A4-DD88-5941-B48C-9DF59E0A8B1F</RequestId>\\n <Total>57</Total>\\n</DescribeLiveStreamTranscodeStreamNumResponse>","errorExample":""}]', + 'title' => '获取直播流转码流数量', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveDomainPvUvData' => [ + 'summary' => '查询指定直播域名的PV、UV数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107030', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。'."\n" + .'> - 传入DomainName时，请保证传入域名为直播域名，同时调用本接口的用户拥有传入域名的操作权限。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ssZ</i>（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-03-17T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，需晚于起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ssZ</i>（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-03-20T16:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '直播域名的PV、UV数据。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ssZ</i>（UTC时间）。', + 'type' => 'string', + 'example' => '2018-03-20T16:00:00Z', + ], + 'StartTime' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ssZ</i>（UTC时间）。', + 'type' => 'string', + 'example' => '2018-03-17T16:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E9D3257A-1B7C-414C-90C1-8D07AC47BCAC', + ], + 'DomainName' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔。单位：秒。固定值为3600。', + 'type' => 'string', + 'example' => '3600', + ], + 'PvUvDataInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PvUvDataInfo' => [ + 'description' => 'PV、UV数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'pv、uv数据列表。', + 'type' => 'object', + 'properties' => [ + 'PV' => [ + 'description' => 'PV数据。', + 'type' => 'string', + 'example' => '3036', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ssZ</i>（UTC时间）。', + 'type' => 'string', + 'example' => '2018-03-19T16:00:00Z', + ], + 'UV' => [ + 'description' => 'UV数据。', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidTime.ValueNotSupported', + 'errorMessage' => 'Specified Time is malformed.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2018-03-20T16:00:00Z\\",\\n \\"StartTime\\": \\"2018-03-17T16:00:00Z\\",\\n \\"RequestId\\": \\"E9D3257A-1B7C-414C-90C1-8D07AC47BCAC\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"PvUvDataInfos\\": {\\n \\"PvUvDataInfo\\": [\\n {\\n \\"PV\\": \\"3036\\",\\n \\"TimeStamp\\": \\"2018-03-19T16:00:00Z\\",\\n \\"UV\\": \\"2\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveDomainPvUvDataResponse>\\n<EndTime>2018-03-20T16:00:00Z</EndTime>\\n<RequestId>E9D3257A-1B7C-414C-90C1-8D07AC47BCAC</RequestId>\\n<DomainName>example.com</DomainName>\\n<DataInterval>3600</DataInterval>\\n<StartTime>2018-03-17T16:00:00Z</StartTime>\\n<PvUvDataInfos>\\n <PvUvDataInfo>\\n <UV>2</UV>\\n <PV>3036</PV>\\n <TimeStamp>2018-03-19T16:00:00Z</TimeStamp>\\n </PvUvDataInfo>\\n</PvUvDataInfos>\\n</DescribeLiveDomainPvUvDataResponse>","errorExample":""}]', + 'title' => '查询直播域名PV/UV数据', + 'description' => '- 调用本接口可以观看视频用户所在地域分布、观看各个加速域名的访问排名、统计当前域名下一定时间段内独立请求的IP次数。'."\n" + .'- 不指定StartTime和EndTime时，默认读取过去24小时的数据，同时支持按指定的起止时间查询。'."\n" + .'- 不支持批量域名查询。'."\n" + .'- 最多可获取最近90天的数据。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 特殊错误码'."\n" + .'|错误代码|描述|HTTP 状态码|语义|'."\n" + .'|--------|--------|----|----|'."\n" + .'|Throttling|Request was denied due to request throttling.|503|请求因流量控制被限制。|'."\n" + .'|InvalidDomain.NotFound|The domain provided does not belong to you.|404|域名不存在或不属于当前用户。|'."\n" + .'|InvalidTime.ValueNotSupported|Specified Time is malformed.|400|EndTime和StartTime差值超过90天或时间参数错误。|', + ], + 'DescribeLiveTopDomainsByFlow' => [ + 'summary' => '调用DescribeLiveTopDomainsByFlow获取用户按流量排名的域名。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。'."\n" + .'格式为：YYYY-MM-DDThh:mm:ssZ（UTC时间）。最小数据粒度为5分钟，不写默认读取当月数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-03-17T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间需大于起始时间。日期格式按照ISO8601表示法，并使用UTC时间。'."\n" + .'格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-03-20T16:00:00Z', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '获取域名数量限制。默认为20，取值支持1~100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DomainOnlineCount' => [ + 'description' => '账户下正在运行域名总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2018-03-20T16:00:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2018-03-17T16:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '33834C3E-388E-5FFE-A8AE-63575035C064', + ], + 'DomainCount' => [ + 'description' => '账户下域名总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TopDomains' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TopDomain' => [ + 'description' => '域名排名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名排名列表。', + 'type' => 'object', + 'properties' => [ + 'MaxBps' => [ + 'description' => '带宽峰值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22139626', + ], + 'Rank' => [ + 'description' => '排名。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalAccess' => [ + 'description' => '访问次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '107784230', + ], + 'TrafficPercent' => [ + 'description' => '流量占比。', + 'type' => 'string', + 'example' => '30.64191989360235', + ], + 'DomainName' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'TotalTraffic' => [ + 'description' => '总流量。', + 'type' => 'string', + 'example' => '2043859876683.9001', + ], + 'MaxBpsTime' => [ + 'description' => '带宽峰值时刻。', + 'type' => 'string', + 'example' => '1457111400', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DomainOnlineCount\\": 1,\\n \\"EndTime\\": \\"2018-03-20T16:00:00Z\\",\\n \\"StartTime\\": \\"2018-03-17T16:00:00Z\\",\\n \\"RequestId\\": \\"33834C3E-388E-5FFE-A8AE-63575035C064\\",\\n \\"DomainCount\\": 1,\\n \\"TopDomains\\": {\\n \\"TopDomain\\": [\\n {\\n \\"MaxBps\\": 22139626,\\n \\"Rank\\": 1,\\n \\"TotalAccess\\": 107784230,\\n \\"TrafficPercent\\": \\"30.64191989360235\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"TotalTraffic\\": \\"2043859876683.9001\\",\\n \\"MaxBpsTime\\": \\"1457111400\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveTopDomainsByFlowResponse>\\n <DomainOnlineCount>1</DomainOnlineCount>\\n <EndTime>2018-03-20T16:00:00Z</EndTime>\\n <StartTime>2018-03-17T16:00:00Z</StartTime>\\n <RequestId>33834C3E-388E-5FFE-A8AE-63575035C064</RequestId>\\n <DomainCount>1</DomainCount>\\n <TopDomains>\\n <MaxBps>22139626</MaxBps>\\n <Rank>1</Rank>\\n <TotalAccess>107784230</TotalAccess>\\n <TrafficPercent>30.64191989360235</TrafficPercent>\\n <DomainName>example.com</DomainName>\\n <TotalTraffic>2043859876683.9001</TotalTraffic>\\n <MaxBpsTime>1457111400</MaxBpsTime>\\n </TopDomains>\\n</DescribeLiveTopDomainsByFlowResponse>","errorExample":""}]', + 'title' => '获取流最多域名', + 'description' => '- 不指定StartTime和EndTime时，默认读取当月的数据，同时支持按指定的起止时间查询，两者需要同时指定。'."\n" + .'- 最多可获取90天的数据。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveStreamsTotalCount' => [ + 'summary' => '调用DescribeLiveStreamsTotalCount接口获取天粒度累计直播流路数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名或播放域名，查域名级别数据时必传。最多支持10个域名批量查询，多个域名用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Typ', + 'in' => 'query', + 'schema' => [ + 'description' => '不传，默认查域名级别的数据。传aliuid查UID维度的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliuid', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'> 支持最大的查询范围是最近1.5年。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-07-24T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。需晚于开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'> StartTime和EndTime时间间隔在15天内，且EndTime不超过当前时间。当天数据第二天才查询。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-07-25T16:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'String FCFFE4A4-F34F-4EEF-B401-36A01689AFBC', + ], + 'StreamCountList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StreamCountInfos' => [ + 'description' => '流信息统计内容。', + 'type' => 'array', + 'items' => [ + 'description' => '统计内容详情。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '累计直播流数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '934', + ], + 'Timestamp' => [ + 'description' => '时间。', + 'type' => 'string', + 'example' => '2023-07-24T16:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + [ + 'errorCode' => 'Duration.Exceed', + 'errorMessage' => 'Duration between StartTime and EndTime is too long.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not belong to you.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"String\\\\tFCFFE4A4-F34F-4EEF-B401-36A01689AFBC\\",\\n \\"StreamCountList\\": {\\n \\"StreamCountInfos\\": [\\n {\\n \\"Count\\": 934,\\n \\"Timestamp\\": \\"2023-07-24T16:00:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamsTotalCountResponse>\\n <RequestId>String\\tFCFFE4A4-F34F-4EEF-B401-36A01689AFBC</RequestId>\\n <StreamCountList>\\n <Count>934</Count>\\n <Timestamp>2023-07-24T16:00:00Z</Timestamp>\\n </StreamCountList>\\n</DescribeLiveStreamsTotalCountResponse>","errorExample":""}]', + 'title' => '获取天粒度累计直播流路数', + 'description' => '- 最大查询时间跨度：15天。'."\n" + .'- 最大查询时间范围：最长可查近1.5年的数据。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'extraInfo' => '| 错误代码 | 描述 | HTTP状态码 | 语义|'."\n" + .'| :-----| :-----| :---- |:----|'."\n" + .'| InvalidStartTime.Malformed | Specified StartTime is malformed. |400|开始时间错误 |'."\n" + .'| InvalidEndTime.Malformed |Specified EndTime is malformed. |400 | 结束时间错误|'."\n" + .'| MissingDomainName | DomainName is mandatory for this action. | 400 | 缺少DomainName值 |'."\n" + .'|InvalidParam |Parameter invalid. | 400 |参数错误 |'."\n" + .'| Duration.Exceed |Duration between StartTime and EndTime is too long. | 400 | 查询的时间段过长 |'."\n" + .'|InvalidDomain.NotFound | The domain provided does not belong to you. |404 |域名不存在或不属于当前用户 |'."\n" + .'| InternalError | The request processing has failed due to backend service exception. | 500 | 内部错误|'."\n" + ."\n", + ], + 'DescribeLiveStreamMetricDetailData' => [ + 'summary' => '调用DescribeLiveStreamMetricDetailData查询指定域名流粒度批量数据，单次查询最多返回5000行数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'cn-shenzhen' => 'cn-shenzhen', + ], + 'example' => 'cn-shenzhen', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '- 需要查询的加速域名。仅支持单个域名查询，传多个域名将报错。'."\n" + .'- 不指定AppName和StreamName时，按域名返回所有流粒度的数据。'."\n" + .'- 域名为空时，查询用户下的所有加速域名的聚合数据'."\n" + .'- DomainName不为空且AppName为all和StreamName为all时，返回指定加速域名下的聚合数据。'."\n" + .'- 传入DomainName时，请保证传入域名为直播域名，同时调用本接口的用户拥有传入域名的操作权限。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2015-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间需大于起始时间，不能相差超过1天；日期格式按照ISO8601表示法，并使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2015-12-10T21:00:00Z', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称，查询指定应用流粒度的数据。'."\n" + ."\n" + .'>指定StreamName时，必须指定AppName。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '流名称，按照设置的AppName指定StreamName，返回流粒度的数据。'."\n" + ."\n" + .'> 指定StreamName时，必须指定AppName。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => '流协议名，目前支持：**flv**、**hls**、**rtmp**、**rts**和**p2p**。'."\n" + ."\n" + .'支持查询多个协议的数据，不同协议之间用英文逗号（,）分隔。但多个协议的数据不会聚合，按照流的粒度输出。'."\n" + ."\n" + .'> **rts**选项可查询artc协议的超低延时直播流。'."\n" + .'> - 使用rts可能需要额外统计xxx_AliRTS-opu转码流。原因：Web端播超低延时直播时，会生成流名后加上_AliRTS-opus后缀的转码流进行自动转码，产生转码流数据。详细请参见[rts亚秒延时自动转码](~~2948703~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'flv', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询token，每次查询最多返回5000行数据，当要查询的数据超过5000行时，响应数据会提供下次查询数据的起始索引。请求时传入该token，将从上一次查询结束的下一行继续查询未获取的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'UjsM9x3aVcJi9a0-ArwJUTTC67CIBKLw*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '查询数据。', + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '查询的加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2015-12-10T21:00:00Z', + ], + 'NextPageToken' => [ + 'description' => '下一次返回数据的起始索引，当查询的数据未获取完时返回该值。', + 'type' => 'string', + 'example' => 'UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=', + ], + 'PageSize' => [ + 'description' => '返回数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5000', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B955107D-E658-4E77-B913-E0AC3D31693E', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + 'StreamDetailData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StreamData' => [ + 'description' => '返回数据组。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据组。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'app', + ], + 'Bps' => [ + 'description' => '流每分钟平均带宽，单位：bps。', + 'type' => 'number', + 'format' => 'float', + 'example' => '423304182.66', + ], + 'Count' => [ + 'description' => '流每分钟总在线人数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '423304182', + ], + 'FlvBps' => [ + 'description' => 'FLV协议带宽，单位：bps。'."\n" + ."\n" + .'> 指定协议不满足时，不返回。', + 'type' => 'number', + 'format' => 'float', + 'example' => '454', + ], + 'FlvCount' => [ + 'description' => 'FLV协议在线人数。'."\n" + ."\n" + .'> 指定协议不满足时，不返回。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'FlvTraffic' => [ + 'description' => 'FLV协议流量，单位：Byte。'."\n" + ."\n" + .'> 指定协议不满足时，不返回。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1254', + ], + 'HlsBps' => [ + 'description' => 'HLS协议带宽，单位：bps。'."\n" + ."\n" + .'> 指定协议不满足时，不返回。', + 'type' => 'number', + 'format' => 'float', + 'example' => '4456', + ], + 'HlsCount' => [ + 'description' => 'HLS协议在线人数。'."\n" + ."\n" + .'> 目前不支持。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '56', + ], + 'HlsTraffic' => [ + 'description' => 'HLS协议流量，单位：Byte。'."\n" + ."\n" + .'> 指定协议不满足时，不返回。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '568', + ], + 'NewConns' => [ + 'description' => '流每分钟新建连接数。', + 'type' => 'string', + 'example' => '450', + ], + 'P2pBps' => [ + 'description' => 'P2P协议带宽，单位：bps。'."\n" + ."\n" + .'>指定协议不满足时，不返回.', + 'type' => 'number', + 'format' => 'float', + 'example' => '6845', + ], + 'P2pCount' => [ + 'description' => 'P2P协议在线人数。'."\n" + ."\n" + .'> 指定协议不满足时，不返回。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '78', + ], + 'P2pTraffic' => [ + 'description' => 'P2P协议流量，单位：Byte。'."\n" + ."\n" + .'> 指定协议不满足时，不返回。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4102', + ], + 'RtmpBps' => [ + 'description' => 'RTMP协议带宽，单位：bps。'."\n" + ."\n" + .'>指定协议不满足时，不返回。', + 'type' => 'number', + 'format' => 'float', + 'example' => '3323', + ], + 'RtmpCount' => [ + 'description' => 'RTMP协议在线人数。'."\n" + ."\n" + .'> 指定协议不满足时，不返回。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '63', + ], + 'RtmpTraffic' => [ + 'description' => 'RTMP协议流量，单位：Byte。'."\n" + ."\n" + .'> 指定协议不满足时，不返回。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5568', + ], + 'RtsBps' => [ + 'description' => 'RTS协议带宽，单位：bps。'."\n" + ."\n" + .'> 指定协议不满足时，不返回。', + 'type' => 'number', + 'format' => 'float', + 'example' => '2361', + ], + 'RtsCount' => [ + 'description' => 'RTS协议在线人数。'."\n" + ."\n" + .'> 指定协议不满足时，不返回。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '89', + ], + 'RtsTraffic' => [ + 'description' => 'RTS协议流量，单位：Byte。'."\n" + ."\n" + .'> 指定协议不满足时，不返回。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2322', + ], + 'StreamName' => [ + 'description' => '流名称。', + 'type' => 'string', + 'example' => 'test.flv', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + 'Traffic' => [ + 'description' => '流每分钟总流量，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '423304182', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidPageToken', + 'errorMessage' => 'The token of page is invalid.', + ], + [ + 'errorCode' => 'InvalidAppName.Mismatch', + 'errorMessage' => 'The AppName param must be passed.', + ], + [ + 'errorCode' => 'InvalidStreamProtocol.NotSupport', + 'errorMessage' => 'The specified stream protocol is not support.', + ], + [ + 'errorCode' => 'InvalidStreamName.LengthTooLong', + 'errorMessage' => 'The specified stream name is too long.', + ], + [ + 'errorCode' => 'InvalidAppName.LengthTooLong', + 'errorMessage' => 'The specified app name is too long.', + ], + [ + 'errorCode' => 'InvalidTime.ValueNotSupported', + 'errorMessage' => 'Specified Time is malformed.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DomainName\\": \\"example.com\\",\\n \\"EndTime\\": \\"2015-12-10T21:00:00Z\\",\\n \\"NextPageToken\\": \\"UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=\\",\\n \\"PageSize\\": 5000,\\n \\"RequestId\\": \\"B955107D-E658-4E77-B913-E0AC3D31693E\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"StreamDetailData\\": {\\n \\"StreamData\\": [\\n {\\n \\"AppName\\": \\"app\\",\\n \\"Bps\\": 423304182.66,\\n \\"Count\\": 423304182,\\n \\"FlvBps\\": 454,\\n \\"FlvCount\\": 32,\\n \\"FlvTraffic\\": 1254,\\n \\"HlsBps\\": 4456,\\n \\"HlsCount\\": 56,\\n \\"HlsTraffic\\": 568,\\n \\"NewConns\\": \\"450\\",\\n \\"P2pBps\\": 6845,\\n \\"P2pCount\\": 78,\\n \\"P2pTraffic\\": 4102,\\n \\"RtmpBps\\": 3323,\\n \\"RtmpCount\\": 63,\\n \\"RtmpTraffic\\": 5568,\\n \\"RtsBps\\": 2361,\\n \\"RtsCount\\": 89,\\n \\"RtsTraffic\\": 2322,\\n \\"StreamName\\": \\"test.flv\\",\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\",\\n \\"Traffic\\": 423304182\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamMetricDetailDataResponse>\\n <EndTime>2015-12-10T21:00:00Z</EndTime>\\n <StartTime>2015-12-10T20:00:00Z</StartTime>\\n <RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>\\n <NextPageToken>UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=</NextPageToken>\\n <PageSize>5000</PageSize>\\n <DomainName>example.com</DomainName>\\n <StreamDetailData>\\n <P2pTraffic>4102</P2pTraffic>\\n <RtmpBps>3323</RtmpBps>\\n <HlsBps>4456</HlsBps>\\n <P2pBps>6845</P2pBps>\\n <StreamName>test.flv</StreamName>\\n <P2pCount>78</P2pCount>\\n <Traffic>423304182</Traffic>\\n <RtmpCount>63</RtmpCount>\\n <RtsCount>89</RtsCount>\\n <RtsBps>2361</RtsBps>\\n <Bps>423304192</Bps>\\n <HlsTraffic>568</HlsTraffic>\\n <FlvBps>454</FlvBps>\\n <Count>423304182</Count>\\n <RtsTraffic>2322</RtsTraffic>\\n <RtmpTraffic>5568</RtmpTraffic>\\n <HlsCount>56</HlsCount>\\n <AppName>app</AppName>\\n <FlvCount>32</FlvCount>\\n <FlvTraffic>1254</FlvTraffic>\\n <TimeStamp>2015-12-10T20:00:00Z</TimeStamp>\\n <NewConns>450</NewConns>\\n </StreamDetailData>\\n</DescribeLiveStreamMetricDetailDataResponse>","errorExample":""}]', + 'title' => '查询指定域名流粒度批量数据', + 'description' => '若指定域名第一次使用此接口进行流粒度数据的查询，需先<props="china">[提交工单](https://workorder.console.aliyun.com/console.htm#/ticket/add?productCode=live&commonQuestionId=4545&isSmart=true&iatraceid=1608439120675-2a5c48de0b84805313c708&channel=selfservice)</props><props="intl">[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.12818093.nav-right.dticket.6cb216d07otFWR#/ticket/createIndex)</props>进行后端配置后方可使用。'."\n" + .'请在工单中提供如下信息：'."\n" + .'- 需要查询的域名。'."\n" + .'- 对应域名下最高并发直播流数。'."\n" + .'- 每个直播流最高并发在线人数。'."\n" + .'- 对应客户端请求包含的协议类型。'."\n" + ."\n" + .'><notice>当前接口将于2025年9月31号不再进行维护，请及时切换到新版流粒度接口[DescribeLiveUserStreamMetricData](~~2948552~~)，新版流粒度接口无需后台配置即可使用。></notice>'."\n" + ."\n\n" + .'## 使用限制'."\n" + .'- 默认不支持HLS的在线人数统计。'."\n" + ."\n" + .'- 仅支持单个域名查询。'."\n" + ."\n" + .'- 数据最大查询跨度：24小时。'."\n" + ."\n" + .'- 数据最小查询粒度：1分钟。'."\n" + ."\n" + .'- 数据最大查询范围：31天。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveStreamDetailFrameRateAndBitRateData' => [ + 'summary' => '查询RTMP协议直播流的详细音视频帧率码率。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215287', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '您的推流域名或播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'AppName', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'exampleStreamName', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> StartTime 和 EndTime 指定不合法，或者不指定 StartTime 和 EndTime 时，默认读取过去 1 小时的数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'FrameRateAndBitRateInfos' => [ + 'description' => '每个时间间隔的详细音视频帧率码率数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AudioBitRate' => [ + 'description' => '直播流的音频码率。单位：Bps。', + 'type' => 'number', + 'format' => 'float', + 'example' => '200', + ], + 'AudioFrameRate' => [ + 'description' => '直播流的音频帧率。单位：FPS。', + 'type' => 'number', + 'format' => 'float', + 'example' => '60', + ], + 'BitRate' => [ + 'description' => '直播流的码率。单位：Bps。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1420', + ], + 'StreamUrl' => [ + 'description' => '直播流的URL。', + 'type' => 'string', + 'example' => 'rtmp://example.com/AppName/exampleStreamName', + ], + 'Time' => [ + 'description' => '统计时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2016-09-13T16:04:00Z', + ], + 'VideoBitRate' => [ + 'description' => '直播流的视频码率。单位：Bps。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1200', + ], + 'VideoFrameRate' => [ + 'description' => '直播流的视频帧率。单位：FPS。', + 'type' => 'number', + 'format' => 'float', + 'example' => '30', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC858082-736F-4A25-867B-E5B67C85ACF7', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"FrameRateAndBitRateInfos\\": [\\n {\\n \\"AudioBitRate\\": 200,\\n \\"AudioFrameRate\\": 60,\\n \\"BitRate\\": 1420,\\n \\"StreamUrl\\": \\"rtmp://example.com/AppName/exampleStreamName\\",\\n \\"Time\\": \\"2016-09-13T16:04:00Z\\",\\n \\"VideoBitRate\\": 1200,\\n \\"VideoFrameRate\\": 30\\n }\\n ],\\n \\"RequestId\\": \\"BC858082-736F-4A25-867B-E5B67C85ACF7\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamDetailFrameRateAndBitRateDataResponse>\\n <FrameRateAndBitRateInfos>\\n <AudioBitRate>200</AudioBitRate>\\n <AudioFrameRate>60</AudioFrameRate>\\n <BitRate>1420</BitRate>\\n <StreamUrl>rtmp://example.com/AppName/exampleStreamName</StreamUrl>\\n <Time>2016-09-13T16:04:00Z</Time>\\n <VideoBitRate>1200</VideoBitRate>\\n <VideoFrameRate>30</VideoFrameRate>\\n </FrameRateAndBitRateInfos>\\n <RequestId>BC858082-736F-4A25-867B-E5B67C85ACF7</RequestId>\\n</DescribeLiveStreamDetailFrameRateAndBitRateDataResponse>","errorExample":""}]', + 'title' => '查询RTMP协议直播流的详细音视频帧率码率', + 'description' => '- 调用本接口查询RTMP协议的直播流在设置时间范围内的一组音视频帧率和音视频码率。'."\n" + .'- 本接口为监控数据接口，数据采集处理方式不同于计费，不能用于计算用量进行对账参考。'."\n" + .'- 适用于获取90天内的历史数据。'."\n" + .'- 接口数据延时在3-5分钟。'."\n" + .'- 单次请求的时间跨度最大为1小时。', + 'responseParamsDescription' => '> 直播流的总码率与音频码率、视频码率的计算采集方式是不同的，音频码率与视频码率的数值之和不一定与总码率相等。本接口返回数据仅用于参考和监控之用，不能用于计算用量和对账。', + ], + 'DescribeLiveUserStreamMetricData' => [ + 'summary' => '用于查询指定加速域名下的流粒度批量数据，支持多种协议。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214643', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的加速域名。'."\n" + ."\n\n" + .'> 仅支持单个域名查询，传多个域名将报错。域名为空时，查询用户下的所有加速域名的聚合数据。不指定 `AppName` 和 `StreamName` 时，按域名返回所有流粒度的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'test.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点，日期格式按照 ISO8601 表示法，并使用 UTC 时间。格式为：`YYYY-MM-DDThh:mm:ssZ`。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2015-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间需大于起始时间，不能相差超过 1 天；日期格式按照 ISO8601 表示法，并使用 UTC 时间。格式为：`YYYY-MM-DDThh:mm:ssZ`。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2015-12-10T21:00:00Z', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。指定应用名称，查询对应应用流粒度的数据；指定 `StreamName` 时，必须指定 `AppName`。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'app', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '流名称。指定 `StreamName` 时，按指定 `AppName` 的指定 `StreamName`，返回流粒度的数据（指定 `StreamName` 时，必须指定 `AppName`）。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test.flv', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => '流协议名。指定流协议名查询流对应协议的数据，目前支持：`flv`, `hls`, `rtmp`, `rts`, `p2p`。支持查询多个协议的数据，协议间用 `,` 分隔，多个协议的数据不会聚合，按照流的粒度输出。'."\n" + .'> **rts**选项可查询artc协议的超低延时直播流。'."\n" + .'> - 使用rts可能需要额外统计xxx_AliRTS-opu转码流。原因：Web端播超低延时直播时，会生成流名后加上_AliRTS-opus后缀的转码流进行自动转码，产生转码流数据。详细请参见[rts亚秒延时自动转码](~~2948703~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'flv', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '单页数据条数，单页最大5000'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'test.com', + ], + 'EndTime' => [ + 'description' => 'YYYY-MM-DDThh:mm:ssZ'."\n", + 'type' => 'string', + 'example' => '2015-12-10T21:00:00Z', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + 'StartTime' => [ + 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。格式为：`YYYY-MM-DDThh:mm:ssZ`'."\n", + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + 'StreamDetailData' => [ + 'description' => '每个时间间隔的流量数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据组。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '应用名称，无论是否指定均返回该值。', + 'type' => 'string', + 'example' => 'app', + ], + 'Bps' => [ + 'description' => '流每分钟总带宽，单位`bps`。', + 'type' => 'number', + 'format' => 'float', + 'example' => '423304182.66', + ], + 'Count' => [ + 'description' => '流每分钟总在并发连接数。'."\n" + ."\n" + .'> **并发连接数**指单位时间内同一个流下对客户端进程连接数的统计。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '423304182', + ], + 'FlvBps' => [ + 'description' => 'flv协议带宽，单位bps （指定协议不满足时，不返回）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '454', + ], + 'FlvCount' => [ + 'description' => 'flv协议的并发连接数（指定协议不满足时，不返回）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'FlvTraffic' => [ + 'description' => 'flv协议流量，单位byte （指定协议不满足时，不返回）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1254', + ], + 'HlsBps' => [ + 'description' => 'hls协议带宽，单位bps （指定协议不满足时，不返回）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '4456', + ], + 'HlsCount' => [ + 'description' => 'hls协议的并发连接数 （指定协议不满足时，不返回）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '56', + ], + 'HlsTraffic' => [ + 'description' => 'hls协议流量，单位byte （指定协议不满足时，不返回）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '568', + ], + 'NewConns' => [ + 'description' => '流每分钟新建连接数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '450', + ], + 'P2pBps' => [ + 'description' => 'p2p协议带宽，单位bps （指定协议不满足时，不返回）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '6845', + ], + 'P2pCount' => [ + 'description' => 'p2p协议的并发连接数（指定协议不满足时，不返回）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '78', + ], + 'P2pTraffic' => [ + 'description' => 'p2p协议流量，单位byte （指定协议不满足时，不返回）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '4102', + ], + 'RtmpBps' => [ + 'description' => 'rtmp协议带宽，单位bps （指定协议不满足时，不返回）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '3323', + ], + 'RtmpCount' => [ + 'description' => 'rtmp协议的并发连接数（指定协议不满足时，不返回）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '63', + ], + 'RtmpTraffic' => [ + 'description' => 'rtmp协议流量，单位byte （指定协议不满足时，不返回）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '5568', + ], + 'RtsBps' => [ + 'description' => 'rts协议带宽，单位bps （指定协议不满足时，不返回）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2361', + ], + 'RtsCount' => [ + 'description' => 'rts协议的并发连接数 （指定协议不满足时，不返回）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '89', + ], + 'RtsTraffic' => [ + 'description' => 'rts协议流量，单位byte （指定协议不满足时，不返回）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2322', + ], + 'StreamName' => [ + 'description' => '流名称，无论是否指定均返回该值。', + 'type' => 'string', + 'example' => 'test.flv', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + 'Traffic' => [ + 'description' => '流每分钟总流量，单位byte。', + 'type' => 'number', + 'format' => 'double', + 'example' => '423304182', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + '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 \\"DomainName\\": \\"test.com\\",\\n \\"EndTime\\": \\"2015-12-10T21:00:00Z\\",\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\",\\n \\"StartTime\\": \\"2015-12-10T20:00:00Z\\",\\n \\"StreamDetailData\\": [\\n {\\n \\"AppName\\": \\"app\\",\\n \\"Bps\\": 423304182.66,\\n \\"Count\\": 423304182,\\n \\"FlvBps\\": 454,\\n \\"FlvCount\\": 32,\\n \\"FlvTraffic\\": 1254,\\n \\"HlsBps\\": 4456,\\n \\"HlsCount\\": 56,\\n \\"HlsTraffic\\": 568,\\n \\"NewConns\\": 450,\\n \\"P2pBps\\": 6845,\\n \\"P2pCount\\": 78,\\n \\"P2pTraffic\\": 4102,\\n \\"RtmpBps\\": 3323,\\n \\"RtmpCount\\": 63,\\n \\"RtmpTraffic\\": 5568,\\n \\"RtsBps\\": 2361,\\n \\"RtsCount\\": 89,\\n \\"RtsTraffic\\": 2322,\\n \\"StreamName\\": \\"test.flv\\",\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\",\\n \\"Traffic\\": 423304182\\n }\\n ],\\n \\"TotalCount\\": 50,\\n \\"PageNumber\\": 1\\n}","type":"json"}]', + 'title' => '查询指定域名流粒度批量数据', + 'description' => '> 暂不支持HLS协议新建连接数查询，HLS的并发连接数按照默认格式的请求进行统计，特殊格式的请求需<props="china">[提交工单](https://workorder.console.aliyun.com/console.htm#/ticket/add?productCode=live&commonQuestionId=4545&isSmart=true&iatraceid=1608439120675-2a5c48de0b84805313c708&channel=selfservice)</props><props="intl">[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.12818093.nav-right.dticket.6cb216d07otFWR#/ticket/createIndex)</props>进行配置。默认格式如下：'."\n" + .'> - m3u8请求示例：http(s)://example.aliyundoc.com/Appname/ StreamName.m3u8'."\n" + .'> - ts请求示例：http(s)://example.aliyundoc.com/Appname/ StreamName/153xxxxxxxx_137xxxxx.ts'."\n" + .'## 请求说明'."\n" + .'- **单次查询限制**：单次查询最多返回5000行数据。'."\n" + .'- **域名查询限制**：仅支持单个域名查询，多个域名会报错。'."\n" + .'- **时间跨度限制**：数据最大查询跨度为24小时。'."\n" + .'- **时间粒度限制**：数据最小查询粒度为1分钟。'."\n" + .'- **查询范围限制**：数据最大查询范围为31天。'."\n" + .'- **调用频率限制**：单用户调用频率为10次/秒。'."\n" + .'- **特殊参数组合**：当`DomainName`不为空且`AppName`和`StreamName`都设置为`all`时，将返回加速域名下的聚合数据。', + ], + 'DescribeLiveDomainRecordUsageData' => [ + 'summary' => '调用DescribeLiveDomainRecordUsageData查询直播录制路数、转封装用量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的主播流域名。'."\n" + ."\n" + .'- 支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。'."\n" + .'- 若参数为空，默认返回所有直播域名合并后的数据。'."\n" + .'- 传入DomainName时，请保证传入域名为直播域名，同时调用本接口的用户拥有传入域名的操作权限。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'- 最小数据粒度为5分钟。'."\n" + .'- 不填默认读取过去24小时数据。'."\n" + ."\n" + .'>起始时间最早可设置为从当前时间开始的90天内，精确到秒。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-05-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。取值要求：'."\n" + ."\n" + .'- 需晚于起始时间（StartTime)。'."\n" + .'- 结束时间减去起始时间（查询数据的时间跨度）最长31天。超出31天请求失败并报错。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-05-10T21:00:00Z', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '地区。取值：'."\n" + ."\n" + .'- **cn-beijing**：北京'."\n" + ."\n" + .'- **cn-shanghai**：上海'."\n" + ."\n" + .'- **cn-shenzhen**：深圳'."\n" + ."\n" + .'- **cn-qingdao**：青岛'."\n" + ."\n" + .'- **ap-southeast-1**：新加坡'."\n" + ."\n" + .'- **eu-central-1**：德国'."\n" + ."\n" + .'- **ap-northeast-1**：东京'."\n" + ."\n" + .'- **ap-southeast-5**：雅加达', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'SplitBy', + 'in' => 'query', + 'schema' => [ + 'description' => '分组键。取值：'."\n" + ."\n" + .'- **domain**：查询结果按域名分组。'."\n" + .'- **record_fmt**：查询结果按录制类型分组。'."\n" + ."\n" + .'> 可选一个，也可多选。多选时用英文逗号（,）分隔。默认为`domain,record_fmt`。置为空或`null`的时候即不区分上述键。', + 'type' => 'string', + 'required' => false, + 'example' => 'domain,record_fmt', + 'default' => 'record_fmt,domain', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度。单位：秒。取值：'."\n" + ."\n" + .'- 60。'."\n" + ."\n" + .'- 300。'."\n" + ."\n" + .'- 3600。'."\n" + ."\n" + .'- 86400。'."\n" + ."\n" + .'>不传或传值不支持时，查询时间跨度在31天以内的时间粒度默认值为300秒；查询时间跨度大于31天的时间粒度默认值为86400。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2021-05-10T21:00:00Z', + ], + 'StartTime' => [ + 'description' => '起始时间。', + 'type' => 'string', + 'example' => '2021-05-10T20:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4B460F8B-993C-4F48-B98A-910811DEBFEB', + ], + 'RecordUsageData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的录制用量数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '录制文件类型。'."\n" + .'请求参数SplitBy取值包含`record_fmt`时有效。', + 'type' => 'string', + 'example' => 'MP4', + ], + 'Domain' => [ + 'description' => '主播流域名。'."\n" + .'请求参数SplitBy取值包含`domain`时返回。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Region' => [ + 'description' => '地区。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'TimeStamp' => [ + 'description' => '起始时刻。', + 'type' => 'string', + 'example' => '2021-05-10T20:00:00Z', + ], + 'Duration' => [ + 'description' => '录制时长用量，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3560', + ], + 'Count' => [ + 'description' => '峰值路数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidRecordFmt.NotSupported', + 'errorMessage' => 'The RecordFmt parameter is not supported.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2021-05-10T21:00:00Z\\",\\n \\"StartTime\\": \\"2021-05-10T20:00:00Z\\",\\n \\"RequestId\\": \\"4B460F8B-993C-4F48-B98A-910811DEBFEB\\",\\n \\"RecordUsageData\\": {\\n \\"DataModule\\": [\\n {\\n \\"Type\\": \\"MP4\\",\\n \\"Domain\\": \\"example.com\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"TimeStamp\\": \\"2021-05-10T20:00:00Z\\",\\n \\"Duration\\": 3560,\\n \\"Count\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDomainRecordUsageDataResponse>\\n <StartTime>2021-05-10T20:00:00Z</StartTime>\\n <EndTime>2021-05-10T21:00:00Z</EndTime>\\n <RequestId>4B460F8B-993C-4F48-B98A-910811DEBFEB</RequestId>\\n <RecordUsageData>\\n <DataModule>\\n <Type>MP4</Type>\\n <Duration>3560</Duration>\\n <Count>1</Count>\\n <Domain>example.com</Domain>\\n <TimeStamp>2021-05-10T20:00:00Z</TimeStamp>\\n </DataModule>\\n </RecordUsageData>\\n</DescribeLiveDomainRecordUsageDataResponse>","errorExample":""}]', + 'title' => '查询直播录制路数、转封装用量', + 'description' => '- 统计每日录制并发路数、不同时间间隔打点数据。可以用来统计每日并发录制峰值路数、每月并发录制峰值路数。'."\n" + .'- 时移的路数不会被包含在录制路数中重复计算。'."\n" + .'- 支持到域名粒度查询，支持批量域名查询。批量查询时多个域名用英文逗号（,）分隔。'."\n" + ."\n" + .'- 数据粒度1分钟，最长查询跨度24小时，最长保存时间60天。'."\n" + ."\n" + .'- 数据粒度1小时，最长查询跨度31天，最长保存时间180天。'."\n" + ."\n" + .'- 数据粒度1天，最长查询跨度90天，最长保存时间366天。'."\n" + ."\n\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特殊错误码'."\n" + .'| 错误代码 | 描述 | HTTP 状态码 | 语义 |'."\n" + .'|------------|--------|---------|------|'."\n" + .'| Throttling | Request was denied due to request throttling. | 503 | 请求被流量控制限制。|'."\n" + .'| InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不属于当前用户。 |', + ], + 'DescribeLiveDomainSnapshotData' => [ + 'summary' => '调用DescribeLiveDomainSnapshotData查询直播域名截图张数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveMH1XD3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的主播流域名。'."\n" + .'- 支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。'."\n" + .'- 若参数为空，默认返回所有直播域名合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.aliyundoc.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'>支持查询最近**90**天的数据。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2018-01-01T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。需晚于起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2018-01-02T00:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B955107D-E658-4E77-B913-E0AC3D*****', + ], + 'SnapshotDataInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SnapshotDataInfo' => [ + 'description' => '直播截图张数的每日数据统计。', + 'type' => 'array', + 'items' => [ + 'description' => '直播截图张数的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => '日期，具体到天。', + 'type' => 'string', + 'example' => '20180209', + ], + 'Total' => [ + 'description' => '单日截图总张数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '110', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'StartTime or EndTime is mismatch.', + ], + [ + 'errorCode' => 'InvalidParamter', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B955107D-E658-4E77-B913-E0AC3D*****\\",\\n \\"SnapshotDataInfos\\": {\\n \\"SnapshotDataInfo\\": [\\n {\\n \\"Date\\": \\"20180209\\",\\n \\"Total\\": 110\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDomainSnapshotDataResponse>\\n <RequestId>B955107D-E658-4E77-B913-E0AC3D31693F</RequestId>\\n <SnapshotDataInfos>\\n <SnapshotDataInfo>\\n <Date>20180209</Date>\\n <Total>110</Total>\\n </SnapshotDataInfo>\\n </SnapshotDataInfos>\\n</DescribeLiveDomainSnapshotDataResponse>","errorExample":""}]', + 'title' => '查询直播域名截图张数数据', + 'description' => '- 可以用来统计单日截图总张数。'."\n" + .'- 支持查询最近90天的数据。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口无单用户QPS限制，请您根据实际需要合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveDetectPornData' => [ + 'summary' => '调用DescribeLiveDetectPornData获取查询直播审核用量数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的主播流域名。'."\n" + .'- 支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。'."\n" + ."\n" + .'- 若参数为空，默认返回所有直播域名合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> - 最多可获取最近90天的数据。'."\n" + .'- 最小数据粒度为5分钟，取值为空则默认获取最近24小时数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-10T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-10T09:00:00Z', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'Stream', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'Fee', + 'in' => 'query', + 'schema' => [ + 'description' => '用户每天拥有免费的图片扫描额度。取值：'."\n" + ."\n" + .'- **free**'."\n" + .'- **charge**', + 'type' => 'string', + 'required' => false, + 'example' => 'free', + ], + ], + [ + 'name' => 'Scene', + 'in' => 'query', + 'schema' => [ + 'description' => '检测场景。取值：'."\n" + ."\n" + .'- **porn**（默认值）：鉴黄。'."\n" + .'- **terrorism**：暴恐涉政。'."\n" + .'- **ad**：图文违规。'."\n" + .'- **live**：不良直播场景。'."\n" + .'- **logo**：logo检测。', + 'type' => 'string', + 'required' => false, + 'example' => 'porn', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '域名所属地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'SplitBy', + 'in' => 'query', + 'schema' => [ + 'description' => '分组字段列表。多个字段用英文逗号（,）分隔。'."\n" + ."\n" + .'> 当**SplitBy**为空时，仅返回**TimeStamp**和**Count**。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****,liveStream****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B955107D-E658-4E77-B913-E0AC3D31693E', + ], + 'DetectPornData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的网络带宽数据。', + 'type' => 'array', + 'items' => [ + 'description' => '每个时间间隔的网络带宽数据。', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Region' => [ + 'description' => '域名所属地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'App' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'Stream' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-12-10T15:00:05Z', + ], + 'Count' => [ + 'description' => '审核数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Scene' => [ + 'description' => '检测场景。取值：'."\n" + ."\n" + .'- **porn**（默认值）：鉴黄。'."\n" + .'- **terrorism**：暴恐涉政。'."\n" + .'- **ad**：图文违规。'."\n" + .'- **live**：不良直播场景。'."\n" + .'- **logo**：logo检测。', + 'type' => 'string', + 'example' => 'porn', + ], + 'Fee' => [ + 'description' => '用户每天拥有免费的图片扫描额度。取值：'."\n" + ."\n" + .'- **free**'."\n" + .'- **charge**', + 'type' => 'string', + 'example' => 'free', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B955107D-E658-4E77-B913-E0AC3D31693E\\",\\n \\"DetectPornData\\": {\\n \\"DataModule\\": [\\n {\\n \\"Domain\\": \\"example.com\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"App\\": \\"liveApp****\\",\\n \\"Stream\\": \\"liveStream****\\",\\n \\"TimeStamp\\": \\"2017-12-10T15:00:05Z\\",\\n \\"Count\\": 2,\\n \\"Scene\\": \\"porn\\",\\n \\"Fee\\": \\"free\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDetectPornDataResponse>\\n <RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>\\n <DetectPornData>\\n <Domain>example.com</Domain>\\n <Region>cn-shanghai</Region>\\n <App>liveApp****</App>\\n <Stream>liveStream****</Stream>\\n <TimeStamp>2017-12-10T15:00:05Z</TimeStamp>\\n <Count>2</Count>\\n <Scene>porn</Scene>\\n <Fee>free</Fee>\\n </DetectPornData>\\n</DescribeLiveDetectPornDataResponse>","errorExample":""}]', + 'title' => '查询直播审核用量数据', + 'description' => '- 最小数据粒度为5分钟，若`StartTime`取值为空则默认获取最近24小时数据。'."\n" + ."\n" + .'- 最多可获取最近90天的数据。'."\n" + ."\n" + .'- 可以用来查询每个时间间隔的网络带宽数据。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特殊错误码'."\n" + .'| 错误代码 | 描述 | HTTP 状态码 | 语义 |'."\n" + .'|---------------------|----------|-----------------------------------|---------|'."\n" + .'| Throttling | Request was denied due to request throttling. | 503| 请求被流量控制限制。 |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不属于当前用户。 |'."\n", + ], + 'DescribeDomainUsageData' => [ + 'summary' => '调用DescribeDomainUsageData查询域名在特定计费区域的用量数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106980', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播域名。'."\n" + .'- 支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。'."\n" + ."\n" + .'- 若参数为空，默认返回所有直播域名合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2015-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'需大于起始时间，且与起始时间相差不能超过**31**天。', + 'type' => 'string', + 'required' => true, + 'example' => '2015-12-10T21:00:00Z', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '需要获取的用量类型。'."\n" + ."\n" + .'当**Field**取值为**bps**或**traf** 时，该参数取值范围：'."\n" + .'- **rts**：RTS带宽或流量。'."\n" + .'- **quic**：QUIC带宽或流量。'."\n" + ."\n" + .'当**Field**取值为**req\\_traf**或**req\\_bps** 时，该参数取值范围：'."\n" + .'- **push**：推流带宽或流量。'."\n" + .'- **push_proxy**：转推带宽或流量。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + 'default' => 'all', + 'enum' => [ + 'static', + 'dynamic', + 'quic', + 'rts', + 'push', + 'normal', + 'all', + 'push_proxy', + ], + ], + ], + [ + 'name' => 'Field', + 'in' => 'query', + 'schema' => [ + 'description' => '查询用量的数据类型。取值：'."\n" + .'- **bps**：播放带宽。'."\n" + ."\n" + .'- **traf**：流量。'."\n" + ."\n" + .'- **req\\_traf**：当Type为push时，为推流流量，当Type为push_proxy时，为转推流量。'."\n" + ."\n" + .'- **req\\_bps**：当Type为push时，为推流带宽，当Type为push_proxy时，为转推带宽。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'traf', + ], + ], + [ + 'name' => 'Area', + 'in' => 'query', + 'schema' => [ + 'description' => '区域代号。支持：'."\n" + .'- **CN**：中国内地。'."\n" + .'- **OverSeas**：海外大区。'."\n" + .'- **AP1**：亚太1区。'."\n" + .'- **AP2**：亚太2区。'."\n" + .'- **AP3**：亚太3区。'."\n" + .'- **NA**：北美。'."\n" + .'- **SA**：南美。'."\n" + .'- **EU**：欧洲。'."\n" + .'- **MEAA**：中东非洲。'."\n" + .'- **all**：全部。'."\n" + ."\n" + .'> 不传值则默认为中国内地。海外大区说明：- 亚太1区：中国香港地区、中国澳门地区、中国台湾地区、日本以及东南亚除越南和印尼之外的国家。- 亚太2区：印尼、韩国、越南。- 亚太3区：澳大利亚、新西兰。北美：美国、加拿大。- 南美：巴西。- 欧洲：乌克兰、英国、法国、荷兰、西班牙、意大利、瑞典、德国。- 中东非洲：南非、阿曼、阿联酋、科威特。', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + 'default' => 'CN', + ], + ], + [ + 'name' => 'DataProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '需要获取的数据的协议。取值：'."\n" + ."\n" + .'- **http**：HTTP协议。'."\n" + ."\n" + .'- **https**：HTTPS协议。'."\n" + ."\n" + .'- **quic**：QUIC协议。'."\n" + ."\n" + .'- **all**（默认）：以上全部协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + 'default' => 'all', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '强制指定获取指定时间粒度的数据，单位为秒。支持**300**（5分钟）、**3600**（1小时）和**86400**（1天）。'."\n" + ."\n\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-10T21:00Z', + ], + 'Type' => [ + 'description' => '用量类型。', + 'type' => 'string', + 'example' => 'all', + ], + 'StartTime' => [ + 'description' => '开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-10T20:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B955107D-E658-4E77-B913-E0AC3D31693E', + ], + 'Area' => [ + 'description' => '用量区域。', + 'type' => 'string', + 'example' => 'CN', + ], + 'DomainName' => [ + 'description' => '直播域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔。单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'UsageDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每条记录的流量数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '用量。'."\n" + .'- 当Field为traf或req_traf时单位是字节（Byte）。'."\n" + ."\n" + .'- 当Field为bps或req_bps时单位是bps。'."\n" + ."\n" + .'- 当Field为acc时单位是次数。', + 'type' => 'string', + 'example' => '423304182', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvaildParameter', + 'errorMessage' => 'Invalid Parameter', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified Time is malformed.', + ], + [ + 'errorCode' => 'InvalidParameterField', + 'errorMessage' => 'The specified Field is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterType', + 'errorMessage' => 'The specified Type is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2015-12-10T21:00Z\\",\\n \\"Type\\": \\"all\\",\\n \\"StartTime\\": \\"2015-12-10T20:00Z\\",\\n \\"RequestId\\": \\"B955107D-E658-4E77-B913-E0AC3D31693E\\",\\n \\"Area\\": \\"CN\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"UsageDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"423304182\\",\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainUsageDataResponse>\\n <DomainName>example.com</DomainName>\\n <DataInterval>300</DataInterval>\\n <UsageDataPerInterval>\\n <DataModule>\\n <TimeStamp>2015-12-10T20:00:00Z</TimeStamp>\\n <Value>423304182</Value>\\n </DataModule>\\n <DataModule>\\n <TimeStamp>2015-12-10T20:05:00Z</TimeStamp>\\n <Value>454680793</Value>\\n </DataModule>\\n <DataModule>\\n <TimeStamp>2015-12-10T20:10:00Z</TimeStamp>\\n <Value>501718342</Value>\\n </DataModule>\\n <DataModule>\\n <TimeStamp>2015-12-10T20:15:00Z</TimeStamp>\\n <Value>434816025</Value>\\n </DataModule>\\n </UsageDataPerInterval>\\n <RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>\\n <StartTime>2015-12-10T20:00Z</StartTime>\\n <EndTime>2015-12-10T21:00Z</EndTime>\\n <Area>CN</Area>\\n <Type>all</Type>\\n</DescribeDomainUsageDataResponse>","errorExample":""}]', + 'title' => '查询域名在特定计费区域的用量数据', + 'description' => '- 此接口支持批量域名查询，多个域名用英文逗号（,）分隔，最多一次可以查询100个域名。如果DomainName参数为空，则返回账号下所有域名的数据。'."\n" + .'- 用量数据包括流量、带宽和请求数三类，单位分别为Byte、bps和次数。'."\n" + .'- 如果不指定Interval参数，最长可查询近1年的数据，单次查询的最大时间跨度为31天。查询时间为1~3天，数据按小时粒度返回；查询时间大于3天，数据按天粒度返回。'."\n" + ."\n" + .'- 指定Interval参数时，支持单次查询的时间跨度、对应的可查询历史数据时间范围和数据延迟如下：'."\n" + ."\n" + .'| 时间粒度 | 单次查询的最大时间跨度 | 可查询历史数据时间范围 | 数据延迟'."\n" + .'| -------------- | -------------- | ------ | ------ |'."\n" + .'| 5分钟 | 3天 | 93天 | 15分钟'."\n" + .'| 1小时 | 31天 | 186天 | 4小时'."\n" + .'| 1天 | 90天 | 366天 | 次日凌晨4点'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '>接口查询T时刻数据时，T+N时刻可获取到稳态数据，N为2小时。<br>示例：当您查询12月21日下午1点钟数据，可在12月21日下午3点钟获取到1点及1点前的稳态数据。', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 特殊错误码'."\n" + .'| 错误代码 | 描述 | HTTP 状态码 | 语义 |'."\n" + .'|------------------------------|--------------------------------------------------------|-----------|----------------------------------|'."\n" + .'| Throttling | Request was denied due to request throttling. | 503 | 请求被流量控制限制 |'."\n" + .'| IllegalOperation | Illegal domain, operation is not permitted. | 403 | 非法域名，无法操作 |'."\n" + .'| OperationDenied | Your account does not open Live service yet. | 403 | 未开通Live服务 |'."\n" + .'| OperationDenied | Your Live service is suspended. | 403 | Live服务已被停止 |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不属于当前用户 |'."\n" + .'| InvalidDomain.Offline | The domain provided is offline. | 404 | 域名已下线 |'."\n" + .'| ServiceBusy | The specified Domain is configuring, please retry later. | 403 | 域名正在配置中，请稍后再试 |'."\n" + .'| InvalidDomain.Configure_failed | Failed to configure the provided domain. | 500 | 域名配置失败 |'."\n" + .'| InvalidParameter | Invalid Parameter. | 400 | 参数错误 |'."\n" + .'| InvalidParameterProduct | Invalid Parameter Product. | 400 | Product参数错误 |'."\n" + .'| InvalidParameterArea | Invalid Parameter Area. | 400 | Area参数错误 |'."\n" + .'| InvalidParameterField | Invalid Parameter Field. | 400 | Field参数错误 |'."\n" + .'| InvalidParameterStartTime | Invalid Parameter StartTime. | 400 | StartTime参数错误 |'."\n" + .'| InvalidParameterEndTime | Invalid Parameter EndTime. | 400 | EndTime参数错误 |'."\n" + .'| InvalidTimeRange | StartTime and EndTime range should less than 1 month. | 400 | EndTime和StartTime差值不能超过31天 |'."\n" + .'| InvalidParameterInterval | Invalid Parameter Interval. | 400 | Interval参数错误 |'."\n", + ], + 'DescribeLivePushProxyUsageData' => [ + 'summary' => '调用DescribeLivePushProxyUsageData查询直播中心转推用量数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '查询不同直播中心, 支持批量地区查询，多个地区用逗号（半角）分隔。取值：'."\n" + .'- cn-beijing：北京'."\n" + .'- cn-shanghai：上海'."\n" + .'- cn-shenzhen：深圳'."\n" + .'- cn-qingdao：青岛'."\n" + .'- ap-southeast-1：新加坡'."\n" + .'- eu-central-1：德国'."\n" + .'- ap-northeast-1：东京'."\n" + .'- ap-southeast-5：雅加达'."\n" + ."\n" + .'若参数为空，默认返回所有Region合并后数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的主播流域名。'."\n" + .'- 支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。'."\n" + .'- 若参数为空，默认返回所有直播域名合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ，默认返回近七天的数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-10-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间需大于起始时间，日期格式按照ISO8601表示法，并使用UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-10-10T21:00:00Z', + ], + ], + [ + 'name' => 'SplitBy', + 'in' => 'query', + 'schema' => [ + 'description' => '分组键，若参数为空，默认为region，按照聚合后数据输出。多个使用逗号（半角）分隔，取值：'."\n" + .'- domain：域名。如果此参数SplitBy（分组键）取值为domain时，返回参数Domain才生效。'."\n" + .'- region（默认值）：直播中心地域。如果此参数SplitBy（分组键）取值为region时，返回参数Region才生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'region', + 'default' => 'region', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2022-10-10T21:00:00Z', + ], + 'PushProxyData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PushProxyDataItem' => [ + 'description' => '直播中心转推用量数据。', + 'type' => 'array', + 'items' => [ + 'description' => '直播中心转推用量数据。', + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '用量域名，SplitBy指定domain时，分组输出。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Region' => [ + 'description' => '直播中心，SplitBy指定region时，分组输出。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'StreamCount' => [ + 'description' => '直播中心转推峰值路数，单位：路。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2022-10-10T20:00:00Z', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '该条任务请求ID。', + 'type' => 'string', + 'example' => '4B460F8B-993C-4F48-B98A-910811DEBFEB', + ], + 'StartTime' => [ + 'description' => '起始时间。', + 'type' => 'string', + 'example' => '2022-10-10T20:00:00Z', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidTime.ValueNotSupported', + 'errorMessage' => 'Specified Time is malformed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2022-10-10T21:00:00Z\\",\\n \\"PushProxyData\\": {\\n \\"PushProxyDataItem\\": [\\n {\\n \\"DomainName\\": \\"example.com\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"StreamCount\\": 8,\\n \\"TimeStamp\\": \\"2022-10-10T20:00:00Z\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"4B460F8B-993C-4F48-B98A-910811DEBFEB\\",\\n \\"StartTime\\": \\"2022-10-10T20:00:00Z\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLivePushProxyUsageDataResponse>\\n <RequestId>C370DAF1-C838-4288-A1A0-9A87633D248E</RequestId>\\n <EndTime>2018-09-30T16:00:00Z</EndTime>\\n <StartTime>2018-10-31T15:59:59Z</StartTime>\\n <PushProxyData>\\n <PushProxyDataItem>\\n <Domain>example.com</Domain>\\n <StreamCount>6777</StreamCount>\\n <TimeStamp>2018-09-30T00:00:00Z</TimeStamp>\\n </PushProxyDataItem>\\n <PushProxyDataItem>\\n <Domain>example.com</Domain>\\n <StreamCount>6777</StreamCount>\\n <TimeStamp>2018-09-30T00:00:00Z</TimeStamp>\\n </PushProxyDataItem>\\n <PushProxyDataItem>\\n <Domain>example.com</Domain>\\n <StreamCount>6777</StreamCount>\\n <TimeStamp>2018-10-01T00:00:00Z</TimeStamp>\\n </PushProxyDataItem>\\n <PushProxyDataItem>\\n <Domain>example.com</Domain>\\n <StreamCount>6777</StreamCount>\\n <TimeStamp>2018-10-01T00:00:00Z</TimeStamp>\\n </PushProxyDataItem>\\n </PushProxyData>\\n</DescribeLivePushProxyUsageDataResponse>","errorExample":""}]', + 'title' => '查询直播中心转推用量数据', + 'description' => '- 查询直播中心转推用量数据。'."\n" + .'- 最大查询跨度：31天。'."\n" + .'- 最小查询粒度：1天。'."\n" + .'- 最大查询范围：最近90天的数据'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveRealtimeDeliveryAcc' => [ + 'summary' => '调用DescribeLiveRealtimeDeliveryAcc查询实时日志投递次数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive066BXV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'结束时间需大于起始时间。起止时间和结束时间，间隔不超过一年。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-10T21:05:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度。单位：秒（s）。取值：'."\n" + ."\n" + .'- **300**。'."\n" + .'- **3600**。'."\n" + .'- **86400**。'."\n" + ."\n" + .'不传或传的值不支持，且时间跨度不超过3天时，默认值300秒。超过3天默认值3600秒。超过30天默认值86400秒。', + 'type' => 'string', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '实时日志投递的Project。若参数为空，默认返回所有Project合并后数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'project_example', + ], + ], + [ + 'name' => 'LogStore', + 'in' => 'query', + 'schema' => [ + 'description' => '实时日志投递的Logstore。若参数为空，默认返回所有Logstore合并后数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'logstore_example', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。'."\n" + .'- 支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。'."\n" + .'- 若参数为空，默认返回所有直播域名合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '684306D2-2511-4977-991D-CE97E91FD7C0', + ], + 'RealTimeDeliveryAccData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AccData' => [ + 'description' => '实时日志投递次数信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2015-12-10T20:00:00Z', + ], + 'FailedNum' => [ + 'description' => '实时日志投递失败次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SuccessNum' => [ + 'description' => '实时日志投递成功次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '321321', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"684306D2-2511-4977-991D-CE97E91FD7C0\\",\\n \\"RealTimeDeliveryAccData\\": {\\n \\"AccData\\": [\\n {\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\",\\n \\"FailedNum\\": 0,\\n \\"SuccessNum\\": 321321\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveRealtimeDeliveryAccResponse>\\n <RequestId>684306D2-2511-4977-991D-CE97E91FD7C0</RequestId>\\n <RealTimeDeliveryAccData>\\n <TimeStamp>2015-12-10T20:00:00Z</TimeStamp>\\n <FailedNum>0</FailedNum>\\n <SuccessNum>321321</SuccessNum>\\n </RealTimeDeliveryAccData>\\n</DescribeLiveRealtimeDeliveryAccResponse>","errorExample":""}]', + 'title' => '查询实时日志投递次数', + 'description' => '- 可以统计实时日志投递次数信息。统计实时日志投递失败次数和实时日志投递成功次数。'."\n" + .'- 支持UID维度查询。'."\n" + .'- 收费次数包含投递成功和失败的全部次数。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 特殊错误码'."\n" + .'|错误代码|描述|HTTP 状态码|语义|'."\n" + .'|--------|--------|--------|--------|'."\n" + .'|InvalidStartTime.ValueNotSupported|The specified value of parameter StartTime is not supported.|400|EndTime和StartTime差值超过90天。|'."\n" + .'|InvalidEndTime.Mismatch|Specified EndTime does not math the specified StartTime.|400|EndTime小于StartTime|', + ], + 'DescribeLiveDomainTimeShiftData' => [ + 'summary' => '查询直播时移用量数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的主播流域名。'."\n" + ."\n" + .'> '."\n" + .'> - 传入DomainName时，请保证传入域名为直播域名，同时调用本接口的用户拥有传入域名的操作权限。'."\n" + .'> - 支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。'."\n" + .'> - 若参数为空，默认返回所有直播域名合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> - 最小数据粒度为5分钟。'."\n" + .'> - 不写默认读取过去24小时数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-03-03T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。结束时间需大于起始时间，格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-03-03T02:00:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度。单位：秒。取值：'."\n" + ."\n" + .'- 300。'."\n" + .'- 3600。'."\n" + .'- 86400。'."\n" + ."\n" + .'不传或传值不支持时，使用默认值300秒。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8AE1CB3A-6510-442E-A6B9-EF03D05B3E09', + ], + 'TimeShiftData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的时移用量数据。', + 'type' => 'array', + 'items' => [ + 'description' => '每个时间间隔的时移用量数据。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '时移类型。可以是HLS_D1、HLS_D7等。', + 'type' => 'string', + 'example' => 'HLS_D7', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2021-03-03T00:00:00Z', + ], + 'Size' => [ + 'description' => '时移存储用量。单位：Byte。', + 'type' => 'string', + 'example' => '1664165660', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8AE1CB3A-6510-442E-A6B9-EF03D05B3E09\\",\\n \\"TimeShiftData\\": {\\n \\"DataModule\\": [\\n {\\n \\"Type\\": \\"HLS_D7\\",\\n \\"TimeStamp\\": \\"2021-03-03T00:00:00Z\\",\\n \\"Size\\": \\"1664165660\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveDomainTimeShiftDataResponse>\\n<TimeShiftData>\\n <DataModule>\\n <Type>HLS_D7</Type>\\n <Size>1664165660</Size>\\n <TimeStamp>2021-03-03T00:00:00Z</TimeStamp>\\n </DataModule>\\n</TimeShiftData>\\n<RequestId>8AE1CB3A-6510-442E-A6B9-EF03D05B3E09</RequestId>\\n</DescribeLiveDomainTimeShiftDataResponse>","errorExample":""}]', + 'title' => '查询直播时移用量数据', + 'description' => '- 可以用来统计每个时间间隔的时移用量数据。'."\n" + .'- 最多可获取最近90天的数据。'."\n" + .'- 数据间隔固定为1小时。'."\n" + .'- 最长获取数据时间跨度31天。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 特殊错误码'."\n" + .'| 错误代码 | 描述 | HTTP 状态码 | 语义 |'."\n" + .'|------------|--------|---------|------|'."\n" + .'| Throttling | Request was denied due to request throttling. | 503 | 请求被流量控制限制。|'."\n" + .'| InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不属于当前用户。|', + ], + 'DescribeLiveDomainStreamTranscodeData' => [ + 'summary' => '调用DescribeLiveDomainStreamTranscodeData查询域名转码用量数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的主播流域名。'."\n" + ."\n" + .'- 支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。'."\n" + .'- 若参数为空，默认返回所有直播域名合并后的数据。'."\n" + .'- 传入DomainName时，请保证传入域名为直播域名，同时调用本接口的用户拥有传入域名的操作权限。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'- 最小数据时间粒度为1小时。'."\n" + .'- 不填默认读取过去24小时数据。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-10T22:00:00Z', + ], + ], + [ + 'name' => 'Precision', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的时间精度。取值：'."\n" + .'- **min**（默认）：以分钟为单位。'."\n" + .'- **sec**：以秒为单位。', + 'type' => 'string', + 'required' => false, + 'example' => 'min', + 'default' => 'min', + 'enum' => [ + 'min', + 'sec', + ], + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的时间粒度。单位：秒。取值：'."\n" + ."\n" + .'- **3600**：按小时粒度。'."\n" + .'- **86400**：按天粒度。'."\n" + ."\n" + .'> 不填默认按小时。', + 'type' => 'string', + 'required' => false, + 'example' => '3600', + 'enum' => [ + '3600', + '86400', + ], + ], + ], + [ + 'name' => 'Split', + 'in' => 'query', + 'schema' => [ + 'description' => '分组键。取值：'."\n" + ."\n" + .'- **domain**：域名。如果此参数Split（分组键）取值为domain时，返回参数Domain才生效。'."\n" + .'- **region**：直播中心地域。如果此参数Split（分组键）取值为region时，返回参数Region才生效。'."\n" + .'- **transcode_type**：转码类型。如果此参数Split（分组键）取值为transcode_type时，返回参数TanscodeType才生效。'."\n" + .'- **resolution**：分辨率。如果此参数Split（分组键）取值为resolution时，返回参数Resolution才生效。'."\n" + .'- **fps**：帧率。如果此参数Split（分组键）取值为fps时，返回参数Fps才生效。'."\n" + ."\n" + .'可选一个，也可多选，用英文逗号（,）分隔。'."\n" + ."\n" + .'默认为`domain,region,transcode_type,resolution,fps`，即全部进行分组。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'domain', + 'default' => 'domain,region,transcode_type,resolution,fps', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3C6CCEC4-6B88-4D4A-93E4-D47B******', + ], + 'TranscodeDataList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TranscodeData' => [ + 'description' => '每个时间间隔的网络带宽数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TanscodeType' => [ + 'description' => '转码类型。取值：'."\n" + ."\n" + .'> 如果请求参数Split（分组键）为transcode_type时，此返回参数才生效。'."\n" + ."\n\n" + .'<props="china">'."\n" + ."\n" + .'- **H264STD**：H.264标准转码。'."\n" + .'- **H265STD**：H.265标准转码。'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'- **H264NBHD**：H.264窄带高清转码。'."\n" + .'- **H265NBHD**：H.265窄带高清转码。'."\n" + .'- **AUDIO**：音频转码。', + 'type' => 'string', + 'example' => 'H264STD', + ], + 'Domain' => [ + 'description' => '主播流域名。'."\n" + ."\n" + .'> 如果请求参数Split（分组键）为domain时，此返回参数才生效。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Region' => [ + 'description' => '域名所属地域。 取值：'."\n" + ."\n" + .'> 如果请求参数Split（分组键）为region时，此返回参数才生效。'."\n" + .'- **cn-beijing**：北京。'."\n" + .'- **cn-shanghai**：上海。'."\n" + .'- **cn-qingdao**：青岛。'."\n" + .'- **cn-shenzhen**：深圳。'."\n" + .'- **ap-northeast-1**：日本。'."\n" + .'- **ap-southeast-1**：新加坡。'."\n" + .'- **ap-southeast-5**：印尼。'."\n" + .'- **eu-central-1**：德国。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'Duration' => [ + 'description' => '时长。单位：分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2017-12-10T20:00:00Z', + ], + 'Fps' => [ + 'description' => '帧率。'."\n" + ."\n" + .'> 如果请求参数Split（分组键）为fps时，此返回参数才生效。', + 'type' => 'string', + 'example' => 'normal', + ], + 'Resolution' => [ + 'description' => '分辨率。取值：'."\n" + ."\n" + .'> 如果请求参数Split（分组键）为resolution时，此返回参数才生效。'."\n" + ."\n" + .'- **2K**'."\n" + .'- **4K**'."\n" + .'- **LD**：流畅。'."\n" + .'- **SD**：标清。'."\n" + .'- **HD**：高清。'."\n" + .'- **def**：音频。', + 'type' => 'string', + 'example' => 'HD', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidParamPrecision', + 'errorMessage' => 'The parameter Precision is invalid, please check StartTime and EndTime or Precision.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3C6CCEC4-6B88-4D4A-93E4-D47B******\\",\\n \\"TranscodeDataList\\": {\\n \\"TranscodeData\\": [\\n {\\n \\"TanscodeType\\": \\"H264STD\\",\\n \\"Domain\\": \\"example.com\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"Duration\\": 2000,\\n \\"TimeStamp\\": \\"2017-12-10T20:00:00Z\\",\\n \\"Fps\\": \\"normal\\",\\n \\"Resolution\\": \\"HD\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveDomainStreamTranscodeDataResponse>\\n<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>\\n<TranscodeDataList>\\n <TranscodeData>\\n <Fps>normal</Fps>\\n <Region>cn-beijing</Region>\\n <Duration>2000</Duration>\\n <TanscodeType>H264STD</TanscodeType>\\n <Domain>example.com</Domain>\\n <TimeStamp>2017-12-10T20:00:00Z</TimeStamp>\\n <Resolution>HD</Resolution>\\n </TranscodeData>\\n</TranscodeDataList>\\n</DescribeLiveDomainStreamTranscodeDataResponse>","errorExample":""}]', + 'title' => '查询域名转码用量数据', + 'description' => '- 可以用来统计每个时间间隔的网络带宽数据。'."\n" + .'- 支持批量域名查询，多个域名用英文逗号（,）分隔。'."\n" + .'- 最多可获取最近90天的数据。'."\n" + .'- 数据时间粒度为小时或天。'."\n" + .'- 不同转码类型与转码分辨率对应的计费档次，请参见[直播转码计费说明](~~90424~~)中的转码账单中不同实例规格对应的转码计费档次说明。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特殊错误码'."\n" + .'|ErrorCode 错误码 |Message 错误信息 |HTTP 状态 |语义 |'."\n" + .'| ------------- |------------ | ----- | ----- |'."\n" + .'|Throttling |Request was denied due to request throttling. |503 |请求被流量控制限制。|'."\n" + .'|InvalidDomain.NotFound |The domain provided does not belong to you. |404 |域名不存在或不属于当前用户。|', + ], + 'DescribeLiveProducerUsageData' => [ + 'summary' => '调用DescribeLiveProducerUsageData查询导播台用量数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '域名所属地域。若参数为空，默认返回所有Region合并后数据，支持批量查询，多个Region用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '云导播播流域名。'."\n" + ."\n" + .'- 支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。'."\n" + .'- 若参数为空，默认返回所有直播域名合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Instance', + 'in' => 'query', + 'schema' => [ + 'description' => '查询实例。支持批量实例查询，多个实例用英文逗号（,）分隔。'."\n" + ."\n" + .'> 若参数为空，默认返回所有实例合并后数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'a17d0184-462d-4630-b2a6-8c26dde2****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '导播类型。支持批量查询，多个类型用英文逗号（,）分隔。取值：'."\n" + ."\n" + .'- **slidelive**：播单型。'."\n" + ."\n" + .'- **universal**：通用型。'."\n" + ."\n" + .'> 若参数为空，默认返回所有导播类型合并后数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'slidelive', + ], + ], + [ + 'name' => 'SplitBy', + 'in' => 'query', + 'schema' => [ + 'description' => '分组键。可以指定domain、region、 instance,、type其中之一或多个, 多个使用英文逗号（,）分隔.。指定了split 的字段将会被分组输出。'."\n" + ."\n\n" + .'>若参数为空, 则只输出按照聚合后数据. ', + 'type' => 'string', + 'required' => false, + 'example' => 'type', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-09-30T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'>结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2018-10-31T15:59:59Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询数据的时间粒度，支持3600（1小时）和86400（1天）的取值。单位：秒。', + 'type' => 'string', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'app', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BillProducerData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BillProducerDataItem' => [ + 'description' => '用户导播台用量数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '用量域名。SplitBy指定为domain时，分组输出。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Instance' => [ + 'description' => '用量实例。SplitBy指定为instance时，分组输出。', + 'type' => 'string', + 'example' => 'a17d0184-462d-4630-b2a6-8c26dde2****', + ], + 'OutputHdDuration' => [ + 'description' => '高清分辨率时长，单位为分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6000', + ], + 'OutputLdDuration' => [ + 'description' => '流畅分辨率时长，单位为分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1001', + ], + 'OutputSdDuration' => [ + 'description' => '标准分辨率时长，单位为分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'Region' => [ + 'description' => '用量地区。SplitBy指定为region时，分组输出。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2018-09-30T00:00:00Z', + ], + 'TranHdDuration' => [ + 'description' => '转码高清分辨率时长，单位为分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6777', + ], + 'TranLdDuration' => [ + 'description' => '转码流畅分辨率时长，单位为分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + 'TranSdDuration' => [ + 'description' => '转码标准分辨率时长，单位为分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '666', + ], + 'Type' => [ + 'description' => '导播类型。SplitBy指定为type时，分组输出。', + 'type' => 'string', + 'example' => 'slidelive', + ], + ], + ], + ], + ], + ], + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2018-09-30T16:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2018-10-31T15:59:59Z', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidTime.ValueNotSupported', + 'errorMessage' => 'Specified Time is malformed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"BillProducerData\\": {\\n \\"BillProducerDataItem\\": [\\n {\\n \\"DomainName\\": \\"example.com\\",\\n \\"Instance\\": \\"a17d0184-462d-4630-b2a6-8c26dde2****\\",\\n \\"OutputHdDuration\\": 6000,\\n \\"OutputLdDuration\\": 1001,\\n \\"OutputSdDuration\\": 500,\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"TimeStamp\\": \\"2018-09-30T00:00:00Z\\",\\n \\"TranHdDuration\\": 6777,\\n \\"TranLdDuration\\": 111,\\n \\"TranSdDuration\\": 666,\\n \\"Type\\": \\"slidelive\\"\\n }\\n ]\\n },\\n \\"EndTime\\": \\"2018-09-30T16:00:00Z\\",\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\",\\n \\"StartTime\\": \\"2018-10-31T15:59:59Z\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveProducerUsageDataResponse>\\n <RequestId>C370DAF1-C838-4288-A1A0-9A87633D248E</RequestId>\\n <EndTime>2018-09-30T16:00:00Z</EndTime>\\n <StartTime>2018-10-31T15:59:59Z</StartTime>\\n <BillProducerData>\\n <BillProducerDataItem>\\n <OutputLdDuration>1001</OutputLdDuration>\\n <OutputSdDuration>500</OutputSdDuration>\\n <OutputHdDuration>6000</OutputHdDuration>\\n <TranLdDuration>111</TranLdDuration>\\n <TranSdDuration>666</TranSdDuration>\\n <TranHdDuration>6777</TranHdDuration>\\n <TimeStamp>2018-09-30T00:00:00Z</TimeStamp>\\n </BillProducerDataItem>\\n <BillProducerDataItem>\\n <OutputLdDuration>1001</OutputLdDuration>\\n <OutputSdDuration>500</OutputSdDuration>\\n <OutputHdDuration>6000</OutputHdDuration>\\n <TranLdDuration>111</TranLdDuration>\\n <TranSdDuration>666</TranSdDuration>\\n <TranHdDuration>6777</TranHdDuration>\\n <TimeStamp>2018-10-01T00:00:00Z</TimeStamp>\\n </BillProducerDataItem>\\n <BillProducerDataItem>\\n <OutputLdDuration>1001</OutputLdDuration>\\n <OutputSdDuration>500</OutputSdDuration>\\n <OutputHdDuration>6000</OutputHdDuration>\\n <TranLdDuration>111</TranLdDuration>\\n <TranSdDuration>666</TranSdDuration>\\n <TranHdDuration>6777</TranHdDuration>\\n <TimeStamp>2018-10-02T00:00:00Z</TimeStamp>\\n </BillProducerDataItem>\\n </BillProducerData>\\n</DescribeLiveProducerUsageDataResponse>","errorExample":""}]', + 'title' => '查询导播台用量数据', + 'description' => '最小数据查询粒度为1小时；最大查询时间跨度为31天；支持历史最大查询时间范围为最近90天。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'extraInfo' => '## 示例2： splitBy=type'."\n" + ."\n" + .'请求示例'."\n" + ."\n" + .'```'."\n" + .'http://live.aliyuncs.com?Action=DescribeLiveProducerUsageData '."\n" + .'&StartTime=2018-09-30T16:00:00Z '."\n" + .'&EndTime=2018-10-31T15:59:59Z '."\n" + .'&SplitBy=type '."\n" + .'&<公共请求参数>'."\n" + .'```'."\n" + .'正常返回示例'."\n" + ."\n" + .'`XML`格式'."\n" + ."\n" + .'```'."\n" + .'<DescribeLiveProducerUsageDataResponse>'."\n" + .' <RequestId>C370DAF1-C838-4288-A1A0-9A87633D248E</RequestId>'."\n" + .' <EndTime>2018-09-30T16:00:00Z</EndTime>'."\n" + .' <StartTime>2018-10-31T15:59:59Z</StartTime>'."\n" + .' <BillProducerData>'."\n" + .' <BillProducerDataItem>'."\n" + .' <Type>universal</Type>'."\n" + .' <OutputLdDuration>1001</OutputLdDuration>'."\n" + .' <OutputSdDuration>500</OutputSdDuration>'."\n" + .' <OutputHdDuration>6000</OutputHdDuration>'."\n" + .' <TranLdDuration>111</TranLdDuration>'."\n" + .' <TranSdDuration>666</TranSdDuration>'."\n" + .' <TranHdDuration>6777</TranHdDuration>'."\n" + .' <TimeStamp>2018-09-30T00:00:00Z</TimeStamp>'."\n" + .' </BillProducerDataItem>'."\n" + .' <BillProducerDataItem>'."\n" + .' <Type>slidelive</Type>'."\n" + .' <OutputLdDuration>1001</OutputLdDuration>'."\n" + .' <OutputSdDuration>500</OutputSdDuration>'."\n" + .' <OutputHdDuration>6000</OutputHdDuration>'."\n" + .' <TranLdDuration>111</TranLdDuration>'."\n" + .' <TranSdDuration>666</TranSdDuration>'."\n" + .' <TranHdDuration>6777</TranHdDuration>'."\n" + .' <TimeStamp>2018-09-30T00:00:00Z</TimeStamp>'."\n" + .' </BillProducerDataItem>'."\n" + .' <BillProducerDataItem>'."\n" + .' <Type>universal</Type>'."\n" + .' <OutputLdDuration>1001</OutputLdDuration>'."\n" + .' <OutputSdDuration>500</OutputSdDuration>'."\n" + .' <OutputHdDuration>6000</OutputHdDuration>'."\n" + .' <TranLdDuration>111</TranLdDuration>'."\n" + .' <TranSdDuration>666</TranSdDuration>'."\n" + .' <TranHdDuration>6777</TranHdDuration>'."\n" + .' <TimeStamp>2018-10-01T00:00:00Z</TimeStamp>'."\n" + .' </BillProducerDataItem>'."\n" + .' <BillProducerDataItem>'."\n" + .' <Type>slidelive</Type>'."\n" + .' <OutputLdDuration>1001</OutputLdDuration>'."\n" + .' <OutputSdDuration>500</OutputSdDuration>'."\n" + .' <OutputHdDuration>6000</OutputHdDuration>'."\n" + .' <TranLdDuration>111</TranLdDuration>'."\n" + .' <TranSdDuration>666</TranSdDuration>'."\n" + .' <TranHdDuration>6777</TranHdDuration>'."\n" + .' <TimeStamp>2018-10-01T00:00:00Z</TimeStamp>'."\n" + .' </BillProducerDataItem>'."\n" + .' <BillProducerDataItem>'."\n" + .' <Type>universal</Type>'."\n" + .' <OutputLdDuration>1001</OutputLdDuration>'."\n" + .' <OutputSdDuration>500</OutputSdDuration>'."\n" + .' <OutputHdDuration>6000</OutputHdDuration>'."\n" + .' <TranLdDuration>111</TranLdDuration>'."\n" + .' <TranSdDuration>666</TranSdDuration>'."\n" + .' <TranHdDuration>6777</TranHdDuration>'."\n" + .' <TimeStamp>2018-10-02T00:00:00Z</TimeStamp>'."\n" + .' </BillProducerDataItem>'."\n" + .' <BillProducerDataItem>'."\n" + .' <Type>slidelive</Type>'."\n" + .' <OutputLdDuration>1001</OutputLdDuration>'."\n" + .' <OutputSdDuration>500</OutputSdDuration>'."\n" + .' <OutputHdDuration>6000</OutputHdDuration>'."\n" + .' <TranLdDuration>111</TranLdDuration>'."\n" + .' <TranSdDuration>666</TranSdDuration>'."\n" + .' <TranHdDuration>6777</TranHdDuration>'."\n" + .' <TimeStamp>2018-10-02T00:00:00Z</TimeStamp>'."\n" + .' </BillProducerDataItem>'."\n" + .' </BillProducerData>'."\n" + .'</DescribeLiveProducerUsageDataResponse>'."\n" + .'```'."\n" + .'`JSON`格式'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "RequestId": "C370DAF1-C838-4288-A1A0-9A87633D248E",'."\n" + .' "EndTime": "2018-09-30T16:00:00Z",'."\n" + .' "StartTime": "2018-10-31T15:59:59Z",'."\n" + .' "BillProducerData": {'."\n" + .' "BillProducerDataItem": ['."\n" + .' {'."\n" + .' "Type": "universal",'."\n" + .' "OutputLdDuration": 1001,'."\n" + .' "OutputSdDuration": 500,'."\n" + .' "OutputHdDuration": 6000,'."\n" + .' "TranLdDuration": 111,'."\n" + .' "TranSdDuration": 666,'."\n" + .' "TranHdDuration": 6777,'."\n" + .' "TimeStamp": "2018-09-30T00:00:00Z"'."\n" + .' }, {'."\n" + .' "Type": "slidelive",'."\n" + .' "OutputLdDuration": 1001,'."\n" + .' "OutputSdDuration": 500,'."\n" + .' "OutputHdDuration": 6000,'."\n" + .' "TranLdDuration": 111,'."\n" + .' "TranSdDuration": 666,'."\n" + .' "TranHdDuration": 6777,'."\n" + .' "TimeStamp": "2018-09-30T00:00:00Z"'."\n" + .' },{'."\n" + .' "Type": "universal",'."\n" + .' "OutputLdDuration": 1001,'."\n" + .' "OutputSdDuration": 500,'."\n" + .' "OutputHdDuration": 6000,'."\n" + .' "TranLdDuration": 111,'."\n" + .' "TranSdDuration": 666,'."\n" + .' "TranHdDuration": 6777,'."\n" + .' "TimeStamp": "2018-10-01T00:00:00Z"'."\n" + .' },{'."\n" + .' "Type": "slidelive",'."\n" + .' "OutputLdDuration": 1001,'."\n" + .' "OutputSdDuration": 500,'."\n" + .' "OutputHdDuration": 6000,'."\n" + .' "TranLdDuration": 111,'."\n" + .' "TranSdDuration": 666,'."\n" + .' "TranHdDuration": 6777,'."\n" + .' "TimeStamp": "2018-10-01T00:00:00Z"'."\n" + .' },{'."\n" + .' "Type": "universal",'."\n" + .' "OutputLdDuration": 1001,'."\n" + .' "OutputSdDuration": 500,'."\n" + .' "OutputHdDuration": 6000,'."\n" + .' "TranLdDuration": 111,'."\n" + .' "TranSdDuration": 666,'."\n" + .' "TranHdDuration": 6777,'."\n" + .' "TimeStamp": "2018-10-02T00:00:00Z"'."\n" + .' },{'."\n" + .' "Type": "slidelive",'."\n" + .' "OutputLdDuration": 1001,'."\n" + .' "OutputSdDuration": 500,'."\n" + .' "OutputHdDuration": 6000,'."\n" + .' "TranLdDuration": 111,'."\n" + .' "TranSdDuration": 666,'."\n" + .' "TranHdDuration": 6777,'."\n" + .' "TimeStamp": "2018-10-02T00:00:00Z"'."\n" + .' }]'."\n" + .' }'."\n" + .'}'."\n" + .'```', + ], + 'DescribeLiveDomainMonitoringUsageData' => [ + 'summary' => '调用DescribeLiveDomainMonitoringUsageData获取域名广目监播用量数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195294', + 'abilityTreeNodes' => [ + 'FEATUREliveSM955S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的主播流域名。'."\n" + ."\n" + .'- 支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。'."\n" + .'- 若参数为空，默认返回所有直播域名合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。'."\n" + .'- 格式为：YYYY-MM-DDThh:mm:ssZ。'."\n" + .'- 最小数据粒度为1小时。'."\n" + .'- 不写默认读取过去24小时数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。结束时间需大于起始时间；获日期格式按照ISO8601表示法，并使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-12-10T22:00:00Z', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '直播中心Region。若参数为空，默认返回所有Region合并后数据，支持批量查询，多个Region用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '监播场次ID，若参数为空，默认返回所有监播场次合并后数据，支持批量查询，多个ID用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'e62af24d-a354-3b0c-9f1f-da592c4b****', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的时间粒度，可以使用**3600**和**86400**，即小时和天粒度。', + 'type' => 'string', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'SplitBy', + 'in' => 'query', + 'schema' => [ + 'description' => '分组键。默认为**resolution**，即按清晰度分组，可选值为**domain**，**region**，**instance**，**resolution**之一。可以指定多个，多个值用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'resolution', + 'default' => 'resolution', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'EndTime' => [ + 'description' => '查询结束时间。', + 'type' => 'string', + 'example' => '2022-12-10T22:00:00Z', + ], + 'InstanceId' => [ + 'description' => '监播场次ID。', + 'type' => 'string', + 'example' => 'e62af24d-a354-3b0c-9f1f-da592c4b****', + ], + 'MonitoringData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MonitoringDataItem' => [ + 'description' => '广目监播用量明细。', + 'type' => 'array', + 'items' => [ + 'description' => '明细详情。', + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '域名。只有当**Split**指定了domain时有效。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Duration' => [ + 'description' => '时长，单位为分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'InstanceId' => [ + 'description' => '监播场次ID。只有当**Split**指定了instance时有效。', + 'type' => 'string', + 'example' => 'e62af24d-a354-3b0c-9f1f-da592c4b****', + ], + 'Region' => [ + 'description' => '直播中心Region。只有当**Split**指定了Region时有效。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'Resolution' => [ + 'description' => '分辨率.。只有当**Split**指定了resolution时有效。', + 'type' => 'string', + 'example' => '720P', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2022-12-10T20:00:00Z', + ], + ], + ], + ], + ], + ], + 'Region' => [ + 'description' => '直播中心Region。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3C6CCEC4-6B88-4D4A-93E4-D47B3******', + ], + 'StartTime' => [ + 'description' => '查询起始时间。', + 'type' => 'string', + 'example' => '2022-12-10T20:00:00Z', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DomainName\\": \\"example.com\\",\\n \\"EndTime\\": \\"2022-12-10T22:00:00Z\\",\\n \\"InstanceId\\": \\"e62af24d-a354-3b0c-9f1f-da592c4b****\\",\\n \\"MonitoringData\\": {\\n \\"MonitoringDataItem\\": [\\n {\\n \\"DomainName\\": \\"example.com\\",\\n \\"Duration\\": 2000,\\n \\"InstanceId\\": \\"e62af24d-a354-3b0c-9f1f-da592c4b****\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"Resolution\\": \\"720P\\",\\n \\"TimeStamp\\": \\"2022-12-10T20:00:00Z\\"\\n }\\n ]\\n },\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"RequestId\\": \\"3C6CCEC4-6B88-4D4A-93E4-D47B3******\\",\\n \\"StartTime\\": \\"2022-12-10T20:00:00Z\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDomainMonitoringUsageDataResponse>\\n <EndTime>2022-12-10T22:00:00Z</EndTime>\\n <StartTime>2022-12-10T20:00:00Z</StartTime>\\n <RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>\\n <Region>cn-shanghai</Region>\\n <InstanceId>e62af24d-a354-3b0c-9f1f-da592c4b****</InstanceId>\\n <DomainName>example.com</DomainName>\\n <MonitoringData>\\n <Region>cn-shanghai</Region>\\n <TimeStamp>2022-12-10T20:00:00Z</TimeStamp>\\n <Duration>2000</Duration>\\n <InstanceId>e62af24d-a354-3b0c-9f1f-da592c4b****</InstanceId>\\n <DomainName>example.com</DomainName>\\n <Resolution>720P</Resolution>\\n </MonitoringData>\\n</DescribeLiveDomainMonitoringUsageDataResponse>","errorExample":""}]', + 'title' => '获取域名广目监播用量', + 'description' => '- 支持批量域名查询，多个域名用半角逗号（,）分隔。'."\n" + .'- 最多可获取最近90天的数据。'."\n" + .'- 查询数据的时间粒度为小时或天。'."\n" + .'- 最大支持查询时间跨度31天。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'extraInfo' => '## 特殊错误码'."\n" + .'| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" + .'|-------------|-------|-----------------|-------|'."\n" + .'| Throttling | Request was denied due to request throttling. | 503 | 请求被流量控制限制 |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不属于当前用户 |', + ], + 'DescribeLiveDelayedStreamingUsage' => [ + 'summary' => '调用DescribeLiveDelayedStreamingUsage查询延播时长用量数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的主播流域名。'."\n" + .'- 支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。'."\n" + .'- 若参数为空，默认返回所有直播域名合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ，默认返回近七天的数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-10-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间需大于起始时间，时间跨度≤10小时；日期格式按照ISO8601表示法，并使用UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-10-10T21:00:00Z', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '流名，多个流名使用逗号（半角）分隔，默认为所有流名数据聚合输出。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '查询不同直播中心, 支持批量地区查询，多个地区用逗号（半角）分隔。取值：'."\n" + .'- cn-beijing：北京'."\n" + .'- cn-shanghai：上海'."\n" + .'- cn-shenzhen：深圳'."\n" + .'- cn-qingdao：青岛'."\n" + .'- ap-southeast-1：新加坡'."\n" + .'- eu-central-1：德国'."\n" + .'- ap-northeast-1：东京'."\n" + .'- ap-southeast-5：雅加达'."\n" + ."\n" + .'不传值时默认为所有区域数据聚合输出。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'SplitBy', + 'in' => 'query', + 'schema' => [ + 'description' => '分组键，若参数为空，则聚合输出用户数据，取值：'."\n" + .'- domain：域名。如果此参数Split（分组键）取值为domain时，返回参数Domain才生效。'."\n" + .'- region：直播中心地域。如果此参数Split（分组键）取值为region时，返回参数Region才生效。'."\n" + .'- stream：流名。如果此参数Split（分组键）取值为stream时，返回参数stream才生效。'."\n" + ."\n" + .'> 当分组键对应的参数不为空时才可以查询，否则返回错误。例如：当DomainName为空时不可以指定domain为分组键。', + 'type' => 'string', + 'required' => false, + 'example' => 'domain', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度。单位：秒。取值：'."\n" + .'- 300'."\n" + .'- 3600'."\n" + .'- 86400'."\n" + ."\n" + .'不传或传值不支持时，使用默认值3600秒。', + 'type' => 'string', + 'required' => false, + 'example' => '3600', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'DelayData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DelayDataItem' => [ + 'description' => '延播时长用量数据。', + 'type' => 'array', + 'items' => [ + 'description' => '延播时长用量数据。', + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '用量域名，SplitBy指定domain时，分组输出。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Duration' => [ + 'description' => '延播用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '84', + ], + 'Region' => [ + 'description' => '直播中心，SplitBy指定region时，分组输出。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'StreamName' => [ + 'description' => '流名，SplitBy指定stream时，分组输出。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2022-10-10T20:00:00Z', + ], + ], + ], + ], + ], + ], + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2022-10-10T21:00:00Z', + ], + 'RequestId' => [ + 'description' => '该条任务请求ID。', + 'type' => 'string', + 'example' => '4B460F8B-993C-4F48-B98A-91081******', + ], + 'StartTime' => [ + 'description' => '起始时间。', + 'type' => 'string', + 'example' => '2022-10-10T20:00:00Z', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'InvalidParameter.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified StartTime parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified EndTime is invalid.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The StartTime cannot exceed 31 days before the current time.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified Time is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'LiveServiceNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DelayData\\": {\\n \\"DelayDataItem\\": [\\n {\\n \\"DomainName\\": \\"example.com\\",\\n \\"Duration\\": 84,\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"TimeStamp\\": \\"2022-10-10T20:00:00Z\\"\\n }\\n ]\\n },\\n \\"EndTime\\": \\"2022-10-10T21:00:00Z\\",\\n \\"RequestId\\": \\"4B460F8B-993C-4F48-B98A-91081******\\",\\n \\"StartTime\\": \\"2022-10-10T20:00:00Z\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDelayedStreamingUsageResponse>\\n <RequestId>b83f5c8c-b07b-4ac8-90c5-96c0f922d394</RequestId>\\n <StartTime/>\\n <EndTime/>\\n <DelayData>\\n <DelayDataItem>\\n <TimeStamp>2022-11-19T16:00:00Z</TimeStamp>\\n <DomainName>www.example.com</DomainName>\\n <Duration>60</Duration>\\n </DelayDataItem>\\n <DelayDataItem>\\n <TimeStamp>2022-11-19T17:00:00Z</TimeStamp>\\n <DomainName>www.example.com</DomainName>\\n <Duration>60</Duration>\\n </DelayDataItem>\\n </DelayData>\\n</DescribeLiveDelayedStreamingUsageResponse>","errorExample":""}]', + 'title' => '查询延播时长数据', + 'description' => '- 查询用户延播服务用量数据，默认粒度为1小时粒度。'."\n" + .'- 最大查询时间跨度：31天。'."\n" + .'- 最小查询时间粒度：1小时。'."\n" + .'- 最大查询时间范围：31天。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveGrtnDuration' => [ + 'summary' => '调用DescribeLiveGrtnDuration查询连麦通话时长用量数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-10-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间需大于起始时间，查询粒度≥5分钟且≤31天；日期格式按照ISO8601表示法，并使用UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-10-10T21:00:00Z', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，支持查询多个应用ID，多个ID用逗号（半角）分隔，最多可查询30个ID。默认返回所有应用合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => '4346289a-a790-4869-9e23-22766d5e****', + ], + ], + [ + 'name' => 'Area', + 'in' => 'query', + 'schema' => [ + 'description' => '区域代号。支持：'."\n" + .'- CN：中国内地。'."\n" + .'- OverSeas：海外大区。'."\n" + .'- AP1：亚太1区，包含中国香港地区、中国澳门地区、中国台湾地区、日本以及东南亚除越南和印尼之外的国家。'."\n" + .'- AP2：亚太2区，包含印尼、韩国、越南。'."\n" + .'- AP3：亚太3区，包含澳大利亚、新西兰。'."\n" + .'- NA：北美，包含美国、加拿大。'."\n" + .'- SA：南美，特指巴西。'."\n" + .'- EU：欧洲，包含乌克兰、英国、法国、荷兰、西班牙、意大利、瑞典、德国。'."\n" + .'- MEAA：中东非洲，包含南非、阿曼、阿联酋、科威特。'."\n" + ."\n" + .'不传值时默认为所有区域数据聚合输出。', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度。单位：秒。取值：'."\n" + ."\n" + .'- 300'."\n" + .'- 3600'."\n" + .'- 86400'."\n" + ."\n" + .'不传或传值不支持时，使用默认值3600秒。', + 'type' => 'string', + 'required' => false, + 'example' => '3600', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '该条任务请求ID。', + 'type' => 'string', + 'example' => '4B460F8B-993C-4F48-B98A-910811DEBFEB', + ], + 'StreamDetailData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StreamData' => [ + 'description' => '连麦用量数据明细。', + 'type' => 'array', + 'items' => [ + 'description' => '连麦用量数据明细。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => '4346289a-a790-4869-9e23-22766d5e****', + ], + 'Duration' => [ + 'description' => '连麦时长，单位：分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'MediaProfile' => [ + 'description' => '媒体规格，取值：'."\n" + ."\n" + .'- 0：纯音频时长，基础规格。'."\n" + .'- 480P：标清时长，视频分辨率为640×480及以下。'."\n" + .'- 720P：高清时长，视频分辨率为1280×720及以下。'."\n" + .'- 1080P：全高清时长，视频分辨率为1920×1080及以下。', + 'type' => 'string', + 'example' => '480P', + ], + 'MediaType' => [ + 'description' => '媒体类型，取值：'."\n" + ."\n" + .'- audio：音频。'."\n" + .'- video：视频。', + 'type' => 'string', + 'example' => 'audio', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2022-12-10T20:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidAreaParameter', + 'errorMessage' => 'The specified Area parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidAppIdParameter', + 'errorMessage' => 'The specified AppId parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidInstanceIdParameter', + 'errorMessage' => 'The specified InstanceId parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidTime.ValueNotSupported', + 'errorMessage' => 'Specified Time is malformed.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4B460F8B-993C-4F48-B98A-910811DEBFEB\\",\\n \\"StreamDetailData\\": {\\n \\"StreamData\\": [\\n {\\n \\"AppId\\": \\"4346289a-a790-4869-9e23-22766d5e****\\",\\n \\"Duration\\": 30,\\n \\"MediaProfile\\": \\"480P\\",\\n \\"MediaType\\": \\"audio\\",\\n \\"TimeStamp\\": \\"2022-12-10T20:00:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveGrtnDurationResponse>\\n <StreamDetailData>\\n <StreamData>\\n <TimeStamp>2022-12-10T20:00:00Z</TimeStamp>\\n <MediaType>video</MediaType>\\n <MediaProfile>720P</MediaProfile>\\n <Duration>423304182</Duration>\\n </StreamData>\\n <StreamData>\\n <TimeStamp>2022-12-10T21:00:00Z</TimeStamp>\\n <MediaType>video</MediaType>\\n <MediaProfile>720P</MediaProfile>\\n <Duration>454680793</Duration>\\n </StreamData>\\n </StreamDetailData>\\n <RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>\\n</DescribeLiveGrtnDurationResponse>","errorExample":""}]', + 'title' => '查询连麦通话时长用量数据', + 'description' => '- 最大查询跨度：31天。'."\n" + .'- 最小查询粒度：5分钟。'."\n" + .'- 最大查询范围：最近90天的数据。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'extraInfo' => '### 特殊错误码'."\n" + .'|错误代码|描述|HTTP状态码|语义|'."\n" + .'|----|----|------|-----|'."\n" + .'|Throttling|Request was denied due to request throttling.|503|请求被流量控制限制。|'."\n" + .'|IllegalOperation|Illegal domain, operation is not permitted.|403|非法域名，无法操作。'."\n" + .'|OperationDenied|Your account does not open LIVE service yet.|403|未开通LIVE服务。|'."\n" + .'|OperationDenied|Your LIVE service is suspended.|403|LIVE服务已被停止。|'."\n" + .'|InvalidStartTime.Malformed|Specified StartTime is malformed.|400|参数错误。|'."\n" + .'|InvalidEndTime.Malformed|Specified EndTime is malformed.|400|时间格式错误。|'."\n" + .'|InvalidTime.Malformed|Specified StartTime or EndTime is malformed.|400|开始时间或结束时间格式错误。|'."\n" + .'|InvalidEndTime.Mismatch|Specified end time does not math the specified start time.|400|开始时间和结束时间不匹配。|'."\n" + .'|InvalidTimeSpan|The time span exceeds the limit.|400|查询跨度错误。|'."\n" + .'|InvalidAppIdParameter|The specified AppId parameter is invalid.|400|AppID参数错误。|'."\n" + .'|InvalidParameterInterval|Invalid Parameter Interval.|400|Interval参数错误。|', + ], + 'DescribeMeterLiveBypassDuration' => [ + 'summary' => 'DescribeMeterLiveBypassDuration', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-10-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间需大于起始时间，查询粒度≥5分钟且≤31天；日期格式按照ISO8601表示法，并使用UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-10-10T21:00:00Z', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。您可在实时音视频[应用管理](~~2355593~~)页面查看。', + 'type' => 'string', + 'required' => true, + 'example' => '4346289a-a790-4869-9e23-22766d5e****', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度。单位：秒。取值：'."\n" + ."\n" + .'- 300'."\n" + .'- 3600'."\n" + .'- 86400'."\n" + ."\n" + .'不传或传值不支持时，使用默认值3600秒。', + 'type' => 'string', + 'required' => false, + 'example' => '86400', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AudioSummaryDuration' => [ + 'description' => '纯音频汇总时长，基础规格，单位：分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Data' => [ + 'description' => '用量统计信息。', + 'type' => 'array', + 'items' => [ + 'description' => '用量统计信息。', + 'type' => 'object', + 'properties' => [ + 'AudioDuration' => [ + 'description' => '纯音频时长，基础规格，单位：分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Single_Audio' => [ + 'description' => '单流转推-语音时长，单位：分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Single_Video' => [ + 'description' => '单流转推-视频时长，单位：分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'Timestamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2022-10-10T20:00:00Z', + ], + 'TotalDuration' => [ + 'description' => '全部时长，单位：分钟 。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '150', + ], + 'V480Duration' => [ + 'description' => '标清时长，视频分辨率为640×480及以下，单位：分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'V720Duration' => [ + 'description' => '高清时长，视频分辨率为1280×720及以下，单位：分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40', + ], + 'V1080Duration' => [ + 'description' => '全高清时长，视频分辨率为1920×1080及以下，单位：分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '该条任务请求ID。', + 'type' => 'string', + 'example' => '4B460F8B-993C-4F48-B98A-910811DEBFEB', + ], + 'SingleAudioSummaryDuration' => [ + 'description' => '单流转推-语音汇总时长，单位：分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'SingleVideoSummaryDuration' => [ + 'description' => '单流转推-视频汇总时长，单位：分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'TotalSummaryDuration' => [ + 'description' => '汇总时长，单位：分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '150', + ], + 'V480SummaryDuration' => [ + 'description' => '标清汇总时长，视频分辨率为640×480及以下，单位：分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'V720SummaryDuration' => [ + 'description' => '高清汇总时长，视频分辨率为1280×720及以下，单位：分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40', + ], + 'V1080SummaryDuration' => [ + 'description' => '全高清汇总时长，视频分辨率为1920×1080及以下，单位：分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + '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' => '[{"type":"json","example":"{\\n \\"AudioSummaryDuration\\": 20,\\n \\"Data\\": [\\n {\\n \\"AudioDuration\\": 20,\\n \\"Single_Audio\\": 20,\\n \\"Single_Video\\": 30,\\n \\"Timestamp\\": \\"2022-10-10T20:00:00Z\\",\\n \\"TotalDuration\\": 150,\\n \\"V480Duration\\": 30,\\n \\"V720Duration\\": 40,\\n \\"V1080Duration\\": 10\\n }\\n ],\\n \\"RequestId\\": \\"4B460F8B-993C-4F48-B98A-910811DEBFEB\\",\\n \\"SingleAudioSummaryDuration\\": 20,\\n \\"SingleVideoSummaryDuration\\": 30,\\n \\"TotalSummaryDuration\\": 150,\\n \\"V480SummaryDuration\\": 30,\\n \\"V720SummaryDuration\\": 40,\\n \\"V1080SummaryDuration\\": 10\\n}","errorExample":""},{"type":"xml","example":"<DescribeMeterLiveBypassDurationResponse>\\n <RequestId>93FAB4C8-42AD-5BB9-BE9B-0AA8C6C0CC2F</RequestId>\\n <V480SummaryDuration>30</V480SummaryDuration>\\n <V1080SummaryDuration>10</V1080SummaryDuration>\\n <V720SummaryDuration>40</V720SummaryDuration>\\n <TotalSummaryDuration>150</TotalSummaryDuration>\\n <AudioSummaryDuration>20</AudioSummaryDuration>\\n <Data>\\n <Single_Audio>20</Single_Audio>\\n <V720Duration>40</V720Duration>\\n <V1080Duration>10</V1080Duration>\\n <V480Duration>30</V480Duration>\\n <Timestamp>2022-10-10T20:00:00Z</Timestamp>\\n <TotalDuration>150</TotalDuration>\\n <Single_Video>30</Single_Video>\\n <AudioDuration>20</AudioDuration>\\n </Data>\\n <SingleAudioSummaryDuration>20</SingleAudioSummaryDuration>\\n <SingleVideoSummaryDuration>30</SingleVideoSummaryDuration>\\n</DescribeMeterLiveBypassDurationResponse>","errorExample":""}]', + 'title' => '查询混流转码用量数据', + 'description' => '## 使用说明'."\n" + .'- 最大查询跨度：31天。'."\n" + .'- 最小查询粒度：5分钟。'."\n" + .'- 最大查询范围：最近90天的数据。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'DescribeLiveDrmUsageData' => [ + 'summary' => '查询指定时间范围内DRM用量数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播域名。'."\n" + .'- 支持单个或批量域名查询。批量查询时多个域名用英文逗号（,）分隔。'."\n" + .'- 若参数为空，默认返回所有直播域名合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。最小数据粒度为5分钟', + 'type' => 'string', + 'required' => true, + 'example' => '2021-05-01T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间需大于起始时间，获日期格式按照ISO8601表示法，并使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ', + 'type' => 'string', + 'required' => true, + 'example' => '2021-05-02T16:00:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度。单位：秒。取值：'."\n" + .'- 300'."\n" + .'- 3600'."\n" + .'- 86400'."\n" + ."\n" + .'不传或传值不支持时，使用默认值3600秒。', + 'type' => 'string', + 'required' => false, + 'example' => '3600', + 'default' => '3600', + 'enum' => [ + '300', + '3600', + '86400', + ], + ], + ], + [ + 'name' => 'SplitBy', + 'in' => 'query', + 'schema' => [ + 'description' => '分组键。默认为domain,region,drm_type。可选值为domain、region、drm_type 中的一个或多个，多个使用逗号（半角）分隔。置为空或null即不区分上述键。', + 'type' => 'string', + 'required' => false, + 'example' => 'domain,region,drm_type', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DrmUsageData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的DRM用量数据。', + 'type' => 'array', + 'items' => [ + 'description' => '每个时间间隔的DRM用量数据。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '调用次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Domain' => [ + 'description' => '用量域名，SplitBy指定domain时，分组输出。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DrmType' => [ + 'description' => 'DRM类型，SplitBy指定drm_type时，分组输出。', + 'type' => 'string', + 'example' => 'Widevine', + ], + 'Region' => [ + 'description' => '直播中心，SplitBy指定region时，分组输出。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2021-05-01T16:00:00Z', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '91FC2D9D-B042-4634-8A5C-7B8E7482C22D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DrmUsageData\\": {\\n \\"DataModule\\": [\\n {\\n \\"Count\\": 1,\\n \\"Domain\\": \\"example.com\\",\\n \\"DrmType\\": \\"Widevine\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"TimeStamp\\": \\"2021-05-01T16:00:00Z\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"91FC2D9D-B042-4634-8A5C-7B8E7482C22D\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDrmUsageDataResponse>\\n <DrmUsageData>\\n <Count>1</Count>\\n <Domain>example.com</Domain>\\n <DrmType>Widevine</DrmType>\\n <Region>cn-beijing</Region>\\n <TimeStamp>2021-05-01T16:00:00Z</TimeStamp>\\n </DrmUsageData>\\n <RequestId>91FC2D9D-B042-4634-8A5C-7B8E7482C22D</RequestId>\\n</DescribeLiveDrmUsageDataResponse>","errorExample":""}]', + 'title' => '获取直播DRM用量数据', + 'description' => '### 使用说明'."\n" + .'- 最多可获取最近90天的数据。'."\n" + .'- 最大允许时间跨度31天。'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'DescribeLiveRtcRecordUsageData' => [ + 'summary' => '云端录制用量查询。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。查询粒度≥5 分钟且≤31 天。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-10-10T21:00:00Z', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '实时音视频应用 ID。可在[实时音视频应用管理](~~2355593~~)中查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'intl7f92-a5a8*************7ce4eb44a6', + ], + ], + [ + 'name' => 'RecordMode', + 'in' => 'query', + 'schema' => [ + 'description' => '录制模式：'."\n" + ."\n" + .'- 0：单流录制模式。'."\n" + ."\n" + .'- 1：混流录制模式。', + 'type' => 'string', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度。单位：秒。取值：'."\n" + ."\n" + .'- 3600（默认）。'."\n" + ."\n" + .'- 86400。', + 'type' => 'string', + 'required' => false, + 'example' => '3600', + ], + ], + ], + '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' => '16A96B9A-F2*************B92E68F4CD8', + ], + 'RecordMode' => [ + 'description' => '录制模式。'."\n" + ."\n" + .'- 0：单流录制模式。'."\n" + ."\n" + .'- 1：混流录制模式。', + 'type' => 'string', + 'example' => '0', + ], + 'AppId' => [ + 'description' => '需要查询的实时音视频应用ID。', + 'type' => 'string', + 'example' => '7fd341b3-c6fa-43e1-96b8-7295a1dd****', + ], + 'TotalSummaryDuration' => [ + 'description' => '汇总时长，单位：秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '150', + ], + 'AudioSummaryDuration' => [ + 'description' => '纯音频汇总时长，单位：秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '20', + ], + 'V480SummaryDuration' => [ + 'description' => '480P及以下视频汇总时长，单位：秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '30', + ], + 'V720SummaryDuration' => [ + 'description' => '720P及以下视频汇总时长，单位：秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '40', + ], + 'V1080SummaryDuration' => [ + 'description' => '720P以上（含1080P）视频汇总时长，单位：秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + 'Data' => [ + 'description' => '用量统计信息。', + 'type' => 'array', + 'items' => [ + 'description' => '用量统计信息。', + 'type' => 'object', + 'properties' => [ + 'Timestamp' => [ + 'description' => '数据统计时刻。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。', + 'type' => 'string', + 'example' => '2022-10-10T20:00:00Z', + ], + 'TotalDuration' => [ + 'description' => '全部时长，单位：秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '150', + ], + 'AudioDuration' => [ + 'description' => '纯音频时长，单位：秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '20', + ], + 'V480Duration' => [ + 'description' => '480P及以下视频时长，单位：秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '30', + ], + 'V720Duration' => [ + 'description' => '720P及以下视频时长，单位：秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '40', + ], + 'V1080Duration' => [ + 'description' => '720P以上视频时长，单位：秒。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidRecordModeParameter', + 'errorMessage' => 'RecordMode parameter error.', + ], + [ + 'errorCode' => 'InvalidAppIdParameter', + 'errorMessage' => 'AppId parameter error.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F2*************B92E68F4CD8\\",\\n \\"RecordMode\\": \\"0\\",\\n \\"AppId\\": \\"7fd341b3-c6fa-43e1-96b8-7295a1dd****\\",\\n \\"TotalSummaryDuration\\": 150,\\n \\"AudioSummaryDuration\\": 20,\\n \\"V480SummaryDuration\\": 30,\\n \\"V720SummaryDuration\\": 40,\\n \\"V1080SummaryDuration\\": 10,\\n \\"Data\\": [\\n {\\n \\"Timestamp\\": \\"2022-10-10T20:00:00Z\\",\\n \\"TotalDuration\\": 150,\\n \\"AudioDuration\\": 20,\\n \\"V480Duration\\": 30,\\n \\"V720Duration\\": 40,\\n \\"V1080Duration\\": 10\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询实时音视频云端录制用量', + 'description' => '- 统计每日云端录制各规格下的录制时长。'."\n" + ."\n" + .'- 支持到实时音视频应用粒度查询。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CreateCaster' => [ + 'summary' => '调用CreateCaster创建导播台。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '106890', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterName', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveCaster****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用户生成的请求token。用于保证请求的幂等性。'."\n" + ."\n" + .'该参数值可自定义，但是要保证在不同请求间唯一，最大值不超过64个ASCII字符。', + 'type' => 'string', + 'required' => true, + 'example' => '53200b81-b761-4c10-842a-a0726d97****', + 'maxLength' => 64, + 'minLength' => 0, + ], + ], + [ + 'name' => 'NormType', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台规格类型。取值：'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- **1**：通用型。'."\n" + ."\n" + .'- **3**：轻量级轮播型。'."\n" + ."\n" + .'- **4**：虚拟演播厅型。'."\n" + ."\n" + .'- **6**：轮播台（新播单型导播台）。'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'- **1**：通用型。'."\n" + ."\n" + .'- **6**：轮播台（新播单型导播台）。'."\n" + ."\n" + .'</props>', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费方式。 目前只支持**PostPaid**。取值：'."\n" + ."\n" + .'- **PrePaid**：预付费（暂不支持）。'."\n" + .'- **PostPaid**：后付费。', + 'type' => 'string', + 'required' => true, + 'example' => 'PostPaid', + ], + ], + [ + 'name' => 'PurchaseTime', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台购买时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> 当**ChargeType**为**PrePaid**时，此参数才可设置。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-08-20T12:10:10Z', + ], + ], + [ + 'name' => 'ExpireTime', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台过期时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> 当**ChargeType**为**PrePaid**时，此参数才可设置。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-08-22T12:10:10Z', + ], + ], + [ + 'name' => 'CasterTemplate', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台预设分辨率。采用预付费方式时，取值：'."\n" + ."\n" + .'- **lp_ld**：流畅。'."\n" + .'- **lp_sd**：标清。'."\n" + .'- **lp_hd**：高清。'."\n" + .'- **lp_ud**：超清。'."\n" + .'- **lp_ld_v**：竖屏流畅。'."\n" + .'- **lp_sd_v**：竖屏标清。'."\n" + .'- **lp_hd_v**：竖屏高清。'."\n" + .'- **lp_ud_v**：竖屏超清。'."\n" + ."\n" + .'>后付费场景下，需要设置分辨率，请调用[SetCasterConfig](~~60271~~)接口进行操作。', + 'type' => 'string', + 'required' => false, + 'example' => 'lp_sd', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。关于资源组的更多信息，请参见[什么是资源组](~~2381067~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzw******', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签健。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。可作为查询导播台流地址、启动导播台、添加导播台视频资源、添加导播台布局、查询导播台布局列表、添加导播台组件和添加导播台节目单的请求参数。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PurchaseTime', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter.ExpireTime', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidChargeType.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidChargeType.PostSupport', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidCasterTemplate.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter.ChargeType', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidPeriod.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidClientToken.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'IncorrectCasterStatus', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'CasterNumberExceed', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDenied', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameter.NormType', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidConfiguration.NotFound', + 'errorMessage' => '%s', + ], + ], + 408 => [ + [ + 'errorCode' => 'CreateCaster.Timeout', + 'errorMessage' => '%s', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<CreateCasterResponse>\\n<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n<CasterId>a2b8e671-2fe5-4642-a2ec-bf93880e1****</CasterId>\\n</CreateCasterResponse>","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"CasterId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e1a49\\"\\n}\\n"}]', + 'title' => '创建导播台', + 'description' => '您已开通云导播服务再调用本接口创建导播台。开通指引，请参见[开通服务](~~60361~~)。'."\n" + .'<props="china">本接口目前支持的导播台规格类型为通用型、轻量级轮播型、虚拟演播厅型和新播单型（轮播台）。</props>'."\n" + .'<props="intl">本接口目前支持的导播台规格类型为通用型和新播单型（轮播台）。</props>'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetCasterConfig' => [ + 'summary' => '调用本接口对导播台进行详细配置，包括导播台的名称、转码配置、录制配置等参数信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107215', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster](~~2848009~~)接口创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + [ + 'name' => 'CasterName', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveCaster****', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。'."\n" + ."\n" + .'请您在导播台启动前完成域名配置。 若该参数为空，默认清除导播台域名配置。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'TranscodeConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '转码配置。 '."\n" + ."\n" + .'JSON格式字符串，结构体内部字段请按首字母大写，驼峰格式输入。 若该参数设置为空，默认清除转码配置， 当转码模板为空的时候，导播台启动时会报错。', + 'type' => 'string', + 'required' => false, + 'example' => '{"casterTemplate": "lp_ld"}', + ], + ], + [ + 'name' => 'RecordConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '录制配置信息。格式为JSON。配置元素信息如下：'."\n" + ."\n" + .'- **endpoint**：阿里云服务的API服务端地址。'."\n" + .'- **ossBucket**：ossBucket名称。'."\n" + .'- **videoFormat**：支持导出的视频文件格式，例如：`[{\\"OssObjectPrefix\\":\\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\\",\\"Format\\":\\"m3u8\\",\\"CycleDuration\\":21600,\\"SliceOssObjectPrefix\\":\\"record/{AppName}/{StreamName}/{UnixTimestamp}\\"},{\\"OssObjectPrefix\\":\\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\\",\\"Format\\":\\"flv\\",\\"CycleDuration\\":21600}]`。'."\n" + .'- **interval**：时间间隔，单位为毫秒（ms）。'."\n" + ."\n" + .'>参数设置为空时表示不启用录制功能。 若该参数置为空，默认清除录制配置。 ', + 'type' => 'string', + 'required' => false, + 'example' => '{ "endpoint": "http://oss-cn-********.aliyuncs.com/api", "ossBucket****": "liveBucket****", "VideoFormat":[{\\"OssObjectPrefix\\":\\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\\",\\"Format\\":\\"m3u8\\",\\"CycleDuration\\":21600,\\"SliceOssObjectPrefix\\":\\"record/{AppName}/{StreamName}/{UnixTimestamp}\\"},{\\"OssObjectPrefix\\":\\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\\",\\"Format\\":\\"flv\\",\\"CycleDuration\\":21600}] "interval": 5 }', + ], + ], + [ + 'name' => 'Delay', + 'in' => 'query', + 'schema' => [ + 'description' => '延时播放。时间单位：秒。'."\n" + ."\n" + .'- **0**（默认值）：禁用延时。'."\n" + .'- 大于**0**：启用延时。'."\n" + .'- **空**：默认清除延播配置。'."\n" + .'> 最大可支持设置300秒。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'UrgentMaterialId', + 'in' => 'query', + 'schema' => [ + 'description' => '备播视频，媒资库素材ID。若该参数置为空，默认清除备播配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'a2b8e671', + ], + ], + [ + 'name' => 'UrgentLiveStreamUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '备播直播流URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://demo.aliyundoc.com', + ], + ], + [ + 'name' => 'SideOutputUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义导播台旁路输出地址对应的推流地址。 '."\n" + .'若该参数为空，则默认使用阿里云自动生成的输出地址对应的推流地址。'."\n" + .'> 目前sideoutputUrl只支持rtmp协议推流。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****', + ], + ], + [ + 'name' => 'SideOutputUrlList', + 'in' => 'query', + 'schema' => [ + 'description' => '多路转推流地址列表，可以是阿里云或第三方厂商的CDN推流地址，一个导播台最多支持添加20个RTMP转推地址。'."\n" + ."\n\n" + .'> 多个地址用["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"]数组格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://domain/app/stream?***', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '用户回调地址。若需要接收回调通知，请输入可用的接收地址，接受HTTP协议。 若该参数置为空，默认取消导播台回调通知。'."\n" + .'> 导播台回调详细信息，请参见[云导播回调信息说明](~~213633~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****', + ], + ], + [ + 'name' => 'ProgramEffect', + 'in' => 'query', + 'schema' => [ + 'description' => '轮播生效标志。 '."\n" + ."\n" + .'- **0**：不生效。'."\n" + .'- **1**：生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProgramName', + 'in' => 'query', + 'schema' => [ + 'description' => '轮播台名称，若使用轮播功能时可配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'program_name', + ], + ], + [ + 'name' => 'ChannelEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用Channel。 '."\n" + .' '."\n" + .'- **0**（默认）：不启用。'."\n" + .'- **1**：启用。 '."\n" + ."\n" + .'> 默认不启用，且启用后不可取消；不启用时Resource直接被布局引用，首次开启Channel需要在导播台停止的状态下进行，之前已存在的布局将被废弃，Resource需要首先设置到Channel中，新增的布局直接引用Channel，通过Channel可调整视频源播放进度和播放状态，该模式下视频源、PVW、PGM三区域若引用同一Resource，则对应画面将保持同步。 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SyncGroupsConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '多视角同步配置，让多个视频源同步。'."\n" + .'多视角同步分为两个模式：'."\n" + ."\n" + .'- mode: 0（主播模式，多个视频源根据指定的模式同步。）'."\n" + ."\n" + .'- mode: 1（会议模式，没有主播视频的概念，所有视频源相互同步。）'."\n" + ."\n\n" + ."\n" + .'主播模式：hostResourceId：主播模式下的主播视频源'."\n" + ."\n" + .'会议模式：没有hostRsoureId 字段，只提供需要提供的resourceIds 中的资源ids'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"[{\\"mode\\":0,\\"resourceIds\\":[\\"5a6c1c33-8424-46f6-813c-c152220a****\\",\\"4e6521dc-a40a-4077-b6bf-1fb12a76****\\"],\\"hostResourceId\\":\\"3aa2b39a-fd0e-4b8c-be73-b7af31c4****\\"}]"', + ], + ], + [ + 'name' => 'UrgentImageId', + 'in' => 'query', + 'schema' => [ + 'description' => '备播媒资库图片素材ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'a089175eb5f4427684fc0715159a****', + ], + ], + [ + 'name' => 'UrgentImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '备播图片素材URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://learn.aliyundoc.com/AppName/image.jpg', + ], + ], + [ + 'name' => 'AutoSwitchUrgentOn', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '开启断流自动切换备播。'."\n" + .'- **true**：开启。'."\n" + .'- **false**：关闭。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AutoSwitchUrgentConfig', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '自动切备播配置。'."\n" + .'`eofThres`：表示断流时间后自动切备播，单位为秒。', + 'type' => 'string', + 'required' => false, + 'example' => '{"eofThres":3}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。可作为查询导播台流地址、启动导播台、添加导播台视频资源、添加导播台布局、查询导播台布局列表、添加导播台组件和添加导播台节目单的请求参数。', + 'type' => 'string', + 'example' => 'b4810848-bcf9-4aef-bd4a-e6bba2d9****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'IncorrectCasterStatus.Inuse', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidCaster.ChannelDisableUnsupported', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'IncorrectCasterStatus.EnableChannel', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDenied', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterId\\": \\"b4810848-bcf9-4aef-bd4a-e6bba2d9****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<SetCasterConfigResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n\\t<casterId>b4810848-bcf9-4aef-bd4a-e6bba2d9****</casterId>\\n</SetCasterConfigResponse>\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"casterId\\": \\"b4810848-bcf9-4aef-bd4a-e6bba2d966c8\\"\\n}"}]', + 'title' => '设置导播台配置', + 'description' => '先通过[CreateCaster](~~2848009~~)接口创建导播台，再调用本接口对导播台进行详细配置。此接口将会全面替换现有的配置信息，如果您将某个参数设置为空，则会清除该参数在导播台中的现有配置。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCasterConfig' => [ + 'summary' => '查询导播台配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106967', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster](~~2848009~~)接口创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '导播台配置信息。', + 'type' => 'object', + 'properties' => [ + 'AutoSwitchUrgentConfig' => [ + 'description' => '自动切备播配置。`eofThres`：表示断流时间后自动切备播，单位为秒。', + 'type' => 'string', + 'example' => '{"eofThres":3}', + ], + 'AutoSwitchUrgentOn' => [ + 'description' => '开启断流自动切换备播。'."\n" + .'- **true**：开启。'."\n" + .'- **false**：关闭。', + 'type' => 'string', + 'example' => 'true', + ], + 'CallbackUrl' => [ + 'description' => '用户回调地址。', + 'type' => 'string', + 'example' => 'http://learn.aliyundoc.com/callBackLive', + ], + 'CasterId' => [ + 'description' => '导播台ID。', + 'type' => 'string', + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + 'CasterName' => [ + 'description' => '导播台名称。', + 'type' => 'string', + 'example' => 'coco-caster10', + ], + 'ChannelEnable' => [ + 'description' => '是否启用Channel。 取值：'."\n" + .' '."\n" + .'- **0**：不启用。'."\n" + .'- **1**：启用。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Delay' => [ + 'description' => '延时播放。单位：秒 。 '."\n" + .' '."\n" + .'- **0**：禁用延时。'."\n" + .'- 大于**0**：启用延时。'."\n" + .' '."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'ProgramEffect' => [ + 'description' => '轮播生效标志。 取值：'."\n" + .' '."\n" + .'- **0**：不生效 。'."\n" + .'- **1**：生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProgramName' => [ + 'description' => '轮播台名称。', + 'type' => 'string', + 'example' => 'program_name', + ], + 'RecordConfig' => [ + 'description' => '录制配置参数为空时，表示不启用录制功能。', + 'type' => 'object', + 'properties' => [ + 'OnDemand' => [ + 'description' => '按需录制。取值：'."\n" + ."\n" + .'- 0：关闭。'."\n" + ."\n" + .'- 1：通过HTTP回调方式。'."\n" + ."\n" + .'- 2：解析推流参数按需录制。'."\n" + ."\n" + .'- 7：默认不录制。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OssBucket' => [ + 'description' => '存储位置。', + 'type' => 'string', + 'example' => 'liveBucket****', + ], + 'OssEndpoint' => [ + 'description' => '存储位置所在OSS节点。', + 'type' => 'string', + 'example' => 'oss-cn-shanghai.aliyundoc.com', + ], + 'RecordFormat' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RecordFormat' => [ + 'description' => '录制格式配置。', + 'type' => 'array', + 'items' => [ + 'description' => '录制时长信息。', + 'type' => 'object', + 'properties' => [ + 'CycleDuration' => [ + 'description' => '录制时长。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'Format' => [ + 'description' => '录制格式。', + 'type' => 'string', + 'example' => 'M3U8', + ], + 'OssObjectPrefix' => [ + 'description' => '录制文件名。', + 'type' => 'string', + 'example' => 'record/{liveApp****}/{liveStream****}', + ], + 'SliceOssObjectPrefix' => [ + 'description' => '切片名称。', + 'type' => 'string', + 'example' => 'record/{liveApp****}/{liveStream****}/{UnixTimestamp****}', + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '97df6b7f-3490-47d2-ac50-8833e1b64597', + ], + 'SideOutputUrl' => [ + 'description' => '用户自定义导播台旁路输出地址。', + 'type' => 'string', + 'example' => 'rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****', + ], + 'SideOutputUrlList' => [ + 'description' => '用户自定义导播台旁路输出地址列表。', + 'type' => 'string', + 'example' => '["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"]', + ], + 'SyncGroupsConfig' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SyncGroup' => [ + 'description' => '存储配置。', + 'type' => 'array', + 'items' => [ + 'description' => '存储配置。', + 'type' => 'object', + 'properties' => [ + 'HostResourceId' => [ + 'description' => '导播台资源ID。', + 'type' => 'string', + 'example' => '28768383240243****', + ], + 'Mode' => [ + 'description' => '静态页面缓存的模式。取值：'."\n" + ."\n" + .'- 0： 标准模式。'."\n" + ."\n" + .'- 1：强力模式。'."\n" + ."\n" + .'- 2：不缓存。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResourceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResourceId' => [ + 'description' => '需要修改资源组的云资源的资源ID列表，资源ID数量限制为1至50。', + 'type' => 'array', + 'items' => [ + 'description' => '需要修改资源组的云资源的资源ID列表，资源ID数量限制为1至50。'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'TranscodeConfig' => [ + 'description' => '转码配置。', + 'type' => 'object', + 'properties' => [ + 'CasterTemplate' => [ + 'description' => '导播台转码模板。取值：'."\n" + ."\n" + .'- **lp_ld**：流畅。'."\n" + .'- **lp_sd**：标清。'."\n" + .'- **lp_hd**：高清。'."\n" + .'- **lp_ud**：超清。'."\n" + .'- **lp_ld_v**：竖屏流畅。'."\n" + .'- **lp_sd_v**：竖屏标清。'."\n" + .'- **lp_hd_v**：竖屏高清。'."\n" + .'- **lp_ud_v**：竖屏超清。', + 'type' => 'string', + 'example' => 'lp_hd', + ], + 'LiveTemplateIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LocationId' => [ + 'description' => '直播转码配置。', + 'type' => 'array', + 'items' => [ + 'description' => '直播转码配置。取值：'."\n" + ."\n" + .'- **lsd**：标清 。'."\n" + .'- **lld**：流畅。'."\n" + .'- **lud**：超清。'."\n" + .'- **lhd**：高清自适应转码模板 。'."\n" + .'- **daobo-lsd**：标清。'."\n" + .'- **daobo-lld**：流畅。'."\n" + .'- **daobo-lud**：超清。'."\n" + .'- **daobo-lhd**：高清 。', + 'type' => 'string', + 'example' => 'lld', + ], + ], + ], + ], + 'CustomParams' => [ + 'description' => '自定义配置', + 'type' => 'object', + 'properties' => [ + 'video' => [ + 'description' => '视频参数', + 'type' => 'object', + 'properties' => [ + 'fps' => [ + 'description' => '视频帧率', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'bitrate' => [ + 'description' => '视频码率', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'width' => [ + 'description' => '视频画面宽度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1080', + ], + 'height' => [ + 'description' => '视频画面高度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '720', + ], + ], + ], + ], + ], + ], + ], + 'UrgentImageId' => [ + 'description' => '备播图片媒资库素材ID。', + 'type' => 'string', + 'example' => 'a089175eb5f4427684fc0715159a****', + ], + 'UrgentImageUrl' => [ + 'description' => '备播图片素材URL。', + 'type' => 'string', + 'example' => 'http://learn.aliyundoc.com/AppName/image.jpg', + ], + 'UrgentLiveStreamUrl' => [ + 'description' => '备播直播流URL。', + 'type' => 'string', + 'example' => 'rtmp://demo.aliyundoc.com', + ], + 'UrgentMaterialId' => [ + 'description' => '备播视频媒资库素材ID。', + 'type' => 'string', + 'example' => '98646538-bcf9-4aef-bd4a-e6bb76588****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AutoSwitchUrgentConfig\\": \\"{\\\\\\"eofThres\\\\\\":3}\\",\\n \\"AutoSwitchUrgentOn\\": \\"true\\",\\n \\"CallbackUrl\\": \\"http://learn.aliyundoc.com/callBackLive\\",\\n \\"CasterId\\": \\"LIVEPRODUCER_POST-cn-0pp1czt****\\",\\n \\"CasterName\\": \\"coco-caster10\\",\\n \\"ChannelEnable\\": 1,\\n \\"Delay\\": 0,\\n \\"DomainName\\": \\"example.com\\",\\n \\"ProgramEffect\\": 0,\\n \\"ProgramName\\": \\"program_name\\",\\n \\"RecordConfig\\": {\\n \\"OnDemand\\": 0,\\n \\"OssBucket\\": \\"liveBucket****\\",\\n \\"OssEndpoint\\": \\"oss-cn-shanghai.aliyundoc.com\\",\\n \\"RecordFormat\\": {\\n \\"RecordFormat\\": [\\n {\\n \\"CycleDuration\\": 3600,\\n \\"Format\\": \\"M3U8\\",\\n \\"OssObjectPrefix\\": \\"record/{liveApp****}/{liveStream****}\\",\\n \\"SliceOssObjectPrefix\\": \\"record/{liveApp****}/{liveStream****}/{UnixTimestamp****}\\"\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"97df6b7f-3490-47d2-ac50-8833e1b64597\\",\\n \\"SideOutputUrl\\": \\"rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****\\",\\n \\"SideOutputUrlList\\": \\"[\\\\\\"rtmp://domain/app1/stream1\\\\\\",\\\\\\"rtmp://domain/app2/stream2\\\\\\"]\\",\\n \\"SyncGroupsConfig\\": {\\n \\"SyncGroup\\": [\\n {\\n \\"HostResourceId\\": \\"28768383240243****\\",\\n \\"Mode\\": 0,\\n \\"ResourceIds\\": {\\n \\"ResourceId\\": [\\n \\"1\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"TranscodeConfig\\": {\\n \\"CasterTemplate\\": \\"lp_hd\\",\\n \\"LiveTemplateIds\\": {\\n \\"LocationId\\": [\\n \\"lld\\"\\n ]\\n },\\n \\"CustomParams\\": {\\n \\"video\\": {\\n \\"fps\\": 300,\\n \\"bitrate\\": 300,\\n \\"width\\": 1080,\\n \\"height\\": 720\\n }\\n }\\n },\\n \\"UrgentImageId\\": \\"a089175eb5f4427684fc0715159a****\\",\\n \\"UrgentImageUrl\\": \\"http://learn.aliyundoc.com/AppName/image.jpg\\",\\n \\"UrgentLiveStreamUrl\\": \\"rtmp://demo.aliyundoc.com\\",\\n \\"UrgentMaterialId\\": \\"98646538-bcf9-4aef-bd4a-e6bb76588****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCasterConfigResponse>\\n <Delay>0</Delay>\\n <UrgentLiveStreamUrl>rtmp://demo.aliyundoc.com</UrgentLiveStreamUrl>\\n <UrgentMaterialId>98646538-bcf9-4aef-bd4a-e6bb76588****</UrgentMaterialId>\\n <UrgentImageId>a089175eb5f4427684fc0715159a****</UrgentImageId>\\n <UrgentImageUrl>http://learn.aliyundoc.com/AppName/image.jpg</UrgentImageUrl>\\n <CallbackUrl>http://learn.aliyundoc.com/callBackLive</CallbackUrl>\\n <ProgramName>program_name</ProgramName>\\n <CasterName>coco-caster10</CasterName>\\n <CasterId>LIVEPRODUCER_POST-cn-0pp1czt****</CasterId>\\n <ProgramEffect>0</ProgramEffect>\\n <ChannelEnable>1</ChannelEnable>\\n <DomainName>example.com</DomainName>\\n <RequestId>97df6b7f-3490-47d2-ac50-8833e1b64597</RequestId>\\n <SideOutputUrlList>[\\"rtmp://domain/app1/stream1\\",\\"rtmp://domain/app2/stream2\\"]</SideOutputUrlList>\\n <SideOutputUrl>rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****</SideOutputUrl>\\n <AutoSwitchUrgentOn>true</AutoSwitchUrgentOn>\\n <AutoSwitchUrgentConfig>{\\"eofThres\\":3}</AutoSwitchUrgentConfig>\\n <TranscodeConfig>\\n <CasterTemplate>lp_hd</CasterTemplate>\\n <LiveTemplateIds>lld</LiveTemplateIds>\\n </TranscodeConfig>\\n <RecordConfig>\\n <OssEndpoint>oss-cn-shanghai.aliyundoc.com</OssEndpoint>\\n <OssBucket>liveBucket****</OssBucket>\\n <OnDemand>0</OnDemand>\\n <RecordFormat>\\n <CycleDuration>3600</CycleDuration>\\n <SliceOssObjectPrefix>record/{liveApp****}/{liveStream****}/{UnixTimestamp****}</SliceOssObjectPrefix>\\n <OssObjectPrefix>record/{liveApp****}/{liveStream****}</OssObjectPrefix>\\n <Format>M3U8</Format>\\n </RecordFormat>\\n </RecordConfig>\\n <SyncGroupsConfig>\\n <HostResourceId>28768383240243****</HostResourceId>\\n <Mode>0</Mode>\\n <ResourceIds>1</ResourceIds>\\n </SyncGroupsConfig>\\n</DescribeCasterConfigResponse>","errorExample":""}]', + 'title' => '查询导播台配置', + 'description' => '先通过[CreateCaster](~~2848009~~)接口创建导播台，再调用本接口查询导播台配置信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCasters' => [ + 'summary' => '查询导播台列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106972', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaste接口](~~2848012~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台 > 导播台 > 云导播台**页面查看。'."\n" + ."\n" + .'> - 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。'."\n" + .'> - 若参数为空，默认返回所有导播台合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'CasterName', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveCaster****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-29T09:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-29T11:00:00Z', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每⻚模板数值，不传默认为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '状态。 取值：'."\n" + ."\n" + .'- 0：空闲。 '."\n" + ."\n" + .'- 1：导播中。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费方式。 取值：'."\n" + ."\n" + .'- 0：PrePaid预付费。'."\n" + ."\n" + .'- 1：PostPaid后付费。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'OrderByModifyAsc', + 'in' => 'query', + 'schema' => [ + 'description' => '是否按照导播台的修改时间进行升序排序。'."\n" + ."\n" + .'> 不填默认为"false"。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NormType', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台规格类型。取值：'."\n" + ."\n" + .'- 1：通用型。'."\n" + ."\n" + .'- 3：轻量级轮播型。'."\n" + ."\n" + .'- 4：虚拟演播厅型。'."\n" + ."\n" + .'- 6：轮播台（新播单型导播台）。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。关于资源组的更多信息，请参见[什么是资源组](~~2381067~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzw******', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签健。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '导播台数量。', + 'type' => 'object', + 'properties' => [ + 'CasterList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Caster' => [ + 'description' => '导播台信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '导播台信息。', + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。可作为查询导播台流地址、启动导播台、添加导播台视频资源、添加导播台布局、查询导播台布局列表、添加导播台组件和添加导播台节目单的请求参数。', + 'type' => 'string', + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + 'CasterName' => [ + 'description' => '导播台名称。', + 'type' => 'string', + 'example' => 'liveCaster****', + ], + 'CasterTemplate' => [ + 'description' => '导播台分辨率配置，付费类型为预付费时必选。 '."\n" + ."\n" + .'- lp_ld：流畅。'."\n" + ."\n" + .'- lp_sd：标清。'."\n" + ."\n" + .'- lp_hd：高清。'."\n" + ."\n" + .'- lp_ud：超清。'."\n" + ."\n" + .'- lp_ld_v：竖屏流畅。'."\n" + ."\n" + .'- lp_sd_v：竖屏标清。'."\n" + ."\n" + .'- lp_hd_v：竖屏高清。'."\n" + ."\n" + .'- lp_ud_v：竖屏超清。', + 'type' => 'string', + 'example' => 'lp_ld', + ], + 'ChannelEnable' => [ + 'description' => '是否启用Channel。'."\n" + ."\n" + .'- 0：不启用。'."\n" + ."\n" + .'- 1：启用。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ChargeType' => [ + 'description' => '付费方式。 '."\n" + ."\n" + .'- PrePaid：预付费。'."\n" + ."\n" + .'- PostPaid：后付费。', + 'type' => 'string', + 'example' => 'PrePaid', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2017-08-30 12:02:57.0', + ], + 'Duration' => [ + 'description' => '时长。格式为：hh:mm:ss（时：分：秒）。', + 'type' => 'string', + 'example' => '1:02:33', + ], + 'ExpireTime' => [ + 'description' => '导播台过期时间。', + 'type' => 'string', + 'example' => '2018-08-30 12:02:57.0', + ], + 'LastModified' => [ + 'description' => '对导播台最新修改时间。例如：近期有对导播台进行过开启，停止，修改配置等操作的时间。', + 'type' => 'string', + 'example' => '2021-12-01T05:08:45Z', + ], + 'NormType' => [ + 'description' => '导播台规格类型 。 取值： '."\n" + ."\n" + .'- 0：播单型。'."\n" + ."\n" + .'- 1：通用型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PurchaseTime' => [ + 'description' => '导播台购买时间。', + 'type' => 'string', + 'example' => '2017-08-30 12:02:57.0', + ], + 'StartTime' => [ + 'description' => '导播台启动时间，当导播台处于导播中时输出。', + 'type' => 'string', + 'example' => '2017-08-30 18:02:57.0', + ], + 'Status' => [ + 'description' => '状态。取值：'."\n" + ."\n" + .'- 0：空闲。'."\n" + ."\n" + .'- 1：导播中。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClientTokenId' => [ + 'description' => '用户生成的请求 token，用于保证请求的幂等性。'."\n" + .'该参数值可自定义，但是要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符。', + 'type' => 'string', + 'example' => '53200b81-b761-4c10-842a-a0726d97****'."\n", + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'tag' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'TagValue' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + ], + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。关于资源组的更多信息，请参见[什么是资源组](~~2381067~~)。', + 'type' => 'string', + 'example' => 'rg-acfmz******', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64- af62-20e91b******', + ], + 'Total' => [ + 'description' => '导播台数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter.PageSize', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter.PageNum', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter.Status', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter.StartTime', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter.EndTime', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'LiveServiceNotFound', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDenied', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterList\\": {\\n \\"Caster\\": [\\n {\\n \\"CasterId\\": \\"LIVEPRODUCER_POST-cn-0pp1czt****\\",\\n \\"CasterName\\": \\"liveCaster****\\",\\n \\"CasterTemplate\\": \\"lp_ld\\",\\n \\"ChannelEnable\\": 1,\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"CreateTime\\": \\"2017-08-30 12:02:57.0\\",\\n \\"Duration\\": \\"1:02:33\\",\\n \\"ExpireTime\\": \\"2018-08-30 12:02:57.0\\",\\n \\"LastModified\\": \\"2021-12-01T05:08:45Z\\",\\n \\"NormType\\": 1,\\n \\"PurchaseTime\\": \\"2017-08-30 12:02:57.0\\",\\n \\"StartTime\\": \\"2017-08-30 18:02:57.0\\",\\n \\"Status\\": 1,\\n \\"ClientTokenId\\": \\"53200b81-b761-4c10-842a-a0726d97****\\\\n\\",\\n \\"Tags\\": {\\n \\"tag\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ]\\n },\\n \\"ResourceGroupId\\": \\"rg-acfmz******\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"5c6a2a0df228-4a64- af62-20e91b******\\",\\n \\"Total\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DescribeCastersResponse>\\n <Total>1</Total>\\n <RequestId>5c6a2a0df228-4a64- af62-20e91b9676b3</RequestId>\\n <CasterList>\\n <Status>1</Status>\\n <PurchaseTime>2017-08-30 12:02:57.0</PurchaseTime>\\n <ExpireTime>2018-08-30 12:02:57.0</ExpireTime>\\n <CreateTime>2017-08-30 12:02:57.0</CreateTime>\\n <CasterName>liveCaster****</CasterName>\\n <ChargeType>PrePaid</ChargeType>\\n <CasterTemplate>lp_ld</CasterTemplate>\\n <CasterId>LIVEPRODUCER_POST-cn-0pp1czt****</CasterId>\\n <ChannelEnable>1</ChannelEnable>\\n <LastModified>2021-12-01T05:08:45Z</LastModified>\\n <StartTime>2017-08-30 18:02:57.0</StartTime>\\n <NormType>1</NormType>\\n <Duration>1:02:33</Duration>\\n </CasterList>\\n</DescribeCastersResponse>","errorExample":""}]', + 'title' => '查询导播台列表', + 'description' => '先通过[CreateCaste接口](~~2848012~~)创建导播台，再调用本接口查询导播台列表。导播台的状态分为空闲和导播中 。'."\n" + ."\n" + .'> '."\n" + .'> - 调用该接口的账号需要先[开通直播服务](https://live.console.aliyun.com/#/overview)'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCasterStreamUrl' => [ + 'summary' => '查询导播台流地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID，请确保传入的CasterId是正确的。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'CasterStreams' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CasterStream' => [ + 'description' => '导播台流信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OutputType' => [ + 'description' => '是否正式输出。 '."\n" + .' '."\n" + .'- **0**：输出预览。'."\n" + .'- **1**：输出正式。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RtmpUrl' => [ + 'description' => 'Rtmp地址。', + 'type' => 'string', + 'example' => 'rtmp://live/caster/example.edu', + ], + 'SceneId' => [ + 'description' => '场景ID。', + 'type' => 'string', + 'example' => '23ca74e0-aca3-4e7a-8561-9d96f525****', + ], + 'StreamInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StreamInfo' => [ + 'description' => '播放地址列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OutputStreamUrl' => [ + 'description' => '播放地址。', + 'type' => 'string', + 'example' => 'http://out/caster/example.net', + ], + 'TranscodeConfig' => [ + 'description' => '转码配置。 取值：'."\n" + .' '."\n" + .'- **lsd**：标清 。'."\n" + .'- **lld**：流畅。'."\n" + .'- **lud**：超清 。'."\n" + .'- **lhd**：高清 。'."\n" + .' ', + 'type' => 'string', + 'example' => 'lld', + ], + 'VideoFormat' => [ + 'description' => '格式。取值：'."\n" + .'- **flv**。'."\n" + .'- **rtmp**。'."\n" + .'- **m3u8**。'."\n" + .'- **artc**'."\n" + ."\n" + .'> 此导播台的播流域名需开通超低延时功能才可返回artc协议的地址。具体开启方法详见[开通超低延时直播功能](~~427722~~)。', + 'type' => 'string', + 'example' => 'flv', + ], + ], + ], + ], + ], + ], + 'StreamUrl' => [ + 'description' => '输出流地址。', + 'type' => 'string', + 'example' => 'http://live/caster/example.org', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E6******', + ], + 'Total' => [ + 'description' => '数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidScene.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\",\\n \\"CasterStreams\\": {\\n \\"CasterStream\\": [\\n {\\n \\"OutputType\\": 1,\\n \\"RtmpUrl\\": \\"rtmp://live/caster/example.edu\\",\\n \\"SceneId\\": \\"23ca74e0-aca3-4e7a-8561-9d96f525****\\",\\n \\"StreamInfos\\": {\\n \\"StreamInfo\\": [\\n {\\n \\"OutputStreamUrl\\": \\"http://out/caster/example.net\\",\\n \\"TranscodeConfig\\": \\"lld\\",\\n \\"VideoFormat\\": \\"flv\\"\\n }\\n ]\\n },\\n \\"StreamUrl\\": \\"http://live/caster/example.org\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E6******\\",\\n \\"Total\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DescribeCasterStreamUrlResponse>\\n <CasterId>a2b8e671-2fe5-4642-a2ec-bf93880e****</CasterId>\\n <CasterStreams>\\n <OutputType>1</OutputType>\\n <RtmpUrl>rtmp://live/caster/example.edu</RtmpUrl>\\n <SceneId>23ca74e0-aca3-4e7a-8561-9d96f525****</SceneId>\\n <StreamInfos>\\n <OutputStreamUrl>http://out/caster/example.net</OutputStreamUrl>\\n <TranscodeConfig>lld</TranscodeConfig>\\n <VideoFormat>flv</VideoFormat>\\n </StreamInfos>\\n <StreamUrl>http://live/caster/example.org</StreamUrl>\\n </CasterStreams>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n <Total>1</Total>\\n</DescribeCasterStreamUrlResponse>","errorExample":""}]', + 'title' => '查询导播台流信息列表', + 'description' => '先通过[CreateCaster接口](~~2848009~~)创建导播台，再调用本接口查询导播台流地址，否则会返回InvalidScene.NotFound错误。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CopyCaster' => [ + 'summary' => '复制导播台，复制指定导播台并返回新导播台实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterName', + 'in' => 'query', + 'schema' => [ + 'description' => '新导播台名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'caster001', + ], + ], + [ + 'name' => 'SrcCasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '原导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**路径查看导播台名称。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用户生成的请求token。用于保证请求的幂等性。'."\n" + ."\n" + .'由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。', + 'type' => 'string', + 'required' => true, + 'example' => '53200b81-b761-4c10-842a-a0726d97****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '新导播台ID。', + 'type' => 'string', + 'example' => '1909f043-e3d3-49e9-82d6-4329ec4a****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidClientToken.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'CasterNumberExceed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterId\\": \\"1909f043-e3d3-49e9-82d6-4329ec4a****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<CopyCasterResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n\\t<CasterId>1909f043-e3d3-49e9-82d6-4329ec4a****</CasterId>\\n</CopyCasterResponse>\\t","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"CasterId\\": \\"1909f043-e3d3-49e9-82d6-4329ec4a0293\\"\\n}"}]', + 'title' => '复制导播台', + 'description' => '调用本接口复制导播台，复制指定导播台并返回新导播台实例。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StartCaster' => [ + 'summary' => '启动导播台。若PVW、PGM场景不存在则创建，启动PVW、PGM场景，启动底层音视频处理任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '80787064-1c94-4dc1-85ce-9409960a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '导播台信息。', + 'type' => 'object', + 'properties' => [ + 'PgmSceneInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SceneInfo' => [ + 'description' => 'PGM场景信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'PGM场景信息列表。', + 'type' => 'object', + 'properties' => [ + 'SceneId' => [ + 'description' => '场景ID。', + 'type' => 'string', + 'example' => 'b5f8c837-ceeb-424f-b30b-68e94e86****', + ], + 'StreamInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StreamInfo' => [ + 'description' => '旁路输出播放地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '旁路输出播放地址列表。', + 'type' => 'object', + 'properties' => [ + 'OutputStreamUrl' => [ + 'description' => '播放地址。', + 'type' => 'string', + 'example' => 'rtmp://abclive/caster/example.net', + ], + 'TranscodeConfig' => [ + 'description' => '转码配置。 取值：'."\n" + .' '."\n" + .'- **lsd**：标清。'."\n" + .'- **lld**：流畅。'."\n" + .'- **lud**：超清。'."\n" + .'- **lhd**：高清。', + 'type' => 'string', + 'example' => 'lld', + ], + 'VideoFormat' => [ + 'description' => '格式。取值：'."\n" + .'- **flv**。'."\n" + .'- **rtmp**。'."\n" + .'- **m3u8**。', + 'type' => 'string', + 'example' => 'flv', + ], + ], + ], + ], + ], + ], + 'StreamUrl' => [ + 'description' => '导播台PGM场景对应播放流地址，非旁路输出流地址。', + 'type' => 'string', + 'example' => 'rtmp://abclive/caster/example.edu', + ], + ], + ], + ], + ], + ], + 'PvwSceneInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SceneInfo' => [ + 'description' => 'PVW场景信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'PVW场景信息列表。', + 'type' => 'object', + 'properties' => [ + 'SceneId' => [ + 'description' => '场景ID。', + 'type' => 'string', + 'example' => 'b5f8c837-ceeb-424f-b30b-68e94e86****', + ], + 'StreamUrl' => [ + 'description' => '导播台PVW场景对应播放流地址，非旁路输出流地址。', + 'type' => 'string', + 'example' => 'rtmp://abclive/caster/example.net', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6EBD1AC4-C34D-4AE1-963E-B688A228BE31', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidShowList.EmptyList', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'IncorrectSceneStatus', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'IncorrectCasterStatus.Cease', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'IncorrectCasterStatus.Expire', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'IncorrectCasterStatus.Inuse', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.Inuse', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'IncorrectChannel.Disable', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserQuotaExceed', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidTranscode.NotFound', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidDelay.NotFound', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidCasterTemplate.NotFound', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidConfiguration.NotFound', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PgmSceneInfos\\": {\\n \\"SceneInfo\\": [\\n {\\n \\"SceneId\\": \\"b5f8c837-ceeb-424f-b30b-68e94e86****\\",\\n \\"StreamInfos\\": {\\n \\"StreamInfo\\": [\\n {\\n \\"OutputStreamUrl\\": \\"rtmp://abclive/caster/example.net\\",\\n \\"TranscodeConfig\\": \\"lld\\",\\n \\"VideoFormat\\": \\"flv\\"\\n }\\n ]\\n },\\n \\"StreamUrl\\": \\"rtmp://abclive/caster/example.edu\\"\\n }\\n ]\\n },\\n \\"PvwSceneInfos\\": {\\n \\"SceneInfo\\": [\\n {\\n \\"SceneId\\": \\"b5f8c837-ceeb-424f-b30b-68e94e86****\\",\\n \\"StreamUrl\\": \\"rtmp://abclive/caster/example.net\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<StartCasterResponse>\\n<RequestId>6EBD1AC4-C34D-4AE1-963E-B688A228BE31</RequestId>\\n<PvwSceneInfos>\\n <SceneInfo>\\n <SceneId>b5f8c837-ceeb-424f-b30b-68e94e86****</SceneId>\\n <RtsUrl/>\\n <StreamUrl>rtmp://abclive/caster/example.net</StreamUrl>\\n </SceneInfo>\\n</PvwSceneInfos>\\n<PgmSceneInfos>\\n <SceneInfo>\\n <SceneId>b5f8c837-ceeb-424f-b30b-68e94e86****</SceneId>\\n <StreamUrl>rtmp://abclive/caster/example.edu</StreamUrl>\\n <StreamInfos>\\n <StreamInfo>\\n <OutputStreamUrl>rtmp://abclive/caster/example.net</OutputStreamUrl>\\n <VideoFormat>flv</VideoFormat>\\n <TranscodeConfig>lld</TranscodeConfig>\\n </StreamInfo>\\n </StreamInfos>\\n </SceneInfo>\\n</PgmSceneInfos>\\n</StartCasterResponse>","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"PvwSceneInfos\\": [\\n {\\n \\"SceneId\\":\\"b5f8c837-ceeb-424f-b30b-68e94e864995\\",\\n \\"StreamUrl\\":\\"rtmp://XXXXXX/caster/1975ee99db904ebb83908d43bc878188?auth_key=1506396160-0-0-063397072a9980fd418d43eb00e02e09\\"\\n }\\n ],\\n \\"PgmSceneInfos\\": [\\n {\\n \\"SceneId\\":\\"b5f8c837-ceeb-424f-b30b-68e94e864996\\",\\n \\"StreamUrl\\":\\"rtmp://XXXXXX/caster/1975ee99db904ebb83908d43bc878188?auth_key=1506396160-0-0-063397072a9980fd418d43eb00e02e10\\",\\n \\"StreamInfos\\": [\\n {\\n \\"VideoFormat\\": \\"flv\\",\\n \\"OutputStreamUrl\\": \\"http://XXXXXX/caster/fb628e2469f94f2aa2c0c219af8b2527_lld.flv?auth_key=1506396160-0-0-7de771a77102680861853af862d5eaf0\\",\\n \\"TranscodeConfig\\": \\"lld\\"\\n },\\n {\\n \\"VideoFormat\\": \\"rtmp\\",\\n \\"OutputStreamUrl\\": \\"rtmp://XXXXXX/caster/fb628e2469f94f2aa2c0c219af8b2527_lld?auth_key=1506396160-0-0-77ed32cd82ed32ccd51a832b5765814c\\",\\n \\"TranscodeConfig\\": \\"lld\\"\\n },\\n {\\n \\"VideoFormat\\": \\"m3u8\\",\\n \\"OutputStreamUrl\\": \\"http://XXXXXX/caster/fb628e2469f94f2aa2c0c219af8b2527.m3u8?auth_key=1506396160-0-0-d51f0512dcf76aa749f79f53ae6421d2\\",\\n \\"TranscodeConfig\\": \\"lld\\"\\n }\\n ]\\n }\\n ]\\n}"}]', + 'title' => '启动导播台', + 'description' => '先通过[CreateCaster接口](~~2848009~~)创建导播台，再调用本接口启动导播台。若PVW、PGM场景不存在则创建，启动PVW、PGM场景，启动底层音视频处理任务。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopCaster' => [ + 'summary' => '停止导播台。停止PVW（预览场景）、PGM（正式输出场景）场景。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID，请确保传入的CasterId是正确的。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '80787064-1c94-4dc1-85ce-9409960a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectSceneStatus', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidScene.NotFound', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<StopCasterResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</StopCasterResponse>\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}"}]', + 'title' => '停止导播台', + 'description' => '先通过[CreateCaster接口](~~2848009~~)创建导播台，再调用本接口停止导播台。停止PVW（预览场景）、PGM（正式输出场景）场景。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCaster' => [ + 'summary' => '调用DeleteCaster删除导播台。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '106904', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID，请确保传入的CasterId是正确的。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。可作为添加导播台视频资源、添加导播台布局、查询导播台布局列表、添加导播台组件和添加导播台节目单的请求参数。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvaildCaster.Delete', + 'errorMessage' => 'Caster can not be deleted when ChargeType is Prepaid', + ], + [ + 'errorCode' => 'IncorrectCasterStatus.Inuse', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDenied', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DeleteCasterResponse>\\n<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n<CasterId>a2b8e671-2fe5-4642-a2ec-bf93880e****</CasterId>\\n</DeleteCasterResponse>","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"CasterId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e1a49\\"\\n}"}]', + 'title' => '删除导播台', + 'description' => '- 只有在导播台关闭状态才能删除，否则会删除失败。'."\n" + .'- 删除导播台会把相关的场景、组件、布局一起删掉。'."\n" + .'- 删除之后不可恢复。 '."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RestartCaster' => [ + 'summary' => '调用RestartCaster重启导播台。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '80787064-1c94-4dc1-85ce-9409960a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6EBD1AC4-C34D-4AE1-963E-B688A228BE31', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectSceneStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectCasterStatus.Idle', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidNormType.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectCasterStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidScene.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EBD1AC4-C34D-4AE1-963E-B688A228BE31\\"\\n}","errorExample":""},{"type":"xml","example":"<RestartCasterResponse>\\n <RequestId>6EBD1AC4-C34D-4AE1-963E-B688A228BE31</RequestId>\\n</RestartCasterResponse>","errorExample":""}]', + 'title' => '重启导播台', + 'description' => '- 目前仅支持新播单型（轮播台）和通用型导播台，暂不支持虚拟演播厅。'."\n" + ."\n" + .'- 重启导播台后，会重新加载当前配置（如分辨率、横竖屏切换等），恢复之前的播放状态。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateCasterResourceGroup' => [ + 'summary' => '调用UpdateCasterResourceGroup更新导播台所在资源组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '233607', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '待转入的新资源组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-aekz7***34cn5ty', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a41300c9-23d3-470e-b9bd-****663e0700', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0D776BD1-****-59D0-9A1B-272832D999F6', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PurchaseTime', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter.ExpireTime', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidChargeType.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidChargeType.PostSupport', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidCasterTemplate.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter.ChargeType', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidPeriod.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidClientToken.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'IncorrectCasterStatus', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'CasterNumberExceed', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDenied', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameter.NormType', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidConfiguration.NotFound', + 'errorMessage' => '%s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0D776BD1-****-59D0-9A1B-272832D999F6\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateCasterResourceGroupResponse>\\n <RequestId>0D776BD1-****-59D0-9A1B-272832D999F6</RequestId>\\n</UpdateCasterResourceGroupResponse>","errorExample":""}]', + 'title' => '更新导播台所在资源组', + 'description' => '## 使用说明'."\n" + .'调用此接口执行更新导播台所在资源组操作时，操作账号需要对原资源组和目标资源组都具备操作权限。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'AddCasterVideoResource' => [ + 'summary' => '添加视频源，视频源数量受限于导播台输入路数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106832', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**路径查看导播台名称。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'ResourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '视频源名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test001', + ], + ], + [ + 'name' => 'LocationId', + 'in' => 'query', + 'schema' => [ + 'description' => '用于标识视频源位置。本参数必填。 '."\n" + ."\n" + .'定义布局内画面的引用编号，每个位置至多关联一个资源，格式需符合“RV01~RV12”，即RV+数字，数字范围`[01~99]`。', + 'type' => 'string', + 'required' => false, + 'example' => 'RV01', + ], + ], + [ + 'name' => 'LiveStreamUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云直播流地址。'."\n" + ."\n" + .'><notice> '."\n" + .' '."\n" + .'- 当视频源类型为直播流时，本参数必填。'."\n" + .' '."\n" + .'- 视频源类型不是直播流时，请求时不要带这个参数。'."\n" + ."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****', + ], + ], + [ + 'name' => 'MaterialId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资库素材ID。'."\n" + .'><notice>当视频源类型为素材时，本参数才可用且必须传入。'."\n" + .'></notice>'."\n" + ."\n" + .'如果您通过[DescribeCasterConfig接口](~~2848011~~)查询导播台配置信息，请查看DescribeCasterConfig接口调用返回的参数UrgentMaterialId值。'."\n" + ."\n" + .'> UrgentMaterialId值即为媒资库素材ID值。', + 'type' => 'string', + 'required' => false, + 'example' => 'f080575eb5f4427684fc0715159a****', + ], + ], + [ + 'name' => 'VodUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '点播文件地址。'."\n" + .'><notice>当视频源类型为文件视频且视频文件未导入素材库时，本参数才可用。'."\n" + .'></notice>'."\n" + ."\n" + .'>点播文件仅限MP4、FLV、TS格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://learn.aliyundoc.com/AppName/StreamName.flv', + ], + ], + [ + 'name' => 'BeginOffset', + 'in' => 'query', + 'schema' => [ + 'description' => '视频文件起始偏移值。单位：毫秒。'."\n" + .'><notice>当视频源类型为文件视频时，本参数才有用。'."\n" + .'></notice>'."\n" + ."\n" + .'> 大于**0**，表示从相对于首帧的偏差时间作为开始读取的位置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'EndOffset', + 'in' => 'query', + 'schema' => [ + 'description' => '视频文件结束偏移值。单位：毫秒。'."\n" + .'><notice>当视频源类型为文件视频时，本参数才有用。'."\n" + .'></notice>'."\n" + .' '."\n" + .'- 大于**0**时：从相对于首帧的偏差时间为结束读取的位置。'."\n" + .'- 小于**0**时：相对于最后一帧的偏差时间作为结束读取的位置。 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'RepeatNum', + 'in' => 'query', + 'schema' => [ + 'description' => '播放完后重复继续播放的次数。取值：'."\n" + .'><notice>当视频源类型为文件视频时，本参数才有用。'."\n" + .'></notice>'."\n" + ."\n" + .'- **0**（默认值）：不重复播放。'."\n" + .'- **-1**：一直循环重复。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '60', + 'minimum' => '-1', + 'example' => '0', + ], + ], + [ + 'name' => 'PtsCallbackInterval', + 'in' => 'query', + 'schema' => [ + 'description' => 'PTS回调间隔。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '2000', + ], + ], + [ + 'name' => 'FixedDelayDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '该字段对视频进行固定延迟设置，可用于字幕同步。单位ms, 默认取值为0， 取值范围`[0-5000]`。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资库图片素材ID。'."\n" + .'> 当视频源类型为图片时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'a089175eb5f4427684fc0715159a****', + ], + ], + [ + 'name' => 'ImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '图片素材URL。'."\n" + .'>当视频源类型为图片且图片文件未导入素材库时，本参数才可用。支持上传jpg、png格式图片，最大文件不可超过10M。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://learn.aliyundoc.com/AppName/image.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CF60DB6A-7FD6-426E-9288-122CC1A52FA7', + ], + 'ResourceId' => [ + 'description' => '资源ID。可作为删除导播台视频源，修改导播台视频源的请求参数。', + 'type' => 'string', + 'example' => 'e5542d98-b08c-46bf-83e9-5b09d08c****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidLiveStreamUrl.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidMaterialId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidVodUrl.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ResourceNumberExceed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'DuplicateLocationID', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'UnexpectedLocationID', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\",\\n \\"ResourceId\\": \\"e5542d98-b08c-46bf-83e9-5b09d08c****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<AddCasterVideoResourceResponse>\\n\\t<RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>\\n\\t<ResourceId>e5542d98-b08c-46bf-83e9-5b09d08c****</ResourceId>\\n</AddCasterVideoResourceResponse>\\t","errorExample":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\",\\n \\"ResourceId\\": \\"e5542d98-b08c-46bf-83e9-5b09d08c692f\\"\\n}"}]', + 'title' => '添加导播台视频资源', + 'description' => '请先创建导播台，再调用本接口添加导播台视频源。视频源数量受限于导播台输入路数。使用API创建导播台，请参见[创建导播台](~~2848009~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' >视频源类型是根据直播流地址里的资源类型判断的。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCasterVideoResource' => [ + 'summary' => '删除视频资源。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '80787064-1c94-4dc1-85ce-9409960a****', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID。如果您通过[AddCasterVideoResource](~~2848020~~)接口添加导播台视频资源，请查看AddCasterVideoResource接口调用返回的参数ResourceId值。', + 'type' => 'string', + 'required' => true, + 'example' => '05ab713c-676e-49c0-96ce-cc408da1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CF60DB6A-7FD6-426E-9288-122C*******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122C*******\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DeleteCasterVideoResourceResponse>\\n\\t<RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>\\n</DeleteCasterVideoResourceResponse>\\t","errorExample":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\"\\n}"}]', + 'title' => '删除导播台视频资源', + 'description' => '先通过[CreateCaster接口](~~2848009~~)创建导播台，再调用本接口删除导播台视频资源。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyCasterVideoResource' => [ + 'summary' => '修改导播台视频资源。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster](~~2848009~~)接口创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID。如果您通过[AddCasterVideoResource](~~2848020~~)接口添加导播台视频源，请查看AddCasterVideoResource接口调用返回的参数ResourceId值。', + 'type' => 'string', + 'required' => true, + 'example' => '05ab713c-676e-49c0-96ce-cc408da1****', + ], + ], + [ + 'name' => 'ResourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '视频源名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test001', + ], + ], + [ + 'name' => 'LiveStreamUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流地址。'."\n" + ."\n" + .'><notice>当视频源类型为直播流时，本参数才可用且必传。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****', + ], + ], + [ + 'name' => 'MaterialId', + 'in' => 'query', + 'schema' => [ + 'description' => '素材ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'f080575eb5f4427684fc0715159a****', + ], + ], + [ + 'name' => 'VodUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '点播文件地址。'."\n" + .'><notice>当视频源类型为文件视频且视频文件未导入素材库时，本参数才可用。'."\n" + .'></notice>'."\n" + .'>点播文件仅限MP4、FLV、TS格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://developer.aliyundoc.com/AppName/StreamName.flv', + ], + ], + [ + 'name' => 'BeginOffset', + 'in' => 'query', + 'schema' => [ + 'description' => '视频文件起始偏移值。单位：毫秒。'."\n" + ."\n" + .'><notice>当视频源类型为文件视频时，本参数才有用。'."\n" + .'></notice>'."\n" + ."\n" + .'>大于0，表示从相对于首帧的偏差时间作为开始读取的位置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'EndOffset', + 'in' => 'query', + 'schema' => [ + 'description' => '仅对文件视频有效。单位：毫秒。 '."\n" + .' '."\n" + .'- 大于**0**时，表示从相对于首帧的偏差时间为结束读取的位置。'."\n" + .'- 小于**0**时，表示相对于最后一帧的偏差时间作为结束读取的位置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'RepeatNum', + 'in' => 'query', + 'schema' => [ + 'description' => '仅对文件视频有效，表示播放完后重复继续播放的次数。 '."\n" + .' '."\n" + .'- **0**（默认值）：表示不重复播放。'."\n" + .'- **-1**：表示一直循环重复。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '60', + 'minimum' => '-1', + 'example' => '0', + ], + ], + [ + 'name' => 'PtsCallbackInterval', + 'in' => 'query', + 'schema' => [ + 'description' => 'PTS回调间隔。单位：毫秒，仅对点播素材有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '2000', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资库图片素材ID。'."\n" + .'>当视频源类型为图片时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'a089175eb5f4427684fc0715159a****', + ], + ], + [ + 'name' => 'ImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '图片素材URL。'."\n" + .'>当视频源类型为图片且图片文件未导入素材库时，本参数才可用。支持上传jpg、png格式图片，最大文件不可超过10M。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://learn.aliyundoc.com/AppName/image.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。可作为查询导播台视频源、添加导播台布局、查询导播台布局列表的请求参数。', + 'type' => 'string', + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CF60DB6A-7FD6-426E-9288-122CC1A52FA7', + ], + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => '98461064-1c94-4dc1-85ce-94098764****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidResourceId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidLiveStreamUrl.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidMaterialId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidVodUrl.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterId\\": \\"LIVEPRODUCER_POST-cn-0pp1czt****\\",\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\",\\n \\"ResourceId\\": \\"98461064-1c94-4dc1-85ce-94098764****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<ModifyCasterVideoResourceResponse>\\n\\t<RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>\\n <CasterId>LIVEPRODUCER_POST-cn-0pp1czt****</CasterId>\\n <ResourceId>98461064-1c94-4dc1-85ce-94098764****</ResourceId>\\n</ModifyCasterVideoResourceResponse>\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\"\\n}"}]', + 'title' => '修改导播台视频源', + 'description' => '先通过[CreateCaster](~~2848009~~)接口创建导播台，再调用本接口修改导播台视频资源。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCasterVideoResources' => [ + 'summary' => '查询导播台视频源。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CF60DB6A-7FD6-426E-9288-122CC1A52FA7', + ], + 'Total' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VideoResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoResource' => [ + 'description' => '资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源列表。', + 'type' => 'object', + 'properties' => [ + 'BeginOffset' => [ + 'description' => '视频文件起始偏移值。仅对文件视频有效， 单位：毫秒。'."\n" + ."\n" + .'**大于0**，表示从相对于首帧的偏差时间作为开始读取的位置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'EndOffset' => [ + 'description' => '视频文件结束偏移值。仅对文件视频有效，单位：毫秒。 '."\n" + .' '."\n" + .'- 大于**0**：从相对于首帧的偏差时间为结束读取的位置。'."\n" + .'- 小于**0**：从相对于最后一帧的偏差时间作为结束读取的位置。 ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'FlvUrl' => [ + 'description' => '拉流地址。', + 'type' => 'string', + 'example' => 'http://guide.aliyundoc.com/example.org', + ], + 'ImageId' => [ + 'description' => '媒资库图片素材ID。', + 'type' => 'string', + 'example' => 'a089175eb5f4427684fc0715159a****', + ], + 'ImageUrl' => [ + 'description' => '图片素材URL。', + 'type' => 'string', + 'example' => 'http://learn.aliyundoc.com/AppName/image.jpg', + ], + 'LiveStreamUrl' => [ + 'description' => '直播流地址。', + 'type' => 'string', + 'example' => 'rtmp://abcLive/appName/b5447c21fcfe444c9e9b6f7ba208****', + ], + 'LocationId' => [ + 'description' => '视频源位置。', + 'type' => 'string', + 'example' => 'RV01', + ], + 'MaterialId' => [ + 'description' => '素材ID。', + 'type' => 'string', + 'example' => 'd2c429cd907742ee8f6e76465ad3****', + ], + 'PtsCallbackInterval' => [ + 'description' => '点播文件的回调间隔，等于0时为不回调。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RepeatNum' => [ + 'description' => '仅对文件视频有效，表示播放完后继续重复播放的次数。 '."\n" + .' '."\n" + .'- **0**（默认值）：不重复播放。'."\n" + .'- **-1**：一直循环重复播放。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'b5f8c837-ceeb-424f-b30b-68e94e86****', + ], + 'ResourceName' => [ + 'description' => '资源名称。', + 'type' => 'string', + 'example' => 'resource-Name1', + ], + 'VodUrl' => [ + 'description' => '点播文件地址。'."\n" + ."\n" + .'当且仅当资源为文件视频，且视频文件未导入素材库时使用，仅限MP4、FLV、TS格式。', + 'type' => 'string', + 'example' => 'http://developer.aliyundoc.com/caster1.flv', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\",\\n \\"Total\\": 2,\\n \\"VideoResources\\": {\\n \\"VideoResource\\": [\\n {\\n \\"BeginOffset\\": 1000,\\n \\"EndOffset\\": 10000,\\n \\"FlvUrl\\": \\"http://guide.aliyundoc.com/example.org\\",\\n \\"ImageId\\": \\"a089175eb5f4427684fc0715159a****\\",\\n \\"ImageUrl\\": \\"http://learn.aliyundoc.com/AppName/image.jpg\\",\\n \\"LiveStreamUrl\\": \\"rtmp://abcLive/appName/b5447c21fcfe444c9e9b6f7ba208****\\",\\n \\"LocationId\\": \\"RV01\\",\\n \\"MaterialId\\": \\"d2c429cd907742ee8f6e76465ad3****\\",\\n \\"PtsCallbackInterval\\": 0,\\n \\"RepeatNum\\": 0,\\n \\"ResourceId\\": \\"b5f8c837-ceeb-424f-b30b-68e94e86****\\",\\n \\"ResourceName\\": \\"resource-Name1\\",\\n \\"VodUrl\\": \\"http://developer.aliyundoc.com/caster1.flv\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeCasterVideoResourcesResponse>\\n<RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>\\n<Total>2</Total>\\n<VideoResources>\\n <VideoResource>\\n <EndOffset>10000</EndOffset>\\n <BeginOffset>1000</BeginOffset>\\n <MaterialId>d2c429cd907742ee8f6e76465ad3****</MaterialId>\\n <FlvUrl>http://guide.aliyundoc.com/example.org</FlvUrl>\\n <ResourceId>b5f8c837-ceeb-424f-b30b-68e94e86****</ResourceId>\\n <ResourceName>resource-Name1</ResourceName>\\n <LocationId>RV01</LocationId>\\n <RepeatNum>0</RepeatNum>\\n <LiveStreamUrl>rtmp://abcLive/appName/b5447c21fcfe444c9e9b6f7ba208****</LiveStreamUrl>\\n <PtsCallbackInterval>0</PtsCallbackInterval>\\n <VodUrl>http://developer.aliyundoc.com/caster1.flv</VodUrl>\\n </VideoResource>\\n</VideoResources>\\n</DescribeCasterVideoResourcesResponse>","errorExample":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\",\\n \\"SceneList\\": [{\\n \\"ResourceId\\": \\"b5f8c837-ceeb-424f-b30b-68e94e864995\\",\\n \\"ResourceName\\": \\"resource-Name1\\",\\n \\"LocationId\\": \\"RV01\\",\\n \\"LiveStreamUrl\\": \\"rtmp://XXXXXX/appName/b5447c21fcfe444c9e9b6f7ba208f141\\",\\n },\\n {\\n \\"ResourceId\\": \\"b5f8c837-ceeb-424f-b30b-68e94e864995\\",\\n \\"MaterialId\\": \\"d2c429cd907742ee8f6e76465ad3c784\\",\\n \\"ResourceName\\": \\"resource-Name3\\",\\n \\"LocationId\\": \\"RV02\\",\\n \\"repeatNum\\": 2\\n }\\n ]\\n}"}]', + 'title' => '查询导播台视频源', + 'description' => '先通过[CreateCaster接口](~~2848009~~)创建导播台，再调用本接口查询导播台视频源。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddCasterLayout' => [ + 'summary' => '添加导播台布局。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'VideoLayer', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '视频布局。', + 'type' => 'array', + 'items' => [ + 'description' => '视频布局。', + 'type' => 'object', + 'properties' => [ + 'FillMode' => [ + 'description' => '元素填充方式。 取值：'."\n" + .' '."\n" + .'- **none**（默认）：不填充。以画面作为配置目标进行设置。'."\n" + .'- **fit**：自适应，以填充区（框）作为配置目标进行设置，此时画面会按照原始的宽高比缩放，长边对齐的自适应方式在填充区（框）内居中填充。若填充区宽高比和画面不一致，则短边两侧无填充（显示为下层元素画面，若下层未配置，默认为底图黑色）。 '."\n" + .' ', + 'type' => 'string', + 'required' => false, + 'example' => 'fit', + ], + 'FixedDelayDuration' => [ + 'description' => '该字段对视频进行固定延迟设置，可用于字幕同步。 单位：毫秒。 默认值：**0** 。取值范围：**0~5000**。'."\n" + .' ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5000', + ], + 'HeightNormalized' => [ + 'description' => '元素的高度归一化比例值。 '."\n" + .' '."\n" + .'- 若采用不填充方式，元素的宽度会按照该高度来进行等比缩放。默认值为**0**，表示按照画面的原始尺寸进行显示。 '."\n" + .'- 若采用自适应方式，该字段必传且大于**0**，表示填充区（框）高度归一化比例值。 '."\n" + .' ', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1', + ], + 'PositionNormalized' => [ + 'description' => '视频元素配置列表，元素为视频画面的配置信息：位置。'."\n" + ."\n" + .'设置该视频元素的位置归一化值`[x,y]`, 默认为`[0,0]`。注意x,y需要进行归一化计算。', + 'type' => 'array', + 'items' => [ + 'description' => '值。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'required' => false, + 'example' => '0.3', + 'maxItems' => 2, + ], + 'PositionRefer' => [ + 'description' => '元素的位置参考坐标值。 取值：'."\n" + .' '."\n" + .'- **topLeft**（默认值）：左上。'."\n" + .'- **topRight**：右上。'."\n" + .'- **bottomLeft**：左下。'."\n" + .'- **bottomRight**：右下。'."\n" + .'- **center**：中间。'."\n" + .'- **topCenter**：中上。'."\n" + .'- **bottomCenter**：中下。'."\n" + .'- **leftCenter**：左中。'."\n" + .'- **rightCenter**：右中。 '."\n" + .' ', + 'type' => 'string', + 'required' => false, + 'example' => 'topLeft', + ], + 'WidthNormalized' => [ + 'description' => '元素的宽度归一化比例值。 '."\n" + .' '."\n" + .'- 若采用不填充方式，元素的高度会按照该宽度来进行等比缩放，默认值为**0**，表示按照画面的原始尺寸进行显示。 '."\n" + .'- 若采用自适应方式，该字段必传且大于**0**，表示填充区（框）宽度归一化比例值。 '."\n" + .' ', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 12, + ], + ], + [ + 'name' => 'AudioLayer', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '音频布局。', + 'type' => 'array', + 'items' => [ + 'description' => '音频布局。', + 'type' => 'object', + 'properties' => [ + 'FixedDelayDuration' => [ + 'description' => '对音频进行固定延迟设置，可用于字幕同步。 单位：毫秒。 默认值：**0** 。取值范围：**0~5000**。'."\n" + .' ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5000', + ], + 'ValidChannel' => [ + 'description' => '确定哪些声道可以作为音量输入。 取值：'."\n" + .' '."\n" + .'- **leftChannel**：左声道。'."\n" + .'- **rightChannel**：右声道。'."\n" + .'- **all**（默认值）：双声道。'."\n" + .' ', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + 'VolumeRate' => [ + 'description' => '调节音频流的音量大小倍数。 取值范围为**0~10.0**。其中：'."\n" + .' '."\n" + .'- **1.0**（默认值）：表示保持原有音量。 '."\n" + .'- 小于**1**：表示降低音量的倍数。 '."\n" + .'- 大于**1**：表示放大的倍数。 '."\n" + ."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1.0', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 12, + ], + ], + [ + 'name' => 'BlendList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '元素为视频资源的位置ID，即LocationId。'."\n" + ."\n" + .'LocationId参见[添加视频源](~~2848020~~)，与VideoLayers元素顺序对应。', + 'type' => 'array', + 'items' => [ + 'description' => 'LocationId。', + 'type' => 'string', + 'required' => false, + 'example' => 'RV01', + ], + 'required' => true, + 'example' => 'RV01', + 'maxItems' => 12, + ], + ], + [ + 'name' => 'MixList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '元素为音频资源的位置ID，即LocationId。'."\n" + ."\n" + .'LocationId参见[添加视频源](~~2848020~~)，与AudioLayers元素顺序对应。', + 'type' => 'array', + 'items' => [ + 'description' => 'LocationId。', + 'type' => 'string', + 'required' => false, + 'example' => 'RV01', + ], + 'required' => true, + 'example' => 'RV01', + 'maxItems' => 12, + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**路径查看导播台名称。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'LayoutId' => [ + 'description' => '布局ID。可作为删除导播台布局，修改导播台布局，查询导播台布局列表，删除虚拟演播厅布局，修改虚拟演播厅布局，查询虚拟演播厅布局的请求参数。', + 'type' => 'string', + 'example' => '21926b36-7dd2-4fde-ae25-51b5bc8e****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidVideoLayersAndBlendListSize.Mismatch', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidAudioLayersAndMixListSize.Mismatch', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidBlendList.ExceedNorm', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidPositionNormalized.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidHeightOrWidthNormalized', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidMixList.ExceedNorm', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LayoutId\\": \\"21926b36-7dd2-4fde-ae25-51b5bc8e****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<AddCasterLayoutResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n\\t<LayoutId>21926b36-7dd2-4fde-ae25-51b5bc8e****</LayoutId>\\n</AddCasterLayoutResponse>\\t","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"LayoutId\\": \\"21926b36-7dd2-4fde-ae25-51b5bc8e52d8\\"\\n}"}]', + 'title' => '添加导播台布局', + 'description' => '先创建导播台和添加导播台视频资源，再调用本接口添加导播台布局。使用API创建导播台，请参见[创建导播台](~~2848009~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '>请求参数中的N表示第几个的意思。例如：VideoLayer.N.FillMode表示传入第几个元素的填充方式。VideoLayer.1.FillMode表示传入第1个元素的填充方式，VideoLayer.2.FillMode表示传入第2个元素的填充方式。'."\n" + ."\n\n" + .' '."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCasterLayout' => [ + 'summary' => '删除布局数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + [ + 'name' => 'LayoutId', + 'in' => 'query', + 'schema' => [ + 'description' => '布局ID。如果您通过[AddCasterLayout接口](~~2848025~~)添加导播台布局，请查看AddCasterLayout接口调用返回的参数LayoutId值。', + 'type' => 'string', + 'required' => true, + 'example' => '21926b36-7dd2-4fde-ae25-51b5bc8e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。可作为修改导播台布局、查询导播台布局列表、添加导播台组件、查询导播台组件列表的请求参数。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'LayoutId' => [ + 'description' => '布局ID。可作为查询导播台布局列表的请求参数。', + 'type' => 'string', + 'example' => '21926b36-7dd2-4fde-ae25-51b5bc8e****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidLayoutId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidLayout.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\",\\n \\"LayoutId\\": \\"21926b36-7dd2-4fde-ae25-51b5bc8e****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCasterLayoutResponse>\\n <CasterId>a2b8e671-2fe5-4642-a2ec-bf93880e****</CasterId>\\n <LayoutId>21926b36-7dd2-4fde-ae25-51b5bc8e****</LayoutId>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteCasterLayoutResponse>","errorExample":""}]', + 'title' => '删除导播台布局数据', + 'description' => '先通过[CreateCaster接口](~~2848009~~)创建导播台，再调用本接口删除导播台布局数据。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyCasterLayout' => [ + 'summary' => '修改布局配置，传递修改项，非修改内容无需传递。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'VideoLayer', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '视频信息。', + 'type' => 'array', + 'items' => [ + 'description' => '视频信息。', + 'type' => 'object', + 'properties' => [ + 'FillMode' => [ + 'description' => '元素填充方式。 '."\n" + ."\n" + .'- **none**（默认）：不填充，以画面作为配置目标进行Layer设置。'."\n" + .'- **fit**：自适应，以填充区（框）作为配置目标进行Layer设置，此时画面会按照原始的宽高比缩放，长边对齐的自适应方式在填充区（框）内居中填充，若填充区宽高比和画面不一致，则短边两侧无填充（显示为下层Layer画面，若下层未配置Layer，默认为底图黑色）。', + 'type' => 'string', + 'required' => false, + 'example' => 'fit', + ], + 'FixedDelayDuration' => [ + 'description' => '该字段对视频进行固定延迟设置，可用于字幕同步。 单位：毫秒。默认值：**0**，取值范围：**0~5000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5000', + ], + 'HeightNormalized' => [ + 'description' => 'layer元素的高度归一化比例值。 '."\n" + .' '."\n" + .'- 若采用不填充模式，元素的宽度会按照该高度来进行等比缩放，默认为**0**，表示按照画面的原始尺寸进行显示。'."\n" + .'- 若采用自适应方式时，该字段必传且大于**0**，表示填充区（框）高度归一化比例值。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1', + ], + 'PositionNormalized' => [ + 'description' => 'layer 元素的位置归一化值`[x,y]`。默认值为`[0,0]`。'."\n" + ."\n" + .'>注意x,y需要进行归一化计算。', + 'type' => 'array', + 'items' => [ + 'description' => 'layer 元素的位置归一化值`[x,y]`。默认值为`[0,0]`。'."\n" + ."\n" + .'>注意x,y需要进行归一化计算。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '[0,3]', + ], + 'required' => false, + 'example' => '0.3', + 'maxItems' => 2, + ], + 'PositionRefer' => [ + 'description' => '元素的position参考坐标值。取值：'."\n" + .'- **topLeft**（默认值）：左上。'."\n" + .'- **topRight**：右上。'."\n" + .'- **bottomLeft**：左下。'."\n" + .'- **bottomRight**：右下。'."\n" + .'- **center**：中间。'."\n" + .'- **topCenter**：中上。'."\n" + .'- **bottomCenter**：中下。'."\n" + .'- **leftCenter**：左中。'."\n" + .'- **rightCenter**：右中。', + 'type' => 'string', + 'required' => false, + 'example' => 'topLeft', + ], + 'WidthNormalized' => [ + 'description' => 'layer元素的宽度归一化比例值。 '."\n" + ."\n" + .'- 若采用不填充模式，元素的高度会按照该宽度来进行等比缩放，默认值为**0**，表示按照画面的原始尺寸进行显示。'."\n" + .'- 若采用自适应方式时，该字段必传且大于**0**，表示填充区（框）宽度归一化比例值。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 12, + ], + ], + [ + 'name' => 'AudioLayer', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '音频信息。', + 'type' => 'array', + 'items' => [ + 'description' => '音频信息。', + 'type' => 'object', + 'properties' => [ + 'FixedDelayDuration' => [ + 'description' => '该字段对音频进行固定延迟设置，可用于字幕同步。 单位：毫秒。默认值：**0**。取值范围：**0~5000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5000', + ], + 'ValidChannel' => [ + 'description' => '确定哪些声道可以作为音量输入。取值：'."\n" + .'- **leftChannel**：左声道。'."\n" + .'- **rightChannel**：右声道。'."\n" + .'- **all**（默认值）：双声道。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + 'VolumeRate' => [ + 'description' => 'layer元素的高度归一化比例值，其中元素的宽度会按照该高度来进行等比缩放。 '."\n" + ."\n" + .'默认值为**0**，表示按照元素的原始尺寸进行显示。 ', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 12, + ], + ], + [ + 'name' => 'BlendList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '元素为视频资源的位置ID，即LocationId。'."\n" + ."\n" + .'LocationId参见[添加视频源](~~2848020~~)，与VideoLayers元素顺序对应。', + 'type' => 'array', + 'items' => [ + 'description' => '元素为视频资源的位置ID，即LocationId。'."\n" + ."\n" + .'LocationId参见[添加视频源](~~2848020~~)，与VideoLayers元素顺序对应。', + 'type' => 'string', + 'required' => false, + 'example' => 'RV02', + ], + 'required' => true, + 'example' => 'RV02', + 'maxItems' => 12, + ], + ], + [ + 'name' => 'MixList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '元素为音频资源的位置ID，即LocationId。'."\n" + ."\n" + .'LocationId参见[添加视频源](~~2848020~~)，与AudioLayers元素顺序对应。', + 'type' => 'array', + 'items' => [ + 'description' => '元素为音频资源的位置ID，即LocationId。'."\n" + ."\n" + .'LocationId参见[添加视频源](~~2848020~~)，与AudioLayers元素顺序对应。', + 'type' => 'string', + 'required' => false, + 'example' => 'RV02', + ], + 'required' => true, + 'example' => 'RV02', + 'maxItems' => 12, + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'LayoutId', + 'in' => 'query', + 'schema' => [ + 'description' => '布局ID。如果您通过[AddCasterLayout接口](~~2848025~~)添加导播台布局，请查看AddCasterLayout接口调用返回的参数LayoutId值。', + 'type' => 'string', + 'required' => true, + 'example' => '21926b36-7dd2-4fde-ae25-51b5bc8e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'LayoutId' => [ + 'description' => '布局ID。可作为查询导播台布局列表的请求参数。', + 'type' => 'string', + 'example' => '21926b36-7dd2-4fde-ae25-51b5bc8e****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidLayoutId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidVideoLayersAndBlendListSize.Mismatch', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidAudioLayersAndMixListSize.Mismatch', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidPositionNormalized.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidBlendList.ExceedNorm', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidMixList.ExceedNorm', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidHeightOrWidthNormalized', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidVideoLayersConfig', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidAudioLayersConfig', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidLayout.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LayoutId\\": \\"21926b36-7dd2-4fde-ae25-51b5bc8e****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<ModifyCasterLayoutResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n\\t<LayoutId>21926b36-7dd2-4fde-ae25-51b5bc8e52d8</LayoutId>\\n</ModifyCasterLayoutResponse>\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"LayoutId\\": \\"21926b36-7dd2-4fde-ae25-51b5bc8e52d8\\"\\n}"}]', + 'title' => '修改导播台布局', + 'description' => '先通过[CreateCaster接口](~~2848009~~)创建导播台，再调用本接口修改布局配置，传递修改项，非修改内容无需传递。本接口目前支持的元素填充方式为默认和自适应。'."\n" + ."\n\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '> 请求参数中的N表示第几个的意思。例如：VideoLayer.N.FillMode表示传入第几个元素的填充方式。VideoLayer.1.FillMode表示传入第1个元素的填充方式，VideoLayer.2.FillMode表示传入第2个元素的填充方式。'."\n" + .' '."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCasterLayouts' => [ + 'summary' => '查询导播台布局列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'LayoutId', + 'in' => 'query', + 'schema' => [ + 'description' => '布局ID。'."\n" + ."\n" + .'如果您不提供LayoutId值，则返回导播台下所有布局列表。', + 'type' => 'string', + 'required' => false, + 'example' => '72d2ec7a-4cd7-4a01-974b-7cd53947****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Layouts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Layout' => [ + 'description' => '布局列表。', + 'type' => 'array', + 'items' => [ + 'description' => '布局列表。', + 'type' => 'object', + 'properties' => [ + 'AudioLayers' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AudioLayer' => [ + 'description' => 'Audiolayer配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'audiolayer配置列表。', + 'type' => 'object', + 'properties' => [ + 'FixedDelayDuration' => [ + 'description' => '该字段对视频进行固定延迟设置，可用于字幕同步。 '."\n" + .' '."\n" + .'单位为毫秒（ms）。默认值为**0**。取值范围为**0~5000**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ValidChannel' => [ + 'description' => '确定哪些声道可以作为音量输入。取值：'."\n" + ."\n" + .'- **leftChannel**：左声道。'."\n" + .'- **rightChannel**：右声道。'."\n" + .'- **all**（默认值）：双声道。', + 'type' => 'string', + 'example' => 'all', + ], + 'VolumeRate' => [ + 'description' => 'Layer元素的高度归一化比例值，其中元素的宽度会按照该高度来进行等比缩放。 '."\n" + .'>默认值为**0**，表示按照元素的原始尺寸进行显示。 ', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'BlendList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LocationId' => [ + 'description' => '位置关联列表，与VideoLayers顺序保持一致。', + 'type' => 'array', + 'items' => [ + 'description' => '位置ID。', + 'type' => 'string', + 'example' => 'RV01', + ], + ], + ], + ], + 'LayoutId' => [ + 'description' => '布局ID。', + 'type' => 'string', + 'example' => '72d2ec7a-4cd7-4a01-974b-7cd53947****', + ], + 'MixList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LocationId' => [ + 'description' => '位置关联列表，与AudioLayers顺序保持一致。', + 'type' => 'array', + 'items' => [ + 'description' => '位置ID。', + 'type' => 'string', + 'example' => 'RV01', + ], + ], + ], + ], + 'VideoLayers' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoLayer' => [ + 'description' => 'Videolayer配置列表，采用数组默认序列。', + 'type' => 'array', + 'items' => [ + 'description' => 'videolayer配置列表，采用数组默认序列。', + 'type' => 'object', + 'properties' => [ + 'FillMode' => [ + 'description' => '元素填充方式。取值： '."\n" + .' '."\n" + .'- **none**（默认）：不填充。以画面作为配置目标进行Layer设置。'."\n" + .'- **fit**：自适应。以填充区（框）作为配置目标进行Layer设置，此时画面会按照原始的宽高比缩放，长边对齐的自适应方式在填充区（框）内居中填充，若填充区宽高比和画面不一致，则短边两侧无填充（显示为下层Layer画面，若下层未配置Layer，默认为底图黑色）。', + 'type' => 'string', + 'example' => 'fit', + ], + 'FixedDelayDuration' => [ + 'description' => '该字段对视频进行固定延迟设置，可用于字幕同步。 '."\n" + .' '."\n" + .'单位：毫秒（ms） 。 默认值为**0** 。取值范围为**0~5000**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'HeightNormalized' => [ + 'description' => 'Layer元素的高度归一化比例值。 '."\n" + .' '."\n" + .'- 若采用不填充模式，元素的宽度会按照该高度来进行等比缩放。默认值为**0**，表示按照画面的原始尺寸进行显示。'."\n" + .'- 若采用自适应方式，该字段必传且大于**0**，表示填充区（框）高度归一化比例值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'PositionNormalizeds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Position' => [ + 'description' => 'Layer元素的位置归一化值`[x,y]`，默认为`[0,0]`。'."\n" + .'>注意x,y需要进行归一化计算。', + 'type' => 'array', + 'items' => [ + 'description' => '值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + ], + ], + ], + 'PositionRefer' => [ + 'description' => '设置元素的位置参考坐标值。取值：'."\n" + ."\n" + .'- **topLeft**（默认值）：左上。'."\n" + .'- **topRight**：右上。'."\n" + .'- **bottomLeft**：左下。'."\n" + .'- **bottomRight**：右下。 '."\n" + .'- **center**：中间。'."\n" + .'- **topCenter**：中上。'."\n" + .'- **bottomCenter**：中下。'."\n" + .'- **leftCenter**：左中。'."\n" + .'- **rightCenter**：右中。', + 'type' => 'string', + 'example' => 'topLeft', + ], + 'WidthNormalized' => [ + 'description' => 'Layer元素的宽度归一化比例值。 '."\n" + .' '."\n" + .'- 若采用不填充模式，元素的高度会按照该宽度来进行等比缩放。默认值为**0**，表示按照画面的原始尺寸进行显示。 '."\n" + .'- 若采用自适应方式，该字段必传且大于**0**，表示填充区（框）宽度归一化比例值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3be7ade8-d907-483c-b24a-0dad45****', + ], + 'Total' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Layouts\\": {\\n \\"Layout\\": [\\n {\\n \\"AudioLayers\\": {\\n \\"AudioLayer\\": [\\n {\\n \\"FixedDelayDuration\\": 20,\\n \\"ValidChannel\\": \\"all\\",\\n \\"VolumeRate\\": 1\\n }\\n ]\\n },\\n \\"BlendList\\": {\\n \\"LocationId\\": [\\n \\"RV01\\"\\n ]\\n },\\n \\"LayoutId\\": \\"72d2ec7a-4cd7-4a01-974b-7cd53947****\\",\\n \\"MixList\\": {\\n \\"LocationId\\": [\\n \\"RV01\\"\\n ]\\n },\\n \\"VideoLayers\\": {\\n \\"VideoLayer\\": [\\n {\\n \\"FillMode\\": \\"fit\\",\\n \\"FixedDelayDuration\\": 20,\\n \\"HeightNormalized\\": 0.5,\\n \\"PositionNormalizeds\\": {\\n \\"Position\\": [\\n 0\\n ]\\n },\\n \\"PositionRefer\\": \\"topLeft\\",\\n \\"WidthNormalized\\": 0.5\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"3be7ade8-d907-483c-b24a-0dad45****\\",\\n \\"Total\\": 3\\n}","errorExample":""},{"type":"xml","example":"<DescribeCasterLayoutsResponse>\\n<RequestId>3be7ade8-d907-483c-b24a-0dad4595beaf</RequestId>\\n<Layouts>\\n <Layout>\\n <LayoutId>72d2ec7a-4cd7-4a01-974b-7cd53947****</LayoutId>\\n <AudioLayers>\\n <AudioLayer>\\n <ValidChannel>all</ValidChannel>\\n <VolumeRate>1</VolumeRate>\\n <FixedDelayDuration>20</FixedDelayDuration>\\n </AudioLayer>\\n </AudioLayers>\\n <VideoLayers>\\n <VideoLayer>\\n <FillMode>fit</FillMode>\\n <HeightNormalized>0.5</HeightNormalized>\\n <PositionRefer>topLeft</PositionRefer>\\n <FixedDelayDuration>20</FixedDelayDuration>\\n <WidthNormalized>0.5</WidthNormalized>\\n <PositionNormalizeds>\\n <Position>[0,3]</Position>\\n </PositionNormalizeds>\\n </VideoLayer>\\n </VideoLayers>\\n <BlendList>\\n <LocationId>\\"RV01\\", \\"RV02\\"</LocationId>\\n </BlendList>\\n <MixList>\\n <LocationId>RV01</LocationId>\\n </MixList>\\n </Layout>\\n</Layouts>\\n<Total>3</Total>\\n</DescribeCasterLayoutsResponse>","errorExample":"{\\n \\"RequestId\\": \\"3be7ade8-d907-483c-b24a-0dad4595beaf\\",\\n \\"Layouts\\": [\\n {\\n \\"MixList\\": [\\n \\"RV01\\"\\n ],\\n \\"AudioLayers\\": [\\n {\\n \\"ValidChannel\\": \\"all\\",\\n \\"VolumeRate\\": 1\\n }\\n ],\\n \\"VideoLayers\\": [\\n {\\n \\"HeightNormalized\\": 0.5,\\n \\"PositionRefer\\": \\"topLeft\\",\\n \\"WidthNormalized\\": 0.5,\\n \\"PositionNormalized\\": [\\n 0,\\n 0.3\\n ]\\n },\\n {\\n \\"HeightNormalized\\": 0.5,\\n \\"PositionRefer\\": \\"topLeft\\",\\n \\"WidthNormalized\\": 0.5,\\n \\"PositionNormalized\\": [\\n 0.5,\\n 0.3\\n ]\\n }\\n ],\\n \\"LayoutId\\": \\"72d2ec7a-4cd7-4a01-974b-7cd53947f053\\",\\n \\"BlendList\\": [\\n \\"RV01\\",\\n \\"RV02\\"\\n ]\\n },\\n {\\n \\"MixList\\": [\\n \\"RV01\\"\\n ],\\n \\"AudioLayers\\": [\\n {\\n \\"ValidChannel\\": \\"all\\",\\n \\"VolumeRate\\": 0.5\\n }\\n ],\\n \\"VideoLayers\\": [\\n {\\n \\"HeightNormalized\\": 1,\\n \\"PositionRefer\\": \\"topLeft\\",\\n \\"WidthNormalized\\": 1,\\n \\"PositionNormalized\\": [\\n 0,\\n 0\\n ]\\n },\\n {\\n \\"HeightNormalized\\": 0.4,\\n \\"PositionRefer\\": \\"topLeft\\",\\n \\"WidthNormalized\\": 0.4,\\n \\"PositionNormalized\\": [\\n 0.1,\\n 0.1\\n ]\\n }\\n ],\\n \\"LayoutId\\": \\"21926b36-7dd2-4fde-ae25-51b5bc8e52d8\\",\\n \\"BlendList\\": [\\n \\"RV01\\",\\n \\"RV02\\"\\n ]\\n }\\n ]\\n}"}]', + 'title' => '查询导播台布局列表', + 'description' => '调用本接口查询导播台布局列表。若未指定具体的布局ID，则默认查询导播台下所有布局列表。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddCasterComponent' => [ + 'summary' => '添加导播台组件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'>直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'ComponentName', + 'in' => 'query', + 'schema' => [ + 'description' => '组件名称。默认为组件ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'text01', + ], + ], + [ + 'name' => 'LocationId', + 'in' => 'query', + 'schema' => [ + 'description' => '用于指定组件位置，每个位置至多设置一个组件，格式需符合“RC01~RC99”。'."\n" + ."\n" + .'> 组件类型为caption时，表示引用的视频源Location。', + 'type' => 'string', + 'required' => true, + 'example' => 'RC01', + ], + ], + [ + 'name' => 'ComponentType', + 'in' => 'query', + 'schema' => [ + 'description' => '组件类型。取值：'."\n" + ."\n" + .'- **text**：文字组件。如果选择text类型，必须同时设置请求参数TextLayerContent。'."\n" + ."\n" + .'- **image**：图片组件。如果选择image类型，必须同时设置请求参数ImageLayerContent。'."\n" + ."\n" + .'- **caption**：翻译字幕组件。如果选择caption类型，必须同时设置请求参数CaptionLayerContent。'."\n" + ."\n\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'text', + ], + ], + [ + 'name' => 'Effect', + 'in' => 'query', + 'schema' => [ + 'description' => '组件显示的特效 。取值：'."\n" + .' '."\n" + .'- **none**（默认值）：无。'."\n" + .'- **animateH**：水平滚动。'."\n" + .'- **animateV**：垂直滚动。', + 'type' => 'string', + 'required' => false, + 'example' => 'animateH', + ], + ], + [ + 'name' => 'ComponentLayer', + 'in' => 'query', + 'schema' => [ + 'description' => '该组件Layer的尺寸，布局等信息。设置元素说明如下：'."\n" + .'- **HeightNormalized**：高度归一化比例值。'."\n" + .'- **WidthNormalized**：宽度归一化比例值。'."\n" + .'- **PositionNormalized**：layer 元素的位置归一化值。'."\n" + .'- **PositionRefer**：元素的位置参考坐标值。'."\n" + ."\n" + .'JSON格式字符串，参数名采用首字母大写、驼峰格式。', + 'type' => 'string', + 'required' => true, + 'example' => '{"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]}', + ], + ], + [ + 'name' => 'LayerOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '组件层叠次序。'."\n" + ."\n" + .'- cover：覆盖。'."\n" + .'- background：背景。', + 'type' => 'string', + 'required' => false, + 'example' => 'cover', + ], + ], + [ + 'name' => 'TextLayerContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'Layer元素属性。元素属性说明如下：'."\n" + .'><notice>当ComponentType为text时，本参数才可用且必传。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'- **SizeNormalized**：字体归一化大小，字体设置大小为“font_size/output_height”，取值范围`[0,1]`，如果系统根据归一化方式反计算出来的字体大小大于1024，取1024。'."\n" + .'- **BorderWidthNormalized**：文字边框宽度归一化值，该归一化值是基于文字的size来计算的，即“BorderWidth/FontSize”，取值范围`[0,1]`，如果根据归一化方式反计算出来的值超过16，取16，默认0。'."\n" + .'- **FontName**：字体名称，取值请参见**导播台字体说明**，默认楷体，“KaiTi”。'."\n" + .'- **BorderColor**：文字边框色彩，取值“0x000000-0xffffff”，默认“”，表示无效。'."\n" + .'- **Text**：文本内容，默认“”。'."\n" + .'- **Color**：文字色彩，默认“0xff0000”，红色。'."\n" + ."\n" + .'JSON格式字符串，参数名采用首字母大写，驼峰格式。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"BorderWidthNormalized":"1","SizeNormalized":"0.2","Color":"0x000000","FontName":"KaiTi","BorderColor":"0x000000","Text":"hello world!"}', + ], + ], + [ + 'name' => 'ImageLayerContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'Layer元素属性。元素属性说明如下：'."\n" + ."\n" + .'><notice> ComponentType为image时，该参数必传。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'MaterialId：媒资库素材ID。上传素材时设置的名称就是媒资库素材ID。'."\n" + ."\n" + .'JSON格式字符串，参数名采用首字母大写，驼峰格式。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"MaterialId":"6cf724c6ebfd4a59b5b3cec6f10d****"}', + ], + ], + [ + 'name' => 'CaptionLayerContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'Layer元素属性。元素属性说明如下：'."\n" + .'><notice>当ComponentType为caption时，该参数必传。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'- **SizeNormalized**：字体归一化大小，字体设置大小为“font_size/output_height”，取值范围`[0,1]`，精确到小数点后两位，如果系统根据归一化方式反计算出来的字体大小大于**1024**，取**1024**。'."\n" + .'- **BorderWidthNormalized**：文字边框宽度归一化值，该归一化值是基于文字的size来计算的，即“BorderWidth/FontSize”，取值范围`[0,1]`，精确到小数点后两位，如果根据归一化方式反计算出来的值超过**16**，取**16**，默认**0**。'."\n" + .'- **FontName**：字体名称，取值请参见**云导播字体说明**，默认楷体，“KaiTi”。'."\n" + .'- **BorderColor**：文字边框色彩，取值“0x000000-0xffffff”，默认“”，表示无效。'."\n" + .'- **LocationId**: 翻译源的channelId。'."\n" + .'- **SourceLan**: 视频源的原始音频语言。En-英文，cn-中文，es-西班牙文，ru-俄文，默认为cn-中文。'."\n" + .'- **TargetLan**：视频源的目标音频语言。不设置表示语音识别，设置表示翻译。取值：en-英文，cn-中文，es-西班牙文，ru-俄文，cn-中文。'."\n" + .'- **ShowSourceLan**：是否显示源语言。取值：true-显示，false-不显示，默认为false。'."\n" + .'- **Truncation**：字幕是否可以被截断。取值：true-可以被截断，false-不可以被截断，默认为false。'."\n" + .'- **SourceLanPerLineWordCount**：源语言每行字数，默认20。'."\n" + .'- **TargetLanPerLineWordCount**：目标语言每行字数，默认20。'."\n" + .'- **SourceLanReservePages**：源语言保留行数，Truncation为true的时候生效，默认2行。'."\n" + .'- **TargetLanReservePages**：目标语言保留行数，Truncation为true的时候生效，默认2行。'."\n" + ."\n" + .'JSON格式字符串，参数名采用首字母大写，驼峰格式。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"BorderWidthNormalized":0.01,"SizeNormalized":0.05,"Color":"0x000000","LocationId":"RV01","SourceLan":"cn","FontName":"KaiTi","BorderColor":"0xffffff"}', + ], + ], + [ + 'name' => 'HtmlLayerContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'H5组件配置。', + 'type' => 'string', + 'required' => false, + 'example' => '{"htmlUrl":http://caster.example.com}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentId' => [ + 'description' => '组件ID。可作为查询导播台组件、修改导播台组件、删除导播台组件的请求参数。', + 'type' => 'string', + 'example' => '21926b36-7dd2-4fde-ae25-51b5bc8e****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidPositionNormalized.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'DuplicateLocationID', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'CanvasNotExist', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ComponentId\\": \\"21926b36-7dd2-4fde-ae25-51b5bc8e****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<AddCasterComponentResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n\\t<ComponentId>21926b36-7dd2-4fde-ae25-51b5bc8e****</ComponentId>\\n</AddCasterComponentResponse>\\t","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"ComponentId\\": \\"21926b36-7dd2-4fde-ae25-51b5bc8e52d8\\"\\n}"}]', + 'title' => '添加导播台组件', + 'description' => '请先创建导播台、了解导播台的布局列表后再调用本接口添加导播台组件。本接口目前支持添加图片、文字、字幕三类组件。使用API创建导播台，请参见[创建导播台](~~2848009~~)。'."\n" + ."\n\n" + .'## QPS限制'."\n" + ."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '## 云导播字体说明'."\n" + .'|字体|FontName取值|'."\n" + .'|-----|-----|'."\n" + .'|楷体|KaiTi|'."\n" + .'|阿里巴巴普惠体-常规|AlibabaPuHuiTi-Regular|'."\n" + .'|阿里巴巴普惠体-粗体|AlibabaPuHuiTi-Bold|'."\n" + .'|阿里巴巴普惠体-细体|AlibabaPuHuiTi-Light|'."\n" + .'|思源黑体-常规|NotoSansHans-Regular|'."\n" + .'|思源黑体-粗体|NotoSansHans-Bold|'."\n" + .'|思源黑体-细体|NotoSansHans-Light|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCasterComponent' => [ + 'summary' => '调用DeleteCasterComponent删除导播台组件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + [ + 'name' => 'ComponentId', + 'in' => 'query', + 'schema' => [ + 'description' => '组件ID。如果您通过[AddCasterComponent接口](~~2848030~~)添加导播台组件，请查看AddCasterComponent接口调用返回的参数ComponentId值。', + 'type' => 'string', + 'required' => true, + 'example' => '21926b36-7dd2-4fde-ae25-51b5bc8e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。可作为查询导播台组件列表、添加导播台节目单、修改导播台组件的请求参数。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880****', + ], + 'ComponentId' => [ + 'description' => '组件ID。可作为查询导播台组件列表、修改导播台组件的请求参数。', + 'type' => 'string', + 'example' => '21926b36-7dd2-4fde-ae25-51b5bc8e****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidComponent.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880****\\",\\n \\"ComponentId\\": \\"21926b36-7dd2-4fde-ae25-51b5bc8e****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCasterComponentResponse>\\n <CasterId>a2b8e671-2fe5-4642-a2ec-bf93880****</CasterId>\\n <ComponentId>21926b36-7dd2-4fde-ae25-51b5bc8e****</ComponentId>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteCasterComponentResponse>","errorExample":""}]', + 'title' => '删除导播台组件', + 'description' => '先通过[CreateCaster接口](~~2848009~~)创建导播台，再调用本接口删除导播台组件。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyCasterComponent' => [ + 'summary' => '调用ModifyCasterComponent修改导播台组件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'ComponentId', + 'in' => 'query', + 'schema' => [ + 'description' => '组件ID。如果您通过[AddCasterComponent接口](~~2848030~~)添加导播台组件，请查看AddCasterComponent接口调用返回的参数ComponentId值。', + 'type' => 'string', + 'required' => true, + 'example' => '05ab713c-676e-49c0-96ce-cc408da1****', + ], + ], + [ + 'name' => 'ComponentName', + 'in' => 'query', + 'schema' => [ + 'description' => '组件名称，默认为组件ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'text01', + ], + ], + [ + 'name' => 'ComponentType', + 'in' => 'query', + 'schema' => [ + 'description' => '组件的类型。取值：'."\n" + .'- **text**：文字组件。如果ComponentType的取值为text，TextLayerContent参数才必传。'."\n" + .'- **image**：图片组件。如果ComponentType的取值为image，ImageLayerContent参数才必传。'."\n" + .'- **caption**：翻译字幕组件。如果ComponentType的取值为caption，CaptionLayerContent参数才必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + ], + [ + 'name' => 'Effect', + 'in' => 'query', + 'schema' => [ + 'description' => '组件显示的特效。取值：'."\n" + ."\n" + .' - **none**（默认值）：无。'."\n" + .' - **animateH**：水平滚动。'."\n" + .' - **animateV**：垂直滚动。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'animateV', + ], + ], + [ + 'name' => 'ComponentLayer', + 'in' => 'query', + 'schema' => [ + 'description' => 'Layer的尺寸，布局等信息。格式为JSON。设置元素说明如下：'."\n" + .'- **HeightNormalized**：高度归一化比例值。'."\n" + .'- **WidthNormalized**：宽度归一化比例值。'."\n" + .'- **PositionNormalized**：layer 元素的位置归一化值。'."\n" + .'- **PositionRefer**：元素的位置参考坐标值。', + 'type' => 'string', + 'required' => false, + 'example' => '{"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]}', + ], + ], + [ + 'name' => 'TextLayerContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'Layer元素属性。格式为JSON。元素属性说明如下：'."\n" + .'><notice>当ComponentType取值为text时，本参数必传。'."\n" + .'></notice>'."\n" + .'- **SizeNormalized**：字体归一化大小，字体设置大小为“font_size/output_height”，取值范围`[0,1]`，如果系统根据归一化方式反计算出来的字体大小大于1024，取1024。'."\n" + .'- **BorderWidthNormalized**：文字边框宽度归一化值，该归一化值是基于文字的size来计算的，即“BorderWidth/FontSize”，取值范围`[0,1]`，如果根据归一化方式反计算出来的值超过16，取16，默认0。'."\n" + .'- **FontName**：字体名称，取值请参见**导播台字体说明**，默认楷体，“KaiTi”。'."\n" + .'- **BorderColor**：文字边框色彩，取值“0x000000-0xffffff”，默认“”，表示无效。'."\n" + .'- **Text**：文本内容，默认“”。'."\n" + .'- **Color**：文字色彩，默认“0xff0000”，红色。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"BorderWidthNormalized":"1","SizeNormalized":"0.2","Color":"0x000000","FontName":"KaiTi","BorderColor":"0x000000","Text":"hello world!"}', + ], + ], + [ + 'name' => 'ImageLayerContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'Layer元素属性。格式为JSON。'."\n" + .'><notice>当ComponentType为image时，本参数必传。'."\n" + .'></notice>'."\n" + ."\n\n" + .'MaterialId为媒资库素材ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"MaterialId":"6cf724c6ebfd4a59b5b3cec6f10d5ecf"}', + ], + ], + [ + 'name' => 'CaptionLayerContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'Layer元素属性。格式为JSON。元素属性说明如下：'."\n" + .'><notice>当ComponentType为caption时，本参数必传。'."\n" + .'></notice>'."\n" + .'- **SizeNormalized**：字体归一化大小，字体设置大小为“font_size/output_height”，取值范围`[0,1]`，如果系统根据归一化方式反计算出来的字体大小大于1024，取1024。'."\n" + .'- **BorderWidthNormalized**：文字边框宽度归一化值，该归一化值是基于文字的size来计算的，即“BorderWidth/FontSize”，取值范围`[0,1]`，如果根据归一化方式反计算出来的值超过16，取16，默认0。'."\n" + .'- **FontName**：字体名称，取值请参见**导播台字体说明**，默认楷体，“KaiTi”。'."\n" + .'- **BorderColor**：文字边框色彩，取值“0x000000-0xffffff”，默认“”，表示无效。'."\n" + .'- **LocationId**: 翻译源的channelId。'."\n" + .'- **SourceLan**: 视频源的原始音频语言。En-英文，cn-中文，es-西班牙文，ru-俄文，默认为cn-中文。'."\n" + .'- **TargetLan**：视频源的目标音频语言。不设置表示语音识别，设置表示翻译。取值：en-英文，cn-中文，es-西班牙文，ru-俄文，cn-中文。'."\n" + .'- **ShowSourceLan**：是否显示源语言。取值：true-显示，false-不显示，默认为false。'."\n" + .'- **Truncation**：字幕是否可以被截断。取值：true-可以被截断，false-不可以被截断，默认为false。'."\n" + .'- **SourceLanPerLineWordCount**：源语言每行字数，Truncation为true的时候生效， 默认20。'."\n" + .'- **TargetLanPerLineWordCount**：目标语言每行字数，Truncation为true的时候生效，默认20。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"BorderWidthNormalized":0.01,"SizeNormalized":0.05,"Color":"0x000000","LocationId":"RV01","SourceLan":"cn","FontName":"KaiTi","BorderColor":"0xffffff"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentId' => [ + 'description' => '组件ID。可作为查询导播台组件列表的请求参数。', + 'type' => 'string', + 'example' => '05ab713c-676e-49c0-96ce-cc408da1****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidPositionNormalized.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidComponent.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'CanvasNotExist', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ComponentId\\": \\"05ab713c-676e-49c0-96ce-cc408da1****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyCasterComponentResponse>\\n <ComponentId>05ab713c-676e-49c0-96ce-cc408da1****</ComponentId>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</ModifyCasterComponentResponse>","errorExample":""}]', + 'title' => '修改导播台组件', + 'description' => '调用本接口修改导播台组件。本接口目前支持的组件类型为文字组件、图片组件和翻译字幕组件。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '## 导播台字体说明'."\n" + .'|字体|FontName取值|'."\n" + .'|-----|-----|'."\n" + .'|楷体|KaiTi|'."\n" + .'|阿里巴巴普惠体-常规|AlibabaPuHuiTi-Regular|'."\n" + .'|阿里巴巴普惠体-粗体|AlibabaPuHuiTi-Bold|'."\n" + .'|阿里巴巴普惠体-细体|AlibabaPuHuiTi-Light|'."\n" + .'|思源黑体-常规|NotoSansHans-Regular|'."\n" + .'|思源黑体-粗体|NotoSansHans-Bold|'."\n" + .'|思源黑体-细体|NotoSansHans-Light|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCasterComponents' => [ + 'summary' => '调用DescribeCasterComponents查询导播台组件列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'ComponentId', + 'in' => 'query', + 'schema' => [ + 'description' => '组件ID。如果您通过[AddCasterComponent接口](~~2848030~~)添加导播台组件，请查看AddCasterComponent接口调用返回的参数ComponentId值。', + 'type' => 'string', + 'required' => false, + 'example' => '21926b36-7dd2-4fde-ae25-51b5bc8e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Components' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Component' => [ + 'description' => '组件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CaptionLayerContent' => [ + 'description' => 'Caption元素属性。', + 'type' => 'object', + 'properties' => [ + 'BorderColor' => [ + 'description' => '文字边框色彩。'."\n" + ."\n" + .'取值范围为**0x000000~0xffffff**。默认：""，表示无效。', + 'type' => 'string', + 'example' => '0x000000', + ], + 'BorderWidthNormalized' => [ + 'description' => '文字边框宽度归一化值。该归一化值是基于文字的size来计算的，即BorderWidth/FontSize。'."\n" + ."\n" + .'如果系统归一化反计算出来的值超过**16**，取**16**。默认值为**0**。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Color' => [ + 'description' => '文字色彩。取值范围为**0x000000~0xffffff**。', + 'type' => 'string', + 'example' => '0x000000', + ], + 'FontName' => [ + 'description' => '字体名字取系统预设值。取值：'."\n" + ."\n" + .'- **KaiTi**：楷体。'."\n" + .'- **AlibabaPuHuiTi-Regular**：阿里巴巴普惠体-常规。'."\n" + .'- **AlibabaPuHuiTi-Bold**：阿里巴巴普惠体-粗体。'."\n" + .'- **NAlibabaPuHuiTi-Light**：阿里巴巴普惠体-细体。'."\n" + .'- **NotoSansHans-Regular**：思源黑体-常规。 '."\n" + .'- **NotoSansHans-Bold**：思源黑体-粗体。 '."\n" + .'- **NotoSansHans-Light**：思源黑体-细体。 '."\n" + ."\n" + .'默认为**KaiTi**。', + 'type' => 'string', + 'example' => 'KaiTi', + ], + 'LineSpaceNormalized' => [ + 'description' => '行间距。表示每两行字之间的间隔。默认值为0。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'LocationId' => [ + 'description' => '组件类型为caption时，表示引用的视频源Location（通道IChannelId）。', + 'type' => 'string', + 'example' => 'RV01', + ], + 'PtsOffset' => [ + 'description' => '纠正当前字幕pts与语音pts偏差值。'."\n" + ."\n" + .'取值范围为 **-10000~+10000**。默认值为**0**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ShowSourceLan' => [ + 'description' => '是否显示源语言。取值：'."\n" + ."\n" + .'- **true**：显示。'."\n" + .'- **false**（默认值）：不显示。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SizeNormalized' => [ + 'description' => '字体归一化大小，字体设置大小为`[font_size,output_height]`。'."\n" + ."\n" + .'如果系统根据归一化方式反计算的出来的字体大小大于**1024**，取**1024**。默认值为 **-1**，表示无效。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'SourceLan' => [ + 'description' => '视频源的原始音频语言。取值：'."\n" + .'- **en**：英文。'."\n" + .'- **cn**（默认）：中文。'."\n" + .'- **es**：西班牙文。'."\n" + .'- **ru**：俄文。', + 'type' => 'string', + 'example' => 'cn', + ], + 'TargetLan' => [ + 'description' => '视频源的目标音频语言。取值：'."\n" + .'- **en**：英文。'."\n" + .'- **cn**（默认）：中文。'."\n" + .'- **es**：西班牙文。'."\n" + .'- **ru**：俄文。', + 'type' => 'string', + 'example' => 'cn', + ], + 'WordCountPerLine' => [ + 'description' => '每行最大展示字数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'WordSpaceNormalized' => [ + 'description' => '字间距，表示每两个字之间的间隔。默认值为**0**。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'WordsCount' => [ + 'description' => '显示字数，可配合字体大小调整。'."\n" + ."\n" + .'取值范围为**10~50**。默认值为**35**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '35', + ], + ], + ], + 'ComponentId' => [ + 'description' => '组件ID。', + 'type' => 'string', + 'example' => '72d2ec7a-4cd7-4a01-974b-7cd53947****', + ], + 'ComponentLayer' => [ + 'description' => '组件Layer的尺寸，布局等信息。', + 'type' => 'object', + 'properties' => [ + 'HeightNormalized' => [ + 'description' => 'Layer元素的高度归一化比例值，其中元素的宽度会按照该高度来进行等比缩放。 '."\n" + ."\n" + .'默认值为**0**，表示按照元素的原始尺寸进行显示。 ', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'PositionNormalizeds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Position' => [ + 'description' => 'Layer 元素的位置归一化值`[x,y]`, 默认为`[0,0]`。 '."\n" + ."\n" + .'>x，y需要进行归一化计算。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.3', + ], + ], + ], + ], + 'PositionRefer' => [ + 'description' => '元素的位置参考坐标值。取值：'."\n" + ."\n" + .'- **topLeft**（默认值）：左上。'."\n" + .'- **topRight**：右上。'."\n" + .'- **bottomLeft**：左下。'."\n" + .'- **bottomRight**：右下。', + 'type' => 'string', + 'example' => 'topLeft', + ], + 'Transparency' => [ + 'description' => '该Layer的透明度，取值范围为0~255。'."\n" + ."\n" + .'**0**代表完全透明。**255**（默认）代表完全不透明。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'WidthNormalized' => [ + 'description' => 'Layer元素的宽度归一化比例值，其中元素的高度会按照该宽度来进行等比缩放。默认值为**0**，表示按照元素的原始尺寸进行显示。'."\n" + ."\n" + .'> 该字段和heightNormalized有冲突。一旦同时设置，只有heightNormalized生效。如果只能设置一个，后面设置的值会影响前面的设置。'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + ], + ], + 'ComponentName' => [ + 'description' => '组件名称，默认为组件ID。', + 'type' => 'string', + 'example' => 'component_name', + ], + 'ComponentType' => [ + 'description' => '组件类型。取值：'."\n" + .'- **text**：文字组件。'."\n" + .'- **image**：图像组件。 '."\n" + .'- **caption**：翻译字幕组件。', + 'type' => 'string', + 'example' => 'text', + ], + 'Effect' => [ + 'description' => '组件显示的特效。取值： '."\n" + .' '."\n" + .'- **none**：无。'."\n" + .' '."\n" + .'- **animateH**：水平滚动。'."\n" + .' '."\n" + .'- **animateV**：垂直滚动。', + 'type' => 'string', + 'example' => 'animateV', + ], + 'ImageLayerContent' => [ + 'description' => 'Image元素属性。', + 'type' => 'object', + 'properties' => [ + 'MaterialId' => [ + 'description' => '媒资库素材ID。', + 'type' => 'string', + 'example' => '6cf724c6ebfd4a59b5b3cec6f10d****', + ], + ], + ], + 'LocationId' => [ + 'description' => '用于指定组件位置。'."\n" + ."\n" + .'每个位置至多设置一个组件，格式需符合“RC01…RC12”。', + 'type' => 'string', + 'example' => 'RC01', + ], + 'TextLayerContent' => [ + 'description' => 'Text元素属性。', + 'type' => 'object', + 'properties' => [ + 'BorderColor' => [ + 'description' => '文字边框色彩。取值范围为**0x000000~0xffffff**。默认为 **""**，表示无效。', + 'type' => 'string', + 'example' => '0x000000', + ], + 'BorderWidthNormalized' => [ + 'description' => '文字边框宽度归一化值是基于文字的size来计算的，即**BorderWidth/FontSize**。'."\n" + ."\n" + .'如果系统归一化反计算出来的值超过**16**，取**16**。默认值为**0**。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Color' => [ + 'description' => '文字色彩。取值范围为**0x000000~0xffffff**。', + 'type' => 'string', + 'example' => '0xff0000', + ], + 'FontName' => [ + 'description' => '字体名字取系统预设值。取值：'."\n" + ."\n" + .'- **KaiTi**：楷体。'."\n" + .'- **AlibabaPuHuiTi-Regular**：阿里巴巴普惠体-常规。'."\n" + .'- **AlibabaPuHuiTi-Bold**：阿里巴巴普惠体-粗体。'."\n" + .'- **NAlibabaPuHuiTi-Light**：阿里巴巴普惠体-细体。'."\n" + .'- **NotoSansHans-Regular**：思源黑体-常规。 '."\n" + .'- **NotoSansHans-Bold**：思源黑体-粗体。 '."\n" + .'- **NotoSansHans-Light**：思源黑体-细体。 '."\n" + ."\n" + .'默认为**KaiTi**。', + 'type' => 'string', + 'example' => 'KaiTi', + ], + 'SizeNormalized' => [ + 'description' => '字体归一化大小。'."\n" + ."\n" + .'设置大小为**font_size/output_height**。如果系统根据归一化方式反计算的出来的字体大小大于**1024**, 取**1024**。默认值为 **-1**，表示无效。', + 'type' => 'number', + 'format' => 'float', + 'example' => '16', + ], + 'Text' => [ + 'description' => '文本内容。', + 'type' => 'string', + 'example' => 'hello world', + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3be7ade8-d907-483c-b24a-0dad45******', + ], + 'Total' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Components\\": {\\n \\"Component\\": [\\n {\\n \\"CaptionLayerContent\\": {\\n \\"BorderColor\\": \\"0x000000\\",\\n \\"BorderWidthNormalized\\": 0,\\n \\"Color\\": \\"0x000000\\",\\n \\"FontName\\": \\"KaiTi\\",\\n \\"LineSpaceNormalized\\": 0,\\n \\"LocationId\\": \\"RV01\\",\\n \\"PtsOffset\\": 0,\\n \\"ShowSourceLan\\": false,\\n \\"SizeNormalized\\": 0.1,\\n \\"SourceLan\\": \\"cn\\",\\n \\"TargetLan\\": \\"cn\\",\\n \\"WordCountPerLine\\": 15,\\n \\"WordSpaceNormalized\\": 0,\\n \\"WordsCount\\": 35\\n },\\n \\"ComponentId\\": \\"72d2ec7a-4cd7-4a01-974b-7cd53947****\\",\\n \\"ComponentLayer\\": {\\n \\"HeightNormalized\\": 0.5,\\n \\"PositionNormalizeds\\": {\\n \\"Position\\": [\\n 0.3\\n ]\\n },\\n \\"PositionRefer\\": \\"topLeft\\",\\n \\"Transparency\\": 200,\\n \\"WidthNormalized\\": 0.5\\n },\\n \\"ComponentName\\": \\"component_name\\",\\n \\"ComponentType\\": \\"text\\",\\n \\"Effect\\": \\"animateV\\",\\n \\"ImageLayerContent\\": {\\n \\"MaterialId\\": \\"6cf724c6ebfd4a59b5b3cec6f10d****\\"\\n },\\n \\"LocationId\\": \\"RC01\\",\\n \\"TextLayerContent\\": {\\n \\"BorderColor\\": \\"0x000000\\",\\n \\"BorderWidthNormalized\\": 0,\\n \\"Color\\": \\"0xff0000\\",\\n \\"FontName\\": \\"KaiTi\\",\\n \\"SizeNormalized\\": 16,\\n \\"Text\\": \\"hello world\\"\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"3be7ade8-d907-483c-b24a-0dad45******\\",\\n \\"Total\\": 3\\n}","errorExample":""},{"type":"xml","example":"<DescribeCasterComponentsResponse>\\n <Components>\\n <CaptionLayerContent>\\n <BorderColor>0x000000</BorderColor>\\n <BorderWidthNormalized>0</BorderWidthNormalized>\\n <Color>0x000000</Color>\\n <FontName>KaiTi</FontName>\\n <LineSpaceNormalized>0</LineSpaceNormalized>\\n <LocationId>RV01</LocationId>\\n <PtsOffset>0</PtsOffset>\\n <ShowSourceLan>false</ShowSourceLan>\\n <SizeNormalized>0.1</SizeNormalized>\\n <SourceLan>cn</SourceLan>\\n <TargetLan>cn</TargetLan>\\n <WordCountPerLine>15</WordCountPerLine>\\n <WordSpaceNormalized>0</WordSpaceNormalized>\\n <WordsCount>35</WordsCount>\\n </CaptionLayerContent>\\n <ComponentId>72d2ec7a-4cd7-4a01-974b-7cd53947****</ComponentId>\\n <ComponentLayer>\\n <HeightNormalized>0.5</HeightNormalized>\\n <PositionNormalizeds>0.3</PositionNormalizeds>\\n <PositionRefer>topLeft</PositionRefer>\\n <Transparency>200</Transparency>\\n <WidthNormalized>0.5</WidthNormalized>\\n </ComponentLayer>\\n <ComponentName>component_name</ComponentName>\\n <ComponentType>text</ComponentType>\\n <Effect>animateV</Effect>\\n <ImageLayerContent>\\n <MaterialId>6cf724c6ebfd4a59b5b3cec6f10d****</MaterialId>\\n </ImageLayerContent>\\n <LocationId>RC01</LocationId>\\n <TextLayerContent>\\n <BorderColor>0x000000</BorderColor>\\n <BorderWidthNormalized>0</BorderWidthNormalized>\\n <Color>0xff0000</Color>\\n <FontName>KaiTi</FontName>\\n <SizeNormalized>16</SizeNormalized>\\n <Text>hello world</Text>\\n </TextLayerContent>\\n </Components>\\n <RequestId>3be7ade8-d907-483c-b24a-0dad4595beaf</RequestId>\\n <Total>3</Total>\\n</DescribeCasterComponentsResponse>","errorExample":""}]', + 'title' => '查询导播台组件列表', + 'description' => '先通过[AddCasterComponent接口](~~2848030~~)添加导播台组件，再调用本接口查询导播台组件列表。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CopyCasterSceneConfig' => [ + 'summary' => '将原场景配置应用至目标场景并生效，仅限PVW场景配置拷贝至PGM场景。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'FromSceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '原场景ID，仅限于PVM场景。', + 'type' => 'string', + 'required' => true, + 'example' => 'f1a361f4-bee3-436d-ae6e-d38e6943****', + ], + ], + [ + 'name' => 'ToSceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标场景ID，仅限于PGM场景。', + 'type' => 'string', + 'required' => true, + 'example' => '05ab713c-676e-49c0-96ce-cc408da1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CF60DB6A-7FD6-426E-9288-122CC1A5****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidSceneId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.Idle', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.ConfigError', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ResourceInChannel.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidScene.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 412 => [ + [ + 'errorCode' => 'ResourceInChannel.PreConditionFailed', + 'errorMessage' => '%s, please try again later.', + ], + [ + 'errorCode' => 'ResourceInChannel.Invalid', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A5****\\"\\n}","type":"json"}]', + 'title' => '复制导播台场景配置', + 'description' => '- 云导播服务根据导播输出规格、转码规格及对应时长计费。计费详情，请参见[云导播费用](~~64531~~)。'."\n" + ."\n" + .'- 调用本接口将原场景配置应用至目标场景并生效，仅限PVW场景配置拷贝至PGM场景。PVW场景是预览场景，PGM是正式输出的场景。'."\n" + .'- 将PVW场景配置复制到PGM场景仅限于同一导播台内。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteCasterSceneConfig' => [ + 'summary' => '删除导播台场景配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'b4810848-bcf9-4aef-bd4a-e6bba2d9****', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'b5f8c837-ceeb-424f-b30b-68e94e86****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '场景配置类型。取值：'."\n" + ."\n" + .'- **Component**：组件配置。'."\n" + .'- **Layout**：布局配置。'."\n" + .'- **All**：组件和布局配置。', + 'type' => 'string', + 'required' => true, + 'example' => 'Component', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB9*********', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectSceneStatus.Inuse', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidSceneId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.ConfigError', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.Idle', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidScene.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidVideo.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidLayout.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidComponent.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB9*********\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCasterSceneConfigResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteCasterSceneConfigResponse>","errorExample":""}]', + 'title' => '清除导播台的指定场景的配置信息', + 'description' => '调用本接口删除导播台场景配置。本接口目前支持的场景配置类型为组件配置、布局配置和组件和布局配置。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateCasterSceneConfig' => [ + 'summary' => '增量设置场景配置，不清空原配置，布局信息在原场景上增量修改，效率较全量设置高。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ComponentId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '组件ID列表，数组内按照由下至上的顺序排列组件。'."\n" + ."\n" + .'>N表示第几个的意思。例如：<br>ComponentId.1表示第1个组件ID，<br>ComponentId.2表示第2个组件ID。', + 'type' => 'array', + 'items' => [ + 'description' => '组件ID列表，数组内按照由下至上的顺序排列组件。'."\n" + ."\n" + .'>N表示第几个的意思。例如：<br>ComponentId.1表示第1个组件ID，<br>ComponentId.2表示第2个组件ID。', + 'type' => 'string', + 'required' => false, + 'example' => '["98778372-c30f-4442-85ba-2e3e4e3d****"]', + ], + 'required' => false, + 'example' => '["98778372-c30f-4442-85ba-2e3e4e3d****"]', + 'maxItems' => 10, + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '80787064-1c94-4dc1-85ce-9409960a****', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景ID。', + 'type' => 'string', + 'required' => true, + 'example' => '242b4e2c-c30f-4442-85ba-2e3e4e3d****', + ], + ], + [ + 'name' => 'LayoutId', + 'in' => 'query', + 'schema' => [ + 'description' => '布局ID。如果您通过[DescribeCasterLayouts接口](~~2848028~~)查询导播台布局列表，请查看DescribeCasterLayouts接口调用返回的参数LayoutId值。', + 'type' => 'string', + 'required' => true, + 'example' => 'eeab74fb-379d-4599-a93d-86d16a05****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CF60DB6A-7FD6-426E-9288-122CC1A52FA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.ConfigError', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ComponentNumberExceed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'SceneNumberExceed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.Waiting', + 'errorMessage' => '%s, please try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.Idle', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCaptionResource', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidScene.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidLayout.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidComponent.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidVideo.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ResourceInChannel.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 412 => [ + [ + 'errorCode' => 'ResourceInChannel.PreConditionFailed', + 'errorMessage' => '%s, please try again later.', + ], + [ + 'errorCode' => 'ResourceInChannel.Invalid', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<UpdateCasterSceneConfigResponse>\\n\\t<RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>\\n</UpdateCasterSceneConfigResponse>\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\"\\n}"}]', + 'title' => '更新导播场景配置', + 'description' => '调用本接口增量设置场景配置，不清空原配置，布局信息在原场景上增量修改，效率较全量设置高。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetCasterSceneConfig' => [ + 'summary' => '全量设置场景配置，清空场景配置，并将布局信息设置并生效至指定场景。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ComponentId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '组件ID列表，数组内按照由下至上的顺序排列组件。'."\n" + ."\n" + .'>N表示第几个的意思。例如：<br>ComponentId.1表示第一个组件ID，<br>ComponentId.2表示第二个组件ID。', + 'type' => 'array', + 'items' => [ + 'description' => '组件ID列表，数组内按照由下至上的顺序排列组件。'."\n" + ."\n" + .'>N表示第几个的意思。例如：<br>ComponentId.1表示第一个组件ID，<br>ComponentId.2表示第二个组件ID。', + 'type' => 'string', + 'required' => false, + 'example' => '[ "a2b8e671-2fe5-4642-a2ec-bf931826****", "a2b8e671-2fe5-4642-a2ec-28374657****"]', + ], + 'required' => false, + 'example' => '[ "a2b8e671-2fe5-4642-a2ec-bf931826****", "a2b8e671-2fe5-4642-a2ec-28374657****"]', + 'maxItems' => 10, + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '80787064-1c94-4dc1-85ce-9409960a****', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景ID。', + 'type' => 'string', + 'required' => true, + 'example' => '242b4e2c-c30f-4442-85ba-2e3e4e3d****', + ], + ], + [ + 'name' => 'LayoutId', + 'in' => 'query', + 'schema' => [ + 'description' => '布局ID。如果您通过[DescribeCasterLayouts接口](~~2848028~~)查询导播台布局列表，请查看DescribeCasterLayouts接口调用返回的参数LayoutId值。', + 'type' => 'string', + 'required' => false, + 'example' => '0c6da077-f037-49e8-8440-3be13393****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CF60DB6A-7FD6-426E-9288-122CC1A52FA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidSceneId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCaptionResource', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ComponentNumberExceed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.Idle', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.ConfigError', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidScene.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidLayout.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidComponent.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ResourceInChannel.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 412 => [ + [ + 'errorCode' => 'ResourceInChannel.PreConditionFailed', + 'errorMessage' => '%s, please try again later.', + ], + [ + 'errorCode' => 'ResourceInChannel.Invalid', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<SetCasterSceneConfigResponse>\\n\\t<RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>\\n</SetCasterSceneConfigResponse>\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\"\\n}"}]', + 'title' => '全量设置导播台场景配置', + 'description' => '调用本接口全量设置场景配置，清空场景配置，并将布局信息设置并生效至指定场景。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCasterScenes' => [ + 'summary' => '查询导播台场景列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '80787064-1c94-4dc1-85ce-9409960a****', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'b5f8c837-ceeb-424f-b30b-68e94e86****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CF60DB6A-7FD6-426E-9288-122CC1*****', + ], + 'SceneList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Scene' => [ + 'description' => '场景信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '场景信息列表。', + 'type' => 'object', + 'properties' => [ + 'ComponentIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'componentId' => [ + 'description' => '组件id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '组件ID列表。', + 'type' => 'string', + 'example' => '["1506396160-0-0-7de771a77102680861853af862d5****"]', + ], + ], + ], + ], + 'LayoutId' => [ + 'description' => '布局ID。', + 'type' => 'string', + 'example' => '37cb2f8b-f152-4338-b928-6704f71d****', + ], + 'OutputType' => [ + 'description' => '是否正式输出。 取值：'."\n" + .' '."\n" + .'- **0**：输出pvw预览场景。'."\n" + .'- **1**：输出pgm正式场景。', + 'type' => 'string', + 'example' => '0', + ], + 'SceneId' => [ + 'description' => '场景ID。可作为更新场景音频配置、查询导播台场景音频配置、启动导播台场景和停止导播台场景的请求参数。', + 'type' => 'string', + 'example' => 'b5f8c837-ceeb-424f-b30b-68e94e86****', + ], + 'SceneName' => [ + 'description' => '场景名称。', + 'type' => 'string', + 'example' => 'scene1', + ], + 'Status' => [ + 'description' => '场景状态。 取值：'."\n" + .' '."\n" + .'- **0**：关闭。'."\n" + .'- **1**：开启。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'StreamInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StreamInfo' => [ + 'description' => '播放地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '播放地址列表。', + 'type' => 'object', + 'properties' => [ + 'OutputStreamUrl' => [ + 'description' => '播放地址。', + 'type' => 'string', + 'example' => 'http://live/caster/example.net', + ], + 'TranscodeConfig' => [ + 'description' => '转码配置。取值：'."\n" + .' '."\n" + .'- **sd**：标清。'."\n" + .'- **lld**：流畅。'."\n" + .'- **lud**：超清。'."\n" + .'- **lhd**：高清。', + 'type' => 'string', + 'example' => 'lld', + ], + 'VideoFormat' => [ + 'description' => '格式。取值：'."\n" + .'- **flv**。'."\n" + .'- **mp4**。 '."\n" + .'- **m3u8**。', + 'type' => 'string', + 'example' => 'flv', + ], + ], + ], + ], + ], + ], + 'StreamUrl' => [ + 'description' => '输出流地址。', + 'type' => 'string', + 'example' => 'rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****', + ], + ], + ], + ], + ], + ], + 'Total' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidSceneId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1*****\\",\\n \\"SceneList\\": {\\n \\"Scene\\": [\\n {\\n \\"ComponentIds\\": {\\n \\"componentId\\": [\\n \\"[\\\\\\"1506396160-0-0-7de771a77102680861853af862d5****\\\\\\"]\\"\\n ]\\n },\\n \\"LayoutId\\": \\"37cb2f8b-f152-4338-b928-6704f71d****\\",\\n \\"OutputType\\": \\"0\\",\\n \\"SceneId\\": \\"b5f8c837-ceeb-424f-b30b-68e94e86****\\",\\n \\"SceneName\\": \\"scene1\\",\\n \\"Status\\": 0,\\n \\"StreamInfos\\": {\\n \\"StreamInfo\\": [\\n {\\n \\"OutputStreamUrl\\": \\"http://live/caster/example.net\\",\\n \\"TranscodeConfig\\": \\"lld\\",\\n \\"VideoFormat\\": \\"flv\\"\\n }\\n ]\\n },\\n \\"StreamUrl\\": \\"rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****\\"\\n }\\n ]\\n },\\n \\"Total\\": 2\\n}","errorExample":""},{"type":"xml","example":"<DescribeCasterScenesResponse>\\n <RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>\\n <SceneList>\\n <ComponentIds>[\\"1506396160-0-0-7de771a77102680861853af862d5****\\"]</ComponentIds>\\n <LayoutId>37cb2f8b-f152-4338-b928-6704f71d****</LayoutId>\\n <OutputType>0</OutputType>\\n <SceneId>b5f8c837-ceeb-424f-b30b-68e94e86****</SceneId>\\n <SceneName>scene1</SceneName>\\n <Status>0</Status>\\n <StreamInfos>\\n <OutputStreamUrl>http://live/caster/example.net</OutputStreamUrl>\\n <TranscodeConfig>lld</TranscodeConfig>\\n <VideoFormat>flv</VideoFormat>\\n </StreamInfos>\\n <StreamUrl>rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****</StreamUrl>\\n </SceneList>\\n <Total>2</Total>\\n</DescribeCasterScenesResponse>","errorExample":""}]', + 'title' => '查询场景信息列表', + 'description' => '先通过[CreateCaster接口](~~2848009~~)创建导播台，再调用本接口查询导播台场景列表。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateCasterSceneAudio' => [ + 'summary' => '增加场景音频配置，将原场景音频添加到新场景。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'AudioLayer', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '音频配置。', + 'type' => 'array', + 'items' => [ + 'description' => '音频配置。', + 'type' => 'object', + 'properties' => [ + 'Filter' => [ + 'description' => '3A美音算法开关。该参数由以下字段组成：'."\n" + ."\n" + .'- **enableAgc**：（可选）3A算法的智能增益算法开关。**0**：不开启（默认值）； **1**：开启。'."\n" + ."\n" + .'- **enableAns**：（可选）3A算法的智能降噪算法开关。**0**：不开启（默认值）；**1**：开启。'."\n" + ."\n" + .'- **ansMode**：（可选）智能降噪算法的模式，该字段只有在**enableAns**取值为**1**时有效。**0**：语音降噪（默认值）；**1**：音乐降噪。'."\n" + .'> 为保证更好的降噪效果，建议将ansMode取值为1：音乐降噪。'."\n" + ."\n" + .'- **enableBeautify**：（可选）美声处理开关。 **0**：不开启（默认值）；**1**：开启。'."\n" + ."\n" + .'- **voiceBeautifyMode**：（可选）美声模式，该字段只有在**enableBeautify**取值为**1**时有效。**0**：磁性男声（默认值）；**1**：清新女声。', + 'type' => 'string', + 'required' => false, + 'example' => '{ "enableAgc":0, "enableAns":1 }', + ], + 'FixedDelayDuration' => [ + 'description' => '该字段对视频进行固定延迟设置，可用于字幕同步。 '."\n" + .' '."\n" + .'单位：毫秒。取值范围为**0~5000**。默认值为**0**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'ValidChannel' => [ + 'description' => '确定哪些声道可以作为音量输入。取值：'."\n" + ."\n" + .'- **leftChannel**：左声道。'."\n" + .'- **rightChannel**：右声道。'."\n" + .'- **all**（默认值）：双声道。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + 'VolumeRate' => [ + 'description' => '调节音频流的音量大小倍数。取值范围为**0~10.0**，默认值为**1.0** 。'."\n" + .' '."\n" + .'- **1.0**：保持原有音量。'."\n" + .'- 小于**1**：降低音量的倍数。'."\n" + .'- 大于**1**：放大音量的倍数。'."\n" + .' '."\n" + ."\n\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 12, + ], + ], + [ + 'name' => 'MixList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '位置关联列表，与audiolayers顺序保持一致。', + 'type' => 'array', + 'items' => [ + 'description' => '资源位置LocationId关联列表。'."\n" + ."\n" + .'与AudioLayers顺序保持一致，若启用Channel时，引用Channel的LocationId，否则引用视频源的LocationId。', + 'type' => 'string', + 'required' => false, + 'example' => 'RV01', + ], + 'required' => false, + 'example' => 'RV01', + 'maxItems' => 12, + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster](~~2848009~~)接口创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景ID。如果您通过[DescribeCasterScenes](~~2848039~~)接口查询导播台场景列表，请查看DescribeCasterScenes接口调用返回的参数ComponentId值。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e1****', + ], + ], + [ + 'name' => 'FollowEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用音频跟随。 默认启用音频跟随，为空则保持最近一次配置不变。取值： '."\n" + ."\n" + .'- **0**：混音模式。'."\n" + .'- **1**：音频跟随视频模式。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidAudioLayersAndMixListSize.Mismatch', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.ConfigError', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidMixList.ExceedNorm', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidScene.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ResourceInChannel.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 412 => [ + [ + 'errorCode' => 'ResourceInChannel.PreConditionFailed', + 'errorMessage' => '%s, please try again later.', + ], + [ + 'errorCode' => 'ResourceInChannel.Invalid', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<UpdateCasterSceneAudioResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</UpdateCasterSceneAudioResponse>\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n}"}]', + 'title' => '更新场景音频配置', + 'description' => '先通过[CreateCaster](~~2848009~~)接口创建导播台，再调用本接口更新场景音频配置。本接口目前支持的音频模式为混音模式和音频跟随视频模式。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '请求参数中的N表示第几个的意思。例如：'."\n" + .'- AudioLayer.N.VolumeRate表示传入第几个元素的音量倍数。'."\n" + .'- AudioLayer.1.VolumeRate表示传入第1个元素的音量倍数。'."\n" + .'- AudioLayer.2.VolumeRate表示传入第2个元素的音量倍数。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCasterSceneAudio' => [ + 'summary' => '查询场景音频配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '97df6b7f-3490-47d2-ac50-88338765****', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景ID。', + 'type' => 'string', + 'required' => true, + 'example' => '97df6b7f-3490-47d2-ac50-88339087****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AudioLayers' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AudioLayer' => [ + 'description' => 'Audiolayer配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Audiolayer配置列表。', + 'type' => 'object', + 'properties' => [ + 'FixedDelayDuration' => [ + 'description' => '固定延时时间，单位毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'ValidChannel' => [ + 'description' => '声道类型。取值：'."\n" + .' '."\n" + .'- **left**：左声道。'."\n" + .'- **right**：右声道。'."\n" + .'- **all**（默认值）：双声道。', + 'type' => 'string', + 'example' => 'all', + ], + 'VolumeRate' => [ + 'description' => '音频音量。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'CasterId' => [ + 'description' => '导播台ID。可作为启动导播台场景的请求参数。', + 'type' => 'string', + 'example' => '97df6b7f-3490-47d2-ac50-88338765****', + ], + 'FollowEnable' => [ + 'description' => '是否启用音频跟随。 默认启用音频跟随。 '."\n" + .' '."\n" + .'- **0**：混音模式。'."\n" + .'- **1**：音频跟随视频模式。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MixList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LocationId' => [ + 'description' => '位置关联列表。 与AudioLayers顺序保持一致。', + 'type' => 'array', + 'items' => [ + 'description' => '位置ID。', + 'type' => 'string', + 'example' => 'RV01', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98745637-3490-47d2-ac50-883387567098', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidScene.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AudioLayers\\": {\\n \\"AudioLayer\\": [\\n {\\n \\"FixedDelayDuration\\": 2000,\\n \\"ValidChannel\\": \\"all\\",\\n \\"VolumeRate\\": 1\\n }\\n ]\\n },\\n \\"CasterId\\": \\"97df6b7f-3490-47d2-ac50-88338765****\\",\\n \\"FollowEnable\\": 1,\\n \\"MixList\\": {\\n \\"LocationId\\": [\\n \\"RV01\\"\\n ]\\n },\\n \\"RequestId\\": \\"98745637-3490-47d2-ac50-883387567098\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeCasterSceneAudioResponse>\\n\\t<RequestId>97df6b7f-3490-47d2-ac50-8833e1b64597</RequestId>\\n\\t<MixList>RV01</MixList>\\n <FollowEnable>1</FollowEnable>\\n <CasterId>97df6b7f-3490-47d2-ac50-88338765****</CasterId>\\n\\t<AudioLayers>\\n\\t\\t<ValidChannel>all</ValidChannel>\\n <VolumeRate>1</VolumeRate>\\n <FixedDelayDuration>2000</FixedDelayDuration>\\n\\t</AudioLayers>\\n</DescribeCasterSceneAudioResponse>\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"97df6b7f-3490-47d2-ac50-8833e1b64597\\",\\n \\"Content\\": {\\n \\"MixList\\": [\\n \\"1\\"\\n ],\\n \\"AudioLayers\\": [\\n {\\n \\"ValidChannel\\": \\"all\\",\\n \\"VolumeRate\\": 1\\n }\\n ],\\n \\"FollowEnable\\": 1\\n }\\n}"}]', + 'title' => '查询场景音频配置信息', + 'description' => '先通过[CreateCaster接口](~~2848009~~)创建导播台，再调用本接口查询场景音频配置。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StartCasterScene' => [ + 'summary' => '启动指定场景，限制仅用于PVW的打开。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '80787064-1c94-4dc1-85ce-9409960a****', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景ID。'."\n" + ."\n" + .'只有是PVW场景时才可用。', + 'type' => 'string', + 'required' => true, + 'example' => '242b4e2c-c30f-4442-85ba-2e3e4e3d****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CF60DB6A-7FD6-426E-9288-122CC1A52FA7', + ], + 'StreamUrl' => [ + 'description' => '当前场景的输出流地址。用于导播台播放，非旁路输出', + 'type' => 'string', + 'example' => 'http://live/caster/example.org', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectSceneStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.Inuse', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidSceneId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectCasterStatus.Idle', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserQuotaExceed', + 'errorMessage' => 'Quota exceeded: %s.', + ], + ], + [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidScene.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidLayout.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidConfiguration.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterTemplate.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\",\\n \\"StreamUrl\\": \\"http://live/caster/example.org\\"\\n}","errorExample":""},{"type":"xml","example":"<StartCasterSceneResponse>\\n <RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>\\n <StreamUrl>http://live/caster/example.org</StreamUrl>\\n</StartCasterSceneResponse>","errorExample":""}]', + 'title' => '启动导播台场景', + 'description' => '调用本接口启动指定场景，限制仅用于PVW场景（预览场景）的启动。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopCasterScene' => [ + 'summary' => '停止指定场景，限制仅用于停止PVW场景（预览场景）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '80787064-1c94-4dc1-85ce-9409960a****', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景ID。'."\n" + ."\n" + .'当场景是PVW场景时，本API接口才可用。场景类型请参见[查询导播台场景](~~2848102~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '242b4e2c-c30f-4442-85ba-2e3e4e3d****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CF60DB6A-7FD6-426E-9288-122CC1A52FA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidSceneId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.Idle', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidScene.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<StopCasterSceneResponse>\\n\\t<RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>\\n</StopCasterSceneResponse>\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\"\\n}"}]', + 'title' => '停止导播台场景', + 'description' => '调用本接口停止指定场景，限制仅用于停止PVW场景（预览场景）。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetCasterChannel' => [ + 'summary' => '设置导播台通道。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '通道ID。'."\n" + ."\n" + .'布局画面的引用编号，每个通道位置至多设置一个资源，数量受限于导播台创建时的通道路数。格式符合“RV01~RV12”。', + 'type' => 'string', + 'required' => true, + 'example' => 'RV01', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频源ID。', + 'type' => 'string', + 'required' => false, + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + [ + 'name' => 'SeekOffset', + 'in' => 'query', + 'schema' => [ + 'description' => '仅对文件视频有效，直播源无效，必须大于或等于0，表示从相对于首帧的偏差时间作为开始读取的位置。 单位：毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'PlayStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '播放状态。仅对文件视频有效，直播源无效。 取值： '."\n" + .' '."\n" + .'- **1**（默认值）：播放。'."\n" + .'- **0**：暂停。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FaceBeauty', + 'in' => 'query', + 'schema' => [ + 'description' => '人脸美颜。具体包括：0（whole）、1（磨皮）、2（美白）、3（去除黑眼圈）、4（法令纹）。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'DuplicateLocationID', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.PlayStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidChannelId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.SeekOffset', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectChannel.Disable', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'ResourceOfChannelExist', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<SetCasterChannelResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</SetCasterChannelResponse>","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n}"}]', + 'title' => '设置导播台通道', + 'description' => '先通过[CreateCaster接口](~~2848009~~)创建导播台，再调用本接口设置导播台通道。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCasterChannels' => [ + 'summary' => '查询导播台通道。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Channel' => [ + 'description' => '通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '通道列表。', + 'type' => 'object', + 'properties' => [ + 'ChannelId' => [ + 'description' => '通道位置ID。'."\n" + ."\n" + .'布局应用通道ID，每个位置至多设置一个视频源，格式需符合“RV01~RV12”。', + 'type' => 'string', + 'example' => 'RV01', + ], + 'FaceBeauty' => [ + 'description' => '人脸美颜。具体包括：0（whole）、1（磨皮）、2（美白）、3（去除黑眼圈）、4（法令纹）。', + 'type' => 'string', + 'example' => '0', + ], + 'ResourceId' => [ + 'description' => '视频源Id。', + 'type' => 'string', + 'example' => '87642866-281E-4AEA-9582-B124879****', + ], + 'RtmpUrl' => [ + 'description' => 'rtmp地址。', + 'type' => 'string', + 'example' => 'rtmp://demo.aliyundoc.com/caster/rtmperf?auth_key=****', + ], + 'StreamUrl' => [ + 'description' => '通道输出地址。', + 'type' => 'string', + 'example' => 'http://demo.aliyundoc.com/caster/streamwsx.flv?auth_key=YYYYY', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '83C52866-281E-4AEA-9582-B124********', + ], + 'Total' => [ + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Channels\\": {\\n \\"Channel\\": [\\n {\\n \\"ChannelId\\": \\"RV01\\",\\n \\"FaceBeauty\\": \\"0\\",\\n \\"ResourceId\\": \\"87642866-281E-4AEA-9582-B124879****\\",\\n \\"RtmpUrl\\": \\"rtmp://demo.aliyundoc.com/caster/rtmperf?auth_key=****\\",\\n \\"StreamUrl\\": \\"http://demo.aliyundoc.com/caster/streamwsx.flv?auth_key=YYYYY\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"83C52866-281E-4AEA-9582-B124********\\",\\n \\"Total\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DescribeCasterChannelsResponse>\\n <Channels>\\n <ChannelId>RV01</ChannelId>\\n <FaceBeauty>0</FaceBeauty>\\n <ResourceId>87642866-281E-4AEA-9582-B124879****</ResourceId>\\n <RtmpUrl>rtmp://demo.aliyundoc.com/caster/rtmperf?auth_key=****</RtmpUrl>\\n <StreamUrl>http://demo.aliyundoc.com/caster/streamwsx.flv?auth_key=YYYYY</StreamUrl>\\n </Channels>\\n <RequestId>83C52866-281E-4AEA-9582-B1245406349D</RequestId>\\n <Total>1</Total>\\n</DescribeCasterChannelsResponse>","errorExample":""}]', + 'title' => '查询导播台通道信息列表', + 'description' => '先通过[CreateCaster接口](~~2848009~~)创建导播台，再调用本接口查询导播台通道。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EffectCasterUrgent' => [ + 'summary' => '切换导播台备播。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '80787064-1c94-4dc1-85ce-9409960a****', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景ID，PGM场景时有效。'."\n" + ."\n" + .'您可以通过[DescribeCasterScenes](~~2848039~~)接口查询导播台场景ID。', + 'type' => 'string', + 'required' => true, + 'example' => '242b4e2c-c30f-4442-85ba-2e3e4e3d****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CF60DB6A-7FD6-426E-9288-122CC1A52FA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidSceneId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.Idle', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectChannel.Disable', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUrgentMaterial.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidScene.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\"\\n}","errorExample":""},{"type":"xml","example":"<EffectCasterUrgentResponse>\\n <RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>\\n</EffectCasterUrgentResponse>","errorExample":""}]', + 'title' => '切换导播台备播', + 'description' => '调用本接口将指定场景画面紧急切换至备播视频，限制仅用于PGM场景的备播切换。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EffectCasterVideoResource' => [ + 'summary' => '更新导播台备播片。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '80787064-1c94-4dc1-85ce-9409960a****', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景ID。', + 'type' => 'string', + 'required' => true, + 'example' => '05ab713c-676e-49c0-96ce-cc408da1****', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID。如果您通过[DescribeCasterChannels接口](~~2848046~~)查询导播台通道，请查看DescribeCasterChannels接口调用返回的参数ResourceId值。', + 'type' => 'string', + 'required' => true, + 'example' => 'f096e8d6-0319-4c96-82bc-ecbc79cf****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CF60DB6A-7FD6-426E-9288-122CC1A52FA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectSceneStatus.Idle', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.ConfigError', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidResourceId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidSceneId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidScene.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidLayout.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\"\\n}","errorExample":""},{"type":"xml","example":"<EffectCasterVideoResourceResponse>\\n <RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>\\n</EffectCasterVideoResourceResponse>","errorExample":""}]', + 'title' => '更新导播台备播片', + 'description' => '调用本接口将视频资源生效至指定场景，场景引用该视频资源时有效。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddShowIntoShowList' => [ + 'summary' => '添加节目到节目单中。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'showList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要添加的多个节目资源列表，每个资源都有独立的showName，resourceUrl等参数。', + 'type' => 'array', + 'items' => [ + 'description' => '导播台列表信息。', + 'type' => 'object', + 'properties' => [ + 'duration' => [ + 'description' => '单个节目播放时间长度，单位：秒。'."\n" + ."\n" + .'>**RepeatTimes**和**Duration**两者只允许设置其中一个。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + 'liveInputType' => [ + 'description' => '自定义的类型标记。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'repeatTimes' => [ + 'description' => '单个节目播放循环次数，默认为0。'."\n" + ."\n" + .'>- **RepeatTimes**和**Duration**两者只允许设置其中一个。'."\n" + .'- RepeatTimes为重复次数，示例：0表示重复0次（实际播放1次），1表示重复1次（实际播放2次），以此类推。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'resourceId' => [ + 'description' => '点播文件ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'resourceType' => [ + 'description' => '素材类型。取值：'."\n" + ."\n" + .'- live：直播素材。'."\n" + ."\n" + .'- vod：点播素材。'."\n" + ."\n" + .'- pic：图片素材。'."\n" + ."\n" + .'>- 使用视频点播（VOD）资源，可优先选择托管Bucket资源，自有Bucket资源存在过期风险，如果您选用自有Bucket资源，需注意资源的有效期时间。'."\n" + .'- 直播文件可支持直播素材和第三方URL。'."\n" + .'- 点播文件可支持点播素材、图片素材和第三方URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'vod', + ], + 'resourceUrl' => [ + 'description' => '播放文件URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://****/atestObject****.m3u8', + ], + 'showName' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveShow****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**路径查看导播台名称。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'ShowName', + 'in' => 'query', + 'schema' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveShow****', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '素材类型。取值：'."\n" + .'- live：直播素材。'."\n" + .'- vod：点播素材。'."\n" + .'- pic：图片素材。'."\n" + ."\n" + .'>- 使用视频点播（VOD）资源，可优先选择托管Bucket资源，自有Bucket资源存在过期风险，如果您选用自有Bucket资源，需注意资源的有效期时间。- 直播文件可支持直播素材和第三方URL。- 点播文件可支持点播素材、图片素材和第三方URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'vod', + ], + ], + [ + 'name' => 'ResourceUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '播放文件URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://****/atestObject****.m3u8', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '点播文件ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '单个节目播放时间长度，单位：秒。'."\n" + .'>**RepeatTimes**和**Duration**两者只允许设置其中一个。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'RepeatTimes', + 'in' => 'query', + 'schema' => [ + 'description' => '单个节目播放循环次数，默认为0。'."\n" + .'> - **RepeatTimes**和**Duration**两者只允许设置其中一个。- RepeatTimes为重复次数，示例：-1表示可无限重复；0表示重复0次（实际播放1次）；1表示重复1次（实际播放2次）；以此类推。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Spot', + 'in' => 'query', + 'schema' => [ + 'description' => '插入到播放列表的位置。位置从0 开始，默认添加到当前节目单的末尾。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'LiveInputType', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义的类型标记。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'isBatchMode', + 'in' => 'query', + 'schema' => [ + 'description' => '是否批量添加节目到节目单。取值：'."\n" + ."\n" + .'- true：批量添加。'."\n" + ."\n" + .'- false：单个添加。'."\n" + ."\n" + .'>该参数不填，取值为空时，也表示单个添加。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '987DA143-A39C-5B5D-AF5B-3B07944A0036', + ], + 'ShowId' => [ + 'description' => '节目ID。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'failedList' => [ + 'description' => '添加失败的资源列表以及失败原因信息。', + 'type' => 'string', + 'example' => 'failedList[Show1, Show2...]', + ], + 'successfulShowIds' => [ + 'description' => '添加成功添加的节目ID列表。', + 'type' => 'string', + 'example' => 'f1933f16-5467-4308-b3a9-e8d451a90999，547436b8-c839-4469-a2c0-704c1ce5ce00', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidVodUrl.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidShowList.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"987DA143-A39C-5B5D-AF5B-3B07944A0036\\",\\n \\"ShowId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\",\\n \\"failedList\\": \\"failedList[Show1, Show2...]\\",\\n \\"successfulShowIds\\": \\"f1933f16-5467-4308-b3a9-e8d451a90999，547436b8-c839-4469-a2c0-704c1ce5ce00\\"\\n}","errorExample":""},{"type":"xml","example":"<AddShowIntoShowListResponse>\\n <RequestId>987DA143-A39C-5B5D-AF5B-3B07944A0036</RequestId>\\n <failedList>\\n <show>\\n <resourceUrl>test</resourceUrl>\\n <resourceType>vod</resourceType>\\n </show>\\n <failInfo>ResourceUrl is invalid, probe failed</failInfo>\\n </failedList>\\n <failedList>\\n <show>\\n <resourceUrl>http://error.test.case</resourceUrl>\\n <resourceType>vod</resourceType>\\n </show>\\n <failInfo>ResourceUrl is invalid, probe failed</failInfo>\\n </failedList>\\n <successfulShowIds>f1933f16-5467-4308-b3a9-e8d451a90999, 547436b8-c839-4469-a2c0-704c1ce5ce00</successfulShowIds>\\n</AddShowIntoShowListResponse>","errorExample":""}]', + 'title' => '添加一个节目到节目单', + 'description' => '请先创建新播单型导播台，添加新播单型导播台视频资源后再调用本接口添加导播台节目到节目单中。使用API创建导播台，请参见[创建导播台](~~2848009~~)。'."\n" + ."\n" + .'每个节目单最多可添加1000个节目。'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'- 使用视频点播（VOD）资源，可优先选择托管Bucket资源，自有Bucket资源存在过期风险，如果您选用自有Bucket资源，需注意资源的有效期时间。'."\n" + ."\n" + .'- 导播台素材资源输入请优先选择视频直播和视频点播的资源，若从第三方URL输入资源存在播放失败可能性，需确定资源的质量和有效性。'."\n" + ."\n\n" + .'></notice>'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 代码示例'."\n" + ."\n" + .'```'."\n" + .'public static DefaultAcsClient initClient(String accessKeyId, String accessKeySecret) throws ClientException {'."\n" + .' String regionId = "cn-shanghai"; '."\n" + .' DefaultProfile profile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);'."\n" + .' DefaultAcsClient client = new DefaultAcsClient(profile);'."\n" + .' return client;'."\n" + .' }'."\n" + ."\n" + .'private static CommonResponse addShowIntoShowList(DefaultAcsClient client, String showName, String resourceId, String resourceUrl,'."\n" + .' String resourceType, Integer spot, Integer repeatTimes,'."\n" + .' String casterId, Long duration) throws ClientException {'."\n" + .' CommonRequest addShowIntoShowListRequest = new CommonRequest();'."\n" + .' addShowIntoShowListRequest.setSysDomain("live.aliyuncs.com");'."\n" + .' addShowIntoShowListRequest.setSysVersion("2016-11-01");'."\n" + .' addShowIntoShowListRequest.setSysAction("AddShowIntoShowList");'."\n" + ."\n\n" + .' '."\n" + .' if (casterId == null || resourceType == null) {'."\n" + .' return null;'."\n" + .' }'."\n" + .' if (resourceId == null && resourceUrl == null) {'."\n" + .' return null;'."\n" + .' }'."\n" + .' addShowIntoShowListRequest.putQueryParameter("CasterId", casterId);'."\n" + .' addShowIntoShowListRequest.putQueryParameter("ResourceType", resourceType);'."\n" + .' if (showName != null) {'."\n" + .' addShowIntoShowListRequest.putQueryParameter("ShowName", showName);'."\n" + .' }'."\n" + .' if (resourceUrl != null) {'."\n" + .' addShowIntoShowListRequest.putQueryParameter("ResourceUrl", resourceUrl);'."\n" + .' }'."\n" + .' if (resourceId != null) {'."\n" + .' addShowIntoShowListRequest.putQueryParameter("ResourceId", resourceId);'."\n" + .' }'."\n" + .' if (spot != null) {'."\n" + .' addShowIntoShowListRequest.putQueryParameter("Spot", spot.toString());'."\n" + .' }'."\n" + .' if (repeatTimes != null) {'."\n" + .' addShowIntoShowListRequest.putQueryParameter("RepeatTimes", repeatTimes.toString());'."\n" + .' }'."\n" + .' if (duration != null) {'."\n" + .' addShowIntoShowListRequest.putQueryParameter("Duration", duration.toString());'."\n" + .' }'."\n" + .' CommonResponse addShowIntoShowListResponse = client.getCommonResponse(addShowIntoShowListRequest);'."\n" + .' return addShowIntoShowListResponse;'."\n" + .' }'."\n" + ."\n\n" + .' public void addshows() throws ClientException {'."\n" + .' DefaultAcsClient client = initClient(ACCESS_KEY_ID, ACCESS_KEY_SECRET);'."\n" + .' String[] resourceIds = new String[]{"698d2b23581f476ea71107703e647d1e", "9c97e83e211a435b9f797e4e20eeea27", "76c6addaa41c438985666a8a964fa5e5"};'."\n" + .' for (int i = 0; i < resourceIds.length; i++) {'."\n" + .' String showName = "ShowName#" + i;'."\n" + .' Integer repeatTimes = i;'."\n" + .' addShowIntoShowList(client, showName, resourceIds[i], null, "vod", null, repeatTimes, testCasterId, null);'."\n" + .' }'."\n" + .' }'."\n" + .'```', + ], + 'RemoveShowFromShowList' => [ + 'summary' => '删除节目单中的节目。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'showIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要删除的节目ID组。', + 'type' => 'array', + 'items' => [ + 'description' => '需要删除的节目ID列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'required' => false, + 'maxItems' => 80, + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**路径查看导播台名称。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'ShowId', + 'in' => 'query', + 'schema' => [ + 'description' => '节目ID。'."\n" + .'>通过查看[AddShowIntoShowList](~~2848051~~)接口的返回参数获取ShowId值。', + 'type' => 'string', + 'required' => false, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + [ + 'name' => 'isBatchMode', + 'in' => 'query', + 'schema' => [ + 'description' => '是否批量删除节目。取值：'."\n" + ."\n" + .'- true：批量删除。'."\n" + ."\n" + .'- false：单个删除。'."\n" + ."\n" + .'>该参数不填，取值为空时，也表示单个删除。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'ShowId' => [ + 'description' => '节目ID。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'failedList' => [ + 'description' => '删除失败的节目ID列表以及失败信息。', + 'type' => 'string', + 'example' => 'failedList[Show1, Show2...]', + ], + 'successfulShowIds' => [ + 'description' => '成功删除的节目ID。', + 'type' => 'string', + 'example' => 'f1933f16-5467-4308-b3a9-e8d451a90999', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidShowList.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidShow.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"ShowId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\",\\n \\"failedList\\": \\"failedList[Show1, Show2...]\\",\\n \\"successfulShowIds\\": \\"f1933f16-5467-4308-b3a9-e8d451a90999\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveShowFromShowListResponse>\\n <RequestId>001A01C4-3023-57C1-9A82-1BF3DC690C0A</RequestId>\\n <failedList>\\n <showId>347436b8-c839-4469-a2c0-704c1ce5ce00</showId>\\n <failInfo>the showId does not exist in our showOrderList</failInfo>\\n </failedList>\\n <successfulShowIds>f1933f16-5467-4308-b3a9-e8d451a90999</successfulShowIds>\\n <successfulShowIds>547436b8-c839-4469-a2c0-704c1ce5ce00</successfulShowIds>\\n</RemoveShowFromShowListResponse>","errorExample":""}]', + 'title' => '删除节目单中的节目', + 'description' => '先通过[AddShowIntoShowList](~~2848051~~)接口添加节目，再调用本接口删除节目单中的节目。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 代码示例'."\n" + .'```'."\n" + .' public static DefaultAcsClient initClient(String accessKeyId, String accessKeySecret) throws ClientException {'."\n" + .' String regionId = "cn-shanghai"; '."\n" + .' DefaultProfile profile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);'."\n" + .' DefaultAcsClient client = new DefaultAcsClient(profile);'."\n" + .' return client;'."\n" + .' }'."\n" + ."\n" + .'private static void removeShowFromShowList(DefaultAcsClient client, String casterId, String showId) throws ClientException {'."\n" + ."\n" + .' CommonRequest removeShowFromShowListFromShowList = new CommonRequest();'."\n" + .' removeShowFromShowListFromShowList.setSysDomain("live.aliyuncs.com");'."\n" + .' removeShowFromShowListFromShowList.setSysVersion("2016-11-01");'."\n" + .' removeShowFromShowListFromShowList.setSysAction("RemoveShowFromShowList");'."\n" + ."\n" + .' removeShowFromShowListFromShowList.putQueryParameter("ShowId", showId);'."\n" + .' removeShowFromShowListFromShowList.putQueryParameter("CasterId", casterId);'."\n" + ."\n" + .' CommonResponse removeShowFromShowListFromShowListResponse = client.getCommonResponse(removeShowFromShowListFromShowList);'."\n" + .' System.out.println("删除导播台节目，removeShowFromShowListFromShowListResponse:" + JSON.toJSONString(removeShowFromShowListFromShowListResponse));'."\n" + .' }'."\n" + ."\n\n" + .' public void removeShow() throws ClientException {'."\n" + .' String showId = "xxx";'."\n" + .' DefaultAcsClient client = initClient(ACCESS_KEY_ID, ACCESS_KEY_SECRET);'."\n" + .' removeShowFromShowList(client, testCasterId, showId);'."\n" + .' }'."\n" + .'```', + ], + 'ModifyShowList' => [ + 'summary' => '修改播单属性。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**路径查看导播台名称。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'ShowId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要被修改顺序的节目ID。'."\n" + .'>通过查看[AddShowIntoShowList](~~2848051~~)或[DescribeShowList](~~2848054~~)接口的返回参数获取ShowId值。', + 'type' => 'string', + 'required' => false, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + [ + 'name' => 'RepeatTimes', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单整体播放的循环次数。'."\n" + ."\n" + .'> - RepeatTimes为重复次数，示例：**0**表示重复**0**次（实际播放**1**次），**1**表示重复**1**次（实际播放**2**次），以此类推。'."\n" + .'> - 另外，取值为**-1**时，表示可无限重复。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'Spot', + 'in' => 'query', + 'schema' => [ + 'description' => '播放列表的位置。将需要被修改顺序的节目ID放到**Spot**的位置。'."\n" + .'>取值需大于等于0且小于等于当前节目单总数值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'HighPriorityShowId', + 'in' => 'query', + 'schema' => [ + 'description' => '最高优先级节目。'."\n" + ."\n" + .'> 此配置只能在节目单未开始启动前设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + [ + 'name' => 'HighPriorityShowStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '最高优先级节目播放时间，格式为：yyyy-MM-dd\'T\'HH:mm:ss。'."\n" + .'> 此配置只能在节目单未开始启动前设置。<br>配置完成，节目单会在最高优先级播放时间进行切播，开始播放最高优先级节目（从当前正在播放的节目切播到最高级优先节目）。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-11-23T12:30:00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidVodUrl.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'IncorrectCasterStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidShowList.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyShowListResponse> \\r\\n<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\r\\n</ModifyShowListResponse> ","errorExample":""}]', + 'title' => '修改播单属性', + 'description' => '此接口支持修改单个节目在播单中的位置、播单的整体播放次数以及最高优先级节目的播放固定时间点。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 代码示例'."\n" + ."\n" + .'```'."\n" + .' public static DefaultAcsClient initClient(String accessKeyId, String accessKeySecret) throws ClientException {'."\n" + .' String regionId = "cn-shanghai"; '."\n" + .' DefaultProfile profile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);'."\n" + .' DefaultAcsClient client = new DefaultAcsClient(profile);'."\n" + .' return client;'."\n" + .' }'."\n" + ."\n\n" + .'private static CommonResponse ModfiyShowList(DefaultAcsClient client, String casterId, String showId, Integer repeatTimes, Integer spot,'."\n" + .' String highPriorityShowId, String highPriorityShowStartTime) throws ClientException {'."\n" + ."\n" + .' CommonRequest modfiyShowListRequest = new CommonRequest();'."\n" + .' modfiyShowListRequest.setSysDomain("live.aliyuncs.com");'."\n" + .' modfiyShowListRequest.setSysVersion("2016-11-01");'."\n" + .' modfiyShowListRequest.setSysAction("ModifyShowList");'."\n" + .' if (casterId != null) {'."\n" + .' modfiyShowListRequest.putQueryParameter("CasterId", casterId);'."\n" + .' }'."\n" + .' if (showId != null) {'."\n" + .' modfiyShowListRequest.putQueryParameter("ShowId", showId);'."\n" + .' }'."\n" + .' if (repeatTimes != null) {'."\n" + .' modfiyShowListRequest.putQueryParameter("RepeatTimes", repeatTimes.toString());'."\n" + .' }'."\n" + .' if (spot != null) {'."\n" + .' modfiyShowListRequest.putQueryParameter("Spot", spot.toString());'."\n" + .' }'."\n" + .' if (highPriorityShowId != null) {'."\n" + .' modfiyShowListRequest.putQueryParameter("HighPriorityShowId", highPriorityShowId.toString());'."\n" + .' }'."\n" + .' if (highPriorityShowStartTime != null) {'."\n" + .' modfiyShowListRequest.putQueryParameter("HighPriorityShowStartTime", highPriorityShowStartTime.toString());'."\n" + .' }'."\n" + .' CommonResponse modfiyShowListResponse = client.getCommonResponse(modfiyShowListRequest);'."\n" + .' System.out.println("修改showList成功，返回值：" + JSON.toJSONString(modfiyShowListResponse));'."\n" + .' return modfiyShowListResponse;'."\n" + ."\n" + .' }'."\n" + ."\n" + .'public void modifyShowList() throws ClientException {'."\n" + .' DefaultAcsClient client = initClient(ACCESS_KEY_ID, ACCESS_KEY_SECRET);'."\n" + .' String showId= "";'."\n" + .' Integer repeatTimes=10;'."\n" + .' String highPriorityShowId="";'."\n" + .' String highPriorityShowStartTime = "2021-11-23T12:30:00";'."\n" + .' modfiyShowList(client,testCasterId, showId,repeatTimes,0,highPriorityShowId, highPriorityShowStartTime);'."\n" + .' }'."\n" + .'```', + ], + 'DescribeShowList' => [ + 'summary' => '查询节目单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '115259', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**路径查看导播台名称。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '查询节目单。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'ShowList' => [ + 'description' => '**ShowList**为播放列表的详细信息。'."\n" + .'Show为节目单中的节目详细信息，具体内容，请参见下表**Show**。', + 'type' => 'string', + 'example' => 'ShowList[Show1, Show2, Show3...]', + ], + 'ShowListInfo' => [ + 'description' => '查询节目单。', + 'type' => 'object', + 'properties' => [ + 'CurrentShowId' => [ + 'description' => '当前正在播放的节目ID。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'Background' => [ + 'description' => '播单背景。', + 'type' => 'string', + 'example' => '{\\"MaterialId\\":\\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\",\\"resourceType\\":\\"VOD\\"}', + ], + 'HighPriorityShowId' => [ + 'description' => '最高优先级节目。'."\n" + ."\n" + .'> 此配置只能在节目单未开始启动前设置。'."\n", + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'HighPriorityShowStartTime' => [ + 'description' => '最高优先级节目播放时间，格式为：yyyy-MM-dd\'T\'HH:mm:ss。'."\n" + ."\n" + .'> 此配置只能在节目单未开始启动前设置。配置完成，节目单会在最高优先级播放时间进行切播，开始播放最高优先级节目（从当前正在播放的节目切播到最高级优先节目）。'."\n" + ."\n\n", + 'type' => 'string', + 'example' => '2021-11-23T12:30:00', + ], + 'ShowList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Show' => [ + 'description' => '播放列表的详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '播放列表的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'description' => '单个节目播放时间长度。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'RepeatTimes' => [ + 'description' => '单个节目播放的循环次数。'."\n" + ."\n" + .'RepeatTimes为重复次数，示例：0表示重复0次（实际播放1次），1表示重复1次（实际播放2次），以此类推。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ResourceInfo' => [ + 'description' => '资源信息。', + 'type' => 'object', + 'properties' => [ + 'LiveInputType' => [ + 'description' => '自定义的类型标记。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ResourceId' => [ + 'description' => '点播文件ID。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'ResourceType' => [ + 'description' => '资源素材类型。', + 'type' => 'string', + 'example' => 'vod', + ], + 'ResourceUrl' => [ + 'description' => '资源URL。', + 'type' => 'string', + 'example' => 'http://**/atestObject**.m3u8', + ], + ], + ], + 'ShowId' => [ + 'description' => '节目ID。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'ShowName' => [ + 'description' => '播放节目名称。', + 'type' => 'string', + 'example' => 'liveShow****', + ], + ], + ], + ], + ], + ], + 'ShowListRepeatTimes' => [ + 'description' => '播单默认循环次数。始终为0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TotalShowListRepeatTimes' => [ + 'description' => '整个节目单播放的循环次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidShowList.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidShow.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"ShowList\\": \\"ShowList[Show1, Show2, Show3...]\\",\\n \\"ShowListInfo\\": {\\n \\"CurrentShowId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\",\\n \\"Background\\": \\"{\\\\\\\\\\\\\\"MaterialId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resourceType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"VOD\\\\\\\\\\\\\\"}\\",\\n \\"HighPriorityShowId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\",\\n \\"HighPriorityShowStartTime\\": \\"2021-11-23T12:30:00\\",\\n \\"ShowList\\": {\\n \\"Show\\": [\\n {\\n \\"Duration\\": 20,\\n \\"RepeatTimes\\": 5,\\n \\"ResourceInfo\\": {\\n \\"LiveInputType\\": 1,\\n \\"ResourceId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\",\\n \\"ResourceType\\": \\"vod\\",\\n \\"ResourceUrl\\": \\"http://**/atestObject**.m3u8\\"\\n },\\n \\"ShowId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\",\\n \\"ShowName\\": \\"liveShow****\\"\\n }\\n ]\\n },\\n \\"ShowListRepeatTimes\\": 0,\\n \\"TotalShowListRepeatTimes\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeShowListResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n <ShowList>ShowList[Show1, Show2, Show3...]</ShowList>\\n <ShowListInfo>\\n <CurrentShowId>a2b8e671-2fe5-4642-a2ec-bf93880e****</CurrentShowId>\\n <Background>{\\\\\\"MaterialId\\\\\\":\\\\\\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\\\\\",\\\\\\"resourceType\\\\\\":\\\\\\"VOD\\\\\\"}</Background>\\n <HighPriorityShowId>a2b8e671-2fe5-4642-a2ec-bf93880e****</HighPriorityShowId>\\n <HighPriorityShowStartTime>2021-11-23T12:30:00</HighPriorityShowStartTime>\\n <ShowList>\\n <Duration>20</Duration>\\n <RepeatTimes>5</RepeatTimes>\\n <ResourceInfo>\\n <LiveInputType>1</LiveInputType>\\n <ResourceId>a2b8e671-2fe5-4642-a2ec-bf93880e****</ResourceId>\\n <ResourceType>vod</ResourceType>\\n <ResourceUrl>http://**/atestObject**.m3u8</ResourceUrl>\\n </ResourceInfo>\\n <ShowId>a2b8e671-2fe5-4642-a2ec-bf93880e****</ShowId>\\n <ShowName>liveShow****</ShowName>\\n </ShowList>\\n <ShowListRepeatTimes>0</ShowListRepeatTimes>\\n <TotalShowListRepeatTimes>1</TotalShowListRepeatTimes>\\n </ShowListInfo>\\n</DescribeShowListResponse>","errorExample":""}]', + 'title' => '节目单查询', + 'description' => '请先添加节目后再调用本接口查询节目单。使用API添加节目，请参见[添加一个节目到节目单](~~2848051~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + ], + 'PlayChoosenShow' => [ + 'summary' => '手动切换节目。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**路径查看导播台名称。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'ShowId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要播放切换的节目ID。'."\n" + .'>通过查看[AddShowIntoShowList](~~2848051~~)或[DescribeShowList](~~2848054~~)接口的返回参数获取ShowId值。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'ShowId' => [ + 'description' => '节目ID。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectCasterStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidShowList.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidShow.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"ShowId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\"\\n}","errorExample":""},{"type":"xml","example":"<PlayChoosenShowResponse> \\n<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n<ShowId>a2b8e671-2fe5-4642-a2ec-bf93880e****</ShowId>\\n</PlayChoosenShowResponse> ","errorExample":""}]', + 'title' => '手动切换节目', + 'description' => '添加节目完成开启直播后，可调用本接口切换节目。使用API添加节目，请参见[添加一个节目到节目单](~~2848051~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'InitializeAutoShowListTask' => [ + 'summary' => '创建一个定时任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ResourceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '播单中的点播媒资文件ID列表（目前仅支持点播平台的mp4格式视频文件）。'."\n" + .'最多支持三个节目，每个节目会按照列表顺序进行播放直到EndTime会自动结束。'."\n" + .'>- 您可以通过控制台或API接口返回参数获取视频文件ID。详情请参见[媒资管理](~~86057~~)或[获取音视频上传地址和凭证](~~55407~~)。- 在EndTime前节目如已经播完，默认会持续播放最后一个节目的最后一帧，直到播放结束。', + 'type' => 'string', + 'required' => false, + 'example' => '["89e02xxxxfb349axxxxa0c350d**** ","6ae0xxxxxb349axxxxa0c350a****"]', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1645688994000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1645688994000', + ], + ], + [ + 'name' => 'CasterConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台配置。包含：'."\n" + ."\n" + .'- （必填）CasterTemplate：导播台输出分辨率。'."\n" + ."\n" + .'- （非必填）LiveTemplate：输出转码任务列表。'."\n" + ."\n" + .'>JSON格式字符串，结构体内部字段请按首字母大写，驼峰格式输入。', + 'type' => 'string', + 'required' => true, + 'example' => '{"CasterTemplate": "lp_ld","LiveTemplates":["lhd", "lsd","lud"]}', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '输出的播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.aliyundoc.com', + ], + ], + [ + 'name' => 'CallBackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '用户回调地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://***.com/callback', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。'."\n" + .'>可作为查询导播台流地址、启动导播台、添加导播台视频资源、添加导播台布局、查询导播台布局列表、添加导播台组件和添加导播台节目单的请求参数。', + 'type' => 'string', + 'example' => 'b4810848-bcf9-4aef-bd4a-e6bba2d9****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'StreamList' => [ + 'description' => '导播台输出地址列表。'."\n" + ."\n" + .'- videoFormat：播流地址格式。'."\n" + ."\n" + .'- outputStreamUrl：拉流地址。'."\n" + ."\n" + .'- transcodeConfig：拉流地址的转码分辨率说明。', + 'type' => 'string', + 'example' => '[{"videoFormat":"flv","outputStreamUrl":"http://example.aliyundoc.com","transcodeConfig":"original"}]', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.PurchaseTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.ExpireTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidChargeType.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidChargeType.PostSupport', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterTemplate.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidParameter.ChargeType', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidPeriod.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidClientToken.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectCasterStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.StartTime', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'CasterNumberExceed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'IncorrectCasterStatus.EnableChannel', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.NormType', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidConfiguration.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 408 => [ + [ + 'errorCode' => 'CreateCaster.Timeout', + 'errorMessage' => '%s, please try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterId\\": \\"b4810848-bcf9-4aef-bd4a-e6bba2d9****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"StreamList\\": \\"[{\\\\\\"videoFormat\\\\\\":\\\\\\"flv\\\\\\",\\\\\\"outputStreamUrl\\\\\\":\\\\\\"http://example.aliyundoc.com\\\\\\",\\\\\\"transcodeConfig\\\\\\":\\\\\\"original\\\\\\"}]\\"\\n}","errorExample":""},{"type":"xml","example":"<InitializeAutoShowListTaskResponse>\\n<RequestId>9F6448C9-6F92-1BAC-AFDD-C308782A6573</RequestId>\\n<StreamList>\\n <videoFormat>flv</videoFormat>\\n <outputStreamUrl>http://example.aliyundoc.com/caster/2967b3b2b52242019c277de2a11a****.flv</outputStreamUrl>\\n <transcodeConfig>original</transcodeConfig>\\n</StreamList>\\n<CasterId>6277b6a3-1a40-4063-85f7-145666e3****</CasterId>\\n</InitializeAutoShowListTaskResponse>","errorExample":""}]', + 'title' => '创建一个定时任务', + 'description' => '本接口支持配置定时启停一个播单定时任务，调用时请保证参数设置符合要求。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DescribeAutoShowListTasks' => [ + 'summary' => '查询自动启停的定时任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询定时任务的导播台ID。'."\n" + .'>如果您通过[InitializeAutoShowListTask](~~2848056~~)接口创建定时任务，请查看InitializeAutoShowListTask接口返回参数CasterId值。若不填，默认查询OwnerId下的全量定时任务。', + 'type' => 'string', + 'required' => false, + 'example' => '53200b81-b761-4c10-842a-a0726d97****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AutoShowListTasks' => [ + 'description' => '定时任务列表。包含：'."\n" + ."\n" + .'- Status：任务状态。0为暂停，1为启动。'."\n" + ."\n" + .'- LiveTemplate：转码配置列表。'."\n" + ."\n" + .'- TranscodeConfig：拉流地址的转码分辨率说明。'."\n" + ."\n" + .'- CasterId ：导播台ID。', + 'type' => 'string', + 'example' => '{"Status":0,"TranscodeConfig":{"CasterTemplate":"lp_hd", "LiveTemplate":["lhd","lsd"]}, "CasterId":"cce04ef3-2226-4865-8704-f84b8375****"}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidVodUrl.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidShowList.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AutoShowListTasks\\": \\"{\\\\\\"Status\\\\\\":0,\\\\\\"TranscodeConfig\\\\\\":{\\\\\\"CasterTemplate\\\\\\":\\\\\\"lp_hd\\\\\\", \\\\\\"LiveTemplate\\\\\\":[\\\\\\"lhd\\\\\\",\\\\\\"lsd\\\\\\"]}, \\\\\\"CasterId\\\\\\":\\\\\\"cce04ef3-2226-4865-8704-f84b8375****\\\\\\"}\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeAutoShowListTasksResponse>\\n<RequestId>04F5D5E0-9FAA-13CB-96A9-850FB06E9A82</RequestId>\\n<AutoShowListTasks>\\n <Status>0</Status>\\n <EndTime>1645594715228</EndTime>\\n <ResourceIds>[\\"6ae09369cab349a78dab7a0c350dfb9d\\"]</ResourceIds>\\n <StartTime>1645594115228</StartTime>\\n <TranscodeConfig>\\n <CasterTemplate>lp_hd</CasterTemplate>\\n <LiveTemplate>lhd</LiveTemplate>\\n <LiveTemplate>lsd</LiveTemplate>\\n </TranscodeConfig>\\n <CasterId>e18b0c36-c0b5-47c1-81fd-7d783b5c7802</CasterId>\\n</AutoShowListTasks>\\n</DescribeAutoShowListTasksResponse>","errorExample":""}]', + 'title' => '查询自动启停的定时任务', + 'description' => '本接口支持查询您已创建的自动启停定时任务相关信息，调用时请保证参数设置符合要求。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'EditShowAndReplace' => [ + 'summary' => '添加剪辑任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '53200b81-b761-4c10-842a-a0726d97****', + ], + ], + [ + 'name' => 'ShowId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要剪辑的节目ID。'."\n" + .'>通过查看[AddShowIntoShowList](~~2848051~~)接口的返回参数获取ShowId值。', + 'type' => 'string', + 'required' => true, + 'example' => '42200b81-b761-4c10-842a-a0726d97****', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户信息。', + 'type' => 'string', + 'required' => false, + 'example' => '900a2b2r8-13c2-****-88f2-75e4a07c1ed9', + ], + ], + [ + 'name' => 'StorageInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '存储信息。描述：'."\n" + ."\n" + .'- **StorageLocation**：用户点播存储地址。'."\n" + .'- **FileName**：用户自定义文件名。'."\n" + ."\n" + .'>剪辑存储地址必须是用户同一账户下的点播存储地址，获取点播存储地址请参见[存储管理](~~86097~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{ "StorageLocation":"***bucket***", "FileName":"EditFile****.mp4" }', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '剪辑开始时间，单位：秒。'."\n" + ."\n" + .'> - 剪辑时间取值范围为0到节目总时长。- 默认从点播文件开头开始剪辑，取值：0.0。'."\n" + .'> - 如果您想要剪辑一个点播文件，从第2秒到第5秒，那么StartTime取值为2.0，EndTime取值为5.0。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '2.0', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '剪辑结束时间，单位：秒。'."\n" + ."\n" + .'> - 剪辑时间取值范围为0到节目总时长。'."\n" + .'> - 默认取值为点播文件结束时长，取值不可超出节目的总时长。'."\n" + .'> - 如果您想要剪辑一个点播文件，从第2秒到第5秒，那么StartTime取值为2.0，EndTime取值为5.0。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '5.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JobInfo' => [ + 'description' => '任务信息，包含：'."\n" + ."\n" + .'- **vodId**：点播文件ID。'."\n" + ."\n" + .'- **mediaid**：媒体文件ID。'."\n" + ."\n" + .'- **jobId**：任务ID。', + 'type' => 'string', + 'example' => '{ "vodId": "3e34733b40b9a96ccf5c1ff6f69****", "mediaid": "eb1861d2c9a842340e989dd56****", "jobId": "7d2fbc380b0e08e55fe98733764****" }', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidVodUrl.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'RequestForbiddenForIce', + 'errorMessage' => '%s, please try again later.', + ], + ], + [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidShowList.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"JobInfo\\": \\"{ \\\\\\"vodId\\\\\\": \\\\\\"3e34733b40b9a96ccf5c1ff6f69****\\\\\\", \\\\\\"mediaid\\\\\\": \\\\\\"eb1861d2c9a842340e989dd56****\\\\\\", \\\\\\"jobId\\\\\\": \\\\\\"7d2fbc380b0e08e55fe98733764****\\\\\\" }\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<EditShowAndReplaceResponse> \\n<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n<JobInfo>\\n <vodId>3e34733b40b9a96ccf5c1ff6f69****</vodId>\\n <mediaid>eb1861d2c9a842340e989dd56****</mediaid>\\n <jobId>7d2fbc380b0e08e55fe98733764****</jobId>\\n</JobInfo>\\n</EditShowAndReplaceResponse>","errorExample":""}]', + 'title' => '添加剪辑任务', + 'description' => '本接口支持指定CasterId和ShowId添加剪辑任务。'."\n" + .'添加剪辑任务成功不会自动通知，您可调用[GetEditingJobInfo](~~2848059~~)接口查询任务状态信息。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetEditingJobInfo' => [ + 'summary' => '查询剪辑任务信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '53200b81-b761-4c10-842a-a0726d97****', + ], + ], + [ + 'name' => 'ShowId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的节目ID。'."\n" + .'>通过查看[AddShowIntoShowList](~~370861~~)接口的返回参数获取ShowId值。', + 'type' => 'string', + 'required' => false, + 'example' => '72200b81-b761-4c10-842a-a0726d97****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。', + 'type' => 'string', + 'example' => '53200b81-b761-4c10-842a-a0726d97****', + ], + 'EditingTasksInfo' => [ + 'description' => '剪辑任务信息。包含：'."\n" + ."\n" + .'- **OutputVodId**：输出的Vod文件ID。'."\n" + ."\n" + .'- **TaskStatus**：剪辑任务状态。（-1：失败；0：任务初始化；1：剪辑中；2：上传中；3：任务成功。）'."\n" + ."\n" + .'- **StorageLocation**：点播存储地址。'."\n" + ."\n" + .'- **FileName**：剪辑文件名。'."\n" + ."\n" + .'- **ShowId**：节目ID。', + 'type' => 'string', + 'example' => '"EditingTasksInfo": { "OutputVodId": "3e34733b40b9a96ccf5c1ff6f69****", "TaskStatus": 1, "StorageInfo": { "StorageLocation": "***bucket***", "FileName": "EditFile****" }, "ShowId": "42200b81-b761-4c10-842a-a0726d97****" },', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidVodUrl.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidShowList.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CasterId\\": \\"53200b81-b761-4c10-842a-a0726d97****\\",\\n \\"EditingTasksInfo\\": \\"\\\\\\"EditingTasksInfo\\\\\\": { \\\\\\"OutputVodId\\\\\\": \\\\\\"3e34733b40b9a96ccf5c1ff6f69****\\\\\\", \\\\\\"TaskStatus\\\\\\": 1, \\\\\\"StorageInfo\\\\\\": { \\\\\\"StorageLocation\\\\\\": \\\\\\"***bucket***\\\\\\", \\\\\\"FileName\\\\\\": \\\\\\"EditFile****\\\\\\" }, \\\\\\"ShowId\\\\\\": \\\\\\"42200b81-b761-4c10-842a-a0726d97****\\\\\\" },\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","type":"json"}]', + 'title' => '查询剪辑任务', + 'description' => '- 本接口支持查询指定CasterId和ShowId剪辑任务的相关信息，调用时请保证参数设置符合要求。'."\n" + ."\n" + .'- 如果您配置请求参数ShowId，接口返回数据为节目单中指定ShowId对应的节目剪辑任务信息。'."\n" + ."\n" + .'- 如果您未配置请求参数ShowId，接口返回数据为整个节目单的剪辑任务信息。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'SetShowListBackground' => [ + 'summary' => '进行播单背景设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227260', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**路径查看导播台名称。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '素材类型。取值：'."\n" + ."\n" + .'- LIVE：直播素材。可支持直播素材和第三方URL。'."\n" + ."\n" + .'- VOD：点播素材。可支持点播素材和第三方URL。'."\n" + ."\n" + .'- PIC：图片素材。可支持点播素材和第三方URL。'."\n" + ."\n" + .'> 三选一或者不传。', + 'type' => 'string', + 'required' => false, + 'example' => 'VOD', + 'enum' => [ + 'VOD', + 'PIC', + 'LIVE', + ], + ], + ], + [ + 'name' => 'MaterialId', + 'in' => 'query', + 'schema' => [ + 'description' => '点播素材ID。'."\n" + ."\n" + .'> 与外部ResourceUrl二选一。', + 'type' => 'string', + 'required' => false, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + [ + 'name' => 'ResourceUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '外部素材url。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://****/atestObject****.m3u8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '987DA143-A39C-5B5D-AF5B-3B07944A0036', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidParameter.Status', + 'errorMessage' => '%s, please check and try again.', + ], + [ + 'errorCode' => 'InvalidParameter.StartTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.EndTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'LiveServiceNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => 'The caster does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"987DA143-A39C-5B5D-AF5B-3B07944A0036\\"\\n}","errorExample":""},{"type":"xml","example":"<SetShowListBackgroundResponse>\\n <RequestId>987DA143-A39C-5B5D-AF5B-3B07944A0036</RequestId>\\n</SetShowListBackgroundResponse>","errorExample":""}]', + 'title' => '播单背景设置', + 'description' => '- 请先创建新播单型导播台，再调用本接口添加背景素材。使用API创建导播台，请参见[创建导播台](~~2848009~~)。'."\n" + .'- 可以使用本接口创建/更新/删除播单背景， 当参数ResourceType、ResourceUrl、MaterialId 都为空即可删除背景。 '."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'- 使用视频点播（VOD）资源，可优先选择托管Bucket资源，自有Bucket资源存在过期风险，如果您选用自有Bucket资源，需注意资源的有效期时间。'."\n" + ."\n" + .'- 素材资源输入请优先选择视频直播和视频点播的资源，若从第三方URL输入资源存在播放失败可能性，需确定资源的质量和有效性。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'AddStudioLayout' => [ + 'summary' => '添加虚拟演播厅的布局设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'><notice>需要提前创建好，必须是虚拟演播厅类型的导播台。可通过控制台或调用[CreateCaster](~~69338~~)接口添加导播台，类型需选择虚拟演播厅。'."\n" + .'></notice>'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + [ + 'name' => 'LayoutName', + 'in' => 'query', + 'schema' => [ + 'description' => '演播厅布局名称。', + 'type' => 'string', + 'required' => true, + 'example' => '测试布局', + ], + ], + [ + 'name' => 'LayoutType', + 'in' => 'query', + 'schema' => [ + 'description' => '演播厅布局类型。取值：'."\n" + ."\n" + .'- **common**：通用布局。当LayoutType取值为common时，请求参数CommonConfig为必填。'."\n" + .'- **studio**：演播厅布局。当LayoutType取值为studio时，请求参数BgImageConfig和ScreenInputConfigList为必填，MediaInputConfigList为选填。', + 'type' => 'string', + 'required' => true, + 'example' => 'studio', + ], + ], + [ + 'name' => 'CommonConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '通用布局配置。格式为JSON字符串，请参见**CommonConfig**。'."\n" + ."\n" + .'><notice>当请求参数LayoutType取值为common时，本参数才必填。'."\n" + .'></notice>'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"ChannelId":"RV01" }', + ], + ], + [ + 'name' => 'BgImageConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '背景资源配置。格式为JSON字符串，请参见**BgImageConfig**。'."\n" + ."\n" + .'><notice>当请求参数LayoutType取值为studio时，本参数才必填。'."\n" + .'></notice>'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{ "Id":"k12kj31****", "MaterialId":"f080575eb5f4427684fc0715159a****" }', + ], + ], + [ + 'name' => 'ScreenInputConfigList', + 'in' => 'query', + 'schema' => [ + 'description' => '抠像输入设置。格式为JSON字符串，请参见**ScreenInputConfig**。'."\n" + ."\n" + .'><notice>当请求参数LayoutType取值为studio时，本参数才必填。'."\n" + .'></notice>'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[ { "Index":"1", "ChannelId":"RV01", "Color":"green", "PositionX":"0.1", "PositionY":"0.2", "HeightNormalized":"0.4" } ]', + ], + ], + [ + 'name' => 'MediaInputConfigList', + 'in' => 'query', + 'schema' => [ + 'description' => '多媒体输入资源设置。格式为JSON字符串，请参见**MediaInputConfig**。'."\n" + ."\n" + .'><notice>当请求参数LayoutType取值为studio时，本参数才有效，且为选填。'."\n" + .'></notice>'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[ { "Id":"k12kj31****", "Index":"1", "ChannelId":"RV01", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.4", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" }, { "Id":"k12kj31****", "Index":"2", "ImageMaterialId":"lkajsdfsa8fd89asd8****", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.6", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" } ]', + ], + ], + [ + 'name' => 'LayerOrderConfigList', + 'in' => 'query', + 'schema' => [ + 'description' => '图层顺序设置。格式为JSON字符串，请参见**layerOrderConfig**。'."\n" + .'支持背景素材、多媒体素材排序，暂不支持抠像层。越排在前面，越在底层。', + 'type' => 'string', + 'required' => false, + 'example' => '[ { "Type":"media", "Id":"k12kj31****" }, { "Type":"media", "Id":"k12kj31****" } ]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'LayoutId' => [ + 'description' => '布局ID。可作为删除虚拟演播厅布局、修改虚拟演播厅布局和查询虚拟演播厅布局的请求参数。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b96****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidPositionNormalized.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidHeightOrWidthNormalized', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LayoutId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9****\\",\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b96****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddStudioLayoutResponse>\\n <LayoutId>445409ec-7eaa-461d-8f29-4bec2eb9****</LayoutId>\\n <RequestId>5c6a2a0d-f228-4a64-af62-20e91b9676b3</RequestId>\\n</AddStudioLayoutResponse>","errorExample":""}]', + 'title' => '添加虚拟演播厅布局', + 'description' => '调用本接口添加虚拟演播厅的布局设置。本接口目前支持的演播厅布局类型为通用布局和演播厅布局。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '## CommonConfig'."\n" + .'| 名称 | 类型 | 示例 | 描述 |'."\n" + .'| --------------- | ------ | --------------------- | -------------------------- |'."\n" + .'| ChannelId | String | RV01 | 视频资源绑定的通道位置ID。 |'."\n" + ."\n" + .'## BgImageConfig'."\n" + .'> 其中ImageUrl和MaterialId仅能输入一个。'."\n" + ."\n" + .'| 名称 | 类型 | 示例 | 描述 |'."\n" + .'| --------------- | ------ | --------------------- | -------------------------- |'."\n" + .'| Id | String | k12kj31**** | 该背景素材唯一ID。 |'."\n" + .'| ImageUrl | String | http://aliyundoc.com | 素材地址URL。 |'."\n" + .'| MaterialId | String | f080575eb5f4427684fc0715159a**** | 点播素材ID。 |'."\n" + ."\n" + .'## ScreenInputConfig'."\n" + .'| 名称 | 类型 | 示例 | 描述 |'."\n" + .'| ---------------- | ------- | ------------------------------------ | ------------------------------------------------------------ |'."\n" + .'| Index | Integer | 1 | 抠像源编号。前端展示使用，无逻辑作用，要求取正整数（>0）。 |'."\n" + .'| ChannelId | String | RV01 | 视频资源绑定的通道位置ID。 |'."\n" + .'| Color | String | green | 抠像色域。取值：<br>**blue**：蓝幕背景。<br>**green**：绿幕背景。<br>**auto**：自动识别。<br>**complex**：实景抠像。 |'."\n" + .'| PositionX | Float | 0.1 | 位置参数，坐标x。取值：[0,1]。<br>素材位置以左上角为基准点。 |'."\n" + .'| PositionY | Float | 0.2 | 位置参数，坐标y。取值：[0,1]。<br>素材位置以左上角为基准点。 |'."\n" + .'| HeightNormalized | Float | 0.4 | 高度归一化值。即抠出的人像与背景的高度比。取值：[0,1]。 |'."\n" + ."\n" + .'## MediaInputConfig'."\n" + .'- 当多媒体素材是视频源，传入ChannelId。'."\n" + .'- 当多媒体素材是图片，传入ImageMeterialId。'."\n" + .'- ChannelId和ImageMeterialId是互斥的，两者选填一项。'."\n" + ."\n" + .'| 名称 | 类型 | 示例 | 描述 |'."\n" + .'| ------------------ | ------- | ------------------------------------ | ------------------------------------------------------------ |'."\n" + .'| Id | String | k12kj31**** | 该多媒体素材唯一ID。 |'."\n" + .'| Index | Integer | 1 | 多媒体素材编号。前端展示使用，无逻辑作用，要求取正整数（>0）。 |'."\n" + .'| ChannelId | String | RV01 | 视频资源绑定的通道位置ID。 |'."\n" + .'| ImageMaterialId | String | lkajsdfsa8fd89asd8**** | 点播图片素材ID。 |'."\n" + .'| FillMode | String | none | 填充类型。填**none**即可。 |'."\n" + .'| PositionRefer | String | topLeft | 素材的位置参考坐标值。填**topLeft**即可，表示位置设置以左上角为基准点。 |'."\n" + .'| WidthNormalized | Float | 0.4 | 素材的宽度归一化值。即素材与背景的宽度比。取值：[0,1]。 |'."\n" + .'| HeightNormalized | Float | 0.4 | 素材的高度归一化值。即素材与背景的高度比。取值：[0,1]。 |'."\n" + .'| PositionNormalized | Float | [0.1, 0.2] | 素材的填充区位置归一化值[x,y]。x、y的取值范围分别为[0,1]。<br>例如[0.1,0.2] 代表左上角水平偏移10%，垂直偏移20%。 |'."\n" + ."\n" + .'## LayerOrderConfig'."\n" + .'| 名称 | 类型 | 示例 | 描述 |'."\n" + .'| ---- | ------ | ----------- | ------------------------------------------------------------ |'."\n" + .'| Type | String | media | 资源配置的类型。<br>background：背景素材。<br>media：多媒体素材。 |'."\n" + .'| Id | String | k12kj31**** | 该资源的唯一ID。 |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteStudioLayout' => [ + 'summary' => '删除虚拟演播厅的布局设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b96****', + ], + ], + [ + 'name' => 'LayoutId', + 'in' => 'query', + 'schema' => [ + 'description' => '布局ID。如果您通过[AddStudioLayout接口](~~2848062~~)添加虚拟演播厅的布局设置，请查看AddStudioLayout接口调用返回的参数LayoutId值。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e9*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidLayoutId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidLayout.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e9*****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeleteStudioLayoutResponse>\\r\\n <RequestId>5c6a2a0d-f228-4a64-af62-20e91b9676b3</RequestId>\\r\\n</DeleteStudioLayoutResponse>","errorExample":""}]', + 'title' => '删除虚拟演播厅布局', + 'description' => '调用本接口删除虚拟演播厅的布局设置，一次仅支持删除一个布局。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyStudioLayout' => [ + 'summary' => '修改虚拟演播厅布局。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'><notice>需要提前创建好，必须是虚拟演播厅类型的导播台。'."\n" + .'></notice>'."\n" + ."\n\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + [ + 'name' => 'LayoutId', + 'in' => 'query', + 'schema' => [ + 'description' => '布局ID。如果您通过[AddStudioLayout接口](~~2848062~~)添加虚拟演播厅的布局设置，请查看AddStudioLayout接口调用返回的参数LayoutId值。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'LayoutName', + 'in' => 'query', + 'schema' => [ + 'description' => '演播厅布局名称。', + 'type' => 'string', + 'required' => false, + 'example' => '测试布局', + ], + ], + [ + 'name' => 'CommonConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '通用布局配置。格式为JSON字符串，请参见**CommonConfig**。'."\n" + .'><notice>当LayoutType取值为common时，本参数才必填。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '{ "ChannelId":"RV01" }', + ], + ], + [ + 'name' => 'BgImageConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '背景资源配置。格式为JSON字符串，请参见**BgImageConfig**。'."\n" + ."\n" + .'><notice>当LayoutType取值为studio时，本参数才必填。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '{ "Id":"k12kj31****", "MaterialId":"f080575eb5f4427684fc0715159a****" }', + ], + ], + [ + 'name' => 'ScreenInputConfigList', + 'in' => 'query', + 'schema' => [ + 'description' => '抠像输入设置。格式为JSON字符串，请参见**ScreenInputConfig**。'."\n" + ."\n" + .'><notice>当LayoutType取值为studio时，本参数才必填。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '[ { "Index":"1", "ChannelId":"RV01", "Color":"green", "PositionX":"0.1", "PositionY":"0.2", "HeightNormalized":"0.4" } ]', + ], + ], + [ + 'name' => 'MediaInputConfigList', + 'in' => 'query', + 'schema' => [ + 'description' => '多媒体输入资源设置。格式为JSON字符串，请参见**MediaInputConfig**。'."\n" + ."\n" + .'><notice>当LayoutType取值为studio时，本参数才有效，且为选填。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '[ { "Id":"k12kj31****", "Index":"1", "ChannelId":"RV01", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.4", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" }, { "Id":"k12kj31****", "Index":"2", "ImageMaterialId":"lkajsdfsa8fd89asd8****", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.6", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" } ]', + ], + ], + [ + 'name' => 'LayerOrderConfigList', + 'in' => 'query', + 'schema' => [ + 'description' => '图层顺序设置。格式为JSON字符串，请参见**layerOrderConfig**。'."\n" + .'支持背景素材、多媒体素材排序，暂不支持抠像层。越排在前面，越在底层。', + 'type' => 'string', + 'required' => false, + 'example' => '[ { "Type":"media", "Id":"k12kj31****" }, { "Type":"media", "Id":"k12kj31****" } ]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b9676b3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidPositionNormalized.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidHeightOrWidthNormalized', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidLayout.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b9676b3\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ModifyStudioLayoutResponse>\\r\\n <RequestId>5c6a2a0d-f228-4a64-af62-20e91b9676b3</RequestId>\\r\\n</ModifyStudioLayoutResponse>","errorExample":""}]', + 'title' => '修改虚拟演播厅布局', + 'description' => '调用本接口修改虚拟演播厅布局。修改布局设置时，仅需传入要修改的参数。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '## CommonConfig'."\n" + .'| 名称 | 类型 | 示例 | 描述 |'."\n" + .'| --------------- | ------ | --------------------- | -------------------------- |'."\n" + .'| ChannelId | String | RV01 | 视频资源绑定的通道位置ID。 |'."\n" + ."\n" + .'## BgImageConfig'."\n" + .'> 其中ImageUrl和MaterialId仅能输入一个。'."\n" + .'| 名称 | 类型 | 示例 | 描述 |'."\n" + .'| --------------- | ------ | --------------------- | -------------------------- |'."\n" + .'| Id | String | k12kj31**** | 该背景素材唯一ID。 |'."\n" + .'| ImageUrl | String | http://aliyundoc.com | 素材地址URL。 |'."\n" + .'| MaterialId | String | f080575eb5f4427684fc0715159a**** | 点播素材ID。 |'."\n" + ."\n" + .'## ScreenInputConfig'."\n" + .'| 名称 | 类型 | 示例 | 描述 |'."\n" + .'| ---------------- | ------- | ------------------------------------ | ------------------------------------------------------------ |'."\n" + .'| Index | Integer | 1 | 抠像源编号。前端展示使用，无逻辑作用，要求取正整数（>0）。 |'."\n" + .'| ChannelId | String | RV01 | 视频资源绑定的通道位置ID。 |'."\n" + .'| Color | String | green | 抠像色域。取值：<br>**blue**：蓝幕背景。<br/>**green**：绿幕背景。<br/>**auto**：自动识别。<br/>**complex**：实景抠像。 |'."\n" + .'| PositionX | Float | 0.1 | 位置参数，坐标x。取值：[0,1]。<br>素材位置以左上角为基准点。 |'."\n" + .'| PositionY | Float | 0.2 | 位置参数，坐标y。取值：[0,1]。<br>素材位置以左上角为基准点。 |'."\n" + .'| HeightNormalized | Float | 0.4 | 高度归一化值。即抠出的人像与背景的高度比。取值：[0,1]。 |'."\n" + ."\n" + .'## MediaInputConfig'."\n" + .'- 当多媒体素材是视频源，ChannelId。'."\n" + .'- 当多媒体素材是图片，传入ImageMeterialId。'."\n" + .'- ChannelId和ImageMeterialId是互斥的，两者选填一项。'."\n" + ."\n" + .'| 名称 | 类型 | 示例 | 描述 |'."\n" + .'| ------------------ | ------- | ------------------------------------ | ------------------------------------------------------------ |'."\n" + .'| Id | String | k12kj31**** | 该多媒体素材唯一ID。 |'."\n" + .'| Index | Integer | 1 | 多媒体素材编号。前端展示使用，无逻辑作用，要求取正整数（>0）。 |'."\n" + .'| ChannelId | String | RV01 | 视频资源绑定的通道位置ID。 |'."\n" + .'| ImageMaterialId | String | lkajsdfsa8fd89asd8**** | 点播图片素材ID。 |'."\n" + .'| FillMode | String | none | 填充类型。填**none**即可。 |'."\n" + .'| PositionRefer | String | topLeft | 素材的位置参考坐标值。填**topLeft**即可，表示位置设置以左上角为基准点。 |'."\n" + .'| WidthNormalized | Float | 0.4 | 素材的宽度归一化值。即素材与背景的宽度比。取值：[0,1]。 |'."\n" + .'| HeightNormalized | Float | 0.4 | 素材的高度归一化值。即素材与背景的高度比。取值：[0,1]。 |'."\n" + .'| PositionNormalized | Float | [0.1, 0.2] | 素材的填充区位置归一化值[x,y]。x、y的取值范围分别为[0,1]。<br>例如[0.1,0.2] 代表左上角水平偏移10%，垂直偏移20%。 |'."\n" + ."\n" + .'## layerOrderConfig'."\n" + .'| 名称 | 类型 | 示例 | 描述 |'."\n" + .'| ---- | ------ | ----------- | ------------------------------------------------------------ |'."\n" + .'| Id | String | k12kj31**** | 该资源的唯一ID。 |'."\n" + .'| Type | String | media | 资源配置的类型。<br>background：背景素材。<br>media：多媒体素材。 |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeStudioLayouts' => [ + 'summary' => '获取虚拟演播厅布局设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b96****', + ], + ], + [ + 'name' => 'LayoutId', + 'in' => 'query', + 'schema' => [ + 'description' => '布局ID。'."\n" + .'多个布局ID用英文逗号（,）隔开，不填则返回该导播台下所有布局。'."\n" + ."\n" + .'如果您通过[AddStudioLayout接口](~~2848062~~)添加虚拟演播厅的布局设置，请查看AddStudioLayout接口调用返回的参数LayoutId值。', + 'type' => 'string', + 'required' => false, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '布局信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b9676b3', + ], + 'StudioLayouts' => [ + 'description' => '布局信息。', + 'type' => 'array', + 'items' => [ + 'description' => '布局信息。', + 'type' => 'object', + 'properties' => [ + 'BgImageConfig' => [ + 'description' => '背景资源配置。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '该背景素材唯一ID。', + 'type' => 'string', + 'example' => 'k12kj31****', + ], + 'ImageUrl' => [ + 'description' => '素材地址URL。', + 'type' => 'string', + 'example' => ' http://example.org', + ], + 'LocationId' => [ + 'description' => '位置id', + 'type' => 'string', + 'example' => 'RV01', + ], + 'MaterialId' => [ + 'description' => '点播素材ID。', + 'type' => 'string', + 'example' => 'asdfas9df89asd8f9****', + ], + ], + ], + 'CommonConfig' => [ + 'description' => '通用布局信息。此布局为通用布局时，返回此字段。', + 'type' => 'object', + 'properties' => [ + 'ChannelId' => [ + 'description' => '视频资源绑定的通道位置ID。 ', + 'type' => 'string', + 'example' => 'RV01', + ], + 'VideoResourceId' => [ + 'description' => '视频资源ID。', + 'type' => 'string', + 'example' => 'asdfasdfasdfasdfa****', + ], + ], + ], + 'LayerOrderConfigList' => [ + 'description' => '图层顺序配置。', + 'type' => 'array', + 'items' => [ + 'description' => '图层顺序配置。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '该资源的唯一ID。', + 'type' => 'string', + 'example' => 'k12kj31****', + ], + 'Type' => [ + 'description' => '资源配置的类型。取值：'."\n" + ."\n" + .'- **background**：背景素材。'."\n" + .'- **media**：多媒体素材。 ', + 'type' => 'string', + 'example' => 'media', + ], + ], + ], + ], + 'LayoutId' => [ + 'description' => '演播厅布局ID。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + 'LayoutName' => [ + 'description' => '演播厅布局名称。', + 'type' => 'string', + 'example' => '测试布局', + ], + 'LayoutType' => [ + 'description' => '演播厅布局类型。取值：'."\n" + ."\n" + .'- **common**：通用布局。'."\n" + .'- **studio**：演播厅布局。', + 'type' => 'string', + 'example' => 'studio', + ], + 'MediaInputConfigList' => [ + 'description' => '多媒体输入资源配置。', + 'type' => 'array', + 'items' => [ + 'description' => '多媒体输入源配置。', + 'type' => 'object', + 'properties' => [ + 'ChannelId' => [ + 'description' => '视频资源绑定的通道位置ID。', + 'type' => 'string', + 'example' => 'RV01', + ], + 'FillMode' => [ + 'description' => '填充类型。默认为none。', + 'type' => 'string', + 'example' => 'none', + ], + 'HeightNormalized' => [ + 'description' => '素材的高度归一化值。即素材与背景的高度比。取值：**0~1**。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.4', + ], + 'Id' => [ + 'description' => '该多媒体素材唯一ID。', + 'type' => 'string', + 'example' => 'k12kj31****', + ], + 'ImageMaterialId' => [ + 'description' => '点播图片素材ID。', + 'type' => 'string', + 'example' => 'lkajsdfsa8fd89asd8****', + ], + 'Index' => [ + 'description' => '多媒体素材编号。前端展示使用，无逻辑作用。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PositionNormalized' => [ + 'description' => '素材的填充区位置归一化值[unk][x,y][unk]。x、y的取值范围分别为**0~1**。例如[unk][0.1,0.2][unk]代表左上角水平偏移10%，垂直偏移20%。', + 'type' => 'array', + 'items' => [ + 'description' => '素材的填充区位置归一化值`[x,y]`。x、y的取值范围分别为**0~1**。'."\n" + .'例如`[0.1,0.2]`代表左上角水平偏移10%，垂直偏移20%。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + ], + 'PositionRefer' => [ + 'description' => '素材的位置参考坐标值。默认为topLeft，表示位置设置以左上角为基准点。', + 'type' => 'string', + 'example' => 'topLeft', + ], + 'VideoResourceId' => [ + 'description' => '视频资源ID。', + 'type' => 'string', + 'example' => 'asdfasdfasdfasdfa****', + ], + 'WidthNormalized' => [ + 'description' => '素材的宽度归一化值。即素材与背景的宽度比。取值：**0~1**。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.4', + ], + ], + ], + ], + 'ScreenInputConfigList' => [ + 'description' => '抠像输入配置。', + 'type' => 'array', + 'items' => [ + 'description' => '抠像输入配置。', + 'type' => 'object', + 'properties' => [ + 'AudioConfig' => [ + 'description' => '音频配置信息。', + 'type' => 'object', + 'properties' => [ + 'ValidChannel' => [ + 'description' => '对应通道。', + 'type' => 'string', + 'example' => '1', + ], + 'VolumeRate' => [ + 'description' => '音量。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1.0', + ], + ], + ], + 'ChannelId' => [ + 'description' => '视频资源绑定的通道位置ID。', + 'type' => 'string', + 'example' => 'RV01', + ], + 'Color' => [ + 'description' => '抠像色域。取值：'."\n" + ."\n" + .'- **blue**：蓝幕背景。'."\n" + .'- **green**：绿幕背景。'."\n" + .'- **auto**：自动识别。'."\n" + .'- **complex**：实景抠像。', + 'type' => 'string', + 'example' => 'green', + ], + 'HeightNormalized' => [ + 'description' => '高度归一化值。即抠出的人像与背景的高度比。取值：**0~1**。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.4', + ], + 'Id' => [ + 'description' => '该抠像源素材唯一ID。', + 'type' => 'string', + 'example' => 'k12kj31****', + ], + 'Index' => [ + 'description' => '抠像源编号。前端展示使用，无逻辑作用。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OnlyAudio' => [ + 'description' => '仅音频', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PortraitType' => [ + 'description' => '人像类型。取值：'."\n" + ."\n" + .'- **0**：半身。'."\n" + .'- **1**：全身。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PositionX' => [ + 'description' => '位置参数，坐标x。取值：**0~1**。素材位置以左上角为基准点。', + 'type' => 'string', + 'example' => '0.1', + ], + 'PositionY' => [ + 'description' => '位置参数，坐标y。取值：**0~1**。素材位置以左上角为基准点。', + 'type' => 'string', + 'example' => '0.2', + ], + 'VideoResourceId' => [ + 'description' => '视频资源ID。', + 'type' => 'string', + 'example' => 'asdfasdfasdfasdfa****', + ], + ], + ], + ], + ], + ], + ], + 'Total' => [ + 'description' => '布局数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b9676b3\\",\\n \\"StudioLayouts\\": [\\n {\\n \\"BgImageConfig\\": {\\n \\"Id\\": \\"k12kj31****\\",\\n \\"ImageUrl\\": \\" http://example.org\\",\\n \\"LocationId\\": \\"RV01\\",\\n \\"MaterialId\\": \\"asdfas9df89asd8f9****\\"\\n },\\n \\"CommonConfig\\": {\\n \\"ChannelId\\": \\"RV01\\",\\n \\"VideoResourceId\\": \\"asdfasdfasdfasdfa****\\"\\n },\\n \\"LayerOrderConfigList\\": [\\n {\\n \\"Id\\": \\"k12kj31****\\",\\n \\"Type\\": \\"media\\"\\n }\\n ],\\n \\"LayoutId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9****\\",\\n \\"LayoutName\\": \\"测试布局\\",\\n \\"LayoutType\\": \\"studio\\",\\n \\"MediaInputConfigList\\": [\\n {\\n \\"ChannelId\\": \\"RV01\\",\\n \\"FillMode\\": \\"none\\",\\n \\"HeightNormalized\\": 0.4,\\n \\"Id\\": \\"k12kj31****\\",\\n \\"ImageMaterialId\\": \\"lkajsdfsa8fd89asd8****\\",\\n \\"Index\\": 1,\\n \\"PositionNormalized\\": [\\n 0.1\\n ],\\n \\"PositionRefer\\": \\"topLeft\\",\\n \\"VideoResourceId\\": \\"asdfasdfasdfasdfa****\\",\\n \\"WidthNormalized\\": 0.4\\n }\\n ],\\n \\"ScreenInputConfigList\\": [\\n {\\n \\"AudioConfig\\": {\\n \\"ValidChannel\\": \\"1\\",\\n \\"VolumeRate\\": 1\\n },\\n \\"ChannelId\\": \\"RV01\\",\\n \\"Color\\": \\"green\\",\\n \\"HeightNormalized\\": 0.4,\\n \\"Id\\": \\"k12kj31****\\",\\n \\"Index\\": 1,\\n \\"OnlyAudio\\": true,\\n \\"PortraitType\\": 0,\\n \\"PositionX\\": \\"0.1\\",\\n \\"PositionY\\": \\"0.2\\",\\n \\"VideoResourceId\\": \\"asdfasdfasdfasdfa****\\"\\n }\\n ]\\n }\\n ],\\n \\"Total\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DescribeStudioLayoutsResponse>\\n <RequestId>5c6a2a0d-f228-4a64-af62-20e91b9676b3</RequestId>\\n <StudioLayouts>\\n <BgImageConfig>\\n <Id>k12kj31****</Id>\\n <ImageUrl> http://example.org</ImageUrl>\\n <LocationId>RV01</LocationId>\\n <MaterialId>asdfas9df89asd8f9****</MaterialId>\\n </BgImageConfig>\\n <CommonConfig>\\n <ChannelId>RV01</ChannelId>\\n <VideoResourceId>asdfasdfasdfasdfa****</VideoResourceId>\\n </CommonConfig>\\n <LayerOrderConfigList>\\n <Id>k12kj31****</Id>\\n <Type>media</Type>\\n </LayerOrderConfigList>\\n <LayoutId>445409ec-7eaa-461d-8f29-4bec2eb9****</LayoutId>\\n <LayoutName>测试布局</LayoutName>\\n <LayoutType>studio</LayoutType>\\n <MediaInputConfigList>\\n <ChannelId>RV01</ChannelId>\\n <FillMode>none</FillMode>\\n <HeightNormalized>0.4</HeightNormalized>\\n <Id>k12kj31****</Id>\\n <ImageMaterialId>lkajsdfsa8fd89asd8****</ImageMaterialId>\\n <Index>1</Index>\\n <PositionNormalized>0.1</PositionNormalized>\\n <PositionRefer>topLeft</PositionRefer>\\n <VideoResourceId>asdfasdfasdfasdfa****</VideoResourceId>\\n <WidthNormalized>0.4</WidthNormalized>\\n </MediaInputConfigList>\\n <ScreenInputConfigList>\\n <AudioConfig>\\n <ValidChannel>1</ValidChannel>\\n <VolumeRate>1</VolumeRate>\\n </AudioConfig>\\n <ChannelId>RV01</ChannelId>\\n <Color>green</Color>\\n <HeightNormalized>0.4</HeightNormalized>\\n <Id>k12kj31****</Id>\\n <Index>1</Index>\\n <OnlyAudio>true</OnlyAudio>\\n <PortraitType>0</PortraitType>\\n <PositionX>0.1</PositionX>\\n <PositionY>0.2</PositionY>\\n <VideoResourceId>asdfasdfasdfasdfa****</VideoResourceId>\\n </ScreenInputConfigList>\\n </StudioLayouts>\\n <Total>1</Total>\\n</DescribeStudioLayoutsResponse>","errorExample":""}]', + 'title' => '查询虚拟演播厅布局', + 'description' => '先通过[AddStudioLayout接口](~~2848062~~)添加虚拟演播厅的布局设置，再调用本接口获取虚拟演播厅布局设置。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddCasterEpisode' => [ + 'summary' => '添加导播台节目。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ComponentId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '组件列表。按照元素顺序由下而上排列。'."\n" + ."\n" + .'如果您通过[AddCasterComponent接口](~~2848030~~)添加导播台组件，请查看AddCasterComponent接口调用返回的参数ComponentId值。'."\n" + ."\n" + .'- 当资源类型为**Component**时，参数有用且必传。'."\n" + .'- 当资源类型为**Resource**时，参数非必传，传入时表示组件与视频源绑定并同步切换。'."\n" + ."\n" + .'>N表示第几个组件ID。例如：**ComponentId.1**表示传入第一个组件ID；**ComponentId.2**表示传入第2个组件ID。', + 'type' => 'array', + 'items' => [ + 'description' => '组件ID', + 'type' => 'string', + 'required' => false, + 'example' => '21926b36-7dd2-4fde-ae25-51b5bc8e****', + ], + 'required' => false, + 'example' => '["a2b8e671-2fe5-4642-a2ec-bf93880e****"]', + 'maxItems' => 10, + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台**> **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'EpisodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型。 取值：'."\n" + .' '."\n" + .'- **Resource**：视频源。如果选择Resource类型，必须同时设置请求参数ResourceId和SwitchType。'."\n" + .'- **Component**：组件。'."\n" + .' ', + 'type' => 'string', + 'required' => true, + 'example' => 'Resource', + ], + ], + [ + 'name' => 'EpisodeName', + 'in' => 'query', + 'schema' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'episode_1', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频源ID。 '."\n" + .'><notice>当EpisodeType（节点类型）设为Resource时本参数有用且必传。'."\n" + .'></notice> '."\n" + .'如果您通过[AddCasterVideoResource接口](~~2848020~~)添加导播台视频源，请查看AddCasterVideoResourcer接口调用返回的参数ResourceId值。', + 'type' => 'string', + 'required' => false, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。 格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .' ', + 'type' => 'string', + 'required' => true, + 'example' => '2016-06-29T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。 格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .' ', + 'type' => 'string', + 'required' => true, + 'example' => '2016-06-29T09:10:00Z', + ], + ], + [ + 'name' => 'SwitchType', + 'in' => 'query', + 'schema' => [ + 'description' => '切换策略。取值： '."\n" + .'><notice>当EpisodeType（节点类型）设为Resource时本参数才有效。'."\n" + .'></notice>'."\n" + .' '."\n" + .'- **TimeFirst**：时间优先 。'."\n" + .'- **ContentFirst**：内容优先。'."\n" + ."\n" + .'>更多关于视频源的信息，请参见[添加视频源](~~66094~~)。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'TimeFirst', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EpisodeId' => [ + 'description' => '节目ID。可作为查询导播台节目单、修改导播台节目、删除导播台节目的请求参数。', + 'type' => 'string', + 'example' => '21926b36-7dd2-4fde-ae25-51b5bc8e****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'SwitchTypeInvalid.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectStartTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectEndTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'EpisodeConflict.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidComponent.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EpisodeId\\": \\"21926b36-7dd2-4fde-ae25-51b5bc8e****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<AddCasterEpisodeResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n\\t<EpisodeId>21926b36-7dd2-4fde-ae25-51b5bc8e****</EpisodeId>\\n</AddCasterEpisodeResponse>\\t","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"EpisodeId\\": \\"21926b36-7dd2-4fde-ae25-51b5bc8e52d8\\"\\n}"}]', + 'title' => '添加导播台节目', + 'description' => '调用本接口必须提前获取导播台ID。导播台ID在创建导播台后生成。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**路径查看导播台名称。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。'."\n" + ."\n" + .'## QPS权限'."\n" + .'本接口的单用户QPS限制为4次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCasterEpisode' => [ + 'summary' => '删除导播台节目。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + [ + 'name' => 'EpisodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '节目ID。如果您通过[AddCasterEpisode接口](~~2848068~~)添加导播台节目，请查看AddCasterEpisode接口调用返回的参数EpisodeId值。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf932738****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。可作为修改导播台节目的请求参数。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'EpisodeId' => [ + 'description' => '节目ID。可作为修改导播台节目的请求参数。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf932738****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectStartTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectEpisodeStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidEpisode.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\",\\n \\"EpisodeId\\": \\"a2b8e671-2fe5-4642-a2ec-bf932738****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCasterEpisodeResponse>\\n <CasterId>a2b8e671-2fe5-4642-a2ec-bf93880e****</CasterId>\\n <EpisodeId>a2b8e671-2fe5-4642-a2ec-bf932738****</EpisodeId>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteCasterEpisodeResponse>","errorExample":""}]', + 'title' => '删除导播台节目', + 'description' => '调用本接口删除导播台节目前必须先获取导播台ID和节目ID。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为4次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyCasterEpisode' => [ + 'summary' => '修改导播台节目配置，节目类型不允许修改。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ComponentId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '组件列表。'."\n" + .'按照元素顺序由下而上排列，组件将与视频源同步切换。'."\n" + ."\n" + .'- 当EpisodeType取值为**Component**视频源时，本参数才有用且必传。'."\n" + .'- 当EpisodeType取值为**Resource**组件时，表示组件与视频源绑定并同步切换。'."\n" + .'> N表示第几个组件ID。例如：ComponentId.1表示传入第一个组件ID；ComponentId.2表示传入第2个组件ID。', + 'type' => 'array', + 'items' => [ + 'description' => '组件列表。', + 'type' => 'string', + 'required' => false, + 'example' => '["16A96B9A-F203-4EC5-8E43-CB92E68F****"]', + ], + 'required' => false, + 'example' => '["16A96B9A-F203-4EC5-8E43-CB92E68F****"]', + 'maxItems' => 10, + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'EpisodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '节目ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf938623****', + ], + ], + [ + 'name' => 'EpisodeName', + 'in' => 'query', + 'schema' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'episode_name_1', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频源ID。 '."\n" + .' '."\n" + .'- 当EpisodeType取值为**Resource**视频源时，本参数才有用且必传。'."\n" + .'- 当EpisodeType取值为**Component**组件时，本参数不可用。', + 'type' => 'string', + 'required' => false, + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E683****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-29T09:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-29T10:20:00Z', + ], + ], + [ + 'name' => 'SwitchType', + 'in' => 'query', + 'schema' => [ + 'description' => '切换策略。 当EpisodeType取值为**Resource**视频源时有效。'."\n" + .' '."\n" + .'- **TimeFirst**：时间优先，直播类视频源只允许采用时间优先。 '."\n" + .'- **ContentFirst**：内容优先。', + 'type' => 'string', + 'required' => false, + 'example' => 'TimeFirst', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。可作为复制导播台场景配置、更新导播场景配置、查询导播台场景列表、查询导播台场景音频配置、启动导播台场景和停止导播台场景的请求参数。', + 'type' => 'string', + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + 'EpisodeId' => [ + 'description' => '节目ID。可作为删除导播台节目列表，创建或添加节目单项，删除节目单项，查询节目单项，编辑节目单，删除节目单，查询节目单，启动节目单，停止节目单的请求参数。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf938623****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'SwitchTypeInvalid.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectStartTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectEndTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectEpisodeStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'EpisodeConflict.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidEpisode.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidComponent.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterId\\": \\"LIVEPRODUCER_POST-cn-0pp1czt****\\",\\n \\"EpisodeId\\": \\"a2b8e671-2fe5-4642-a2ec-bf938623****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<ModifyCasterEpisodeResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n <EpisodeId>a2b8e671-2fe5-4642-a2ec-bf938623****</EpisodeId>\\n <CasterId>LIVEPRODUCER_POST-cn-0pp1czt****</CasterId>\\n</ModifyCasterEpisodeResponse>\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n}"}]', + 'title' => '修改导播台节目配置,节目类型不允许修改', + 'description' => '调用本接口修改导播台节目配置，节目类型不允许修改。'."\n" + ."\n\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为4次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddCasterEpisodeGroup' => [ + 'summary' => '添加导播台节目列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Item', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '节目列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节目对象。', + 'type' => 'object', + 'properties' => [ + 'ItemName' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'required' => false, + 'example' => '节目1', + ], + 'VodUrl' => [ + 'description' => '点播文件地址。'."\n" + ."\n" + .'如果您通过[DescribeCasterVideoResources接口](~~2848023~~)查询导播台视频源，请查看DescribeCasterVideoResources接口调用返回的参数VodUrl值。'."\n" + ."\n" + .'> 当且仅当资源为文件视频，且视频文件未导入素材库时使用。<br>'."\n" + .'支持MP4、FLV、TS格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://learn.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****.flv?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 150, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用户生成的请求token。用于保证请求的幂等性。'."\n" + ."\n" + .'><notice> 由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '8751ad99-2ddb-4aac-ad44-84b21102****', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2018-03-06T19:00:00Z', + ], + ], + [ + 'name' => 'RepeatNum', + 'in' => 'query', + 'schema' => [ + 'description' => '重复次数。取值：'."\n" + .'- **0**：不循环。'."\n" + .'- **-1**：无限循环。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'SideOutputUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义导播台旁路输出地址对应的推流地址。'."\n" + ."\n" + .'若该参数为空，则默认使用阿里云自动生成的输出地址对应的推流地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '用户回调地址。'."\n" + ."\n" + .'如果您通过[DescribeCasterConfig接口](~~2848011~~)查询导播台配置信息，请查看DescribeCasterConfig接口调用返回的参数CallbackUrl值。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ItemIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ItemId' => [ + 'description' => '节目ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节目ID。', + 'type' => 'string', + 'example' => '21926b36-7dd2-4fde-ae25-51b5bc98****', + ], + ], + ], + ], + 'ProgramId' => [ + 'description' => '节目单ID。可作为删除导播台节目列表，创建或添加节目单项，删除节目单项，查询节目单项，编辑节目单，删除节目单，查询节目单，启动节目单，停止节目单的请求参数。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68X****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'IncorrectStartTime', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ItemIds\\": {\\n \\"ItemId\\": [\\n \\"21926b36-7dd2-4fde-ae25-51b5bc98****\\"\\n ]\\n },\\n \\"ProgramId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68X****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<AddCasterEpisodeGroupResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n\\t<ProgramId>16A96B9A-F203-4EC5-8E43-CB92E68X****</ProgramId>\\n\\t<ItemIds>21926b36-7dd2-4fde-ae25-51b5bc8e****</ItemIds>\\n\\t<ItemIds>21926b36-7dd2-4fde-ae25-51b5bc98****</ItemIds>\\n</AddCasterEpisodeGroupResponse>\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"ProgramId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68XX876\\",\\n \\"ItemIds\\": [\\n \\"21926b36-7dd2-4fde-ae25-51b5bc8e52d8\\",\\n \\"21926b36-7dd2-4fde-ae25-51b5bc98765t\\"\\n ]\\n}"}]', + 'title' => '添加导播台节目列表', + 'description' => '先创建导播台和获取导播台配置信息，再调用本接口添加导播台节目列表。使用API创建导播台，请参见[创建导播台](~~2848009~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + ."\n" + .'本接口的单用户QPS限制为4次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCasterEpisodeGroup' => [ + 'summary' => '删除导播台节目列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProgramId', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单ID。如果您通过[AddCasterEpisodeGroup接口](~~2848071~~)添加导播台节目列表，请查看AddCasterEpisodeGroup接口调用返回的参数ProgramId值。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf932738****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DeleteCasterEpisodeGroupResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteCasterEpisodeGroupResponse>\\t\\n","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}"}]', + 'title' => '删除导播台节目列表', + 'description' => '先通过[AddCasterEpisodeGroup接口](~~2848071~~)添加导播台节目列表，再调用本接口删除导播台节目列表。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为4次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddCasterEpisodeGroupContent' => [ + 'summary' => '添加导播台节目列表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用户生成的请求token。用于保证请求的幂等性。'."\n" + ."\n" + .'> 由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。', + 'type' => 'string', + 'required' => true, + 'example' => '8751ad99-2ddb-4aac-ad44-84b21102****', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '设置导播台节目属性。JSON字符串格式。参数采用首字母大写驼峰格式。属性信息说明如下：'."\n" + .'- **CallbackUrl**：用户回调地址。'."\n" + .'- **SideOutputUrl**： 用户自定义旁路输出地址。'."\n" + .'- **RepeatNum**：重复次数。0表示不循环，-1表示无限循环。'."\n" + .'- **StartTime**：起始时间，格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'- **DomainName**：域名。'."\n" + .'- **Items**：节目列表。'."\n" + .' - **ItemName**：节目名称。'."\n" + .' - **VodUrl**：点播文件地址，当且仅当资源为文件视频，且视频文件未导入素材库时使用，支持MP4、FLV、TS格式。'."\n" + ."\n" + .' ', + 'type' => 'string', + 'required' => true, + 'example' => '{"CallbackUrl":"http://example.aliyundoc.com/callBackLive","SideOutputUrl":"rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****","DomainName":"developer.aliyundoc.com ","StartTime":"2018-03-26T16:00:00Z","RepeatNum":-1,"Items":[{"ItemName":"节目1","VodUrl":"http://learn.aliyundoc.com"},{"ItemName":"节目2","VodUrl":"http://demo.aliyundoc.com"}]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ItemIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ItemId' => [ + 'description' => '节目ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节目ID。', + 'type' => 'string', + 'example' => '21926b36-7dd2-4fde-ae25-51b5bc8e****', + ], + ], + ], + ], + 'ProgramId' => [ + 'description' => '节目单ID。可作为创建或添加节目单项，删除节目单项，查询节目单项，编辑节目单，删除节目单，查询节目单，启动节目单，停止节目单的请求参数。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68X****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'IncorrectStartTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidClientToken.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ItemIds\\": {\\n \\"ItemId\\": [\\n \\"21926b36-7dd2-4fde-ae25-51b5bc8e****\\"\\n ]\\n },\\n \\"ProgramId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68X****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"ProgramId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68XX876\\",\\n \\"ItemIds\\": [\\n \\"21926b36-7dd2-4fde-ae25-51b5bc8e52d8\\",\\n \\"21926b36-7dd2-4fde-ae25-51b5bc98765t\\"\\n ]\\n}"},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<AddCasterEpisodeGroupContentResponse>\\n\\t<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n\\t<ProgramId>16A96B9A-F203-4EC5-8E43-CB92E68X****</ProgramId>\\n\\t<ItemIds>21926b36-7dd2-4fde-ae25-51b5bc8e****</ItemIds>\\n\\t<ItemIds>21926b36-7dd2-4fde-ae25-51b5bc98****</ItemIds>\\n</AddCasterEpisodeGroupContentResponse>\\t\\n","errorExample":"Content 参数格式示例\\n {\\n \\"StartTime\\": \\"2018-04-02T19:00:00Z\\",\\n \\"DomainName\\": \\"XXX.XXX.XXX\\",\\n \\"RepeatNum\\":3,\\n \\"SideOutputUrl\\":\\"rtmp://XXXX/XXXX/XXXX\\",\\n \\"CallbackUrl\\":\\"http://XXXXXX/XXXXXXX\\",\\n \\"Items\\": [\\n {\\n \\"ItemName\\": \\"节目1\\",\\n \\"VodUrl\\": \\"http://XXXX/XXXXXX1.flv\\"\\n },\\n {\\n \\"ItemName\\": \\"节目2\\",\\n \\"VodUrl\\": \\"http://XXXX/XXXXXX2.mp4\\"\\n }\\n ]\\n }"}]', + 'title' => '添加导播台节目列表', + 'description' => '先创建导播台和添加导播台节目列表，再调用接口添加导播台节目列表信息。使用API创建导播台，请参见[创建导播台](~~2848009~~)。'."\n" + .' '."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为4次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddCasterProgram' => [ + 'summary' => '添加导播台节目单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Episode', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '节目单信息。', + 'type' => 'array', + 'items' => [ + 'description' => '节目单信息。', + 'type' => 'object', + 'properties' => [ + 'ComponentId' => [ + 'description' => '组件列表。按照元素顺序由下而上排列。'."\n" + .'><notice>当Episode.N.EpisodeType为**Component**时，本参数有用且必传。'."\n" + .'></notice>'."\n" + ."\n" + .' 当节点类型为**Resource**时，表示组件与视频源绑定并同步切换。', + 'type' => 'array', + 'items' => [ + 'description' => '组件ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf931826****', + ], + 'required' => false, + 'example' => '[ "a2b8e671-2fe5-4642-a2ec-bf931826****", "a2b8e671-2fe5-4642-a2ec-28374657****"]', + 'maxItems' => 10, + ], + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .' ', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-29T10:02:00Z', + ], + 'EpisodeName' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'program_name_1', + ], + 'EpisodeType' => [ + 'description' => '节点类型。 '."\n" + .' '."\n" + .'- **Resource**：视频源。如果选择Resource类型，必须同时设置请求参数Episode.N.ResourceId和Episode.N.SwitchType。'."\n" + .'- **Component**：组件。 如果选择Component类型，必须同时设置请求参数Episode.N.ComponentId.N。'."\n" + .' ', + 'type' => 'string', + 'required' => false, + 'example' => 'Resource', + ], + 'ResourceId' => [ + 'description' => '视频源ID。'."\n" + .'><notice>当Episode.N.EpisodeType为**Resource**时，本参数有用且必传。'."\n" + .'></notice> '."\n" + .' 当Episode.N.EpisodeType为**Component**时，本参数不可用。'."\n" + ."\n" + .'如果您通过[AddCasterVideoResource接口](~~60250~~)添加导播台视频源，请查看AddCasterVideoResource接口调用返回的参数ResourceId值。'."\n" + .' '."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'StartTime' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .' ', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-29T09:00:00Z', + ], + 'SwitchType' => [ + 'description' => '切换策略。取值：'."\n" + .'><notice>当Episode.N.EpisodeType为**Resource**时，本参数才有用。'."\n" + .'></notice>'."\n" + .' '."\n" + .'- **TimeFirst**：时间优先，直播类视频源只允许采用时间优先。 '."\n" + .'- **ContentFirst**：内容优先。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TimeFirst', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**路径查看导播台名称。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EpisodeIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EpisodeId' => [ + 'description' => '节目ID列表，列表中元素顺序和传入节目顺序保持一致。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EpisodeId' => [ + 'description' => '节目组ID。可作为修改导播台节目单，查询导播台节目单，删除导播台节目，修改导播台节目的请求参数。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'SwitchTypeInvalid.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectStartTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectEndTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'EpisodeConflict.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.EndTime', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidComponent.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EpisodeIds\\": {\\n \\"EpisodeId\\": [\\n {\\n \\"EpisodeId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddCasterProgramResponse>\\n <EpisodeIds>\\n <EpisodeId>[ \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\", \\"16A96B9A-F203-4EC5-8E43-CB92E688****\\" ]</EpisodeId>\\n </EpisodeIds>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</AddCasterProgramResponse>","errorExample":""}]', + 'title' => '添加导播台节目单', + 'description' => '请先创建导播台，添加导播台视频资源后再调用本接口添加导播台节目单。本接口目前只支持视频源和组件两种节点类型。使用API创建导播台，请参见[创建导播台](~~2848009~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' >请求参数中的N表示第几个的意思。例如：<br>Episode.N.EpisodeName表示传入第几个节目名称。Episode.1.EpisodeName表示传入第1个节目名称，Episode.2.EpisodeName表示传入第2个节目名称。'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCasterProgram' => [ + 'summary' => '查询导播台节目单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + ], + [ + 'name' => 'EpisodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '节目ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1872639A-F203-4EC5-8E43-CB92E68F****', + ], + ], + [ + 'name' => 'EpisodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型。取值：'."\n" + .' '."\n" + .'- **Resource**：视频源。'."\n" + .'- **Component**：组件。', + 'type' => 'string', + 'required' => false, + 'example' => 'Resource', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。 ', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-29T09:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-29T10:00:00Z', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页节目数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '节目状态。 取值：'."\n" + .' '."\n" + .'- **0**：未播放。'."\n" + .'- **1**：播放中。'."\n" + .'- **2**：播放完毕。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。', + 'type' => 'string', + 'example' => 'LIVEPRODUCER_POST-cn-0pp1czt****', + ], + 'Episodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Episode' => [ + 'description' => '节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点列表。', + 'type' => 'object', + 'properties' => [ + 'ComponentIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ComponentId' => [ + 'description' => '组件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '组件列表。', + 'type' => 'string', + 'example' => '["1872639A-F203-4EC5-8E43-CB929282****" ]', + ], + ], + ], + ], + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2016-06-29T10:02:00Z', + ], + 'EpisodeId' => [ + 'description' => '节目ID。', + 'type' => 'string', + 'example' => '1872639A-F203-4EC5-8E43-CB92E68F****', + ], + 'EpisodeName' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'example' => 'program_name_1', + ], + 'EpisodeType' => [ + 'description' => '节点类型。 取值：'."\n" + .'- **Resource**：视频源。'."\n" + .'- **Component**：组件。', + 'type' => 'string', + 'example' => 'Resource', + ], + 'ResourceId' => [ + 'description' => '视频源ID。', + 'type' => 'string', + 'example' => '1872639A-F203-4EC5-8E43-CB92E837****', + ], + 'StartTime' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2016-06-29T09:00:00Z', + ], + 'Status' => [ + 'description' => '节目状态。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SwitchType' => [ + 'description' => '切换策略。取值： '."\n" + ."\n" + .'- **TimeFirst**：时间优先，直播节目只允许采用时间优先。 '."\n" + .'- **ContentFirst**：内容优先。'."\n" + .' '."\n" + .' ', + 'type' => 'string', + 'example' => 'TimeFirst', + ], + ], + ], + ], + ], + ], + 'ProgramEffect' => [ + 'description' => '启用标志。 '."\n" + .' '."\n" + .'- **0**：不启用 。'."\n" + .'- **1**：启用。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProgramName' => [ + 'description' => '节目单名称。', + 'type' => 'string', + 'example' => 'programs_name', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'Total' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidPageNum.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Status', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterId\\": \\"LIVEPRODUCER_POST-cn-0pp1czt****\\",\\n \\"Episodes\\": {\\n \\"Episode\\": [\\n {\\n \\"ComponentIds\\": {\\n \\"ComponentId\\": [\\n \\"[\\\\\\"1872639A-F203-4EC5-8E43-CB929282****\\\\\\" ]\\"\\n ]\\n },\\n \\"EndTime\\": \\"2016-06-29T10:02:00Z\\",\\n \\"EpisodeId\\": \\"1872639A-F203-4EC5-8E43-CB92E68F****\\",\\n \\"EpisodeName\\": \\"program_name_1\\",\\n \\"EpisodeType\\": \\"Resource\\",\\n \\"ResourceId\\": \\"1872639A-F203-4EC5-8E43-CB92E837****\\",\\n \\"StartTime\\": \\"2016-06-29T09:00:00Z\\",\\n \\"Status\\": 0,\\n \\"SwitchType\\": \\"TimeFirst\\"\\n }\\n ]\\n },\\n \\"ProgramEffect\\": 1,\\n \\"ProgramName\\": \\"programs_name\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"Total\\": 1\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeCasterProgramResponse>\\n<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n<ProgramId>1872639A-F203-4EC5-8E43-CB92E68F****</ProgramId>\\n<ProgramName>programs_name</ProgramName>\\n<ProgramEffect>1</ProgramEffect>\\n<Episodes>\\n <EpisodeId>1872639A-F203-4EC5-8E43-CB92E68F****</EpisodeId>\\n <EpisodeType>Resource</EpisodeType>\\n <EpisodeName>program_name_1</EpisodeName>\\n <ResourceId>1872639A-F203-4EC5-8E43-CB92E837****</ResourceId>\\n <ComponentIds>1872639A-F203-4EC5-8E43-CB929282****</ComponentIds>\\n <StartTime>2016-06-29T09:00:00Z</StartTime>\\n <EndTime>2016-06-29T10:02:00Z</EndTime>\\n <Duration>120</Duration>\\n <SwitchType>TimeFirst</SwitchType>\\n</Episodes>\\n<Episodes>\\n <EpisodeId>1872639A-F203-4EC5-8E43-CB92E687****</EpisodeId>\\n <EpisodeType>Component</EpisodeType>\\n <ComponentIds>1872639A-F203-4EC5-8E43-CB625364****</ComponentIds>\\n <StartTime>2016-06-29T19:02:00Z</StartTime>\\n <EndTime>2016-06-29T19:04:00Z</EndTime>\\n</Episodes>\\n</DescribeCasterProgramResponse>","errorExample":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"ProgramId\\":\\"1872639A-F203-4EC5-8E43-CB92E68F8378\\",\\n \\"ProgramName\\": \\"programs_name\\",\\n \\"Episodes\\": [\\n {\\n \\"EpisodeId\\":\\"1872639A-F203-4EC5-8E43-CB92E68F8732\\",\\n \\"EpisodeType\\":\\"Resource\\",\\n \\"EpisodeName\\": \\"program_name_1\\",\\n \\"ResourceId\\":\\"1872639A-F203-4EC5-8E43-CB92E8374827\\",\\n \\"ComponentIds\\":[\\n \\"1872639A-F203-4EC5-8E43-CB9292827362\\"\\n ],\\n \\"StartTime\\": \\"2016-06-29T19:00:00Z\\",\\n \\"EndTime\\": \\"2016-06-29T19:02:00Z\\",\\n \\"Duration\\": 120.0,\\n \\"SwitchType\\": \\"TimeFirst\\"\\n },\\n {\\n \\"EpisodeId\\":\\"1872639A-F203-4EC5-8E43-CB92E6873726\\",\\n \\"EpisodeType\\":\\"Component\\",\\n \\"ComponentIds\\":[\\n \\"1872639A-F203-4EC5-8E43-CB6253647382\\"\\n ],\\n \\"StartTime\\": \\"2016-06-29T19:02:00Z\\",\\n \\"EndTime\\": \\"2016-06-29T19:04:00Z\\",\\n }\\n ]\\n}"}]', + 'title' => '查询导播台节目单', + 'description' => '调用本接口查询导播台节目单，本接口目前支持的节点类型为视频源和组件。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为4次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyCasterProgram' => [ + 'summary' => '修改导播台节目单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Episode', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '节目信息。', + 'type' => 'array', + 'items' => [ + 'description' => '节目信息。', + 'type' => 'object', + 'properties' => [ + 'ComponentId' => [ + 'description' => '组件列表。按照元素顺序由下而上排列，组件将与视频源同步切换'."\n" + ."\n" + .'- 当节点类型为**Component**时，本参数才有用且必传。'."\n" + .'- 当节点类型为**Resource**时，表示组件与视频源绑定并同步切换。', + 'type' => 'array', + 'items' => [ + 'description' => '组件列表。按照元素顺序由下而上排列，组件将与视频源同步切换'."\n" + ."\n" + .'- 当节点类型为**Component**时，本参数才有用且必传。'."\n" + .'- 当节点类型为**Resource**时，表示组件与视频源绑定并同步切换。', + 'type' => 'string', + 'required' => false, + 'example' => '["a2b8e671-2fe5-4642-a2ec-bf93888****" ]', + ], + 'required' => false, + 'example' => '["a2b8e671-2fe5-4642-a2ec-bf93888****" ]', + 'maxItems' => 10, + ], + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-29T10:04:00Z', + ], + 'EpisodeId' => [ + 'description' => '节目ID。如果您通过[AddCasterEpisode接口](~~2848068~~)添加导播台节目，请查看AddCasterEpisode接口调用返回的参数EpisodeId值。', + 'type' => 'string', + 'required' => false, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf938887****', + ], + 'EpisodeName' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'program_name_2', + ], + 'EpisodeType' => [ + 'description' => '节目类型。取值：'."\n" + ."\n" + .'- **Resource**：视频源。'."\n" + .'- **Component**：组件。', + 'type' => 'string', + 'required' => false, + 'example' => 'Resource', + ], + 'ResourceId' => [ + 'description' => '视频源ID。 如果您通过[AddCasterVideoResource接口](~~2848020~~)添加导播台视频源，请查看AddCasterVideoResource接口调用返回的参数ResourceId值。', + 'type' => 'string', + 'required' => false, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf938887****', + ], + 'StartTime' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-06-29T09:02:00Z', + ], + 'SwitchType' => [ + 'description' => '切换策略。 节点类型为**Resource**视频源时有效。'."\n" + .' '."\n" + .'- **TimeFirst**：时间优先，直播类视频源只允许采用时间优先。 '."\n" + .'- **ContentFirst**：内容优先。', + 'type' => 'string', + 'required' => false, + 'example' => 'TimeFirst', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'SwitchTypeInvalid.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectStartTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectEndTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectEpisodeStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'EpisodeConflict.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidResource.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidEpisode.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidComponent.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyCasterProgramResponse>\\n <CasterId>a2b8e671-2fe5-4642-a2ec-bf93880e****</CasterId>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</ModifyCasterProgramResponse>","errorExample":""}]', + 'title' => '修改导播台节目单', + 'description' => '先通过[AddCasterProgram接口](~~2848074~~)添加导播台节目单，再调用本接口修改导播台节目单。本接口目前支持的节目类型为视频源和组件。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为4次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '请求参数必须传一个要修改的节目内容，即至少一个Episode属性。'."\n" + .' > 请求参数中的N表示第几个的意思。例如：<br>Episode.N.EpisodeName表示传入第几个节目名称。Episode.1.EpisodeName表示传入第1个节目名称，Episode.2.EpisodeName表示传入第2个节目名称。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCasterProgram' => [ + 'summary' => '删除导播台节目单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**页面查看。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。可作为添加导播台节目、删除导播台节目、修改导播台节目的请求参数。', + 'type' => 'string', + 'example' => 'a2b8e671-2fe5-4642-a2ec-bf93880e****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterId\\": \\"a2b8e671-2fe5-4642-a2ec-bf93880e****\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCasterProgramResponse>\\n <CasterId>a2b8e671-2fe5-4642-a2ec-bf93880e****</CasterId>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteCasterProgramResponse>","errorExample":""}]', + 'title' => '删除导播台节目单', + 'description' => '先通过[CreateCaster接口](~~2848009~~)创建导播台，再调用本接口删除导播台节目单。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为4次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddPlaylistItems' => [ + 'summary' => '添加节目单项。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CasterId', + 'in' => 'query', + 'schema' => [ + 'description' => '导播台ID。'."\n" + ."\n" + .'- 如果您通过[CreateCaster接口](~~2848009~~)创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。'."\n" + ."\n" + .'- 如果您通过直播控制台创建导播台，请通过**直播控制台** > **导播台** > **云导播台**路径查看导播台名称。'."\n" + ."\n" + .'> 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。'."\n" + ."\n\n" + .'导播台需满足如下配置：'."\n" + .'- **NormType**：**3**。您需要提前创建好轻量级轮播型的导播台，可以调用**CreateCaster**接口创建导播台。'."\n" + .'- **CasterTemplate**：lp_noTranscode。'."\n" + .'- **channelEnable**：0。'."\n" + .'- **programEffect**：1。', + 'type' => 'string', + 'required' => true, + 'example' => '0e94d1f4-1a65-445c-9dcf-de8b3b8d****', + ], + ], + [ + 'name' => 'ProgramItems', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单项输入列表。为JSON字符串，更多信息，请参见**InputProgramItem**。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f****"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c****"}]', + ], + ], + [ + 'name' => 'ProgramId', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单ID。不填则默认创建一个新的节目单。', + 'type' => 'string', + 'required' => false, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'ProgramConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单项配置。若首次添加，传该参数进行初始化配置。更多信息，请参见**ProgramConfig**。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"RepeatNumber":"0","ProgramName":"my program"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => '添加节目单项信息列表。', + 'type' => 'object', + 'properties' => [ + 'FailedItems' => [ + 'description' => '添加失败的节目单项列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ItemId' => [ + 'description' => '节目单项ID。', + 'type' => 'string', + 'example' => 'c09f3d63-eacf-4fbf-bd48-a07a6ba7****', + ], + 'ItemName' => [ + 'description' => '节目单项名称。', + 'type' => 'string', + 'example' => 'item1', + ], + ], + ], + ], + 'SuccessItems' => [ + 'description' => '添加成功的节目单项列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ItemId' => [ + 'description' => '节目单项ID。', + 'type' => 'string', + 'example' => 'c09f3d63-eacf-4fbf-bd48-a07a6ba7****', + ], + 'ItemName' => [ + 'description' => '节目单项名称。', + 'type' => 'string', + 'example' => 'item2', + ], + ], + ], + ], + ], + ], + 'ProgramId' => [ + 'description' => '节目单ID。可作为删除节目单项，查询节目单项，编辑节目单，删除节目单，查询节目单，启动节目单，停止节目单的请求参数。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b96****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'PlayListIsEmpty', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissInputParams', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidProgramId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserQuotaExceed', + 'errorMessage' => 'Quota exceeded: %s.', + ], + ], + [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"FailedItems\\": [\\n {\\n \\"ItemId\\": \\"c09f3d63-eacf-4fbf-bd48-a07a6ba7****\\",\\n \\"ItemName\\": \\"item1\\"\\n }\\n ],\\n \\"SuccessItems\\": [\\n {\\n \\"ItemId\\": \\"c09f3d63-eacf-4fbf-bd48-a07a6ba7****\\",\\n \\"ItemName\\": \\"item2\\"\\n }\\n ]\\n },\\n \\"ProgramId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9****\\",\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b96****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddPlaylistItemsResponse>\\n <RequestId>5c6a2a0d-f228-4a64-af62-20e91b96****</RequestId>\\n <Items>\\n <FailedItems>\\n <ItemName>item2</ItemName>\\n <ItemId>c09f3d63-eacf-4fbf-bd48-a07a6ba7****</ItemId>\\n </FailedItems>\\n <SuccessItems>\\n <ItemName>item2</ItemName>\\n <ItemId>c09f3d63-eacf-4fbf-bd48-a07a6ba7****</ItemId>\\n </SuccessItems>\\n </Items>\\n <ProgramId>445409ec-7eaa-461d-8f29-4bec2eb9****</ProgramId>\\n</AddPlaylistItemsResponse>","errorExample":""}]', + 'title' => '添加播放列表项', + 'description' => '先创建导播台，添加导播台布局和导播台组件，再调用本接口添加节目单项。若没有创建过节目单，则直接创建。使用API创建导播台请参考[创建导播台](~~2848009~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '### InputProgramItem'."\n" + ."\n" + .'|参数名称|示例值|类型|描述|'."\n" + .'|--------|--------|--------|--------|'."\n" + .'|ItemName|item1|String|节目单项名称。|'."\n" + .'|ResourceType|vod|String|资源类型。取值：<br>**vod**：阿里云视频点播资源。<br>**url**：第三方视频资源。|'."\n" + .'|ResourceValue|5f8809f2-3352-4d1f-a8f7-86f9429f****|String|当ResourceType为vod时，ResourceValue为媒资ID。<br>当ResourceType为URL时，ResourceValue为第三方视频URL。|'."\n" + ."\n" + .'### ProgramConfig'."\n" + ."\n" + .'|参数名称|示例值|类型|描述|'."\n" + .'|--------|--------|--------|--------|'."\n" + .'|RepeatNumber|0|Integer|播放完后重复继续播放的次数。取值：<br>**0**（默认值）：不重复播放。<br>**-1**：一直循环重复。<br>其他正整数：播放完后重复继续播放的次数。|'."\n" + .'|ProgramName|myprogram|String|节目单名称。|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeletePlaylistItems' => [ + 'summary' => '删除节目单项。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProgramId', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单ID。如果您通过[AddPlaylistItems接口](~~2848078~~)添加节目单项，请查看AddPlaylistItems接口调用返回的参数ProgramId值。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'ProgramItemIds', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单项ID列表。', + 'type' => 'string', + 'required' => true, + 'example' => '["c09f3d63-eacf-4fbf-bd48-a07a6ba7****","c10f3d63-eacf-4fbf-bd48-a07a6ba7****"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ProgramId' => [ + 'description' => '节目单ID。可作为查询节目单项，编辑节目单，删除节目单，查询节目单，启动节目单，停止节目单的请求参数。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b96****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidProgramId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectPlaylistStatus.Inuse', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'PlayListIsEmpty', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'PlayListNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ProgramId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9****\\",\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b96****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DeletePlaylistItemsResponse>\\n <RequestId>5c6a2a0d-f228-4a64-af62-20e91b96****</RequestId>\\n <ProgramId>445409ec-7eaa-461d-8f29-4bec2eb9****</ProgramId>\\n</DeletePlaylistItemsResponse>","errorExample":""}]', + 'title' => '删除播放列表项目', + 'description' => '先通过[AddPlaylistItems接口](~~2848078~~)添加节目单项，再调用本接口删除节目单项。'."\n" + ."\n" + .'## QPS限制'."\n" + ."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListPlaylistItems' => [ + 'summary' => '查询指定节目单下的节目单项。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProgramId', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单ID。如果您通过[AddPlaylistItems接口](~~2848078~~)添加节目单项，请查看AddPlaylistItems接口调用返回的参数ProgramId值。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'ProgramItemIds', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单项ID列表。用英文逗号（,）隔开。'."\n" + .'如果传该参数，则只返回指定节目单项的信息。若不传，则返回该节目单所有节目单项的信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'c10f3d63-eacf-4fbf-bd48-a07a6ba7****,c09f3d63-eacf-4fbf-bd48-a07a6ba7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '节目单项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b9****', + ], + 'ProgramItems' => [ + 'description' => '节目单列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => '编排索引。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'vod', + ], + 'ProgramItemId' => [ + 'description' => '节目单项ID。', + 'type' => 'string', + 'example' => 'c10f3d63-eacf-4fbf-bd48-a07a6ba7****', + ], + 'ProgramId' => [ + 'description' => '节目单ID。可作为编辑节目单，删除节目单，查询节目单，启动节目单，停止节目单的请求参数。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + 'ProgramItemName' => [ + 'description' => '节目单项名称。', + 'type' => 'string', + 'example' => 'playlistItem1', + ], + 'ResourceValue' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'asdfasdf8as9df8sa9df89****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidProgramId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'PlayListNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Total\\": 1,\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b9****\\",\\n \\"ProgramItems\\": [\\n {\\n \\"Index\\": 1,\\n \\"ResourceType\\": \\"vod\\",\\n \\"ProgramItemId\\": \\"c10f3d63-eacf-4fbf-bd48-a07a6ba7****\\",\\n \\"ProgramId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9****\\",\\n \\"ProgramItemName\\": \\"playlistItem1\\",\\n \\"ResourceValue\\": \\"asdfasdf8as9df8sa9df89****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<ListPlaylistItemsResponse>\\n <RequestId>5c6a2a0d-f228-4a64-af62-20e91b9****</RequestId>\\n <ProgramItems>\\n <ProgramItemName>playlistItem1</ProgramItemName>\\n <ResourceValue>asdfasdf8as9df8sa9df89****</ResourceValue>\\n <ProgramItemId>c10f3d63-eacf-4fbf-bd48-a07a6ba7****</ProgramItemId>\\n <Index>1</Index>\\n <ResourceType>vod</ResourceType>\\n <ProgramId>445409ec-7eaa-461d-8f29-4bec2eb9****</ProgramId>\\n </ProgramItems>\\n <Total>1</Total>\\n</ListPlaylistItemsResponse>","errorExample":""}]', + 'title' => '列出播放列表项', + 'description' => '先通过[AddPlaylistItems接口](~~2848078~~)添加节目单项，再调用本接口查询指定节目单下的节目单项。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EditPlaylist' => [ + 'summary' => '编辑节目单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProgramId', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单ID。如果您通过[AddPlaylistItems接口](~~2848078~~)添加节目单项，请查看AddPlaylistItems接口调用返回的参数ProgramId值。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'ProgramItems', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单项输入列表。为JSON字符串，更多信息，请参见**InputProgramItem**。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f****"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c****"}]', + ], + ], + [ + 'name' => 'ProgramConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单项配置。更多信息，请参见**ProgramConfig**。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"RepeatNumber":"0","ProgramName":"my program"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '导播台ID。可作为添加回调和添加虚拟演播厅布局的请求参数。', + 'type' => 'string', + 'example' => '0e94d1f4-1a65-445c-9dcf-de8b3b8d****', + ], + 'Items' => [ + 'description' => '添加节目单项信息列表。', + 'type' => 'object', + 'properties' => [ + 'FailedItems' => [ + 'description' => '添加失败的节目单项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '添加失败的节目单项列表。', + 'type' => 'object', + 'properties' => [ + 'ItemId' => [ + 'description' => '节目单项ID。', + 'type' => 'string', + 'example' => 'c09f3d63-eacf-4fbf-bd48-a07a6ba7****', + ], + 'ItemName' => [ + 'description' => '节目单项名称。', + 'type' => 'string', + 'example' => 'item2', + ], + ], + ], + ], + 'SuccessItems' => [ + 'description' => '添加成功的节目单项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '添加成功的项目列表。', + 'type' => 'object', + 'properties' => [ + 'ItemId' => [ + 'description' => '节目单项ID。', + 'type' => 'string', + 'example' => 'c09f3d63-eacf-4fbf-bd48-a07a6ba7****', + ], + 'ItemName' => [ + 'description' => '节目单项名称。', + 'type' => 'string', + 'example' => 'item1', + ], + ], + ], + ], + ], + ], + 'ProgramId' => [ + 'description' => '节目单ID。可作为删除节目单，查询节目单，启动节目单，停止节目单的请求参数。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b96****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidProgramId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'PlayListIsEmpty', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissInputParams', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectPlaylistStatus.Inuse', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'PlayListNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CasterId\\": \\"0e94d1f4-1a65-445c-9dcf-de8b3b8d****\\",\\n \\"Items\\": {\\n \\"FailedItems\\": [\\n {\\n \\"ItemId\\": \\"c09f3d63-eacf-4fbf-bd48-a07a6ba7****\\",\\n \\"ItemName\\": \\"item2\\"\\n }\\n ],\\n \\"SuccessItems\\": [\\n {\\n \\"ItemId\\": \\"c09f3d63-eacf-4fbf-bd48-a07a6ba7****\\",\\n \\"ItemName\\": \\"item1\\"\\n }\\n ]\\n },\\n \\"ProgramId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9****\\",\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b96****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<EditPlaylistResponse>\\n <RequestId>5c6a2a0d-f228-4a64-af62-20e91b96****</RequestId>\\n <Items>\\n <FailedItems>\\n <ItemName>item2</ItemName>\\n <ItemId>c09f3d63-eacf-4fbf-bd48-a07a6ba7****</ItemId>\\n </FailedItems>\\n <SuccessItems>\\n <ItemName>item1</ItemName>\\n <ItemId>c09f3d63-eacf-4fbf-bd48-a07a6ba7****</ItemId>\\n </SuccessItems>\\n </Items>\\n <ProgramId>445409ec-7eaa-461d-8f29-4bec2eb9****</ProgramId>\\n <CasterId>0e94d1f4-1a65-445c-9dcf-de8b3b8d****</CasterId>\\n</EditPlaylistResponse>","errorExample":""}]', + 'title' => '编辑播放列表', + 'description' => '本接口为全量编辑，主要用于编辑配置信息或替换大量节目单项。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '### InputProgramItem'."\n" + .'|参数名称|示例值|类型|描述|'."\n" + .'|--------|--------|--------|--------|'."\n" + .'|ItemName|item1|String|节目单项名称。|'."\n" + .'|ResourceType|vod|String|资源类型。取值：<br>**vod**，暂时只支持点播资源。|'."\n" + .'|ResourceValue|5f8809f2-3352-4d1f-a8f7-86f9429f****|String|资源ID。|'."\n" + ."\n" + .'### ProgramConfig'."\n" + .'|参数名称|示例值|类型|描述|'."\n" + .'|--------|--------|--------|--------|'."\n" + .'|RepeatNumber|0|Integer|播放完后重复继续播放的次数。取值：<br>**0**（默认值）：不重复播放。<br>**-1**：一直循环重复。<br>其他正整数：播放完后重复继续播放的次数。|'."\n" + .'|ProgramName|myprogram|String|节目单名称。|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeletePlaylist' => [ + 'summary' => '删除整个节目单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProgramId', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单ID。如果您通过[AddPlaylistItems接口](~~2848078~~)添加节目单项，请查看AddPlaylistItems接口调用返回的参数ProgramId值。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ProgramId' => [ + 'description' => '节目单ID。可作为查询节目单，启动节目单和停止节目单的请求参数。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b96****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectPlaylistStatus.Inuse', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidProgramId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'PlayListNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ProgramId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9****\\",\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b96****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DeletePlaylistResponse>\\n <RequestId>5c6a2a0d-f228-4a64-af62-20e91b96****</RequestId>\\n <ProgramId>445409ec-7eaa-461d-8f29-4bec2eb9****</ProgramId>\\n</DeletePlaylistResponse>","errorExample":""}]', + 'title' => '删除播放列表', + 'description' => '先通过[AddPlaylistItems接口](~~2848078~~)添加节目单项，再调用本接口删除整个节目单。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListPlaylist' => [ + 'summary' => '查询节目单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProgramId', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单ID。如果填此参数，则返回该节目单信息。若不填，默认返回该用户所有节目单信息。'."\n" + .'如果您通过[AddPlaylistItems接口](~~2848078~~)添加节目单项，请查看AddPlaylistItems接口调用返回的参数ProgramId值。', + 'type' => 'string', + 'required' => false, + 'example' => 'c09f3d63-eacf-4fbf-bd48-a07a6ba7****', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '查询分页页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '查询分页每页数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ProgramList' => [ + 'description' => '节目单信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CasterId' => [ + 'description' => '节目单对应导播台ID。可作为添加虚拟演播厅布局、删除虚拟演播厅布局、修改虚拟演播厅布局和查询虚拟演播厅布局的请求参数。', + 'type' => 'string', + 'example' => 'casdfasdfasfdasdflkasjdflaj****', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'ProgramId' => [ + 'description' => '节目单ID。', + 'type' => 'string', + 'example' => 'c09f3d63-eacf-4fbf-bd48-a07a6ba7****', + ], + 'ProgramName' => [ + 'description' => '节目单名称。', + 'type' => 'string', + 'example' => 'playlist1', + ], + 'RepeatNumber' => [ + 'description' => '播放完后继续重复播放的次数。取值：'."\n" + .'- **0**（默认值）：不重复播放。'."\n" + .'- **-1**：一直循环重复。'."\n" + .'- 其他正整数：播放完1遍后继续重复播放的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Status' => [ + 'description' => '节目单状态。取值：'."\n" + .'- **0**：停止。'."\n" + .'- **1**：运行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b96****', + ], + 'Total' => [ + 'description' => '节目单数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPageSize.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidPageNum.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + 404 => [ + [ + 'errorCode' => 'PlayListNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ProgramList\\": [\\n {\\n \\"CasterId\\": \\"casdfasdfasfdasdflkasjdflaj****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"ProgramId\\": \\"c09f3d63-eacf-4fbf-bd48-a07a6ba7****\\",\\n \\"ProgramName\\": \\"playlist1\\",\\n \\"RepeatNumber\\": 1,\\n \\"Status\\": 1\\n }\\n ],\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b96****\\",\\n \\"Total\\": 1\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<ListPlaylistResponse>\\n<ProgramList>\\n <Status>1</Status>\\n <RepeatNumber>1</RepeatNumber>\\n <DomainName>example.com</DomainName>\\n <ProgramId>c09f3d63-eacf-4fbf-bd48-a07a6ba7****</ProgramId>\\n <CasterId>casdfasdfasfdasdflkasjdflaj****</CasterId>\\n <ProgramName>playlist1</ProgramName>\\n</ProgramList>\\n<RequestId>5c6a2a0d-f228-4a64-af62-20e91b96****</RequestId>\\n<Total>1</Total>\\n</ListPlaylistResponse>","errorExample":""}]', + 'title' => '获取播放列表', + 'description' => '先通过[AddPlaylistItems接口](~~2848078~~)添加节目单项，再调用本接口查询节目单。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StartPlaylist' => [ + 'summary' => '启动整个节目单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProgramId', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单ID。如果您通过[AddPlaylistItems接口](~~2848078~~)添加节目单项，请查看AddPlaylistItems接口调用返回的参数ProgramId值。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'ResumeMode', + 'in' => 'query', + 'schema' => [ + 'description' => '重启模式。取值：'."\n" + .'- **Restart**：从头开始。'."\n" + .'- **Continue**：根据停止前播放位置继续。如果**ResumeMode**参数设置为**Custom**时，请求参数**StartItemId**才必填。'."\n" + .'- **Custom**：自定义。', + 'type' => 'string', + 'required' => false, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'StartItemId', + 'in' => 'query', + 'schema' => [ + 'description' => '起始节目单项ID。启动轮播时将先播放此节目单项。'."\n" + .'><notice> 如果**ResumeMode**参数设置为**Custom**时，此参数才必传。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'asdfasdfasdf****', + ], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => [ + 'description' => '启动偏移。视频文件起始偏移值。仅对文件视频有效， 单位：毫秒。'."\n" + ."\n" + .'大于0，表示从相对于首帧的偏差时间作为开始读取的位置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ProgramId' => [ + 'description' => '节目单ID。可作为停止节目单的请求参数。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b96****', + ], + 'StreamInfo' => [ + 'description' => '返回的流信息。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'StreamName' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'Streams' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Stream' => [ + 'description' => '流信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PullFlvUrl' => [ + 'description' => 'FLV播流地址。', + 'type' => 'string', + 'example' => 'http://aliyundoc.com/caster/liveStream****.flv?auth_key=1612772224-0-0-3632be7cd9907169e8b09e91099c****', + ], + 'PullM3U8Url' => [ + 'description' => 'RTMP播流地址。', + 'type' => 'string', + 'example' => 'rtmp:///aliyundoc.com/caster/liveStream****?auth_key=1612772224-0-0-4404ca59c0246226d49d01f734b1****', + ], + 'PullRtmpUrl' => [ + 'description' => 'm3u8播流地址。', + 'type' => 'string', + 'example' => 'http://aliyundoc.com/caster/liveStream****.m3u8?auth_key=1612772224-0-0-919a023a127156fe82e3562c3b3b****', + ], + 'Quality' => [ + 'description' => '画质。取值：'."\n" + .'**original**：原画。', + 'type' => 'string', + 'example' => 'original', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IncorrectSceneStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectCasterStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectSceneStatus.Inuse', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidProgramId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidNormType.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Offset', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.StartItemId', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserQuotaExceed', + 'errorMessage' => 'Quota exceeded: %s.', + ], + ], + [ + [ + 'errorCode' => 'PlayListNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'PlayListItemNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterTemplate.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectCasterStatus.EnableChannel', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ProgramId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9****\\",\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b96****\\",\\n \\"StreamInfo\\": {\\n \\"AppName\\": \\"liveApp****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"Streams\\": {\\n \\"Stream\\": [\\n {\\n \\"PullFlvUrl\\": \\"http://aliyundoc.com/caster/liveStream****.flv?auth_key=1612772224-0-0-3632be7cd9907169e8b09e91099c****\\",\\n \\"PullM3U8Url\\": \\"rtmp:///aliyundoc.com/caster/liveStream****?auth_key=1612772224-0-0-4404ca59c0246226d49d01f734b1****\\",\\n \\"PullRtmpUrl\\": \\"http://aliyundoc.com/caster/liveStream****.m3u8?auth_key=1612772224-0-0-919a023a127156fe82e3562c3b3b****\\",\\n \\"Quality\\": \\"original\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<StartPlaylistResponse>\\n <ProgramId>445409ec-7eaa-461d-8f29-4bec2eb9****</ProgramId>\\n <RequestId>5c6a2a0d-f228-4a64-af62-20e91b96****</RequestId>\\n <StreamInfo>\\n <AppName>liveApp****</AppName>\\n <DomainName>example.com</DomainName>\\n <StreamName>liveStream****</StreamName>\\n <Streams>\\n <PullFlvUrl>http://aliyundoc.com/caster/liveStream****.flv?auth_key=1612772224-0-0-3632be7cd9907169e8b09e91099c****</PullFlvUrl>\\n <PullM3U8Url>rtmp:///aliyundoc.com/caster/liveStream****?auth_key=1612772224-0-0-4404ca59c0246226d49d01f734b1****</PullM3U8Url>\\n <PullRtmpUrl>http://aliyundoc.com/caster/liveStream****.m3u8?auth_key=1612772224-0-0-919a023a127156fe82e3562c3b3b****</PullRtmpUrl>\\n <Quality>original</Quality>\\n </Streams>\\n </StreamInfo>\\n</StartPlaylistResponse>","errorExample":""}]', + 'title' => '开始播放列表项', + 'description' => '先通过[AddPlaylistItems接口](~~2848078~~)添加节目单项，再调用本接口启动整个节目单。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopPlaylist' => [ + 'summary' => '停止整个节目单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProgramId', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单ID。如果您通过[AddPlaylistItems接口](~~2848078~~)添加节目单项，请查看AddPlaylistItems接口调用返回的参数ProgramId值。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ProgramId' => [ + 'description' => '节目单ID。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b96****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidProgramId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'PlayListNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ProgramId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9****\\",\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b96****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<StopPlaylistResponse>\\n<RequestId>5c6a2a0d-f228-4a64-af62-20e91b96****</RequestId>\\n<ProgramId>445409ec-7eaa-461d-8f29-4bec2eb9****</ProgramId>\\n</StopPlaylistResponse>","errorExample":""}]', + 'title' => '停止节目单', + 'description' => '先通过[AddPlaylistItems接口](~~2848078~~)添加节目单项，再调用本接口停止整个节目单。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateMixStream' => [ + 'summary' => '创建合流任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveI16NIW', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。'."\n" + .'><notice>目前仅支持华东2（cn-shanghai）和华北2（cn-beijing）两个区域的域名。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'LayoutId', + 'in' => 'query', + 'schema' => [ + 'description' => '布局ID。取值： '."\n" + .'- **MixStreamLayout-1-1**'."\n" + .'- **MixStreamLayout-2-1**'."\n" + .'- **MixStreamLayout-2-2**'."\n" + .'- **MixStreamLayout-2-3**'."\n" + .'- **MixStreamLayout-3-1**'."\n" + .'- **MixStreamLayout-3-2**'."\n" + .'- **MixStreamLayout-4-1**'."\n" + .'- **USERDEFINED**（非上述预设布局，固定取值**USERDEFINED**）'."\n" + .'> 更多信息请参见[合流预设布局参考](~~199359~~)', + 'type' => 'string', + 'required' => true, + 'example' => 'MixStreamLayout-1-1', + ], + ], + [ + 'name' => 'InputStreamList', + 'in' => 'query', + 'schema' => [ + 'description' => '合流输入列表。JSON数组。'."\n" + ."\n" + .'参考下方的**InputStreamConfig**。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"LayoutChildId":1,"ResourceType":"live","ResourceValue":"rtmp://example.net/live/f2139ec2b8d6a191068cd****ea9064d?auth_key=1600947017-0-0-0b5645fe35d21a65ab92b394bd4d****","LayoutConfig":{"FillMode":"fit","PositionRefer":"topLeft","FillPositionNormalized":[0,0],"FillSizeNormalized":[1,1]}}]', + ], + ], + [ + 'name' => 'OutputConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '合流输出配置。格式为JSON字符串。'."\n" + ."\n" + .'参考下方的**OutputConfig**。', + 'type' => 'string', + 'required' => true, + 'example' => '{"AppName":"liveApp****","StreamName":"9a78fb3f5c508be0122746f677a3****","MixStreamTemplate":"lp_hd_v","ExpireDuration":"86400"}', + ], + ], + [ + 'name' => 'CallbackConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '回调地址。JSON数组。'."\n" + .'当事件产生时，直播服务端会向该地址发起HTTP POST请求，具体内容将通过HTTP Body送达。', + 'type' => 'string', + 'required' => false, + 'example' => '{"CallbackUrl":"http://aliyundoc.com"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MixStreamId' => [ + 'description' => '合流任务ID。可作为查询合流任务列表和删除合流任务的请求参数。', + 'type' => 'string', + 'example' => '5b2a046e-74d7-385e-253f-8a5b87e4****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0D715397-2E66-4AE1-694h-C546628AD145', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MixStreamAlreadyExist', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MixStreamNotExist', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'UserQuotaExceed', + 'errorMessage' => 'Quota exceeded: %s.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MixStreamId\\": \\"5b2a046e-74d7-385e-253f-8a5b87e4****\\",\\n \\"RequestId\\": \\"0D715397-2E66-4AE1-694h-C546628AD145\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateMixStreamResponse>\\n <MixStreamId>5b2a046e-74d7-385e-253f-8a5b87e4****</MixStreamId>\\n <RequestId>0D715397-2E66-4AE1-694h-C546628AD145</RequestId>\\n</CreateMixStreamResponse>","errorExample":""}]', + 'title' => '创建合流任务', + 'description' => '><notice>云端合流属于收费功能，当前为公测阶段，您可以免费使用，公测结束后将正常收费，具体时间另行通知。></notice>'."\n" + .'调用本接口创建合流任务，目前本接口支持的布局类型为预设布局和自定义布局。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '### InputStreamConfig'."\n" + ."\n" + .'|名称 |类型 |描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'|ResourceType|String|资源类型。<br>**live**：直播流地址。 <br>**url**：文件流地址。 |'."\n" + .'|ResourceValue|String|资源地址。<br>如果ResourceType为live，则为直播流地址。直播流地址支持RTMP、FLV和HLS协议，不支持ARTC协议。 <br>如果ResourceType为url，则为文件流地址。 |'."\n" + .'|LayoutChildId|String|布局方格对应ID（也代表合流的叠加顺序）。 |'."\n" + .'|LayoutConfig |LayoutConfig[] |JSON数组，代表所在位置、填充方式等布局信息。<br>如果使用预设布局，则此参数可以不填。<br>如果设置了该值，则忽略LayoutChildId对应的预设布局信息。|'."\n" + ."\n" + .'### LayoutConfig'."\n" + ."\n" + .'|名称 |类型 |必选 |描述 |'."\n" + .'| ------------- |------------ |------------ | ----- |'."\n" + .'|FillSizeNormalized|JSON浮点数组|必选|表示该Layer元素需要填充的尺寸大小。 <br>[w,h]：w、h取值范围[0-1]。其中宽高都是进行了归一化计算。<br>例如：[0.2,0.3]代表水平占比20%，垂直占比30%。 |'."\n" + .'|FillPositionNormalized|浮点数数组|必选|表示该Layer元素填充区位置归一化值。 <br>[x,y]：x、y的取值范围[0-1]。<br>例如：[0.1,0.1]代表左上角水平偏移10%， 垂直偏移10%。 |'."\n" + .'|PositionRefer|字符串|可选|设置元素的position参考坐标值。 <br>建议设置topLeft，代表左上角。|'."\n" + .'|FillMode|字符串|可选|设置元素填充方式。 <br>**none**：不填充。 <br>**fit**：缩放填充保证最长的边达到边界，而最短的边可能需要加黑边。 <br>**fill**：先按照宽和高的最大比例值进行等比缩放，然后进行crop，保证全部填充。 <br>建议设置为fit。 |'."\n" + ."\n" + .'### OutputConfig'."\n" + ."\n" + .'|名称 |类型 |必选 |描述 |'."\n" + .'| ------------- |------------ |------------ | ----- |'."\n" + .'|AppName |String |是 |输出App名。不支持#、?等特殊字符。 |'."\n" + .'|StreamName |String |是 |输出流名。不支持#、?等特殊字符。 |'."\n" + .'|MixStreamTemplate |String |是 |合流输出规格模板ID （在传参时仅传模板ID，例如lp_ld）。<br>支持：<br>lp_ld（分辨率：640x360），<br>lp_sd（分辨率：854x480），<br>lp_hd（分辨率：1280x720），<br>lp_ud（分辨率：1920x1080），<br>lp_ld_v（分辨率：640x360），<br>lp_sd_v（分辨率：854x480），<br>lp_hd_v（分辨率：1280x720），<br>lp_ud_v（分辨率：1920x1080） ，<br>lp_ld_v_optm（分辨率：640x360），<br>lp_sd_v_optm（分辨率：854x480），<br>lp_hd_v_optm（分辨率：1280x720），<br>lp_ud_v_optm（分辨率：1920x1080）。<br>_v表示竖屏模板，_optm表示低延迟模板，括号里表示模板的分辨率。|'."\n" + .'|ExpireDuration|Long|可选|任务过期时间。单位：秒。取值范围：**1**~**31536000**（1年）。<br>如果不设置默认7天过期清理任务。 |', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 增加合流事件回调示例'."\n" + .'- 合流创建成功'."\n" + .'```'."\n" + .'{'."\n" + .'"EventMessage":'."\n" + .' {'."\n" + .' "StreamName":"liveStream****",//合流输出流名'."\n" + .' "Message":"",'."\n" + .' "DomainName":"example.com",'."\n" + .' "MixstreamId":"5b2a046e-74d7-385e-253f-8a5b87e4****",//合流任务ID'."\n" + .' "Code":"Success",'."\n" + .' "AppName":"liveApp****"//合流输出App名'."\n" + .' },'."\n" + .'"EventType":"MixstreamStartCallback",'."\n" + .'"MessageMd5":"7c7b1d9480ae892lkasjdflkasjbd****",'."\n" + .'"CasterId":""}'."\n" + .' ```'."\n" + .'- 合流创建失败'."\n" + .'```'."\n" + .'{"EventMessage":'."\n" + .' {'."\n" + .' "StreamName":"liveStream****",'."\n" + .' "Message":"MixStreamAlreadyExist",'."\n" + .' "DomainName":"example.com",'."\n" + .' "Code":"Error",'."\n" + .' "AppName":"liveApp****"'."\n" + .' },'."\n" + .'"EventType":"MixstreamStartCallback",'."\n" + .'"MessageMd5":"7c7b1d9480ae892lkasjdflkasjbd****",'."\n" + .'"CasterId":""'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'### SDK示例'."\n" + .'详细示例，请参见[合流代码示例](https://help.aliyun.com/document_detail/199362.html)。', + ], + 'UpdateMixStream' => [ + 'summary' => '更新合流任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107287', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。'."\n" + .'><notice>目前仅支持华东2（cn-shanghai）和华北2（cn-beijing）两个区域的域名。'."\n" + .'></notice>'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'MixStreamId', + 'in' => 'query', + 'schema' => [ + 'description' => '合流任务ID。如果您通过[CreateMixStream接口](~~2848087~~)创建合流任务，请查看CreateMixStream接口调用返回的参数MixStreamId值。', + 'type' => 'string', + 'required' => true, + 'example' => '5b2a046e-74d7-385e-d2d7-8a5b87e4****', + ], + ], + [ + 'name' => 'InputStreamList', + 'in' => 'query', + 'schema' => [ + 'description' => '合流输入列表，JSON数组。'."\n" + ."\n" + .'参考下方的**InputStreamConfig**。', + 'type' => 'string', + 'required' => true, + 'example' => '{"InputStreamList":[{"LayoutConfig":{"FillSizeNormalized":[0.5,0.5],"FillPositionNormalized":[0,0],"PositionRefer":"topLeft","FillMode":"fit"},"LayoutChildId":1,"ResourceValue":"rtmp://aliyundoc.com/caster/8564a8d1659b4dc69df5f66cf4c9****","ResourceType":"live"},{"LayoutConfig":{"FillSizeNormalized":[0.5,0.5],"FillPositionNormalized":[0.5,0],"PositionRefer":"topLeft","FillMode":"fit"},"LayoutChildId":2,"ResourceValue":"http://developer.aliyundoc.com/3c3c25426cf744fdb90423e76b78a28a/69b1a16e2b1d423d9841bf27a96f134e-0b1cba51f58bb5ad3a854x96a2c735f****.mp4","ResourceType":"url"},{"LayoutConfig":{"FillSizeNormalized":[1,0.5],"FillPositionNormalized":[0,0.5],"PositionRefer":"topLeft","FillMode":"fit"},"LayoutChildId":3,"ResourceValue":"http://aliyundoc.com/c0c6c5446b56432389e91535864938da/ed4adc5263b4474c954b95607a5350ae-fda757b3328438a8cf-4k57f373a0f0****.mp4","ResourceType":"url"}]}', + ], + ], + [ + 'name' => 'LayoutId', + 'in' => 'query', + 'schema' => [ + 'description' => '布局ID。支持： '."\n" + .'- **MixStreamLayout-1-1**'."\n" + .'- **MixStreamLayout-2-1**'."\n" + .'- **MixStreamLayout-2-2**'."\n" + .'- **MixStreamLayout-2-3**'."\n" + .'- **MixStreamLayout-3-1**'."\n" + .'- **MixStreamLayout-3-2**'."\n" + .'- **MixStreamLayout-4-1**'."\n" + .'- **USERDEFINED**（非上述预设布局，取固定值**USERDEFINED**）'."\n" + .'> 更多信息请参见[合流预设布局参考](~~199361~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'MixStreamLayout-3-2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MixStreamId' => [ + 'description' => '合流任务ID。可作为查询合流任务列表和删除合流任务的请求参数。', + 'type' => 'string', + 'example' => '5b2a046e-74d7-385e-d2d7-8a5b87e4****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1A8CDDFF-0121-4ABB-DA60-AEF095A8W34F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MixStreamAlreadyExist', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MixStreamNotExist', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MixStreamId\\": \\"5b2a046e-74d7-385e-d2d7-8a5b87e4****\\",\\n \\"RequestId\\": \\"1A8CDDFF-0121-4ABB-DA60-AEF095A8W34F\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateMixStreamResponse>\\n <MixStreamId>5b2a046e-74d7-385e-d2d7-8a5b87e4****</MixStreamId>\\n <RequestId>1A8CDDFF-0121-4ABB-DA60-AEF095A8W34F</RequestId>\\n</UpdateMixStreamResponse>","errorExample":""}]', + 'title' => '更新合流任务', + 'description' => '调用本接口更新合流任务。本接口目前支持更新输入源以及布局，不支持更新输出分辨率等内容。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '### InputStreamConfig'."\n" + ."\n" + .'|名称 |类型 |描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'|ResourceType|String|资源类型。<br>**live**：直播流地址。 <br>**url**：文件流地址。 |'."\n" + .'|ResourceValue|String|资源地址。<br>如果ResourceType为live，则为直播流地址。直播流地址支持RTMP、FLV和ARTC协议，不支持HLS协议。 <br>如果ResourceType为url，则为文件流地址。 |'."\n" + .'|LayoutChildId|String|布局方格对应ID（也代表合流的叠加顺序）。 |'."\n" + .'|LayoutConfig |LayoutConfig[] |JSON数组，代表所在位置、填充方式等布局信息。<br>如果使用预设布局，则此参数可以不填。<br>如果设置了该值，则忽略LayoutChildId对应的预设布局信息。|'."\n" + ."\n" + .'### LayoutConfig'."\n" + ."\n" + .'|名称 |类型 |必选 |描述 |'."\n" + .'| ------------- |------------ |------------ | ----- |'."\n" + .'|FillSizeNormalized|JSON浮点数组|必选|表示该Layer元素需要填充的尺寸大小。 <br>[w,h]：w、h取值范围[0-1]。其中宽高都是进行了归一化计算。<br>例如：[0.2,0.3]代表水平占比20%，垂直占比30%。 |'."\n" + .'|FillPositionNormalized|浮点数数组|必选|表示该Layer元素填充区位置归一化值。 <br>[x,y]：x、y的取值范围[0-1]。<br>例如：[0.1,0.1]代表左上角水平偏移10%， 垂直偏移10%。 |'."\n" + .'|PositionRefer|字符串|可选|设置元素的position参考坐标值。 <br>建议设置topLeft，代表左上角。|'."\n" + .'|FillMode|字符串|可选|设置元素填充方式。 <br>**none**：不填充。 <br>**fit**：缩放填充保证最长的边达到边界，而最短的边可能需要加黑边。 <br>**fill**：先按照宽和高的最大比例值进行等比缩放，然后进行crop，保证全部填充。 <br>建议设置为fit。 |', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### SDK示例'."\n" + .'详细示例，请参见[合流代码示例](https://help.aliyun.com/document_detail/199362.html)。', + ], + 'DescribeMixStreamList' => [ + 'summary' => '查询合流任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveI16NIW', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'App名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '合流任务的流名。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'MixStreamId', + 'in' => 'query', + 'schema' => [ + 'description' => '合流任务ID。如果您通过[CreateMixStream接口](~~2848087~~)创建合流任务，请查看CreateMixStream接口调用返回的参数MixStreamId值。', + 'type' => 'string', + 'required' => false, + 'example' => '5b2a046e-74d7-385e-d2d7-8a5b87e4****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-09-11T12:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-09-20T13:00:00Z', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。大于**0**且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页可展示的记录数。默认值为**1000**。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MixStreamList' => [ + 'description' => '合流任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '合流任务列表。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => 'App名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'DomainName' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'GmtCreate' => [ + 'description' => '合流任务创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2020-09-17T08:39:14Z', + ], + 'GmtModified' => [ + 'description' => '合流任务修改时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2020-09-17T08:39:15Z', + ], + 'InputStreamNumber' => [ + 'description' => '输入源个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'LayoutId' => [ + 'description' => '布局ID。', + 'type' => 'string', + 'example' => 'USERDEFINED', + ], + 'MixStreamTemplate' => [ + 'description' => '合流输出模板。', + 'type' => 'string', + 'example' => 'lp_ld', + ], + 'MixstreamId' => [ + 'description' => '合流任务ID。可作为删除合流任务的请求参数。', + 'type' => 'string', + 'example' => 'aaf9a50f-c460-3a9b-f180-38dd8f05****', + ], + 'StreamName' => [ + 'description' => '合流任务的流名。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC1E78D3-FA8B-4457-DEE2-6093E1232254', + ], + 'Total' => [ + 'description' => '任务总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MixStreamList\\": [\\n {\\n \\"AppName\\": \\"liveApp****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"GmtCreate\\": \\"2020-09-17T08:39:14Z\\",\\n \\"GmtModified\\": \\"2020-09-17T08:39:15Z\\",\\n \\"InputStreamNumber\\": 2,\\n \\"LayoutId\\": \\"USERDEFINED\\",\\n \\"MixStreamTemplate\\": \\"lp_ld\\",\\n \\"MixstreamId\\": \\"aaf9a50f-c460-3a9b-f180-38dd8f05****\\",\\n \\"StreamName\\": \\"liveStream****\\"\\n }\\n ],\\n \\"RequestId\\": \\"BC1E78D3-FA8B-4457-DEE2-6093E1232254\\",\\n \\"Total\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DescribeMixStreamListResponse>\\n <MixStreamList>\\n <AppName>liveApp****</AppName>\\n <DomainName>example.com</DomainName>\\n <GmtCreate>2020-09-17T08:39:14Z</GmtCreate>\\n <GmtModified>2020-09-17T08:39:15Z</GmtModified>\\n <InputStreamNumber>2</InputStreamNumber>\\n <LayoutId>USERDEFINED</LayoutId>\\n <MixStreamTemplate>lp_ld</MixStreamTemplate>\\n <MixstreamId>aaf9a50f-c460-3a9b-f180-38dd8f05****</MixstreamId>\\n <StreamName>liveStream****</StreamName>\\n </MixStreamList>\\n <RequestId>BC1E78D3-FA8B-4457-DEE2-6093E1232254</RequestId>\\n <Total>1</Total>\\n</DescribeMixStreamListResponse>","errorExample":""}]', + 'title' => '查询合流任务列表', + 'description' => '先通过[CreateMixStream接口](~~2848087~~)创建合流任务，再调用本接口查询合流任务列表。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '### MixStreamInfo'."\n" + .'| 名称 | 类型 | 描述 |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'|MixStreamId |String |合流任务ID。|'."\n" + .'|DomainName |String |主播流域名。|'."\n" + .'|AppName |String |App名称。|'."\n" + .'|StreamName |String |合流任务的流名。|'."\n" + .'|LayoutId |String |布局ID。|'."\n" + .'|InputStreamNumber |Integer |输入源个数。|'."\n" + .'|MixStreamTemplate |String |合流任务模板。|'."\n" + .'|GmtCreate |String |创建时间，格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。|'."\n" + .'|GmtModified |String |修改时间，格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。|', + 'extraInfo' => '### SDK示例'."\n" + .'详细示例，请参见[合流代码示例](https://help.aliyun.com/document_detail/199362.html)。', + ], + 'DeleteMixStream' => [ + 'summary' => '删除合流任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveI16NIW', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'App名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '合流任务的流名。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'MixStreamId', + 'in' => 'query', + 'schema' => [ + 'description' => '合流任务ID。如果您通过[CreateMixStream接口](~~2848087~~)创建合流任务，请查看CreateMixStream接口调用返回的参数MixStreamId值。', + 'type' => 'string', + 'required' => true, + 'example' => '749b7594-86d6-37b1-513b-e1e19845****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MixStreamId' => [ + 'description' => '合流任务ID。', + 'type' => 'string', + 'example' => '749b7594-86d6-37b1-513b-e1e19845****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BE9407FF-F897-4DBD-338D-98A750AD805F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'MixStreamAlreadyExist', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MixStreamNotExist', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MixStreamId\\": \\"749b7594-86d6-37b1-513b-e1e19845****\\",\\n \\"RequestId\\": \\"BE9407FF-F897-4DBD-338D-98A750AD805F\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteMixStreamResponse>\\n <MixStreamId>749b7594-86d6-37b1-513b-e1e19845****</MixStreamId>\\n <RequestId>BE9407FF-F897-4DBD-338D-98A750AD805F</RequestId>\\n</DeleteMixStreamResponse>","errorExample":""}]', + 'title' => '删除合流任务', + 'description' => '先通过[CreateMixStream接口](~~2848087~~)创建合流任务，再调用本接口删除合流任务。当您不需要使用某条合流后，请删除此条合流，否则合流将一直处于输出状态。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### SDK示例'."\n" + .'详细示例，请参见[合流代码示例](https://help.aliyun.com/document_detail/199362.html)。', + ], + 'CreateCustomTemplate' => [ + 'summary' => '创建合流自定义模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveI16NIW', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'CustomTemplate', + 'in' => 'query', + 'schema' => [ + 'description' => 'JSON格式{height:xxx,scale:xxx,gop:xxx,bframes:xxx,cdesc:xxx}，所有字段均必填，缺少其中任意字段会调用失败。'."\n" + ."\n" + .'> 具体参数请参考下表**CustomTemplate说明**。', + 'type' => 'string', + 'required' => true, + 'example' => '{"height":"1060","scale":"[16:9]","gop":"60","bframes":"30","cdesc":"h264"}', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'schema' => [ + 'description' => '需要添加的模板名。'."\n" + .'>请在创建时记录模板名，用于使用、查询和删除操作。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'TestTemplate', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0D715397-2E66-4AE1-694h-C546628AD145', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'TemplateAlreadyExist', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'CustomTemplateInvalid', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0D715397-2E66-4AE1-694h-C546628AD145\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateCustomTemplateResponse>\\n <RequestId>0D715397-2E66-4AE1-694h-C546628AD145</RequestId>\\n</CreateCustomTemplateResponse>","errorExample":""}]', + 'title' => '创建合流自定义模板', + 'description' => '调用本接口创建好自定义模板后，请记录模板名。通过[CreateMixStream接口](~~2848087~~)创建合流任务时，MixStreamTemplate传入模板名来使用自定义模板。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '**CustomTemplate说明**'."\n" + .'|名称 |类型 |必选 |描述 |'."\n" + .'| ---------|------- |------ | ----------- |'."\n" + .'|height|String|必选|输出分辨率的高。<br>scale为16:9时最大支持1920x1080。<br>scale为4:3时最大支持1440x1080 。|'."\n" + .'|scale|String|必选|输出分辨率高宽比。只能接受 String 取值如下：<br> [3:4]<br> [4:3] <br>[16:9] <br>[9:16]|'."\n" + .'|bframes|String|必选|输出流b帧数。取值需要大于0小于9。|'."\n" + .'|cdesc|String|必选|编码格式。只能取值 h264。|'."\n" + .'|gop|String|必选|关键帧间隔。取值大于25小于250。|'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCustomTemplate' => [ + 'summary' => '删除合流自定义模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106913', + 'abilityTreeNodes' => [ + 'FEATUREliveI16NIW', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名String，需要删除的模板名。', + 'type' => 'string', + 'required' => true, + 'example' => 'TestTemplate', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC1E78D3-FA8B-4457-DEE2-6093E1232254', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'CustomTemplateInvalid', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC1E78D3-FA8B-4457-DEE2-6093E1232254\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCustomTemplateResponse>\\n <RequestId>BC1E78D3-FA8B-4457-DEE2-6093E1232254</RequestId>\\n</DeleteCustomTemplateResponse>","errorExample":""}]', + 'title' => '删除合流自定义模板', + 'description' => '先获取需要删除的模板名，再调用本接口删除合流自定义模板。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetCustomTemplate' => [ + 'summary' => '获取合流自定义模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveI16NIW', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名String，需要查询的自定义模板名。', + 'type' => 'string', + 'required' => true, + 'example' => 'TestTemplate', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC1E78D3-FA8B-4457-DEE2-6093E1232254', + ], + 'CustomTemplate' => [ + 'description' => '模板配置。', + 'type' => 'string', + 'example' => '{height:1080,scale:[16:9],gop:60,bframes:30,cdesc:h264}', + ], + 'Template' => [ + 'description' => '模板名。', + 'type' => 'string', + 'example' => 'TestTemplate', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'CustomTemplateInvalid', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BC1E78D3-FA8B-4457-DEE2-6093E1232254\\",\\n \\"CustomTemplate\\": \\"{height:1080,scale:[16:9],gop:60,bframes:30,cdesc:h264}\\",\\n \\"Template\\": \\"TestTemplate\\"\\n}","errorExample":""},{"type":"xml","example":"<GetCustomTemplateResponse>\\n <RequestId>BC1E78D3-FA8B-4457-DEE2-6093E1232254</RequestId>\\n <CustomTemplate>{height:1080,scale:[16:9],gop:60,bframes:30,cdesc:h264}</CustomTemplate>\\n <Template>TestTemplate</Template>\\n</GetCustomTemplateResponse>","errorExample":""}]', + 'title' => '获取自定义合流模板', + 'description' => '先获取需要查询的自定义模板名，再调用本接口获取合流自定义模板。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetAllCustomTemplates' => [ + 'summary' => '获取全量自定义合流模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveI16NIW', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '25346073170691****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CustomTemplates' => [ + 'description' => '模板名和模板配置列表。', + 'type' => 'string', + 'example' => ' [{"templateConfig": "{\\"cdesc\\":\\"H264\\",\\"scale\\":\\"[3:4]\\",\\"gop\\":\\"1\\",\\"bframes\\":\\"1\\",\\"height\\":\\"1080\\"}","templateName": "custom1"},{"templateConfig": "{\\"ar\\":\\"44100\\",\\"cdesc\\":\\"H264\\",\\"scale\\":\\"[3:4]\\",\\"gop\\":\\"1\\",\\"bframes\\":\\"1\\",\\"height\\":\\"1080\\"}","templateName": "cus"}]', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4791648Q-813C-6254-865C-0ED913661230', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'CustomTemplateInvalid', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CustomTemplates\\": \\" [{\\\\\\"templateConfig\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"cdesc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"H264\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"scale\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[3:4]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"gop\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bframes\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"height\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1080\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"templateName\\\\\\": \\\\\\"custom1\\\\\\"},{\\\\\\"templateConfig\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"ar\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"44100\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cdesc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"H264\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"scale\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[3:4]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"gop\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bframes\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"height\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1080\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"templateName\\\\\\": \\\\\\"cus\\\\\\"}]\\",\\n \\"RequestId\\": \\"4791648Q-813C-6254-865C-0ED913661230\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAllCustomTemplatesResponse>\\n <CustomTemplates> [{\\"templateConfig\\": \\"{\\\\\\"cdesc\\\\\\":\\\\\\"H264\\\\\\",\\\\\\"scale\\\\\\":\\\\\\"[3:4]\\\\\\",\\\\\\"gop\\\\\\":\\\\\\"1\\\\\\",\\\\\\"bframes\\\\\\":\\\\\\"1\\\\\\",\\\\\\"height\\\\\\":\\\\\\"1080\\\\\\"}\\",\\"templateName\\": \\"custom1\\"},{\\"templateConfig\\": \\"{\\\\\\"ar\\\\\\":\\\\\\"44100\\\\\\",\\\\\\"cdesc\\\\\\":\\\\\\"H264\\\\\\",\\\\\\"scale\\\\\\":\\\\\\"[3:4]\\\\\\",\\\\\\"gop\\\\\\":\\\\\\"1\\\\\\",\\\\\\"bframes\\\\\\":\\\\\\"1\\\\\\",\\\\\\"height\\\\\\":\\\\\\"1080\\\\\\"}\\",\\"templateName\\": \\"cus\\"}]</CustomTemplates>\\n <RequestId>4791648Q-813C-6254-865C-0ED913661230</RequestId>\\n</GetAllCustomTemplatesResponse>","errorExample":""}]', + 'title' => '获取全量自定义合流模板', + 'description' => '通过调用本接口获取全量自定义合流模板。返回模板名和模板配置列表。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddLiveStreamWatermark' => [ + 'summary' => '调用AddLiveStreamWatermark添加水印模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveCT0GRQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '水印类型。取值：'."\n" + ."\n" + .'- **0**：图片。'."\n" + ."\n" + .'- **1**：文字（目前只支持图片）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '水印名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'livewatermark****', + ], + ], + [ + 'name' => 'RefWidth', + 'in' => 'query', + 'schema' => [ + 'description' => '参考背景视频宽，单位：px。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1920', + ], + ], + [ + 'name' => 'RefHeight', + 'in' => 'query', + 'schema' => [ + 'description' => '参考背景视频高，单位：px。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1080', + ], + ], + [ + 'name' => 'XOffset', + 'in' => 'query', + 'schema' => [ + 'description' => '⽔印X轴偏移，单位：px。'."\n" + .'>相对于参考背景宽RefWidth， 如果选择的是TopLeft，那么XOffset是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置X。其中坐标指向背景视频中⼼的⽅向为正⽅向，即X轴的正⽅向是向右。', + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '50.0', + ], + ], + [ + 'name' => 'YOffset', + 'in' => 'query', + 'schema' => [ + 'description' => '⽔印Y轴偏移，单位：px。'."\n" + .'>相对于参考背景⾼RefHeight，如果选择的是TopLeft，那么YOffset是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置Y。其中坐标指向背景视频中⼼的⽅向为正⽅向，即Y轴的正⽅向是向下。', + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '100.0', + ], + ], + [ + 'name' => 'Height', + 'in' => 'query', + 'schema' => [ + 'description' => '水印图片高度，单位：px。对比参考背景RefHeight，最终按照⽐例进⾏⾃适应缩放为准。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '200', + ], + ], + [ + 'name' => 'Transparency', + 'in' => 'query', + 'schema' => [ + 'description' => '水印透明度，数值越小越透明。取值：0~255。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '255', + ], + ], + [ + 'name' => 'OffsetCorner', + 'in' => 'query', + 'schema' => [ + 'description' => '位置。取值：'."\n" + ."\n" + .'- TopLeft：左上。'."\n" + ."\n" + .'- TopRight：右上。'."\n" + ."\n" + .'- BottomLeft：左下。'."\n" + ."\n" + .'- BottomRight：右下。', + 'type' => 'string', + 'required' => true, + 'example' => 'TopRight', + ], + ], + [ + 'name' => 'PictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '水印图片链接。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://example.com', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义水印描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'my watermark', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.aliyundoc.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => '水印模板ID。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64- af62-20e91b96****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TemplateId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9****\\",\\n \\"RequestId\\": \\"5c6a2a0df228-4a64- af62-20e91b96****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddLiveStreamWatermarkResponse>\\n<RequestId>5c6a2a0df228-4a64- af62-20e91b9676b3</RequestId>\\n<TemplateId>445409ec-7eaa-461d-8f29-4bec2eb9****</TemplateId>\\n</AddLiveStreamWatermarkResponse>","errorExample":""}]', + 'title' => '添加⽔印模板', + 'description' => '- 本接口支持添加直播⽔印模板配置，模板配置支持描述⽔印内容、布局等信息。'."\n" + ."\n" + .'- 添加水印模板后，您还需要调用[AddLiveStreamWatermarkRule](~~2848100~~)接口添加水印规则，重新推流后，播流中才能带水印。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveStreamWatermark' => [ + 'summary' => '调用DeleteLiveStreamWatermark删除指定⽔印模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveCT0GRQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '水印模板ID。'."\n" + .'>可查看[AddLiveStreamWatermark](~~2848096~~)接口返回参数值获取TemplateId。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64-af62-20e91b******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0df228-4a64-af62-20e91b******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveStreamWatermarkResponse>\\r\\n <RequestId>5c6a2a0df228-4a64-af62-20e91b9676b3</RequestId>\\r\\n</DeleteLiveStreamWatermarkResponse>","errorExample":""}]', + 'title' => '删除⽔印模板', + 'description' => '本接口支持删除直播指定TemplateId的⽔印模板。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateLiveStreamWatermark' => [ + 'summary' => '调用UpdateLiveStreamWatermark更新水印模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveCT0GRQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '水印模板ID。'."\n" + .'>可查看[AddLiveStreamWatermark](~~2848096~~)接口返回参数值获取TemplateId。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '水印名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'livewatermark****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义水印描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'my watermark', + ], + ], + [ + 'name' => 'RefWidth', + 'in' => 'query', + 'schema' => [ + 'description' => '参考背景视频宽，单位：px。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1920', + ], + ], + [ + 'name' => 'RefHeight', + 'in' => 'query', + 'schema' => [ + 'description' => '参考背景视频高，单位：px。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1080', + ], + ], + [ + 'name' => 'XOffset', + 'in' => 'query', + 'schema' => [ + 'description' => '⽔印X轴偏移，单位：px。'."\n" + .'>相对于参考背景宽RefWidth， 如果选择的是TopLeft，那么XOffset是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置X。其中坐标指向背景视频中⼼的⽅向为正⽅向，即X轴的正⽅向是向右。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '50.0', + ], + ], + [ + 'name' => 'YOffset', + 'in' => 'query', + 'schema' => [ + 'description' => '⽔印Y轴偏移，单位：px。'."\n" + .'>相对于参考背景⾼RefHeight，如果选择的是TopLeft，那么YOffset是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置Y。其中坐标指向背景视频中⼼的⽅向为正⽅向，即Y轴的正⽅向是向下。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '100.0', + ], + ], + [ + 'name' => 'Height', + 'in' => 'query', + 'schema' => [ + 'description' => '水印图片高度，单位：px。对比参考背景RefHeight，最终按照⽐例进⾏⾃适应缩放为准。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'Transparency', + 'in' => 'query', + 'schema' => [ + 'description' => '水印透明度，数值越小越透明。取值：0~255。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '255', + ], + ], + [ + 'name' => 'OffsetCorner', + 'in' => 'query', + 'schema' => [ + 'description' => '位置。取值：'."\n" + ."\n" + .'- TopLeft：左上。'."\n" + ."\n" + .'- TopRight：右上。'."\n" + ."\n" + .'- BottomLeft：左下。'."\n" + ."\n" + .'- BottomRight：右下。', + 'type' => 'string', + 'required' => false, + 'example' => 'TopRight', + ], + ], + [ + 'name' => 'PictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '水印图片链接。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64-af62-20e91b9676b3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0df228-4a64-af62-20e91b9676b3\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveStreamWatermarkResponse>\\r\\n <RequestId>5c6a2a0df228-4a64-af62-20e91b9676b3</RequestId>\\r\\n</UpdateLiveStreamWatermarkResponse>","errorExample":""}]', + 'title' => '更新水印模板', + 'description' => '本接口支持对指定TemplateId的⽔印模板各项参数进⾏更新调整。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DynamicUpdateWaterMarkStreamRule' => [ + 'summary' => '调用DynamicUpdateWaterMarkStreamRule动态更新水印。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveCT0GRQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'pull.aliyundoc.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'Stream', + 'in' => 'query', + 'schema' => [ + 'description' => '水印流名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '水印模板ID，可调用[DescribeLiveStreamWatermarks](~~2848102~~)接口获取可用的水印模板ID。'."\n" + .'>此参数TemplateId用于替换直播过程中的水印模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '749b7594-86d6-37b1-513b-e1e19845****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BE9407FF-F897-4DBD-338D-98A750AD805F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BE9407FF-F897-4DBD-338D-98A750AD805F\\"\\n}","errorExample":""},{"type":"xml","example":"<DynamicUpdateWaterMarkStreamRuleResponse>\\r\\n<RequestId>BE9407FF-F897-4DBD-338D-98A750AD805F</RequestId>\\r\\n</DynamicUpdateWaterMarkStreamRuleResponse>","errorExample":""}]', + 'title' => '动态更新水印', + 'description' => '动态更新水印是指在直播过程中替换水印模板ID。'."\n" + .'调用本接口更新水印前需准备用于替换的水印模板ID，用于定义本接口中**TemplateId**参数。您可以调用[DescribeLiveStreamWatermarks](~~2848102~~)接口获取可用的水印模板ID。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamWatermarks' => [ + 'summary' => '调用DescribeLiveStreamWatermarks查询水印模板列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveCT0GRQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'live.yourdomain.com', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词。模板ID或名称，名称支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页数。不传默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每⻚模板数值，不传默认为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '水印模板信息。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '符合条件的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64- af62-20e91b9676b3', + ], + 'WatermarkList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Watermark' => [ + 'description' => '水印模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '水印模板列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '水印类型。'."\n" + ."\n" + .'- 0：图片（目前只支持图片）。'."\n" + ."\n" + .'- 1：文字。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'XOffset' => [ + 'description' => '⽔印X轴偏移，单位：px。'."\n" + .'>相对于参考背景宽RefWidth， 如果选择的是TopLeft，那么XOffset是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置X。其中坐标指向背景视频中⼼的⽅向为正⽅向，即X轴的正⽅向是向右。', + 'type' => 'number', + 'format' => 'float', + 'example' => '50.0', + ], + 'RefWidth' => [ + 'description' => '参考背景视频宽，单位：px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1920', + ], + 'YOffset' => [ + 'description' => '⽔印Y轴偏移，单位：px。'."\n" + .'>相对于参考背景⾼RefHeight，如果选择的是TopLeft，那么YOffset是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置Y。其中坐标指向背景视频中⼼的⽅向为正⽅向，即Y轴的正⽅向是向下。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100.0', + ], + 'Height' => [ + 'description' => '水印图片高度，单位：px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RefHeight' => [ + 'description' => '参考背景视频高，单位：px。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1080', + ], + 'PictureUrl' => [ + 'description' => '水印图片链接。', + 'type' => 'string', + 'example' => 'http://example.com', + ], + 'Transparency' => [ + 'description' => '水印透明度，数值越小越透明。取值：0~255。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + ], + 'Description' => [ + 'description' => '自定义水印描述信息。', + 'type' => 'string', + 'example' => 'my watermark', + ], + 'OffsetCorner' => [ + 'description' => '水印位置。'."\n" + .'- TopLeft：左上。'."\n" + ."\n" + .'- TopRight：右上。'."\n" + ."\n" + .'- BottomLeft：左下。'."\n" + ."\n" + .'- BottomRight：右下。', + 'type' => 'string', + 'example' => 'TopRight', + ], + 'RuleCount' => [ + 'description' => 'Domain下配置的水印规则数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Name' => [ + 'description' => '水印名称。', + 'type' => 'string', + 'example' => 'livewatermark****', + ], + 'TemplateId' => [ + 'description' => '水印模板ID。'."\n", + 'type' => 'string', + 'example' => '445409ec-7eaa-4 61d-8f29-4bec2eb9 ****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Total\\": 100,\\n \\"RequestId\\": \\"5c6a2a0df228-4a64- af62-20e91b9676b3\\",\\n \\"WatermarkList\\": {\\n \\"Watermark\\": [\\n {\\n \\"Type\\": 0,\\n \\"XOffset\\": 50,\\n \\"RefWidth\\": 1920,\\n \\"YOffset\\": 100,\\n \\"Height\\": 200,\\n \\"RefHeight\\": 1080,\\n \\"PictureUrl\\": \\"http://example.com\\",\\n \\"Transparency\\": 255,\\n \\"Description\\": \\"my watermark\\",\\n \\"OffsetCorner\\": \\"TopRight\\",\\n \\"RuleCount\\": 12,\\n \\"Name\\": \\"livewatermark****\\",\\n \\"TemplateId\\": \\"445409ec-7eaa-4 61d-8f29-4bec2eb9 ****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamWatermarksResponse>\\n <Total>100</Total>\\n <RequestId>5c6a2a0df228-4a64- af62-20e91b9676b3</RequestId>\\n <WatermarkList>\\n <Watermark>\\n <Type>0</Type>\\n <XOffset>50</XOffset>\\n <RefWidth>1920</RefWidth>\\n <YOffset>100</YOffset>\\n <Height>200</Height>\\n <RefHeight>1080</RefHeight>\\n <PictureUrl>http://example.com</PictureUrl>\\n <Transparency>255</Transparency>\\n <Description>my watermark</Description>\\n <OffsetCorner>TopRight</OffsetCorner>\\n <RuleCount>12</RuleCount>\\n <Name>livewatermark****</Name>\\n <TemplateId>445409ec-7eaa-4 61d-8f29-4bec2eb9 ****</TemplateId>\\n </Watermark>\\n </WatermarkList>\\n</DescribeLiveStreamWatermarksResponse>","errorExample":""}]', + 'title' => '查询水印模板列表', + 'description' => '本接口支持指定分⻚参数查询水印模板列表信息，调用时请保证参数设置符合要求。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddLiveStreamWatermarkRule' => [ + 'summary' => '调用AddLiveStreamWatermarkRule添加水印规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveCT0GRQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'WatermarkRule****', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.aliyundoc.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'Stream', + 'in' => 'query', + 'schema' => [ + 'description' => '流名称。规则如下：'."\n" + ."\n" + .'- 直接写流名称则仅匹配该流名称。示例：liveStreamA。'."\n" + ."\n" + .'- 可进行模糊匹配，`*`匹配所有流。'."\n" + ."\n" + .'- 可进行前匹配和后匹配。'."\n" + ."\n" + .'>- 模糊匹配格式说明：模糊匹配下的`*`要求有且仅有一个，只能在最前或最后，且匹配项需要`()`包围，多个匹配项用竖线`|`分隔。'."\n" + .'>- 示例：`*(t1|t2) `匹配所有后缀为`t1`或`t2`的流` (abc|123)*`匹配所有前缀为`abc`或者`123`的流。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStreamA', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '水印模板ID。'."\n" + .'>可查看[AddLiveStreamWatermark](~~2848096~~)接口返回参数值获取TemplateId。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'my rule', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RuleId' => [ + 'description' => '水印规则ID。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64-af62-20e91b96****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RuleId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9****\\",\\n \\"RequestId\\": \\"5c6a2a0df228-4a64-af62-20e91b96****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddLiveStreamWatermarkRuleResponse>\\n<RequestId>5c6a2a0df228-4a64-af62-20e91b9676b3</RequestId>\\n<RuleId>445409ec-7eaa-461d-8f29-4bec2eb9****</RuleId>\\n</AddLiveStreamWatermarkRuleResponse>","errorExample":""}]', + 'title' => '添加水印规则', + 'description' => '调用[AddLiveStreamWatermark](~~2848096~~)接口添加水印模板后，可使用本接口添加水印规则。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveStreamWatermarkRule' => [ + 'summary' => '调用DeleteLiveStreamWatermarkRule删除水印规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveCT0GRQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.aliyundoc.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'Stream', + 'in' => 'query', + 'schema' => [ + 'description' => '流名称。规则如下：'."\n" + ."\n" + .'- 直接写流名称则仅匹配该流名称。示例：liveStreamA。'."\n" + ."\n" + .'- 可进行模糊匹配，`*`匹配所有流。'."\n" + ."\n" + .'- 可进行前匹配和后匹配。'."\n" + ."\n" + .'>- 模糊匹配格式说明：模糊匹配下的`*`要求有且仅有一个，只能在最前或最后，且匹配项需要`()`包围，多个匹配项用竖线`|`分隔。'."\n" + .'>- 示例：`*(t1|t2) `匹配所有后缀为`t1`或`t2`的流` (abc|123)*`匹配所有前缀为`abc`或者`123`的流。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStreamA', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '水印规则ID。'."\n" + .'>可查看[AddLiveStreamWatermarkRule](~~2848100~~)接口返回参数值获取RuleId。', + 'type' => 'string', + 'required' => false, + 'example' => '445409ec-7eaa-461d -8f29-4bec2eb9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64- af62-20e91******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0df228-4a64- af62-20e91******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveStreamWatermarkRuleResponse>\\r\\n<RequestId>5c6a2a0df228-4a64- af62-20e91b9676b3</RequestId>\\r\\n</DeleteLiveStreamWatermarkRuleResponse>","errorExample":""}]', + 'title' => '删除水印规则', + 'description' => '本接口支持删除指定RuleId的水印规则。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateLiveStreamWatermarkRule' => [ + 'summary' => '调用UpdateLiveStreamWatermarkRule更新水印规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveCT0GRQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '水印规则ID。'."\n" + .'>可查看[AddLiveStreamWatermarkRule](~~2848100~~)接口返回参数值获取RuleId。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'WatermarkRule****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'my rule', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '水印模板ID。'."\n" + .'>可查看[AddLiveStreamWatermark](~~2848096~~)接口返回参数值获取TemplateId。', + 'type' => 'string', + 'required' => false, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9 ****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64-af62-20e91b9676b3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0df228-4a64-af62-20e91b9676b3\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveStreamWatermarkRuleResponse>\\r\\n<RequestId>5c6a2a0df228-4a64-af62-20e91b9676b3</RequestId>\\r\\n</UpdateLiveStreamWatermarkRuleResponse>","errorExample":""}]', + 'title' => '更新水印规则', + 'description' => '本接口支持对指定RuleId的⽔印规则各项参数进⾏更新调整。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamWatermarkRules' => [ + 'summary' => '调用DescribeLiveStreamWatermarkRules查询水印规则列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveCT0GRQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'live.yourdomain.com', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分⻚的⻚数，不传默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分⻚每⻚个数，不传默认为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '符合条件的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64- af62-20e91b9676b3', + ], + 'RuleInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleInfo' => [ + 'description' => '⽔印规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '⽔印规则列表。', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'example' => 'example.aliyundoc.com', + ], + 'Description' => [ + 'description' => '自定义规则描述信息。', + 'type' => 'string', + 'example' => 'my rule', + ], + 'App' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'Stream' => [ + 'description' => '流名称。规则如下：'."\n" + ."\n" + .'- 直接写流名称则仅匹配该流名称。示例：liveStreamA。'."\n" + ."\n" + .'- 可进行模糊匹配，`*`匹配所有流。'."\n" + ."\n" + .'- 可进行前匹配和后匹配。'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'- 模糊匹配格式说明：模糊匹配下的`*`要求有且仅有一个，只能在最前或最后，且匹配项需要`()`包围，多个匹配项用竖线`|`分隔。'."\n" + .'- 示例：`*(t1|t2) `匹配所有后缀为`t1`或`t2`的流` (abc|123)*`匹配所有前缀为`abc`或者`123`的流。'."\n" + ."\n" + .' '."\n" + .'></notice>', + 'type' => 'string', + 'example' => 'liveStreamA', + ], + 'Name' => [ + 'description' => '自定义规则名称。', + 'type' => 'string', + 'example' => 'WatermarkRule****', + ], + 'TemplateId' => [ + 'description' => '水印模板ID。'."\n" + ."\n" + .'>可查看[AddLiveStreamWatermark](~~2848096~~)接口返回参数值获取TemplateId。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9 ****', + ], + 'RuleId' => [ + 'description' => '水印规则ID。'."\n" + .'>可查看[AddLiveStreamWatermarkRule](~~2848100~~)接口返回参数值获取RuleId。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d -8f29-4bec2eb9****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameters', + 'errorMessage' => '%s Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Total\\": 100,\\n \\"RequestId\\": \\"5c6a2a0df228-4a64- af62-20e91b9676b3\\",\\n \\"RuleInfoList\\": {\\n \\"RuleInfo\\": [\\n {\\n \\"Domain\\": \\"example.aliyundoc.com\\",\\n \\"Description\\": \\"my rule\\",\\n \\"App\\": \\"liveApp****\\",\\n \\"Stream\\": \\"liveStreamA\\",\\n \\"Name\\": \\"WatermarkRule****\\",\\n \\"TemplateId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9 ****\\",\\n \\"RuleId\\": \\"445409ec-7eaa-461d -8f29-4bec2eb9****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamWatermarkRulesResponse>\\n<RuleInfoList>\\n <RuleInfo>\\n <App>liveApp****</App>\\n <Description>my rule</Description>\\n <RuleId>445409ec-7eaa-461d -8f29-4bec2eb9****</RuleId>\\n <Stream>liveStreamA</Stream>\\n <Domain>example.aliyundoc.com</Domain>\\n <TemplateId>445409ec-7eaa-461d-8f29-4bec2eb9 ****</TemplateId>\\n <Name>WatermarkRule****</Name>\\n </RuleInfo>\\n</RuleInfoList>\\n<RequestId>5c6a2a0df228-4a64- af62-20e91b9676b3</RequestId>\\n</DescribeLiveStreamWatermarkRulesResponse>","errorExample":""}]', + 'title' => '查询水印规则列表', + 'description' => '本接口支持指定分⻚参数查询水印规则列表信息，调用时请保证参数设置符合要求。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListEdgeTranscodeTemplate' => [ + 'summary' => '查询边缘转码模板列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '机房ID。', + 'type' => 'string', + 'required' => true, + 'example' => '******3b-4d18-395c-8106-ff21a6******', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '边缘转码类型，枚举：'."\n" + .'- **common** 通用（普通+窄带高清1.0）。'."\n" + .'- **nbhd-2** 窄带高清2.0。'."\n" + .'- **ultra-hd** 超高清。'."\n" + ."\n" + .'> 当该参数不填写时，系统会展示用户拥有的转码类型权限的转码模板。', + 'type' => 'string', + 'required' => false, + 'example' => 'nbhd-2', + ], + ], + [ + 'name' => 'VideoCodec', + 'in' => 'query', + 'schema' => [ + 'description' => '视频编码格式，枚举：'."\n" + .'- H.264。'."\n" + .'- H.265。'."\n" + ."\n" + .'> 当该参数不填写时，系统会展示用户拥有的视频编码格式权限的转码模板。', + 'type' => 'string', + 'required' => false, + 'example' => 'H.264', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为10，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序规则，按模板创建时间（CreateTime）排序。默认是desc，枚举：'."\n" + .'- desc 降序排序。'."\n" + .'- asc 升序排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，枚举：'."\n" + .'- 模板ID，模板ID支持精确匹配。'."\n" + .'- 模板名称，模板名称支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'baseline', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'TemplateList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Template' => [ + 'description' => '边缘转码模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '边缘转码模板列表。', + 'type' => 'object', + 'properties' => [ + 'Bitrate' => [ + 'description' => '码率配置，有固定码率，码率随源（ws）2种。', + 'type' => 'string', + 'example' => '3000', + ], + 'Codec' => [ + 'description' => '视频编码格式，枚举：'."\n" + .'- H.264。'."\n" + .'- H.265。', + 'type' => 'string', + 'example' => 'H.264', + ], + 'CreateTime' => [ + 'description' => '模板创建时间。', + 'type' => 'string', + 'example' => '2023-07-25T02:48:58Z', + ], + 'Fps' => [ + 'description' => '帧率配置，有固定帧率，帧率随源（ws）2种。', + 'type' => 'string', + 'example' => '30', + ], + 'Gop' => [ + 'description' => '关键帧配置，有按帧配置，按秒配置，关键帧随源（ws）3种。', + 'type' => 'string', + 'example' => '2s', + ], + 'Name' => [ + 'description' => '模版名称。', + 'type' => 'string', + 'example' => 'my_template', + ], + 'Resolution' => [ + 'description' => '分辨率配置，有固定分辨率，分辨率随源（ws）2种。'."\n" + .'> 当使用固定分辨率时，width/height取值为-1/-2，则表示宽/高自适应。', + 'type' => 'string', + 'example' => '1920*1080', + ], + 'TemplateId' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '9b1571b513cb44f7a1ba6ae561ff46f7', + ], + 'Type' => [ + 'description' => '边缘转码类型。', + 'type' => 'string', + 'example' => 'common', + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"TemplateList\\": {\\n \\"Template\\": [\\n {\\n \\"Bitrate\\": \\"3000\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"CreateTime\\": \\"2023-07-25T02:48:58Z\\",\\n \\"Fps\\": \\"30\\",\\n \\"Gop\\": \\"2s\\",\\n \\"Name\\": \\"my_template\\",\\n \\"Resolution\\": \\"1920*1080\\",\\n \\"TemplateId\\": \\"9b1571b513cb44f7a1ba6ae561ff46f7\\",\\n \\"Type\\": \\"common\\"\\n }\\n ]\\n },\\n \\"TotalCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"<ListEdgeTranscodeTemplateResponse>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n <TemplateList>\\n <Bitrate>3000</Bitrate>\\n <Codec>H.264</Codec>\\n <CreateTime>2023-07-25T02:48:58Z</CreateTime>\\n <Fps>30</Fps>\\n <Gop>2s</Gop>\\n <Name>my_template</Name>\\n <Resolution>1920*1080</Resolution>\\n <TemplateId>9b1571b513cb44f7a1ba6ae561ff46f7</TemplateId>\\n <Type>common</Type>\\n </TemplateList>\\n <TotalCount>100</TotalCount>\\n</ListEdgeTranscodeTemplateResponse>","errorExample":""}]', + 'title' => '查询边缘转码模板列表', + 'description' => '- 本接口用于查询边缘转码模板列表。'."\n" + ."\n" + .'- 用户需要具有访问边缘转码服务的权限，才能正常调用本接口。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetEdgeTranscodeTemplate' => [ + 'summary' => '查询边缘转码模板详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '机房ID。', + 'type' => 'string', + 'required' => true, + 'example' => '******3b-4d18-395c-8106-ff21a6******', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****a046-263c-3560-978a-fb287666****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'Template' => [ + 'description' => '边缘转码模版。', + 'type' => 'object', + 'properties' => [ + 'Bitrate' => [ + 'description' => '码率配置，有固定码率，码率随源（ws）2种。', + 'type' => 'string', + 'example' => '3000', + ], + 'Codec' => [ + 'description' => '视频编码格式，枚举：'."\n" + .'- H.264。'."\n" + .'- H.265。', + 'type' => 'string', + 'example' => 'H.264', + ], + 'CreateTime' => [ + 'description' => '模板创建时间。', + 'type' => 'string', + 'example' => '2023-07-25T02:48:58Z', + ], + 'Fps' => [ + 'description' => '帧率配置，有固定帧率，帧率随源（ws）2种。', + 'type' => 'string', + 'example' => '30', + ], + 'Gop' => [ + 'description' => '关键帧配置，有按帧配置，按秒配置，关键帧随源（ws）3种。', + 'type' => 'string', + 'example' => '2s', + ], + 'Name' => [ + 'description' => '模版名称。', + 'type' => 'string', + 'example' => 'my_template', + ], + 'Resolution' => [ + 'description' => '分辨率配置，有固定分辨率，分辨率随源（ws）2种。'."\n" + .'> 当使用固定分辨率，width/height取值为-1/-2时，则表示宽/高自适应。', + 'type' => 'string', + 'example' => '1920*1080', + ], + 'TemplateId' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '9b1571b513cb44f7a1ba6ae561ff****', + ], + 'Type' => [ + 'description' => '边缘转码类型。', + 'type' => 'string', + 'example' => 'common', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'TemplateNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Template\\": {\\n \\"Bitrate\\": \\"3000\\",\\n \\"Codec\\": \\"H.264\\",\\n \\"CreateTime\\": \\"2023-07-25T02:48:58Z\\",\\n \\"Fps\\": \\"30\\",\\n \\"Gop\\": \\"2s\\",\\n \\"Name\\": \\"my_template\\",\\n \\"Resolution\\": \\"1920*1080\\",\\n \\"TemplateId\\": \\"9b1571b513cb44f7a1ba6ae561ff****\\",\\n \\"Type\\": \\"common\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetEdgeTranscodeTemplateResponse>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n <Template>\\n <Bitrate>3000</Bitrate>\\n <Codec>H.264</Codec>\\n <CreateTime>2023-07-25T02:48:58Z</CreateTime>\\n <Fps>30</Fps>\\n <Gop>2s</Gop>\\n <Name>my_template</Name>\\n <Resolution>1920*1080</Resolution>\\n <TemplateId>9b1571b513cb44f7a1ba6ae561ff****</TemplateId>\\n <Type>common</Type>\\n </Template>\\n</GetEdgeTranscodeTemplateResponse>","errorExample":""}]', + 'title' => '查询边缘转码模板详情', + 'description' => '- 本接口用于查询边缘转码模板详情。'."\n" + ."\n" + .'- 用户需要具有访问边缘转码服务的权限，才能正常调用本接口。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CreateEdgeTranscodeJob' => [ + 'summary' => '创建边缘转码任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '机房ID。', + 'type' => 'string', + 'required' => true, + 'example' => '******3b-4d18-395c-8106-ff21a6******', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称，支持中英文+数字+英文短划线、下划线。长度限制英文255字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'task1', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****96e8864746a0b6f3****', + ], + ], + [ + 'name' => 'StreamInput', + 'in' => 'query', + 'schema' => [ + 'description' => '输入流地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp://mydomain/app/stream1', + ], + ], + [ + 'name' => 'StreamOutput', + 'in' => 'query', + 'schema' => [ + 'description' => '输出流地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp://testdomain/app/stream2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '边缘转码任务ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'TemplateNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateEdgeTranscodeJobResponse>\\n <JobId>****20b48fb04483915d4f2cd8ac****</JobId>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n</CreateEdgeTranscodeJobResponse>","errorExample":""}]', + 'title' => '创建边缘转码任务', + 'description' => '- 本接口用于创建边缘转码任务。'."\n" + ."\n" + .'- 用户需要具有访问边缘转码服务的权限，才能正常调用本接口。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteEdgeTranscodeJob' => [ + 'summary' => '删除边缘转码任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '机房ID。', + 'type' => 'string', + 'required' => true, + 'example' => '******3b-4d18-395c-8106-ff21a6******', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '边缘转码任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteEdgeTranscodeJobResponse>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n</DeleteEdgeTranscodeJobResponse>","errorExample":""}]', + 'title' => '删除边缘转码任务', + 'description' => '- 本接口用于删除边缘转码任务。'."\n" + ."\n" + .'- 用户需要具有访问边缘转码服务的权限，才能正常调用本接口。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListEdgeTranscodeJob' => [ + 'summary' => '查询边缘转码任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '机房ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cluster-1', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '边缘转码类型，枚举：'."\n" + .'- common，通用(普通+窄带高清1.0)。'."\n" + .'- nbhd-2，窄带高清2.0。'."\n" + .'- ultra-hd，超高清。'."\n" + ."\n" + .'> 该参数不填写时，会展示用户有对应转码类型权限的转码模板', + 'type' => 'string', + 'required' => false, + 'example' => 'common', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '边缘转码任务状态，枚举：'."\n" + .'- 0 未启动。'."\n" + .'- 1 运行中。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，即每页显示条数。默认值为10，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序规则，按CreateTime排序。默认是desc，枚举：'."\n" + .'- desc 降序排序。'."\n" + .'- asc 升序排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，枚举：'."\n" + .'- 任务ID，任务ID支持精确匹配。'."\n" + .'- 任务名称，任务名称支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JobList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Job' => [ + 'description' => '边缘转码任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2023-07-24T16:44:55Z', + ], + 'JobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'LastStartAt' => [ + 'description' => '任务上一次启动的时间。', + 'type' => 'string', + 'example' => '2023-07-25T02:48:58Z', + ], + 'LastStopAt' => [ + 'description' => '任务上一次停止的时间。', + 'type' => 'string', + 'example' => '2023-07-25T05:48:58Z', + ], + 'Name' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'my_job', + ], + 'Status' => [ + 'description' => '边缘转码任务状态，枚举：'."\n" + .'- 0 未启动。'."\n" + .'- 1 运行中。', + 'type' => 'string', + 'example' => '0', + ], + 'StreamInput' => [ + 'description' => '输入流地址。', + 'type' => 'string', + 'example' => 'rtmp://mydomain/app/stream1', + ], + 'StreamOutput' => [ + 'description' => '输出流地址。', + 'type' => 'string', + 'example' => 'rtmp://testdomain/app/stream2', + ], + 'TemplateId' => [ + 'description' => '任务使用的边缘转码模板ID。', + 'type' => 'string', + 'example' => '9b1571b513cb44f7a1ba6ae561ff****', + ], + 'TemplateName' => [ + 'description' => '任务使用的边缘转码模板名。', + 'type' => 'string', + 'example' => 'my_template', + ], + 'Type' => [ + 'description' => '边缘转码类型，枚举：'."\n" + .'- common，通用(普通+窄带高清1.0)。'."\n" + .'- nbhd-2，窄带高清2.0。'."\n" + .'- ultra-hd，超高清。', + 'type' => 'string', + 'example' => 'common', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"JobList\\": {\\n \\"Job\\": [\\n {\\n \\"CreateTime\\": \\"2023-07-24T16:44:55Z\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"LastStartAt\\": \\"2023-07-25T02:48:58Z\\",\\n \\"LastStopAt\\": \\"2023-07-25T05:48:58Z\\",\\n \\"Name\\": \\"my_job\\",\\n \\"Status\\": \\"0\\",\\n \\"StreamInput\\": \\"rtmp://mydomain/app/stream1\\",\\n \\"StreamOutput\\": \\"rtmp://testdomain/app/stream2\\",\\n \\"TemplateId\\": \\"9b1571b513cb44f7a1ba6ae561ff****\\",\\n \\"TemplateName\\": \\"my_template\\",\\n \\"Type\\": \\"common\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"TotalCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"<ListEdgeTranscodeJobResponse>\\n <JobList>\\n <CreateTime>2023-07-24T16:44:55Z</CreateTime>\\n <JobId>****20b48fb04483915d4f2cd8ac****</JobId>\\n <LastStartAt>2023-07-25T02:48:58Z</LastStartAt>\\n <LastStopAt>2023-07-25T05:48:58Z</LastStopAt>\\n <Name>my_job</Name>\\n <Status>0</Status>\\n <StreamInput>rtmp://mydomain/app/stream1</StreamInput>\\n <StreamOutput>rtmp://testdomain/app/stream2</StreamOutput>\\n <TemplateId>9b1571b513cb44f7a1ba6ae561ff****</TemplateId>\\n <TemplateName>my_template</TemplateName>\\n <Type>common</Type>\\n </JobList>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n <TotalCount>100</TotalCount>\\n</ListEdgeTranscodeJobResponse>","errorExample":""}]', + 'title' => '查询边缘转码任务列表', + 'description' => '- 本接口用于查询边缘转码任务列表。'."\n" + ."\n" + .'- 用户需要具有访问边缘转码服务的权限，才能正常调用本接口。'."\n" + .'- 本接口只返回距今180天内的任务，且最后一次操作时间需要在这180天之内。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '## 请求参数使用说明'."\n" + .'- 本接口支持按转码类型(Type)、转码任务状态(Status)筛选查询结果。'."\n" + .'- 本接口支持按任务创建时间(CreateTime)对查询结果排序，默认为降序。'."\n" + .'- 本接口支持以任务ID（精确匹配）、任务名称（模糊查询）为关键字(Keyword)进行查询。 ', + ], + 'GetEdgeTranscodeJob' => [ + 'summary' => '查询边缘转码任务详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '机房ID。', + 'type' => 'string', + 'required' => true, + 'example' => '******3b-4d18-395c-8106-ff21a6******', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '边缘转码任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Job' => [ + 'description' => '边缘转码任务。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2023-07-24T16:44:55Z', + ], + 'JobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'LastStartAt' => [ + 'description' => '任务上一次启动的时间。', + 'type' => 'string', + 'example' => '2023-07-25T02:48:58Z', + ], + 'LastStopAt' => [ + 'description' => '任务上一次停止的时间。', + 'type' => 'string', + 'example' => '2023-07-25T05:48:58Z', + ], + 'Name' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'my_job', + ], + 'Status' => [ + 'description' => '转码任务状态，枚举：'."\n" + .'- 0 未启动。'."\n" + .'- 1 运行中。', + 'type' => 'string', + 'example' => '0', + ], + 'StreamInput' => [ + 'description' => '输入流地址。', + 'type' => 'string', + 'example' => 'rtmp://mydomain/app/stream1', + ], + 'StreamOutput' => [ + 'description' => '输出流地址。', + 'type' => 'string', + 'example' => 'rtmp://testdomain/app/stream2', + ], + 'TemplateId' => [ + 'description' => '任务使用的边缘转码模板ID。', + 'type' => 'string', + 'example' => '9b1571b513cb44f7a1ba6ae561ff****', + ], + 'TemplateName' => [ + 'description' => '任务使用的边缘转码模板名。', + 'type' => 'string', + 'example' => 'my_template', + ], + 'Type' => [ + 'description' => '边缘转码类型，枚举：'."\n" + .'- common，通用(普通+窄带高清1.0)。'."\n" + .'- nbhd-2，窄带高清2.0。'."\n" + .'- ultra-hd，超高清。', + 'type' => 'string', + 'example' => 'common', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Job\\": {\\n \\"CreateTime\\": \\"2023-07-24T16:44:55Z\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"LastStartAt\\": \\"2023-07-25T02:48:58Z\\",\\n \\"LastStopAt\\": \\"2023-07-25T05:48:58Z\\",\\n \\"Name\\": \\"my_job\\",\\n \\"Status\\": \\"0\\",\\n \\"StreamInput\\": \\"rtmp://mydomain/app/stream1\\",\\n \\"StreamOutput\\": \\"rtmp://testdomain/app/stream2\\",\\n \\"TemplateId\\": \\"9b1571b513cb44f7a1ba6ae561ff****\\",\\n \\"TemplateName\\": \\"my_template\\",\\n \\"Type\\": \\"common\\"\\n },\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","errorExample":""},{"type":"xml","example":"<GetEdgeTranscodeJobResponse>\\n <Job>\\n <CreateTime>2023-07-24T16:44:55Z</CreateTime>\\n <JobId>****20b48fb04483915d4f2cd8ac****</JobId>\\n <LastStartAt>2023-07-25T02:48:58Z</LastStartAt>\\n <LastStopAt>2023-07-25T05:48:58Z</LastStopAt>\\n <Name>my_job</Name>\\n <Status>0</Status>\\n <StreamInput>rtmp://mydomain/app/stream1</StreamInput>\\n <StreamOutput>rtmp://testdomain/app/stream2</StreamOutput>\\n <TemplateId>9b1571b513cb44f7a1ba6ae561ff****</TemplateId>\\n <TemplateName>my_template</TemplateName>\\n <Type>common</Type>\\n </Job>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n</GetEdgeTranscodeJobResponse>","errorExample":""}]', + 'title' => '查询边缘转码任务详情', + 'description' => '用户需要具有访问边缘转码服务的权限，才能正常调用本接口。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateEdgeTranscodeJob' => [ + 'summary' => '更新边缘转码任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '机房ID。', + 'type' => 'string', + 'required' => true, + 'example' => '******3b-4d18-395c-8106-ff21a6******', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '边缘转码任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'task1', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => '****96e8864746a0b6f3****', + ], + ], + [ + 'name' => 'StreamInput', + 'in' => 'query', + 'schema' => [ + 'description' => '输入流地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://mydomain/app/stream1', + ], + ], + [ + 'name' => 'StreamOutput', + 'in' => 'query', + 'schema' => [ + 'description' => '输出流地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://testdomain/app/stream2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '边缘转码任务ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'TemplateNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateEdgeTranscodeJobResponse>\\n <JobId>****20b48fb04483915d4f2cd8ac****</JobId>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n</UpdateEdgeTranscodeJobResponse>","errorExample":""}]', + 'title' => '更新边缘转码任务', + 'description' => '- 本接口用于更新边缘转码任务。'."\n" + ."\n" + .'- 用户需要具有访问边缘转码服务的权限，且转码任务处于未启动状态，才能正常调用本接口。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'StartEdgeTranscodeJob' => [ + 'summary' => '启动边缘转码任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '机房ID。', + 'type' => 'string', + 'required' => true, + 'example' => '******3b-4d18-395c-8106-ff21a6******', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '边缘转码任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '边缘转码任务ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'UserTaskExceed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserQuotaExceed', + 'errorMessage' => 'Quota exceeded: %s.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","errorExample":""},{"type":"xml","example":"<StartEdgeTranscodeJobResponse>\\n <JobId>****20b48fb04483915d4f2cd8ac****</JobId>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n</StartEdgeTranscodeJobResponse>","errorExample":""}]', + 'title' => '启动边缘转码任务', + 'description' => '- 本接口用于启动边缘转码任务。'."\n" + ."\n" + .'- 用户需要具有访问边缘转码服务的权限，且转码任务处于未启动状态，才能正常调用本接口。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'StopEdgeTranscodeJob' => [ + 'summary' => '停止边缘转码任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveHVN9B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '机房ID。', + 'type' => 'string', + 'required' => true, + 'example' => '******3b-4d18-395c-8106-ff21a6******', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '边缘转码任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '边缘转码任务ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","errorExample":""},{"type":"xml","example":"<StopEdgeTranscodeJobResponse>\\n <JobId>****20b48fb04483915d4f2cd8ac****</JobId>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n</StopEdgeTranscodeJobResponse>","errorExample":""}]', + 'title' => '停止边缘转码任务', + 'description' => '- 本接口用于查停止边缘转码任务。'."\n" + ."\n" + .'- 用户需要具有访问边缘转码服务的权限，且转码任务处于运行中状态，才能正常调用本接口。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'EnableLiveRealtimeLogDelivery' => [ + 'summary' => '调用EnableLiveRealtimeLogDelivery开启域名实时日志投递。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive066BXV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '开启实时日志投递服务播流域名。'."\n" + ."\n" + .'多个域名之间用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service Not Authorized', + ], + ], + 404 => [ + [ + 'errorCode' => 'Domain.NotFound', + 'errorMessage' => 'Domain not found', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableLiveRealtimeLogDeliveryResponse>\\n <RequestId>9732E117-8A37-49FD-A36F-ABBB87556CA7</RequestId>\\n</EnableLiveRealtimeLogDeliveryResponse>","errorExample":""}]', + 'title' => '开启域名实时日志投递', + 'description' => '<props="china">目前仅支持配置播流域名，如需推送上行实时日志（即配置推流域名），请[提交工单](https://workorder.console.aliyun.com/console.htm#/ticket/add?productCode=live&commonQuestionId=4545&isSmart=true&iatraceid=1608439120675-2a5c48de0b84805313c708&channel=selfservice)配置。</props>'."\n" + .'<props="intl">目前仅支持配置播流域名，如需推送上行实时日志（即配置推流域名），请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.12818093.nav-right.dticket.6cb216d07otFWR#/ticket/createIndex)配置。</props>'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特定错误码'."\n" + .'| 错误代码 | HTTP状态码 | 含义 |'."\n" + .'|--------------------------|-------------------------------------------|-----------|'."\n" + .'| Unauthorized | 403 | 没有开启实时投递授权。 |', + ], + 'DisableLiveRealtimeLogDelivery' => [ + 'summary' => '调用DisableLiveRealtimeLogDelivery暂停域名实时日志投递。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive066BXV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '暂停实时日志投递的播流域名。'."\n" + .'多个域名之间用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service Not Authorized', + ], + ], + 404 => [ + [ + 'errorCode' => 'Domain.NotFound', + 'errorMessage' => 'Domain not found', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableLiveRealtimeLogDeliveryResponse>\\n <RequestId>9732E117-8A37-49FD-A36F-ABBB87556CA7</RequestId>\\n</DisableLiveRealtimeLogDeliveryResponse>","errorExample":""}]', + 'title' => '暂停域名实时日志投递', + 'description' => '先获取实时日志投递的播流域名，再调用本接口暂停域名实时日志投递。'."\n" + .'<props="china">目前仅支持配置播流域名，如需推送上行实时日志（即配置推流域名），请[提交工单](https://workorder.console.aliyun.com/console.htm#/ticket/add?productCode=live&commonQuestionId=4545&isSmart=true&iatraceid=1608439120675-2a5c48de0b84805313c708&channel=selfservice)配置。</props>'."\n" + .'<props="intl">目前仅支持配置播流域名，如需推送上行实时日志（即配置推流域名），请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.12818093.nav-right.dticket.6cb216d07otFWR#/ticket/createIndex)配置。</props>'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特定错误码'."\n" + ."\n" + .'| HttpCode | 错误码 | 描述 |'."\n" + .'|--------------------------|-----------------|---------------------------|'."\n" + .'| 403 | Unauthorized | 没有开启实时投递授权。 |', + ], + 'ModifyLiveRealtimeLogDelivery' => [ + 'summary' => '调用ModifyLiveRealtimeLogDelivery更改域名实时日志投递。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive066BXV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的ProjectName。', + 'type' => 'string', + 'required' => true, + 'example' => 'project_example', + ], + ], + [ + 'name' => 'Logstore', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递日志服务（SLS）的LogStoreName。', + 'type' => 'string', + 'required' => true, + 'example' => 'logstore_example', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的Region。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '修改实时日志投递的主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service Not Authorized', + ], + ], + 404 => [ + [ + 'errorCode' => 'Domain.NotFound', + 'errorMessage' => 'Domain not found', + ], + [ + 'errorCode' => 'LogstoreNotExist', + 'errorMessage' => 'Logstore does not exist', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyLiveRealtimeLogDeliveryResponse>\\n <RequestId>9732E117-8A37-49FD-A36F-ABBB87556CA7</RequestId>\\n</ModifyLiveRealtimeLogDeliveryResponse>","errorExample":""}]', + 'title' => '更改域名实时日志投递', + 'description' => '- 调用本接口更改域名实时日志投递。一个域名同时仅支持投递单个logstore。'."\n" + .'<props="china">目前仅支持配置播流域名，如需推送上行实时日志（即配置推流域名），请[提交工单](https://workorder.console.aliyun.com/console.htm#/ticket/add?productCode=live&commonQuestionId=4545&isSmart=true&iatraceid=1608439120675-2a5c48de0b84805313c708&channel=selfservice)配置。</props>'."\n" + .'<props="intl">目前仅支持配置播流域名，如需推送上行实时日志（即配置推流域名），请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.12818093.nav-right.dticket.6cb216d07otFWR#/ticket/createIndex)配置。</props>'."\n" + ."\n" + .'- 您可调用[DescribeLiveDomainRealtimeLogDelivery](~~2848121~~)查询Project、Logstore、Region参数信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特定错误码'."\n" + ."\n" + .'|HttpCode | 错误码 |描述 |'."\n" + .'|--------------------------|-------------------------------------------|-----------|'."\n" + .'| 403 | LogstoreNotExist | 未找到对应Logstore 信息。 |'."\n" + .'| 404 | Domain.NotFound | 域名未开通实时日志投递服务。 |', + ], + 'CreateLiveRealTimeLogDelivery' => [ + 'summary' => '调用CreateLiveRealTimeLogDelivery创建域名实时日志投递。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive066BXV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的ProjectName。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'Logstore', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的LogStoreName。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_logstore', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的Region。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F32C57AA-7BF8-49AE-A2CC-9F42390F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service Not Authorized', + ], + ], + 404 => [ + [ + 'errorCode' => 'LogstoreNotExist', + 'errorMessage' => 'Logstore does not exist', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F32C57AA-7BF8-49AE-A2CC-9F42390F****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<CreateLiveRealTimeLogDeliveryResponse>\\r\\n <RequestId>F32C57AA-7BF8-49AE-A2CC-9F42390F5A19</RequestId>\\r\\n</CreateLiveRealTimeLogDeliveryResponse>","errorExample":""}]', + 'title' => '创建域名实时日志投递', + 'description' => '先获取播流域名，再调用本接口创建域名实时日志投递。'."\n" + ."\n" + .'<props="china">目前仅支持配置播流域名，如需推送上行实时日志（即配置推流域名），请[提交工单](https://workorder.console.aliyun.com/console.htm#/ticket/add?productCode=live&commonQuestionId=4545&isSmart=true&iatraceid=1608439120675-2a5c48de0b84805313c708&channel=selfservice)配置。</props>'."\n" + .'<props="intl">目前仅支持配置播流域名，如需推送上行实时日志（即配置推流域名），请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.12818093.nav-right.dticket.6cb216d07otFWR#/ticket/createIndex)配置。</props>'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特定错误码'."\n" + ."\n" + .'| HttpCode| 错误码 | 描述 |'."\n" + .'|--------------------------|-------------------------------------------|-----------|'."\n" + .'| 403| Unauthorized | 没有开启实时投递授权。 |'."\n" + .'| 404| LogstoreNotExist | 未找到对应Logstore信息。 |'."\n", + ], + 'DeleteLiveRealtimeLogDelivery' => [ + 'summary' => '调用DeleteLiveRealtimeLogDelivery删除域名实时日志推送。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive066BXV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。'."\n" + ."\n" + .'多个域名使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com,example.aliyundoc.com', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的ProjectName。', + 'type' => 'string', + 'required' => true, + 'example' => 'project_example', + ], + ], + [ + 'name' => 'Logstore', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的LogStoreName。', + 'type' => 'string', + 'required' => true, + 'example' => 'logstore_example', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的Region。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service Not Authorized', + ], + ], + 404 => [ + [ + 'errorCode' => 'LogstoreNotExist', + 'errorMessage' => 'Logstore does not exist', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveRealtimeLogDeliveryResponse>\\n <RequestId>9732E117-8A37-49FD-A36F-ABBB87556CA7</RequestId>\\n</DeleteLiveRealtimeLogDeliveryResponse>","errorExample":""}]', + 'title' => '删除域名实时日志推送', + 'description' => '- <props="china">目前仅支持配置播流域名，如需配置上行实时日志（即配置推流域名），请[提交工单](https://workorder.console.aliyun.com/console.htm#/ticket/add?productCode=live&commonQuestionId=4545&isSmart=true&iatraceid=1608439120675-2a5c48de0b84805313c708&channel=selfservice)配置。</props><props="intl">目前仅支持配置播流域名，如需配置上行实时日志（即配置推流域名），请[提交工单](https://workorder-intl.console.aliyun.com/?spm=5176.12818093.nav-right.dticket.6cb216d07otFWR#/ticket/createIndex)配置。</props>'."\n" + ."\n" + .'- 您可调用[DescribeLiveDomainRealtimeLogDelivery](~~2848121~~)查询Project、Logstore、Region参数信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特定错误码'."\n" + ."\n" + .'| HttpCode| 错误码 | 描述 |'."\n" + .'|--------------------------|-------------------------------------------|-----------|'."\n" + .'| 403| Unauthorized | 没有开启实时投递授权。 |'."\n" + .'| 404| LogstoreNotExist | 未找到对应Logstore信息。 |', + ], + 'DescribeLiveDomainRealtimeLogDelivery' => [ + 'summary' => '调用DescribeLiveDomainRealtimeLogDelivery查询域名实时日志投递信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107035', + 'abilityTreeNodes' => [ + 'FEATURElive066BXV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '域名实时投递状态。取值：'."\n" + ."\n" + .'- online：开启实时投递。'."\n" + .'- offline：未开启实时投递。', + 'type' => 'string', + 'example' => 'online', + ], + 'Logstore' => [ + 'description' => '实时投递SLS的LogStoreName。', + 'type' => 'string', + 'example' => 'logstore_example', + ], + 'Project' => [ + 'description' => '实时投递SLS的ProjectName。', + 'type' => 'string', + 'example' => 'project_example', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2F8F3852-912F-42AC-80EB-F1CF4284DE93', + ], + 'Region' => [ + 'description' => '实时投递SLS的Region。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service Not Authorized', + ], + ], + 404 => [ + [ + 'errorCode' => 'Domain.NotFound', + 'errorMessage' => 'Domain not found', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"online\\",\\n \\"Logstore\\": \\"logstore_example\\",\\n \\"Project\\": \\"project_example\\",\\n \\"RequestId\\": \\"2F8F3852-912F-42AC-80EB-F1CF4284DE93\\",\\n \\"Region\\": \\"cn-shanghai\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDomainRealtimeLogDeliveryResponse>\\n <Status>online</Status>\\n <Logstore>logstore_example</Logstore>\\n <Project>project_example</Project>\\n <RequestId>2F8F3852-912F-42AC-80EB-F1CF4284DE93</RequestId>\\n <Region>cn-shanghai</Region>\\n</DescribeLiveDomainRealtimeLogDeliveryResponse>","errorExample":""}]', + 'title' => '查询域名实时日志投递信息', + 'description' => '调用本接口查询域名实时日志投递状态，无其他特殊使用说明，调用时请保证参数设置符合要求。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特定错误码'."\n" + ."\n" + .'| HttpCode| 错误码 | 描述 |'."\n" + .'|--------------------------|-------------------------------------------|-----------|'."\n" + .'| 404 | Domain.NotFound | 域名未开通实时日志投递服务。 |', + ], + 'ListLiveRealtimeLogDelivery' => [ + 'summary' => '调用ListLiveRealtimeLogDelivery查询用户下所有实时日志投递。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive066BXV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'LiveOpenapiReserve', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数暂无实际意义。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '实时日志投递信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '30559C03-86C9-4EEC-B840-0DC5F5A2189B', + ], + 'Content' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RealtimeLogDeliveryInfo' => [ + 'description' => '实时日志投递信息。', + 'type' => 'array', + 'items' => [ + 'description' => '实时日志投递信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '日志服务状态。取值：'."\n" + ."\n" + .'- **online**：正在服务。'."\n" + .'- **offline**：停止服务。', + 'type' => 'string', + 'example' => 'online', + ], + 'DmId' => [ + 'description' => '域名ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1001010', + ], + 'Region' => [ + 'description' => '实时投递SLS的Region。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Logstore' => [ + 'description' => '实时投递SLS的LogStoreName。', + 'type' => 'string', + 'example' => 'logstore_example', + ], + 'Project' => [ + 'description' => '实时投递SLS的ProjectName。', + 'type' => 'string', + 'example' => 'project_example', + ], + 'DomainName' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service Not Authorized', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"30559C03-86C9-4EEC-B840-0DC5F5A2189B\\",\\n \\"Content\\": {\\n \\"RealtimeLogDeliveryInfo\\": [\\n {\\n \\"Status\\": \\"online\\",\\n \\"DmId\\": 1001010,\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Logstore\\": \\"logstore_example\\",\\n \\"Project\\": \\"project_example\\",\\n \\"DomainName\\": \\"example.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListLiveRealtimeLogDeliveryResponse>\\n <RequestId>30559C03-86C9-4EEC-B840-0DC5F5A2189B</RequestId>\\n <Content>\\n <RealtimeLogDeliveryInfo>\\n <Status>online</Status>\\n <Region>cn-hangzhou-corp</Region>\\n <Domain>example.com</Domain>\\n <DmId>1001010</DmId>\\n <Project>project_example</Project>\\n <Logstore>logstore_example</Logstore>\\n </RealtimeLogDeliveryInfo>\\n <RealtimeLogDeliveryInfo>\\n <Status>online</Status>\\n <Region>cn-hangzhou</Region>\\n <Domain>example.com</Domain>\\n <DmId>101010101</DmId>\\n <Project>project_example</Project>\\n <Logstore>logstore_example</Logstore>\\n </RealtimeLogDeliveryInfo>\\n </Content>\\n</ListLiveRealtimeLogDeliveryResponse>","errorExample":""}]', + 'title' => '查询用户下所有实时日志投递', + 'description' => '您可调用本接口查询用户下所有实时日志投递，无其他特殊使用说明，调用时请保证参数设置符合要求。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特定错误码'."\n" + .'| HttpCode| 错误码 | 错误信息|描述 |'."\n" + .'|--------------------------|----------------------|---------------------|-----------|'."\n" + .'| 403| Unauthorized |RealtimeLogDelivery Service Not Authorized | 没有开启实时投递授权。|', + ], + 'ListLiveRealtimeLogDeliveryDomains' => [ + 'summary' => '调用ListLiveRealtimeLogDeliveryDomains查询实时日志投递服务下所有直播域名。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107178', + 'abilityTreeNodes' => [ + 'FEATURElive066BXV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的ProjectName。', + 'type' => 'string', + 'required' => true, + 'example' => 'project_example', + ], + ], + [ + 'name' => 'Logstore', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的LogStoreName。', + 'type' => 'string', + 'required' => true, + 'example' => 'logstore_example', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的Region。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '95D5B69F-8AEC-419B-8F3A-612B35032B0D', + ], + 'Content' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Domains' => [ + 'description' => '域名详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '日志服务状态。取值：'."\n" + ."\n" + .'- **online**：正在服务。'."\n" + .'- **offline**：停止服务。', + 'type' => 'string', + 'example' => 'online', + ], + 'DomainName' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service Not Authorized', + ], + ], + 404 => [ + [ + 'errorCode' => 'LogstoreNotExist', + 'errorMessage' => 'Logstore does not exist', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"95D5B69F-8AEC-419B-8F3A-612B35032B0D\\",\\n \\"Content\\": {\\n \\"Domains\\": [\\n {\\n \\"Status\\": \\"online\\",\\n \\"DomainName\\": \\"example.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListLiveRealtimeLogDeliveryDomainsResponse>\\n <RequestId>95D5B69F-8AEC-419B-8F3A-612B35032B0D</RequestId>\\n <Content>\\n <Status>online</Status>\\n <DomainName>example.com</DomainName>\\n </Content>\\n</ListLiveRealtimeLogDeliveryDomainsResponse>","errorExample":""}]', + 'title' => '查询实时日志投递服务下所有直播域名', + 'description' => '- 调用本接口查询实时日志投递服务下所有直播域名，返回的日志服务状态分为正在服务和停止服务。'."\n" + ."\n" + .'- 您可调用[DescribeLiveDomainRealtimeLogDelivery](~~2848121~~)查询Project、Logstore、Region参数信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特定错误码'."\n" + .'| HttpCode| 错误码 | 错误信息 | 描述 |'."\n" + .'|--------------------------|--------------------------|-----------------|-----------|'."\n" + .'| 403| Unauthorized | RealtimeLogDelivery Service Not Authorized|没有开启实时投递授权。 |'."\n" + .'| 404| LogstoreNotExist |Logstore does not exist| 未找到对应Logstore信息。 |', + ], + 'ListLiveRealtimeLogDeliveryInfos' => [ + 'summary' => '调用ListLiveRealtimeLogDeliveryInfo查询所有实时日志投递服务信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive066BXV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'LiveOpenapiReserve', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数暂无实际意义。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '95D5B69F-8AEC-419B-8F3A-612B35032B0D', + ], + 'Content' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RealtimeLogDeliveryInfos' => [ + 'description' => '日志投递服务信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Logstore' => [ + 'description' => '实时投递SLS的LogStoreName。', + 'type' => 'string', + 'example' => 'logstore_example', + ], + 'Project' => [ + 'description' => '实时投递SLS的ProjectName。', + 'type' => 'string', + 'example' => 'project_example', + ], + 'Region' => [ + 'description' => '实时投递SLS的Region。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service Not Authorized', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"95D5B69F-8AEC-419B-8F3A-612B35032B0D\\",\\n \\"Content\\": {\\n \\"RealtimeLogDeliveryInfos\\": [\\n {\\n \\"Logstore\\": \\"logstore_example\\",\\n \\"Project\\": \\"project_example\\",\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<ListLiveRealtimeLogDeliveryInfoResponse>\\n<RequestId>95D5B69F-8AEC-419B-8F3A-612B35032B0D</RequestId>\\n<Content>\\n <RealtimeLogDeliveryInfos>\\n <Project>project_example</Project>\\n <Logstore>logstore_example</Logstore>\\n <Region>cn-hangzhou</Region>\\n </RealtimeLogDeliveryInfos>\\n</Content>\\n</ListLiveRealtimeLogDeliveryInfoResponse>","errorExample":""}]', + 'title' => '查询所有实时日志投递服务信息', + 'description' => '您可调用本接口所有实时日志投递服务信息，无其他特殊使用说明，调用时请保证参数设置符合要求。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特定错误码'."\n" + .'| HttpCode| 错误码 | 错误信息 | 描述 |'."\n" + .'|--------------------------|----------------|---------------------------|-----------|'."\n" + .'| 403| Unauthorized | RealtimeLogDelivery Service Not Authorized | 没有开启实时投递授权。 |', + ], + 'DescribeLivePushProxyLog' => [ + 'summary' => '通过DescribeLivePushProxyLog，获取直播转推离线日志下载地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive066BXV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名。不支持多域名查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。取值范围：\\[1, 1000\\]，默认值为300。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '300', + 'default' => '300', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页数，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + 'default' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取日志起始时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-09-20T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取日志结束时间。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-09-20T09:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'DomainLogDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DomainLogDetail' => [ + 'description' => 'DomainLogDetail组成的数据。', + 'type' => 'array', + 'items' => [ + 'description' => 'DomainLogDetail组成的数据。', + 'type' => 'object', + 'properties' => [ + 'LogCount' => [ + 'description' => '本页返回的总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'LogInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogInfoDetail' => [ + 'description' => 'LogInfoDetail组成的数据。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'LogInfoDetail组成的数据。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。'."\n" + ."\n" + .'格式时间戳', + 'type' => 'string', + 'example' => '1695189600', + ], + 'LogName' => [ + 'description' => '日志名称。', + 'type' => 'string', + 'example' => 'example.com'."\n" + .'_2023_09_20_160000_170000.****.gz', + ], + 'LogPath' => [ + 'description' => '日志路径。'."\n", + 'type' => 'string', + 'example' => '****.aliyuncs.com/push_proxy/****/example.com/2023_09_20/1600/example.com'."\n" + .'_2023_09_20_160000_170000.****.gz', + ], + 'LogSize' => [ + 'description' => '日志大小。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '512', + ], + 'StartTime' => [ + 'description' => '起始时间。'."\n" + ."\n" + .'格式时间戳', + 'type' => 'string', + 'example' => '1695193200', + ], + ], + ], + ], + ], + ], + 'PageInfos' => [ + 'description' => 'PageInfoDetail组成的数据。', + 'type' => 'object', + 'properties' => [ + 'PageIndex' => [ + 'description' => '返回数据的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + ], + 'DomainName' => [ + 'description' => '推流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CF60DB6A-7FD6-426E-9288-122CC1A52FA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'Invalid Parameter', + 'errorMessage' => 'The specified Invalid Parameter', + ], + [ + 'errorCode' => 'Internal Error', + 'errorMessage' => 'Internal Error contact admin', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DomainLogDetails\\": {\\n \\"DomainLogDetail\\": [\\n {\\n \\"LogCount\\": 10,\\n \\"LogInfos\\": {\\n \\"LogInfoDetail\\": [\\n {\\n \\"EndTime\\": \\"1695189600\\",\\n \\"LogName\\": \\"example.com\\\\n_2023_09_20_160000_170000.****.gz\\",\\n \\"LogPath\\": \\"****.aliyuncs.com/push_proxy/****/example.com/2023_09_20/1600/example.com\\\\n_2023_09_20_160000_170000.****.gz\\",\\n \\"LogSize\\": 512,\\n \\"StartTime\\": \\"1695193200\\"\\n }\\n ]\\n },\\n \\"PageInfos\\": {\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 20\\n }\\n }\\n ]\\n },\\n \\"DomainName\\": \\"example.com\\",\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A52FA7\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLivePushProxyLogResponse>\\n <DomainName>example.com</DomainName>\\n <RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>\\n <DomainLogDetails>\\n <LogCount>10</LogCount>\\n <LogInfos>\\n <EndTime>1695189600</EndTime>\\n <LogSize>512</LogSize>\\n <StartTime>1695193200</StartTime>\\n <LogName>example.com\\n_2023_09_20_160000_170000.****.gz</LogName>\\n <LogPath>****.aliyuncs.com/push_proxy/****/example.com/2023_09_20/1600/example.com\\n_2023_09_20_160000_170000.****.gz</LogPath>\\n </LogInfos>\\n <PageInfos>\\n <PageIndex>1</PageIndex>\\n <PageSize>20</PageSize>\\n <Total>20</Total>\\n </PageInfos>\\n </DomainLogDetails>\\n</DescribeLivePushProxyLogResponse>","errorExample":""}]', + 'title' => '查询转推离线日志下载地址', + 'description' => '- 查询数据时间粒度：1小时。'."\n" + .'- 最大查询范围：最近31天的数据。'."\n" + .'- 如果不指定StartTime和EndTime，该接口默认读取过去24小时的数据；指定StartTime和EndTime时，按指定的起止时间查询。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteLiveRealTimeLogLogstore' => [ + 'summary' => '调用DeleteLiveRealTimeLogLogstore删除实时日志推送的logstore。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive066BXV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的ProjectName。', + 'type' => 'string', + 'required' => true, + 'example' => 'project_example', + ], + ], + [ + 'name' => 'Logstore', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的LogStoreName。', + 'type' => 'string', + 'required' => true, + 'example' => 'logstore_example', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '实时投递SLS的Region。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9732E117-8A37-49FD-A36F-ABBB*******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Unauthorized', + 'errorMessage' => 'RealtimeLogDelivery Service Not Authorized', + ], + ], + 404 => [ + [ + 'errorCode' => 'LogstoreNotExist', + 'errorMessage' => 'Logstore does not exist', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB*******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveRealTimeLogLogstoreResponse>\\n <RequestId>9732E117-8A37-49FD-A36F-ABBB87556CA7</RequestId>\\n</DeleteLiveRealTimeLogLogstoreResponse>","errorExample":""}]', + 'title' => '删除实时日志推送的logstore', + 'description' => '- 您可调用本接口删除实时日志推送的logstore，无其他特殊使用说明，调用时请保证参数设置符合要求。'."\n" + ."\n" + .'- 您可调用[DescribeLiveDomainRealtimeLogDelivery](~~2848121~~)查询Project、Logstore、Region参数信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为6000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 特定错误码'."\n" + .'| HttpCode| 错误码 | 错误信息|描述 |'."\n" + .'|--------------------------|----------------------|---------------------|-----------|'."\n" + .'| 403| Unauthorized | RealtimeLogDelivery Service Not Authorized | 没有开启实时投递授权。 |'."\n" + .'| 404| LogstoreNotExist | Logstore does not exist | 未找到对应Logstore信息。 |', + ], + 'DescribeLiveDomainLog' => [ + 'summary' => '获取直播指定域名的原始访问日志的下载地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '107021', + 'abilityTreeNodes' => [ + 'FEATURElive066BXV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名或推流域名。'."\n" + .'> - 传入DomainName时，请保证传入域名为直播域名，同时调用本接口的用户拥有传入域名的操作权限。'."\n" + .'> - 只支持单个域名查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。取值：'."\n" + ."\n" + .'- **1~1000**之间的任意整数。'."\n" + .'- 默认值为**300**。'."\n" + .'- 最大值为**1000**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + 'default' => '300', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。'."\n" + .'>若不指定PageNumber查询，将默认返回第一页数据。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2016-10-20T04:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'结束时间需大于起始时间。起始时间和结束时间，间隔不超过31天。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-10-20T05:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '播流域名或推流域名。'."\n", + 'type' => 'string', + 'example' => 'example.com', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'DomainLogDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DomainLogDetail' => [ + 'description' => 'DomainLogDetail组成的数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LogCount' => [ + 'description' => '本页返回的总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'LogInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogInfoDetail' => [ + 'description' => 'LogInfoDetail组成的数据。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。'."\n", + 'type' => 'string', + 'example' => '2016-10-20T05:00:00Z', + ], + 'LogSize' => [ + 'description' => '日志大小。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'StartTime' => [ + 'description' => '起始时间。'."\n", + 'type' => 'string', + 'example' => '2016-10-20T04:00:00Z', + ], + 'LogName' => [ + 'description' => '日志名称。', + 'type' => 'string', + 'example' => 'developer.aliyundoc.com_2016_10_20_040000_050000.gz', + ], + 'LogPath' => [ + 'description' => '日志路径。'."\n", + 'type' => 'string', + 'example' => 'learn.aliyundoc.com/developer.aliyundoc.com/2016_10_20/example.aliyundoc.com_2016_10_20_040000_050000.gz?Expires=1522659931&OSSAccessKeyId=LTAI******eo4ZEuA&Signature=C01p%2BtA%******KP9Sru2Oxwy7Do0%3D', + ], + ], + ], + ], + ], + ], + 'PageInfos' => [ + 'description' => '页面信息。', + 'type' => 'object', + 'properties' => [ + 'PageIndex' => [ + 'description' => '返回数据的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Total' => [ + 'description' => '总日志条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DomainName\\": \\"example.com\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"DomainLogDetails\\": {\\n \\"DomainLogDetail\\": [\\n {\\n \\"LogCount\\": 10,\\n \\"LogInfos\\": {\\n \\"LogInfoDetail\\": [\\n {\\n \\"EndTime\\": \\"2016-10-20T05:00:00Z\\",\\n \\"LogSize\\": 10,\\n \\"StartTime\\": \\"2016-10-20T04:00:00Z\\",\\n \\"LogName\\": \\"developer.aliyundoc.com_2016_10_20_040000_050000.gz\\",\\n \\"LogPath\\": \\"learn.aliyundoc.com/developer.aliyundoc.com/2016_10_20/example.aliyundoc.com_2016_10_20_040000_050000.gz?Expires=1522659931&OSSAccessKeyId=LTAI******eo4ZEuA&Signature=C01p%2BtA%******KP9Sru2Oxwy7Do0%3D\\"\\n }\\n ]\\n },\\n \\"PageInfos\\": {\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 20\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveDomainLogResponse>\\n<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n<DomainName>example.com</DomainName>\\n<DomainLogDetails>\\n <DomainLogDetail>\\n <LogCount>10</LogCount>\\n <LogInfos>\\n <LogInfoDetail>\\n <LogSize>10</LogSize>\\n <EndTime>2016-10-20T05:00:00Z</EndTime>\\n <StartTime>2016-10-20T04:00:00Z</StartTime>\\n <LogName>developer.aliyundoc.com_2016_10_20_040000_050000.gz</LogName>\\n <LogPath>learn.aliyundoc.com/developer.aliyundoc.com/2016_10_20/example.aliyundoc.com_2016_10_20_040000_050000.gz?Expires=1522659931&OSSAccessKeyId=LTAI******eo4ZEuA&Signature=C01p%2BtA%******KP9Sru2Oxwy7Do0%3D</LogPath>\\n </LogInfoDetail>\\n </LogInfos>\\n <PageInfos>\\n <PageSize>20</PageSize>\\n <Total>20</Total>\\n <PageIndex>1</PageIndex>\\n </PageInfos>\\n </DomainLogDetail>\\n</DomainLogDetails>\\n</DescribeLiveDomainLogResponse>","errorExample":""}]', + 'title' => '查询日志下载地址', + 'description' => '- 调用一次API仅支持查询单个域名的离线日志。'."\n" + .'- 可选参数StartTime和EndTime需要同时指定，指定起止时间后查询指定时间范围内的日志。'."\n" + .'- 不指定StartTime和EndTime时，默认读取过去24小时的日志数据。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateLiveStreamMonitor' => [ + 'summary' => '创建监播室。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106895', + 'abilityTreeNodes' => [ + 'FEATUREliveSM955S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'MonitorName', + 'in' => 'query', + 'schema' => [ + 'description' => '监播名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveMonitor****', + ], + ], + [ + 'name' => 'OutputTemplate', + 'in' => 'query', + 'schema' => [ + 'description' => '监播输出模版。类型取值：'."\n" + ."\n" + .'- **lp_ld**：流畅。'."\n" + .'- **lp_sd**：标清。'."\n" + .'- **lp_hd**：高清。'."\n" + .'- **lp_ud**：超清。', + 'type' => 'string', + 'required' => true, + 'example' => 'lp_ud', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '监播域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '监播输出流的App。'."\n" + .'名称可自取，不传默认用**monitor**作为AppName名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'monitor****', + ], + ], + [ + 'name' => 'Stream', + 'in' => 'query', + 'schema' => [ + 'description' => '监播输出流名，不传则系统随机生成。', + 'type' => 'string', + 'required' => false, + 'example' => 'monitorStream****', + ], + ], + [ + 'name' => 'InputList', + 'in' => 'query', + 'schema' => [ + 'description' => '监控流输入列表。具体内容，请参考下表**InputConfig**。', + 'type' => 'string', + 'required' => true, + 'example' => 'InputConfig', + ], + ], + [ + 'name' => 'MonitorConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '监播告警阈值设置，JSON格式，具体内容，请参考下表MonitorConfig。', + 'type' => 'string', + 'required' => false, + 'example' => '"{\\"fpsLowThres\\": 0.6,\\"brLowThres\\": 1.1,\\"eofDurationThresSec\\": 10}"', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '支持输入HTTP(S)格式的回调地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://guide.aliyundoc.com/notify', + ], + ], + [ + 'name' => 'DingTalkWebHookUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '监播钉钉告警通过钉群机器人进行告警信息的通知，请先设置钉群机器人，并在此输入机器人的HTTP(S)地址。详情请参见[自定义机器人接入](https://open.dingtalk.com/document/robots/custom-robot-access)。'."\n" + ."\n" + .'> 配置钉群机器人自定义关键词为“告警”，否则消息无法接收。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MonitorId' => [ + 'description' => '监播室ID。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b96****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'StreamMonitorExist', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MonitorId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9****\\",\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b96****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateLiveStreamMonitorResponse>\\n<RequestId>5c6a2a0d-f228-4a64-af62-20e91b9676b3</RequestId>\\n<MonitorId>445409ec-7eaa-461d-8f29-4bec2eb9****</MonitorId>\\n</CreateLiveStreamMonitorResponse>","errorExample":""}]', + 'title' => '创建监播室', + 'description' => '调用本接口创建监播室，调用时请保证参数设置符合要求。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '**InputConfig**'."\n" + .'|名称|类型|描述|示例值|'."\n" + .'|----|----|------|-----|'."\n" + .'|Index|Integer|索引，前端使用。|1|'."\n" + .'|LayoutId|Integer|布局ID，必须从1开始。|1|'."\n" + .'|StreamName|String|监播流的显示名称。|monitorStream****|'."\n" + .'|InputUrl|String|输入流地址。|demo.aliyundoc.com|'."\n" + .'|LayoutConfig|LayoutConfig|布局信息。|参考下表**LayoutConfig**|'."\n" + .'|PlayConfig|PlayConfig|播放配置。|参考下表**PlayConfig**|'."\n" + ."\n" + .'**LayoutConfig**'."\n" + .'|名称|类型|描述|示例值|'."\n" + .'|----|----|------|-----|'."\n" + .'|FillMode|String|填充类型，前端填none即可。|none|'."\n" + .'|PositionRefer|String|设置元素的position参考坐标值，取值：topLeft（左上），topRight（右上），bottomLeft（左下），bottomRight（右下）。|topLeft|'."\n" + .'|PositionNormalized|Float|表示该Layer元素填充区位置归一化值[x,y]。<br>x和y的取值范围为0~1。<br>例如[0.1,0.1] 代表左上角水平偏移10%, 垂直偏移10%。|[0.1, 0.1]|'."\n" + .'|SizeNormalized|Float|表示该Layer元素需要填充的尺寸大小[w,h]。<br> w和h取值范围为0~1，宽高都是进行了归一化计算。<br>例如 [0.2,0.3]代表水平占比20%，垂直占比30%。|[0.2, 0.3]|'."\n" + ."\n" + .'**PlayConfig**'."\n" + .'|名称|类型|描述|示例值|'."\n" + .'|----|----|------|-----|'."\n" + .'|VolumeRate|Float|音量。取值0~1之间，精确小数点后2位。|0.50|'."\n" + ."\n" + .'**MonitorConfig**'."\n" + .'|名称|类型|描述|示例值|'."\n" + .'|----|----|------|-----|'."\n" + .'|fpsLowThres|Float|视频帧率告警阈值。此阈值为比例系数，取值范围（0.0,1.0]，默认值0.7。当监播流的视频帧率＜帧率告警阈值*直播流原始帧率，则会报警。|0.7|'."\n" + .'|brHighThres|Float|音视频码率告警阈值。此阈值为比例系数，取值范围（0.0,100]，默认值1.0。当监播流的音视频码率＞码率告警阈值*直播流原始码率，则会报警。|1.0|'."\n" + .'|eofDurationThresSec|Float|断流时长检测阈值，表示当前监播流断流超过多少时间（单位：秒）才会报警。取值范围（0,65535]，默认值0。- 由于断流后连接不断，系统会有内部收包超时时间（5秒）来判断断流。因此如果设置此参数时间<=5s，实际检测时间仍为5s；如果设置该项时间>5s，实际检测时间为设置值，只是前5s为内部收包超时，剩余时间为持续等待流没有恢复时间。 - 如果断流后没达到此超时时间流自动恢复，则不会报警。如果断流未超时，此时修改了监播地址，对前流也不会继续检测超时和报警。|10|'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateLiveStreamMonitor' => [ + 'summary' => '更新监播室配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107285', + 'abilityTreeNodes' => [ + 'FEATUREliveSM955S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'MonitorId', + 'in' => 'query', + 'schema' => [ + 'description' => '监播室ID。'."\n" + .'>通过查看[CreateLiveStreamMonitor](~~2848129~~)接口的返回参数获取MonitorId值。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'MonitorName', + 'in' => 'query', + 'schema' => [ + 'description' => '监播室名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveMonitor****', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '监播输出域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '监播输出流的App。'."\n" + .'名称可自取，不传默认用**monitor**作为AppName名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'monitor****', + ], + ], + [ + 'name' => 'Stream', + 'in' => 'query', + 'schema' => [ + 'description' => '监播输出流名。', + 'type' => 'string', + 'required' => false, + 'example' => 'monitorStream****', + ], + ], + [ + 'name' => 'OutputTemplate', + 'in' => 'query', + 'schema' => [ + 'description' => '监播输出模版。类型取值：'."\n" + ."\n" + .'- **lp_ld**：流畅。'."\n" + .'- **lp_sd**：标清。'."\n" + .'- **lp_hd**：高清。'."\n" + .'- **lp_ud**：超清。', + 'type' => 'string', + 'required' => false, + 'example' => 'lp_ud', + ], + ], + [ + 'name' => 'InputList', + 'in' => 'query', + 'schema' => [ + 'description' => '监控流输入列表。具体内容，请参考下表**InputConfig**。', + 'type' => 'string', + 'required' => true, + 'example' => 'InputConfig', + ], + ], + [ + 'name' => 'MonitorConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '监播告警阈值设置，JSON格式，具体内容，请参考下表MonitorConfig。', + 'type' => 'string', + 'required' => false, + 'example' => '"{\\"fpsLowThres\\": 0.6,\\"brLowThres\\": 1.1,\\"eofDurationThresSec\\": 10}"', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '支持输入HTTP(S)格式的回调地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://guide.aliyundoc.com/notify', + ], + ], + [ + 'name' => 'DingTalkWebHookUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '监播钉钉告警通过钉群机器人进行告警信息的通知，请先设置钉群机器人，并在此输入机器人的HTTP(S)地址。详情请参见[自定义机器人接入](https://open.dingtalk.com/document/robots/custom-robot-access)。'."\n" + ."\n" + .'> 配置钉群机器人自定义关键词为“告警”，否则消息无法接收。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b9676b3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidMonitorId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomainName.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'StreamMonitorNotExist', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b9676b3\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveStreamMonitorResponse>\\r\\n<RequestId>5c6a2a0d-f228-4a64-af62-20e91b9676b3</RequestId>\\r\\n</UpdateLiveStreamMonitorResponse>","errorExample":""}]', + 'title' => '更新监播室', + 'description' => '此接口针对监播室配置进行更新，监播室在启动状态下对输入源配置更新可实时生效。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '**InputConfig**'."\n" + .'|名称|类型|描述|示例值|'."\n" + .'|----|----|------|-----|'."\n" + .'|Index|Integer|索引，前端使用。|1|'."\n" + .'|LayoutId|Integer|布局ID，必须从1开始。|1|'."\n" + .'|StreamName|String|监播流的显示名称。|monitorStream****|'."\n" + .'|InputUrl|String|输入流地址。|demo.aliyundoc.com|'."\n" + .'|LayoutConfig|LayoutConfig|布局信息。|参考下表**LayoutConfig**|'."\n" + .'|PlayConfig|PlayConfig|播放配置。|参考下表**PlayConfig**|'."\n" + ."\n" + .'**LayoutConfig**'."\n" + .'|名称|类型|描述|示例值|'."\n" + .'|----|----|------|-----|'."\n" + .'|FillMode|String|填充类型，前端填none即可。|none|'."\n" + .'|PositionRefer|String|设置元素的position参考坐标值，取值：TopLeft（左上），TopRight（右上），BottomLeft（左下），BottomRight（右下）。|TopLeft|'."\n" + .'|PositionNormalized|Float|表示该Layer元素填充区位置归一化值[x,y]。<br>x和y的取值范围为0~1。<br>例如[0.1,0.1] 代表左上角水平偏移10%, 垂直偏移10%。|[0.1, 0.1]|'."\n" + .'|SizeNormalized|Float|表示该Layer元素需要填充的尺寸大小[w,h]。<br> w和h取值范围为0~1，宽高都是进行了归一化计算。<br>例如 [0.2,0.3]代表水平占比20%，垂直占比30%。|[0.2, 0.3]|'."\n" + ."\n" + .'**PlayConfig**'."\n" + .'|名称|类型|描述|示例值|'."\n" + .'|----|----|------|-----|'."\n" + .'|VolumeRate|Float|音量。取值0~1之间，精确小数点后2位。|0.50|'."\n" + ."\n" + .'**MonitorConfig**'."\n" + .'|名称|类型|描述|示例值|'."\n" + .'|----|----|------|-----|'."\n" + .'|fpsLowThres|Float|视频帧率告警阈值。此阈值为比例系数，取值范围（0.0,1.0]，默认值0.7。当监播流的视频帧率＜帧率告警阈值*直播流原始帧率，则会报警。|0.7|'."\n" + .'|brHighThres|Float|音视频码率告警阈值。此阈值为比例系数，取值范围（0.0,100]，默认值1.0。当监播流的音视频码率＞码率告警阈值*直播流原始码率，则会报警。|1.0|'."\n" + .'|eofDurationThresSec|Float|断流时长检测阈值，表示当前监播流断流超过多少时间（单位：秒）才会报警。取值范围（0,65535]，默认值0。 - 由于断流后连接不断，系统会有内部收包超时时间（5秒）来判断断流。因此如果设置此参数时间<=5s，实际检测时间仍为5s；如果设置该项时间>5s，实际检测时间为设置值，只是前5s为内部收包超时，剩余时间为持续等待流没有恢复时间。 - 如果断流后没达到此超时时间流自动恢复，则不会报警。如果断流未超时，此时修改了监播地址，对前流也不会继续检测超时和报警。|10|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveStreamMonitorList' => [ + 'summary' => '查询已创建的监播室列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveSM955S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'MonitorId', + 'in' => 'query', + 'schema' => [ + 'description' => '监播室ID。'."\n" + .'>通过查看[CreateLiveStreamMonitor](~~2848129~~)接口的返回参数获取MonitorId值。若参数为空，默认返回所有监播室合并后的数据。', + 'type' => 'string', + 'required' => false, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页数值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页监播室数值个数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '监播室内状态。取值：'."\n" + ."\n" + .'- 1：监播中。'."\n" + .'- 0：未监播。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'OrderRule', + 'in' => 'query', + 'schema' => [ + 'description' => '启动时间顺序。取值：'."\n" + ."\n" + .'- 0：默认（按启动状态倒序，启动时间不参与排序）。'."\n" + .'- 1：启动时间倒序。'."\n" + .'- 2：启动时间正序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2234baba-a586-46ea-8bd4-c8f7891abcdef', + ], + 'LiveStreamMonitorList' => [ + 'description' => '监播室列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MonitorConfig' => [ + 'description' => '监播告警阈值设置。参数字段如下：'."\n" + .'- fpsLowThres：视频帧率告警阈值，Float类型。'."\n" + .'- brHighThres：音视频码率告警阈值，Float类型。'."\n" + .'- eofDurationThresSec：断流时长检测阈值，Float类型。', + 'type' => 'string', + 'example' => '"{\\"fpsLowThres\\": 0.6,\\"brLowThres\\": 1.1,\\"eofDurationThresSec\\": 10}"', + ], + 'Status' => [ + 'description' => '监播室内状态。取值：'."\n" + ."\n" + .'- 1：监播中。'."\n" + .'- 0：未监播。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MonitorId' => [ + 'description' => '监播室ID。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + 'Domain' => [ + 'description' => '监播输出域名。', + 'type' => 'string', + 'example' => 'demo.aliyundoc.com', + ], + 'CallbackUrl' => [ + 'description' => '监播告警通知回调地址。', + 'type' => 'string', + 'example' => 'http://guide.aliyundoc.com/notify', + ], + 'AudioFrom' => [ + 'description' => '布局声音来源。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DingTalkWebHookUrl' => [ + 'description' => '钉群机器人URL。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa****', + ], + 'MonitorName' => [ + 'description' => '监播室名称。', + 'type' => 'string', + 'example' => 'liveMonito****', + ], + 'StopTime' => [ + 'description' => '停止监播时间，UTC格式。', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'StartTime' => [ + 'description' => '开始监播时间，UTC格式。', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'OutputTemplate' => [ + 'description' => '监播输出分辨率模板。类型取值：'."\n" + ."\n" + .'- **lp_ld**：流畅。'."\n" + .'- **lp_sd**：标清。'."\n" + .'- **lp_hd**：高清。'."\n" + .'- **lp_ud**：超清。', + 'type' => 'string', + 'example' => 'lp_ud', + ], + 'Region' => [ + 'description' => '地区。取值：'."\n" + ."\n" + .'- cn-shanghai：上海。'."\n" + .'- cn-beijing：北京。'."\n" + .'- ap-southeast-1：新加坡。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'InputList' => [ + 'description' => '监控流输入列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => '索引，前端使用。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InputUrl' => [ + 'description' => '输入流地址。', + 'type' => 'string', + 'example' => 'demo.aliyundoc.com', + ], + 'LayoutId' => [ + 'description' => '布局ID，必须从1开始。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StreamName' => [ + 'description' => '监播流的显示名称。', + 'type' => 'string', + 'example' => 'monitorStream****', + ], + 'LayoutConfig' => [ + 'description' => '布局信息。', + 'type' => 'object', + 'properties' => [ + 'FillMode' => [ + 'description' => '填充类型，前端填none即可。', + 'type' => 'string', + 'example' => 'none', + ], + 'PositionRefer' => [ + 'description' => '设置元素的position参考坐标值，取值：'."\n" + ."\n" + .'- topLeft'."\n" + .'- topRight'."\n" + .'- bottomLeft'."\n" + .'- bottomRight'."\n" + ."\n", + 'type' => 'string', + 'example' => 'topLeft', + ], + 'PositionNormalized' => [ + 'description' => '位置归一化值[unk][x,y][unk]，默认为[unk][0,0][unk]。>x，y需要进行归一化计算。', + 'type' => 'array', + 'items' => [ + 'description' => '表示该Layer元素填充区位置\\[x,y]，x和y归一化百分比。<br>例如\\[0.1,0.1]代表左上角水平偏移10%, 垂直偏移10%。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + ], + 'SizeNormalized' => [ + 'description' => '字幕文件大小，单位为字节。', + 'type' => 'array', + 'items' => [ + 'description' => 'Layer元素需要填充的尺寸大小\\[w,h]，w和h归一化百分比。<br>例如\\[0.2,0.3]代表水平占比20%，垂直占比30%。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.3', + ], + ], + ], + ], + 'PlayConfig' => [ + 'description' => '播放配置。', + 'type' => 'object', + 'properties' => [ + 'VolumeRate' => [ + 'description' => '音量。取值0~1之间，精确小数点后2位。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.50', + ], + ], + ], + ], + ], + ], + 'OutputUrls' => [ + 'description' => '监播输出地址。', + 'type' => 'object', + 'properties' => [ + 'FlvUrl' => [ + 'description' => 'FLV输出地址。', + 'type' => 'string', + 'example' => 'http://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****.flv', + ], + 'RtmpUrl' => [ + 'description' => 'RTMP输出地址。', + 'type' => 'string', + 'example' => 'rtmp://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Total\\": 1,\\n \\"RequestId\\": \\"2234baba-a586-46ea-8bd4-c8f7891abcdef\\",\\n \\"LiveStreamMonitorList\\": [\\n {\\n \\"MonitorConfig\\": \\"\\\\\\"{\\\\\\\\\\\\\\"fpsLowThres\\\\\\\\\\\\\\": 0.6,\\\\\\\\\\\\\\"brLowThres\\\\\\\\\\\\\\": 1.1,\\\\\\\\\\\\\\"eofDurationThresSec\\\\\\\\\\\\\\": 10}\\\\\\"\\",\\n \\"Status\\": 1,\\n \\"MonitorId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9****\\",\\n \\"Domain\\": \\"demo.aliyundoc.com\\",\\n \\"CallbackUrl\\": \\"http://guide.aliyundoc.com/notify\\",\\n \\"AudioFrom\\": 1,\\n \\"DingTalkWebHookUrl\\": \\"https://oapi.dingtalk.com/robot/send?access_token=7a7d404056eee1f2fd944ace9bcfc361dc6448583e1d3d3baa****\\",\\n \\"MonitorName\\": \\"liveMonito****\\",\\n \\"StopTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"StartTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"OutputTemplate\\": \\"lp_ud\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"InputList\\": [\\n {\\n \\"Index\\": 1,\\n \\"InputUrl\\": \\"demo.aliyundoc.com\\",\\n \\"LayoutId\\": 1,\\n \\"StreamName\\": \\"monitorStream****\\",\\n \\"LayoutConfig\\": {\\n \\"FillMode\\": \\"none\\",\\n \\"PositionRefer\\": \\"topLeft\\",\\n \\"PositionNormalized\\": [\\n 0.1\\n ],\\n \\"SizeNormalized\\": [\\n 0.3\\n ]\\n },\\n \\"PlayConfig\\": {\\n \\"VolumeRate\\": 0.5\\n }\\n }\\n ],\\n \\"OutputUrls\\": {\\n \\"FlvUrl\\": \\"http://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****.flv\\",\\n \\"RtmpUrl\\": \\"rtmp://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamMonitorListResponse>\\n<RequestId>2234baba-a586-46ea-8bd4-c8f7891abcdef</RequestId>\\n<Total>1</Total>\\n<LiveStreamMonitorList>\\n <Status>1</Status>\\n <AudioFrom>1</AudioFrom>\\n <OutputTemplate>lp_ud</OutputTemplate>\\n <StartTime>2017-01-11T12:00:00Z</StartTime>\\n <MonitorName>liveMonito****</MonitorName>\\n <Region>cn-shanghai</Region>\\n <Domain>demo.aliyundoc.com</Domain>\\n <MonitorId>445409ec-7eaa-461d-8f29-4bec2eb9****</MonitorId>\\n <StopTime>2017-01-11T12:00:00Z</StopTime>\\n <InputList>\\n <StreamName>monitorStream****</StreamName>\\n <LayoutId>1</LayoutId>\\n <Index>1</Index>\\n <InputUrl>demo.aliyundoc.com</InputUrl>\\n <LayoutConfig>\\n <FillMode>none</FillMode>\\n <PositionRefer>topLeft</PositionRefer>\\n <PositionNormalized>0.1</PositionNormalized>\\n <SizeNormalized>0.3</SizeNormalized>\\n </LayoutConfig>\\n <PlayConfig>\\n <VolumeRate>0.50</VolumeRate>\\n </PlayConfig>\\n </InputList>\\n <OutputUrls>\\n <FlvUrl>http://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****.flv</FlvUrl>\\n <RtmpUrl>rtmp://demo.aliyundoc.com/monitor/445409ec-7eaa-461d-8f29-4bec2eb9****</RtmpUrl>\\n </OutputUrls>\\n</LiveStreamMonitorList>\\n</DescribeLiveStreamMonitorListResponse>","errorExample":""}]', + 'title' => '查询监播室列表', + 'description' => '先[创建监播室](~~2848129~~)后再调用本接口查询监播室列表，调用时请保证参数设置符合要求。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StartLiveStreamMonitor' => [ + 'summary' => '开启监播。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREliveSM955S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'MonitorId', + 'in' => 'query', + 'schema' => [ + 'description' => '监播室ID。'."\n" + .'>通过查看[CreateLiveStreamMonitor](~~2848129~~)接口的返回参数获取MonitorId值。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b9676b3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidMonitorId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'StreamMonitorAlreadyStarted', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserQuotaExceed', + 'errorMessage' => 'Quota exceeded: %s.', + ], + ], + [ + [ + 'errorCode' => 'StreamMonitorNotExist', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b9676b3\\"\\n}","errorExample":""},{"type":"xml","example":"<StartLiveStreamMonitorResponse>\\r\\n<RequestId>5c6a2a0d-f228-4a64-af62-20e91b9676b3</RequestId>\\r\\n</StartLiveStreamMonitorResponse>","errorExample":""}]', + 'title' => '开启监播', + 'description' => '先通过[CreateLiveStreamMonitor](~~2848129~~)创建监播室，由接口返回参数获取**MonitorId**后开启监播。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopLiveStreamMonitor' => [ + 'summary' => '停止监播。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveSM955S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'MonitorId', + 'in' => 'query', + 'schema' => [ + 'description' => '监播室ID。'."\n" + .'>可查看[CreateLiveStreamMonitor](~~2848129~~)接口返回参数值获取**MonitorId**。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b9676b3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidMonitorId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'StreamMonitorAlreadyStop', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserQuotaExceed', + 'errorMessage' => 'Quota exceeded: %s.', + ], + ], + [ + [ + 'errorCode' => 'StreamMonitorNotExist', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b9676b3\\"\\n}","errorExample":""},{"type":"xml","example":"<StopLiveStreamMonitorResponse>\\r\\n<RequestId>5c6a2a0d-f228-4a64-af62-20e91b9676b3</RequestId>\\r\\n</StopLiveStreamMonitorResponse>","errorExample":""}]', + 'title' => '停止监播', + 'description' => '由创建监播室[CreateLiveStreamMonitor](~~2848129~~)接口返回参数获取**MonitorId**后开启监播，再调用本接口停止监播。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveStreamMonitor' => [ + 'summary' => '删除监播室。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveSM955S', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'MonitorId', + 'in' => 'query', + 'schema' => [ + 'description' => '监播室ID。'."\n" + .'>可查看[CreateLiveStreamMonitor](~~2848129~~)接口返回参数值获取**MonitorId**。', + 'type' => 'string', + 'required' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0d-f228-4a64-af62-20e91b9676b3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidMonitorId.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'StreamMonitorNotExist', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0d-f228-4a64-af62-20e91b9676b3\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveStreamMonitorResponse>\\r\\n<RequestId>5c6a2a0d-f228-4a64-af62-20e91b9676b3</RequestId>\\r\\n</DeleteLiveStreamMonitorResponse>","errorExample":""}]', + 'title' => '删除监播室', + 'description' => '通过创建监播室[CreateLiveStreamMonitor](~~2848129~~)接口返回参数获取**MonitorId**，再调用本接口删除监播室。'."\n" + .'><notice>启动状态下的监播室不可以删除，删除时返回400报错。'."\n" + .'></notice>'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetMessageToken' => [ + 'summary' => '调用GetMessageToken获取长连接建连Token，客户端可以用此Token通过LWP协议和各个原子能力进行长连接通信。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用ID', + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a494caec-***-695ef345db77', + ], + ], + [ + 'name' => 'DeviceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '终端设备ID', + 'description' => '终端设备ID，唯一代表一个用户终端设备，用户自定义。小写英文、数字、下划线（_）和短横线（-）组成，最大长度64个字符。不同终端设备需要使用不同的DeviceId，建议从终端设备获取并传入给服务端。', + 'type' => 'string', + 'required' => true, + 'example' => 'a494caec-***-695ef345db77', + ], + ], + [ + 'name' => 'DeviceType', + 'in' => 'formData', + 'schema' => [ + 'title' => '终端设备类型', + 'description' => '终端设备类型，取值：'."\n" + ."\n" + .'- ios'."\n" + ."\n" + .'- android'."\n" + ."\n" + .'- web'."\n" + ."\n" + .'- pc'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'android', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户UserId,在AppId下单独唯一', + 'description' => '用户UserId，用户自定义，在AppId下单独唯一。小写英文、数字、下划线（_）和小数点（.）组成，最大长度32个字符。不同的用户需要使用不同的UserId。', + 'type' => 'string', + 'required' => true, + 'example' => 'de1**a0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'AccessToken' => [ + 'title' => '用于长连接建连的token', + 'description' => '用于长连接建连的Token。', + 'type' => 'string', + 'example' => 'oauth_cloud_key:***-b0YY5Gy6Q', + ], + 'AccessTokenExpiredTime' => [ + 'title' => '登录token过期时间(毫秒)', + 'description' => '登录Token过期时间，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '86400000', + ], + 'RefreshToken' => [ + 'title' => '更新Token，若AccessToken过期，则可以使用RefreshToken再次获取新Token', + 'description' => '更新Token，若AccessToken过期，则可以使用RefreshToken再次获取新Token。', + 'type' => 'string', + 'example' => 'oauth_cloud_key:****-Q62xggOTdgk3gw=', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvaildParameter', + 'errorMessage' => 'Invalid Parameter', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"AccessToken\\": \\"oauth_cloud_key:***-b0YY5Gy6Q\\",\\n \\"AccessTokenExpiredTime\\": 86400000,\\n \\"RefreshToken\\": \\"oauth_cloud_key:****-Q62xggOTdgk3gw=\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMessageTokenResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <AccessToken>oauth_cloud_key:***-b0YY5Gy6Q</AccessToken>\\n <RefreshToken>oauth_cloud_key:****-Q62xggOTdgk3gw=</RefreshToken>\\n <AccessTokenExpiredTime>86400000</AccessTokenExpiredTime>\\n </Result>\\n</GetMessageTokenResponse>","errorExample":""}]', + 'title' => '获取长连接建连Token（旧版）', + 'description' => '## 使用说明'."\n" + .'先获取客户端UserId、DeviceId、DeviceType信息，然后传入到服务端，服务端使用该接口获取鉴权Token，并返回给客户端。不同的用户需要使用不同的UserId，不同的终端设备需要使用不同的DeviceId。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'CreateMessageApp' => [ + 'summary' => '调用CreateMessageApp创建互动消息应用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用名称，长度2~16个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'AppConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '应用配置。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '应用的配置信息，用户自定义内容。', + 'example' => '"appAlias":"localApp"', + ], + ], + ], + [ + 'name' => 'Extension', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '拓展字段。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '拓展字段，按需传递，需要额外记录的应用属性。', + 'example' => 'test001', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'title' => '用于长连接建连的token', + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'example' => 'VKL3***', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"AppId\\": \\"VKL3***\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateMessageAppResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <AppId>7m***q</AppId>\\n </Result>\\n</CreateMessageAppResponse>","errorExample":""}]', + 'title' => '创建互动消息应用（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。'."\n", + ], + 'UpdateMessageApp' => [ + 'summary' => '调用UpdateMessageApp更新互动消息应用信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'AppConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '应用配置。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '应用的配置信息，用户自定义内容。', + 'example' => '"appAlias":"localApp"', + ], + ], + ], + [ + 'name' => 'Extension', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '拓展字段。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '拓展字段，按需传递，需要额外记录的应用属性。', + 'example' => 'test001', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '更新是否成功，取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：不成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"Success\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateMessageAppResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <Success>true</Success>\\n </Result>\\n</UpdateMessageAppResponse>","errorExample":""}]', + 'title' => '更新互动消息应用信息（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'ListMessageApp' => [ + 'summary' => '调用ListMessageApp查询互动消息应用列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SortType', + 'in' => 'formData', + 'schema' => [ + 'description' => '排列方式，取值：'."\n" + ."\n" + .'- 0：时间递增顺序。'."\n" + ."\n" + .'- 1：时间递减顺序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码，默认值：1。取值范围：1~100000。'."\n" + .'> 此页码为当前展示页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '单页显示应用的数量，默认值：20。取值范围：1~50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'AppList' => [ + 'description' => '应用列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppConfig' => [ + 'description' => '应用配置。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '应用的配置。', + 'example' => '"appAlias":"localApp"', + ], + ], + 'AppId' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'example' => 'VKL3***', + ], + 'AppName' => [ + 'description' => '互动消息应用名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => '应用创建的UTC时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '502280113', + ], + 'Extension' => [ + 'description' => '拓展字段。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'test001', + 'description' => '拓展字段。', + ], + ], + 'Status' => [ + 'description' => '互动消息应用状态。取值为**1**表示应用状态正常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'HasMore' => [ + 'description' => '是否还有下一页，取值：'."\n" + ."\n" + .'- true：有下一页。'."\n" + ."\n" + .'- false：没有下一页。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Total' => [ + 'description' => '互动消息应用总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"AppList\\": [\\n {\\n \\"AppConfig\\": {\\n \\"key\\": \\"\\\\\\"appAlias\\\\\\":\\\\\\"localApp\\\\\\"\\"\\n },\\n \\"AppId\\": \\"VKL3***\\",\\n \\"AppName\\": \\"test\\",\\n \\"CreateTime\\": 502280113,\\n \\"Extension\\": {\\n \\"key\\": \\"test001\\"\\n },\\n \\"Status\\": 1\\n }\\n ],\\n \\"HasMore\\": false,\\n \\"Total\\": 15\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMessageAppResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <Total>15</Total>\\n <HasMore>false</HasMore>\\n <AppList>\\n <AppId>VKL3***</AppId>\\n <AppName>test</AppName>\\n <CreateTime>502280113</CreateTime>\\n <Status>1</Status>\\n <AppConfig>\\n <key>\\"appAlias\\":\\"localApp\\"</key>\\n </AppConfig>\\n <Extension>\\n <key>test001</key>\\n </Extension>\\n </AppList>\\n </Result>\\n</ListMessageAppResponse>","errorExample":""}]', + 'title' => '查询互动消息应用列表（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'GetMessageApp' => [ + 'summary' => '调用GetMessageApp获取指定互动消息应用详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'AppConfig' => [ + 'description' => '应用配置。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '"appAlias":"localApp"', + 'description' => '应用的配置。', + ], + ], + 'AppId' => [ + 'title' => '应用ID。', + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'example' => 'VKL3***', + ], + 'AppName' => [ + 'title' => '应用名称。长度2~16位。', + 'description' => '互动消息应用名称。', + 'type' => 'string', + 'example' => 'testApp', + ], + 'CreateTime' => [ + 'description' => '应用创建的UTC时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '502280113', + ], + 'Extension' => [ + 'description' => '拓展字段。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '拓展字段。', + 'example' => 'test001', + ], + ], + 'Status' => [ + 'description' => '互动消息应用状态。取值为1表示应用状态正常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"AppConfig\\": {\\n \\"key\\": \\"\\\\\\"appAlias\\\\\\":\\\\\\"localApp\\\\\\"\\"\\n },\\n \\"AppId\\": \\"VKL3***\\",\\n \\"AppName\\": \\"testApp\\",\\n \\"CreateTime\\": 502280113,\\n \\"Extension\\": {\\n \\"key\\": \\"test001\\"\\n },\\n \\"Status\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMessageAppResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <AppId>VKL3***</AppId>\\n <AppName>testApp</AppName>\\n <Status>1</Status>\\n <AppConfig>\\n <key>\\"appAlias\\":\\"localApp\\"</key>\\n </AppConfig>\\n <Extension>\\n <key>test001</key>\\n </Extension>\\n </Result>\\n</GetMessageAppResponse>","errorExample":""}]', + 'title' => '获取指定互动消息应用详情（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'QueryMessageApp' => [ + 'summary' => '调用QueryMessageApp按指定条件查询互动消息应用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'formData', + 'schema' => [ + 'description' => '排列方式，取值：'."\n" + ."\n" + .'- 0：时间递增顺序。'."\n" + ."\n" + .'- 1：时间递减顺序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码，默认值：1。取值范围：1~100000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '单页显示应用的数量，默认值：20。取值范围：1~50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppList' => [ + 'description' => '互动消息应用列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppConfig' => [ + 'description' => '应用配置。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '应用的配置。', + 'example' => 'dawd', + ], + ], + 'AppId' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'example' => 'VKL3***', + ], + 'AppName' => [ + 'description' => '互动消息应用名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => '应用创建的UTC时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '502280113', + ], + 'Extension' => [ + 'description' => '拓展字段。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'test001', + 'description' => '拓展字段。', + ], + ], + 'Status' => [ + 'description' => '互动消息应用状态。取值为**1**表示应用状态正常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'HasMore' => [ + 'description' => '是否还有下一页，取值：'."\n" + ."\n" + .'- true：有下一页。'."\n" + ."\n" + .'- false：没有下一页。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TotalCount' => [ + 'description' => '查询到的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": [\\n {\\n \\"AppList\\": [\\n {\\n \\"AppConfig\\": {\\n \\"key\\": \\"dawd\\"\\n },\\n \\"AppId\\": \\"VKL3***\\",\\n \\"AppName\\": \\"test\\",\\n \\"CreateTime\\": 502280113,\\n \\"Extension\\": {\\n \\"key\\": \\"test001\\"\\n },\\n \\"Status\\": 1\\n }\\n ],\\n \\"HasMore\\": false,\\n \\"TotalCount\\": 4\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<QueryMessageAppResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <TotalCount>4</TotalCount>\\n <HasMore>false</HasMore>\\n <AppList>\\n <AppId>VKL3***</AppId>\\n <AppName>test</AppName>\\n <CreateTime>502280113</CreateTime>\\n <Status>1</Status>\\n <AppConfig>\\n <key>dawd</key>\\n </AppConfig>\\n <Extension>\\n <key>test001</key>\\n </Extension>\\n </AppList>\\n </Result>\\n</QueryMessageAppResponse>","errorExample":""}]', + 'title' => '按指定条件查询互动消息应用（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'DeleteMessageApp' => [ + 'summary' => '调用DeleteMessageApp删除互动消息应用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '需要删除的互动消息应用ID，仅支持配置单个应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '删除是否成功，取值：'."\n" + ."\n" + .'- true：成功删除。'."\n" + ."\n" + .'- false：删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"Success\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteMessageAppResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <Success>true</Success>\\n </Result>\\n</DeleteMessageAppResponse>","errorExample":""}]', + 'title' => '删除互动消息应用（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'CreateMessageGroup' => [ + 'summary' => '调用CreateMessageGroup创建消息组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a494caec-***-695ef345db77', + ], + ], + [ + 'name' => 'CreatorId', + 'in' => 'formData', + 'schema' => [ + 'description' => '创建人ID，仅支持英文和数字，最大长度36位。', + 'type' => 'string', + 'required' => true, + 'example' => 'as****hs', + ], + ], + [ + 'name' => 'Extension', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '拓展字段。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '拓展字段，按需传递，需要额外记录的消息组属性。', + 'example' => 'test001', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Extension' => [ + 'description' => '拓展字段。', + 'type' => 'object', + 'example' => 'test001', + ], + 'GroupId' => [ + 'title' => '用于长连接建连的token', + 'description' => '消息组ID。', + 'type' => 'string', + 'example' => 'AE35-****-T95F', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"Extension\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"GroupId\\": \\"AE35-****-T95F\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateMessageGroupResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <GroupId>AE35-****-T95F</GroupId>\\n </Result>\\n</CreateMessageGroupResponse>","errorExample":""}]', + 'title' => '创建消息组（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'UpdateMessageGroup' => [ + 'summary' => '调用UpdateMessageGroup更新消息组信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE35-****-T95F', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'Extension', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '拓展字段。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '消息组拓展字段。', + 'example' => 'test01', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '更新是否成功，取值：'."\n" + ."\n" + .'- true：成功更新。'."\n" + ."\n" + .'- false：更新失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"Success\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateMessageGroupResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <Success>true</Success>\\n </Result>\\n</UpdateMessageGroupResponse>","errorExample":""}]', + 'title' => '更新消息组（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'ListMessageGroupUser' => [ + 'summary' => '查询消息组成员。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE35-****-T95F', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'formData', + 'schema' => [ + 'description' => '排列方式，取值：'."\n" + ."\n" + .'- 0：时间递增顺序。'."\n" + ."\n" + .'- 1：时间递减顺序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码，默认值：1。'."\n" + ."\n" + .'取值范围：1~100000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '单页显示消息组成员的数量，默认值：20。'."\n" + ."\n" + .'取值范围：1~50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HasMore' => [ + 'description' => '是否还有下一页，取值：'."\n" + ."\n" + .'- true：有下一页。'."\n" + ."\n" + .'- false：没有下一页。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Total' => [ + 'description' => '消息组用户总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'UserList' => [ + 'description' => '用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户列表。', + 'type' => 'object', + 'properties' => [ + 'JoinTime' => [ + 'description' => '加入消息组的UTC时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12**45', + ], + 'UserId' => [ + 'description' => '用户UserId。', + 'type' => 'string', + 'example' => 'de1**a0,hu**9', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"HasMore\\": false,\\n \\"Total\\": 2,\\n \\"UserList\\": [\\n {\\n \\"JoinTime\\": 0,\\n \\"UserId\\": \\"de1**a0,hu**9\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMessageGroupUserResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <Total>2</Total>\\n <HasMore>false</HasMore>\\n <UserList>\\n <UserId>de1**a0,hu**9</UserId>\\n </UserList>\\n </Result>\\n</ListMessageGroupUserResponse>","errorExample":""}]', + 'title' => '查询消息组成员（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'ListMessageGroup' => [ + 'summary' => '调用ListMessageGroup查询指定用户下消息组列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户UserId，用户自定义，在AppId下单独唯一。不同的用户需要使用不同的UserId。'."\n" + .'> 正确填写此参数内容，才能正常查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'de1**a0', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。'."\n" + .'> 正确填写此参数内容，才能正常查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'formData', + 'schema' => [ + 'description' => '排列方式，取值：'."\n" + ."\n" + .'- 0：时间递增顺序。'."\n" + ."\n" + .'- 1：时间递减顺序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码，默认值：1。取值范围：1~100000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '单页显示消息组的数量，默认值：20。'."\n" + ."\n" + .'取值范围：1~50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'GroupList' => [ + 'description' => '消息组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '消息组详情。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'example' => 'VKL3***', + ], + 'CreateTime' => [ + 'description' => '消息组创建UTC时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1502280113', + ], + 'CreatorId' => [ + 'description' => '创建人ID。', + 'type' => 'string', + 'example' => 'as****hs', + ], + 'Extension' => [ + 'description' => '拓展字段。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'test001', + 'description' => '拓展字段。', + ], + ], + 'GroupId' => [ + 'description' => '消息组ID。', + 'type' => 'string', + 'example' => 'AE35-****-T95F', + ], + 'Status' => [ + 'description' => '消息组状态。默认值为**1**，表示消息组状态正常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'HasMore' => [ + 'description' => '是否还有下一页，取值：'."\n" + ."\n" + .'- true：有下一页。'."\n" + ."\n" + .'- false：没有下一页。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Total' => [ + 'description' => '消息组总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"GroupList\\": [\\n {\\n \\"AppId\\": \\"VKL3***\\",\\n \\"CreateTime\\": 1502280113,\\n \\"CreatorId\\": \\"as****hs\\",\\n \\"Extension\\": {\\n \\"key\\": \\"test001\\"\\n },\\n \\"GroupId\\": \\"AE35-****-T95F\\",\\n \\"Status\\": 1\\n }\\n ],\\n \\"HasMore\\": false,\\n \\"Total\\": 5\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMessageGroupResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <Total>5</Total>\\n <HasMore>false</HasMore>\\n <GroupList>\\n <GroupId>AE35-****-T95F</GroupId>\\n <AppId>VKL3***</AppId>\\n <CreateTime>1502280113</CreateTime>\\n <Status>1</Status>\\n <CreatorId>as****hs</CreatorId>\\n <Extension>\\n <key>test001</key>\\n </Extension>\\n </GroupList>\\n </Result>\\n</ListMessageGroupResponse>","errorExample":""}]', + 'title' => '查询指定用户下消息组（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。'."\n", + ], + 'GetMessageGroup' => [ + 'summary' => '调用GetMessageGroup获取消息组详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE35-****-T95F', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '消息组创建UTC时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1502280113', + ], + 'CreatorId' => [ + 'description' => '创建人ID。', + 'type' => 'string', + 'example' => 'as****hs', + ], + 'Extension' => [ + 'description' => '扩展字段。', + 'type' => 'object', + 'example' => '1', + ], + 'GroupId' => [ + 'title' => '用于长连接建连的token', + 'description' => '消息组ID。', + 'type' => 'string', + 'example' => 'AE35-****-T95F', + ], + 'IsMuteAll' => [ + 'description' => '该消息组是否启用了全员禁言。'."\n" + ."\n" + .'- true：启动全员禁言。'."\n" + ."\n" + .'- false：未启动全员禁言。'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Status' => [ + 'description' => '消息组状态。默认为**1**，表示消息组状态正常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"CreateTime\\": 1502280113,\\n \\"CreatorId\\": \\"as****hs\\",\\n \\"Extension\\": 1,\\n \\"GroupId\\": \\"AE35-****-T95F\\",\\n \\"IsMuteAll\\": true,\\n \\"Status\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMessageGroupResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <GroupId>AE35-****-T95F</GroupId>\\n <CreateTime>1502280113</CreateTime>\\n <Status>1</Status>\\n <CreatorId>as****hs</CreatorId>\\n <IsMuteAll>true</IsMuteAll>\\n </Result>\\n</GetMessageGroupResponse>","errorExample":""}]', + 'title' => '获取消息组详情（旧版）', + 'description' => '## 使用说明'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'JoinMessageGroup' => [ + 'summary' => '加入消息组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a494caec-***-695ef345db77', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '要加入的消息组ID，请确保传入的GroupId是存在的。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE35-****-T95F', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户UserId，用户自定义，在AppId下单独唯一。小写英文、数字、下划线（_）和小数点（.）组成，最大长度32个字符。不同的用户需要使用不同的UserId。', + 'type' => 'string', + 'required' => true, + 'example' => 'de1**a0', + ], + ], + [ + 'name' => 'BroadCastType', + 'in' => 'formData', + 'schema' => [ + 'description' => '系统消息扩散类型，取值：'."\n" + ."\n" + .'- 0（默认值）：不扩散。'."\n" + ."\n" + .'- 1：扩散到指定人。'."\n" + ."\n" + .'- 2：扩散到群组。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'BroadCastStatistics', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否扩散统计类消息，打开时在加入消息组后会广播消息组的统计信息，客户端可以接收处理该消息。取值：'."\n" + ."\n" + .'- true：扩散统计类消息。'."\n" + ."\n" + .'- false：不扩散统计类消息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '加入消息组是否成功，取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：不成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"Success\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<JoinMessageGroupResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <Success>true</Success>\\n </Result>\\n</JoinMessageGroupResponse>","errorExample":""}]', + 'title' => '加入消息组（旧版）', + 'description' => '本接口的单用户QPS限制为200次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'MuteAllGroupUser' => [ + 'summary' => '调用MuteAllGroupUser对消息组禁言，即开启全员禁言。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE35-****-T95F', + ], + ], + [ + 'name' => 'OperatorUserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '操作人用户UserId。该用户必须是群组的创建者。', + 'type' => 'string', + 'required' => true, + 'example' => 'de1**a0', + ], + ], + [ + 'name' => 'BroadCastType', + 'in' => 'formData', + 'schema' => [ + 'description' => '系统消息扩散类型，取值：'."\n" + ."\n" + .'- 0：不扩散。'."\n" + ."\n" + .'- 1：扩散到指定人。'."\n" + ."\n" + .'- 2：扩散到群组。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '禁言是否成功，取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：不成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"Success\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<MuteAllGroupUserResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <Success>true</Success>\\n </Result>\\n</MuteAllGroupUserResponse>","errorExample":""}]', + 'title' => '禁言消息组全员（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'MuteGroupUser' => [ + 'summary' => '调用MuteGroupUser批量禁言消息组内成员。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE35-****-T95F', + ], + ], + [ + 'name' => 'MuteUserList', + 'in' => 'formData', + 'style' => 'simple', + 'schema' => [ + 'description' => '禁言详情。', + 'type' => 'array', + 'items' => [ + 'description' => '禁言用户ID列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'qu***,yu1***', + ], + 'required' => true, + ], + ], + [ + 'name' => 'MuteTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '禁言的时间，单位：秒。'."\n" + ."\n" + .'>如果不传或者传0则采用默认禁言时间（86400秒）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'OperatorUserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '操作人用户UserId。'."\n" + .'> 该参数需填写且该用户必须是群组的创建者。', + 'type' => 'string', + 'required' => false, + 'example' => 'de1**a0', + ], + ], + [ + 'name' => 'BroadCastType', + 'in' => 'formData', + 'schema' => [ + 'description' => '系统消息扩散类型，取值：'."\n" + ."\n" + .'- 0：不扩散。'."\n" + ."\n" + .'- 1：扩散到指定人。'."\n" + ."\n" + .'- 2：扩散到群组。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '禁言是否成功，取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：不成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"Success\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<MuteGroupUserResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <Success>true</Success>\\n </Result>\\n</MuteGroupUserResponse>","errorExample":""}]', + 'title' => '批量禁言消息组内成员（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'CancelMuteGroupUser' => [ + 'summary' => '调用CancelMuteGroupUser批量取消消息组内禁言成员。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE35-****-T95F', + ], + ], + [ + 'name' => 'CancelMuteUserList', + 'in' => 'formData', + 'style' => 'simple', + 'schema' => [ + 'description' => '用户ID组。', + 'type' => 'array', + 'items' => [ + 'description' => '取消的禁言用户ID列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'qu***,yu1***', + ], + 'required' => true, + ], + ], + [ + 'name' => 'OperatorUserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '操作人用户UserId。'."\n" + .'> 该参数需填写且该用户必须是群组的创建者。', + 'type' => 'string', + 'required' => false, + 'example' => 'de1**a0', + ], + ], + [ + 'name' => 'BroadCastType', + 'in' => 'formData', + 'schema' => [ + 'description' => '系统消息扩散类型，取值：'."\n" + ."\n" + .'- 0（默认值）：不扩散。'."\n" + ."\n" + .'- 1：扩散到指定人。'."\n" + ."\n" + .'- 2：扩散到群组。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '取消禁言是否成功，取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：不成功。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"Success\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"<CancelMuteGroupUserResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <Success>false</Success>\\n </Result>\\n</CancelMuteGroupUserResponse>","errorExample":""}]', + 'title' => '批量取消消息组内禁言成员（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'CancelMuteAllGroupUser' => [ + 'summary' => '取消消息组用户的静音。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE35-****-T95F', + ], + ], + [ + 'name' => 'OperatorUserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '操作员的用户ID。'."\n" + .' > 此参数是必需的，用户必须是组的创建者。', + 'type' => 'string', + 'required' => false, + 'example' => 'de1**a0', + ], + ], + [ + 'name' => 'BroadCastType', + 'in' => 'formData', + 'schema' => [ + 'description' => '系统消息扩散类型，取值：'."\n" + ."\n" + .'- 0：不扩散。'."\n" + ."\n" + .'- 1：扩散到指定人。'."\n" + ."\n" + .'- 2：扩散到群组。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '服务的实际返回结果', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '取消是否成功，取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：不成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"Success\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<CancelMuteAllGroupUserResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <Success>true</Success>\\n </Result>\\n</CancelMuteAllGroupUserResponse>","errorExample":""}]', + 'title' => '取消消息组用户的静音（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'LeaveMessageGroup' => [ + 'summary' => '调用LeaveMessageGroup用户退出消息组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE35-****-T95F', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户UserId，用户自定义，在AppId下单独唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'de1**a0', + ], + ], + [ + 'name' => 'BroadCastType', + 'in' => 'formData', + 'schema' => [ + 'description' => '系统消息扩散类型，取值：'."\n" + ."\n" + .'- 0（默认值）：不扩散。'."\n" + ."\n" + .'- 1：扩散到指定人。'."\n" + ."\n" + .'- 2：扩散到群组。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'BroadCastStatistics', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否扩散统计类消息，打开时在加入消息组后会广播消息组的统计信息，客户端可以接收处理该消息。取值：'."\n" + ."\n" + .'- true：扩散统计类消息。'."\n" + ."\n" + .'- false：不扩散统计类消息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '离开消息组是否成功，取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：不成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"Success\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<LeaveMessageGroupResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <Success>true</Success>\\n </Result>\\n</LeaveMessageGroupResponse>","errorExample":""}]', + 'title' => '退出消息组（旧版）', + 'description' => '## 使用说明'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'SendLike' => [ + 'summary' => '调用SendLike设置系统点赞消息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '消息组ID。', + 'description' => '消息组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE35-****-T95F', + ], + ], + [ + 'name' => 'OperatorUserId', + 'in' => 'formData', + 'schema' => [ + 'title' => '操作者ID。示例值：testUserId。', + 'description' => '操作人用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'de1**a0', + ], + ], + [ + 'name' => 'Count', + 'in' => 'formData', + 'schema' => [ + 'title' => '点赞数。示例值：1。', + 'description' => '点赞数量。', + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'BroadCastType', + 'in' => 'formData', + 'schema' => [ + 'title' => '系统消息广播类型，取值0，1，2.'."\n" + .'0：不广播。'."\n" + .'1：广播至消息组指定成员。'."\n" + .'2：广播至消息组。', + 'description' => '系统消息扩散类型，取值：'."\n" + ."\n" + .'- 0：不扩散。'."\n" + ."\n" + .'- 1：扩散到指定人。'."\n" + ."\n" + .'- 2：扩散到群组。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'LikeCount' => [ + 'description' => '点赞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"LikeCount\\": 10\\n }\\n}","errorExample":""},{"type":"xml","example":"<SendLikeResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <LikeCount>10</LikeCount>\\n </Result>\\n</SendLikeResponse>","errorExample":""}]', + 'title' => '设置点赞消息（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'SendMessageToGroup' => [ + 'summary' => '调用SendMessageToGroup向消息组全员发送消息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE35-****-T95F', + ], + ], + [ + 'name' => 'OperatorUserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '操作人用户ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'de1**a0', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息类型。type字段值小于等于10000时表示系统消息，大于10000时表示自定义消息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12000', + ], + ], + [ + 'name' => 'Data', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息体，JSONString类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'SkipAudit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前消息内容是否需要阿里云内容安全审核。取值：'."\n" + ."\n" + .'- **true**： 不需要安全审核。'."\n" + ."\n" + .'- **false**（默认值）：需要安全审核。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'title' => '用于长连接建连的token', + 'description' => '消息ID。', + 'type' => 'string', + 'example' => 'qt***', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"MessageId\\": \\"qt***\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<SendMessageToGroupResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <MessageId>qt***</MessageId>\\n </Result>\\n</SendMessageToGroupResponse>","errorExample":""}]', + 'title' => '向消息组全员发送消息（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'SendMessageToGroupUsers' => [ + 'summary' => '调用SendMessageToGroupUsers向消息组内指定用户发送消息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE35-****-T95F', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息类型。type字段值小于等于10000时表示系统消息，大于10000时表示自定义消息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '12000', + ], + ], + [ + 'name' => 'OperatorUserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '操作人用户ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'de1**a0', + ], + ], + [ + 'name' => 'ReceiverIdList', + 'in' => 'formData', + 'style' => 'simple', + 'schema' => [ + 'description' => '用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '接受消息的用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'hj***,3h***', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Data', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息体，JSONString类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'SkipAudit', + 'in' => 'query', + 'schema' => [ + 'description' => '当前消息内容是否需要阿里云内容安全审核。取值：'."\n" + ."\n" + .'- **true**： 不需要安全审核。'."\n" + ."\n" + .'- **false**（默认值）：需要安全审核。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'title' => '用于长连接建连的token', + 'description' => '消息ID。', + 'type' => 'string', + 'example' => 'hp***', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"MessageId\\": \\"hp***\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<SendMessageToGroupUsersResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <MessageId>hp***</MessageId>\\n </Result>\\n</SendMessageToGroupUsersResponse>","errorExample":""}]', + 'title' => '向消息组内指定用户发送消息（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'ListMessage' => [ + 'summary' => '查询消息列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE35-****-T95F', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户自定义消息类型，需大于10000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10002', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'formData', + 'schema' => [ + 'description' => '排列方式，取值：'."\n" + ."\n" + .'- 0：时间递增顺序。'."\n" + ."\n" + .'- 1：时间递减顺序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码，默认值：1。取值范围：1~100000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '单页显示用户的数量，默认值：20。取值范围：1~50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HasMore' => [ + 'description' => '是否还有下一页，取值：'."\n" + ."\n" + .'- true：有下一页。'."\n" + ."\n" + .'- false：没有下一页。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MessageList' => [ + 'description' => '消息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '消息体，JSONString类型。', + 'type' => 'string', + 'example' => 'test', + ], + 'GroupId' => [ + 'description' => '消息组ID。', + 'type' => 'string', + 'example' => 'AE35-****-T95F', + ], + 'MessageId' => [ + 'description' => '消息ID。', + 'type' => 'string', + 'example' => 'qt***', + ], + 'SenderId' => [ + 'description' => '消息发送者ID。', + 'type' => 'string', + 'example' => 'yi***', + ], + 'Type' => [ + 'description' => '消息类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10002', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"HasMore\\": false,\\n \\"MessageList\\": [\\n {\\n \\"Data\\": \\"test\\",\\n \\"GroupId\\": \\"AE35-****-T95F\\",\\n \\"MessageId\\": \\"qt***\\",\\n \\"SenderId\\": \\"yi***\\",\\n \\"Type\\": 10002\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMessageResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <HasMore>false</HasMore>\\n <MessageList>\\n <GroupId>AE35-****-T95F</GroupId>\\n <MessageId>qt***</MessageId>\\n <Type>10002</Type>\\n <SenderId>yi***</SenderId>\\n <Data>test</Data>\\n </MessageList>\\n </Result>\\n</ListMessageResponse>","errorExample":""}]', + 'title' => '查询消息列表（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'ListMessageGroupUserById' => [ + 'summary' => '调用ListMessageGroupUserById通过用户ID列表查询用户信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE35-****-T95F', + ], + ], + [ + 'name' => 'UserIdList', + 'in' => 'formData', + 'style' => 'simple', + 'schema' => [ + 'description' => '用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'de1**a0', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HasMore' => [ + 'description' => '是否还有下一页，取值：'."\n" + ."\n" + .'- true：有下一页。'."\n" + ."\n" + .'- false：没有下一页。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Total' => [ + 'description' => '查询到的用户总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'UserList' => [ + 'description' => '用户列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IsMute' => [ + 'description' => '用户是否被禁言。取值：'."\n" + ."\n" + .'- true：禁言。'."\n" + ."\n" + .'- false：没禁言。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MuteBy' => [ + 'description' => '禁言类型，取值：'."\n" + ."\n" + .'- group：消息组全员禁言。'."\n" + ."\n" + .'- user：单个用户禁言。', + 'type' => 'array', + 'items' => [ + 'description' => '禁言类型，取值：'."\n" + ."\n" + .'- group：消息组全员禁言。'."\n" + ."\n" + .'- user：单个用户禁言。', + 'type' => 'string', + 'example' => 'user', + ], + ], + 'UserAvatar' => [ + 'description' => '用户头像地址。', + 'type' => 'string', + 'example' => '"http://www.aliyundoc.com/xxyy.png"', + ], + 'UserExtension' => [ + 'description' => '用户信息自定义内容。', + 'type' => 'string', + 'example' => '12e', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'ad***', + ], + 'UserNick' => [ + 'description' => '用户昵称。', + 'type' => 'string', + 'example' => 'xxyy', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"HasMore\\": false,\\n \\"Total\\": 3,\\n \\"UserList\\": [\\n {\\n \\"IsMute\\": true,\\n \\"MuteBy\\": [\\n \\"user\\"\\n ],\\n \\"UserAvatar\\": \\"\\\\\\"http://www.aliyundoc.com/xxyy.png\\\\\\"\\",\\n \\"UserExtension\\": \\"12e\\",\\n \\"UserId\\": \\"ad***\\",\\n \\"UserNick\\": \\"xxyy\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMessageGroupUserByIdResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <Total>3</Total>\\n <HasMore>false</HasMore>\\n <UserList>\\n <UserId>ad***</UserId>\\n <UserNick>xxyy</UserNick>\\n <UserAvatar>\\"http://www.aliyundoc.com/xxyy.png\\"</UserAvatar>\\n <UserExtension>12e</UserExtension>\\n <IsMute>true</IsMute>\\n <MuteBy>user</MuteBy>\\n </UserList>\\n </Result>\\n</ListMessageGroupUserByIdResponse>","errorExample":""}]', + 'title' => '通过用户ID查询用户信息（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'BatchGetOnlineUsers' => [ + 'summary' => '根据一个或多个用户uid查询用户是否在线', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a494caec-***-695ef345db77', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息组ID。', + 'type' => 'string', + 'required' => true, + 'example' => '23wcaec-***695ef', + ], + ], + [ + 'name' => 'UserIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户UserId列表。多个UserId之间用半角逗号（,）分隔。最多配置20个UserId。', + 'type' => 'string', + 'required' => true, + 'example' => 'de1**a0,hu**9', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'OnlineUsers' => [ + 'description' => '对象数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JoinTime' => [ + 'description' => '加入消息组的UTC时间戳。单位：毫秒', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12**45', + ], + 'Online' => [ + 'description' => '是否在线， 取值：'."\n" + ."\n" + .'- **true**：在线。'."\n" + ."\n" + .'- **false**：不在线。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'UserId' => [ + 'description' => '用户UserId。', + 'type' => 'string', + 'example' => 'de1**a0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"OnlineUsers\\": [\\n {\\n \\"JoinTime\\": 0,\\n \\"Online\\": true,\\n \\"UserId\\": \\"de1**a0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<BatchGetOnlineUsersResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <OnlineUsers>\\n <UserId>de1**a0</UserId>\\n <Online>true</Online>\\n </OnlineUsers>\\n </Result>\\n</BatchGetOnlineUsersResponse>","errorExample":""}]', + 'title' => '查询用户是否在线（旧版）', + 'description' => '## 使用说明'."\n" + ."\n" + .'该接口支持批量查询，每次最多可以查询20个用户是否在线。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'ListMuteGroupUser' => [ + 'summary' => '调用ListMuteGroupUser查询被禁言的消息组成员列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'VKL3***', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '消息组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE35-****-T95F', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码，默认值：1。取值范围：1~100000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '单页显示用户的数量，默认值：20。取值范围：1~50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'OperatorUserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '操作人用户UserId。该用户必须是群组的创建者。', + 'type' => 'string', + 'required' => false, + 'example' => 'de1**a0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HasMore' => [ + 'description' => '是否还有下一页，取值：'."\n" + ."\n" + .'- true：有下一页。'."\n" + ."\n" + .'- false：没有下一页。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Total' => [ + 'description' => '禁言成员总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'UserList' => [ + 'description' => '禁言用户列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '禁言用户ID。', + 'type' => 'string', + 'example' => '1sd***,yu***', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\",\\n \\"Result\\": {\\n \\"HasMore\\": false,\\n \\"Total\\": 2,\\n \\"UserList\\": [\\n {\\n \\"UserId\\": \\"1sd***,yu***\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMuteGroupUserResponse>\\n <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>\\n <Result>\\n <Total>2</Total>\\n <HasMore>false</HasMore>\\n <UserList>\\n <UserId>1sd***,yu***</UserId>\\n </UserList>\\n </Result>\\n</ListMuteGroupUserResponse>","errorExample":""}]', + 'title' => '查询被禁言的消息组成员（旧版）', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'CreateLiveMessageApp' => [ + 'summary' => '调用CreateLiveMessageApp创建互动消息应用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '198173', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名，长度2~16个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'testApp', + ], + ], + [ + 'name' => 'AuditType', + 'in' => 'query', + 'schema' => [ + 'title' => '安全审核方式：0为不开启安全审核，1为内置安全审核， 2为自定义安全审核', + 'description' => '安全审核方式，取值：'."\n" + .'- 0：默认值，不开启安全审核。'."\n" + .'- 1：内置安全审核。'."\n" + .'- 2：自定义安全审核。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'enum' => [ + '0', + '1', + '2', + ], + ], + ], + [ + 'name' => 'AuditUrl', + 'in' => 'query', + 'schema' => [ + 'title' => '如果是自定义安全审核，则需要提供安全审核的地址', + 'description' => '如果是自定义安全审核（AuditType=2），则需要提供安全审核的地址。安全审核地址以http://或https://开头，不包含私有IP，不允许带端口号。自定义安全审核内容格式见下文。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://demo.aliyundoc.com/exampleaudit', + ], + ], + [ + 'name' => 'EventCallbackUrl', + 'in' => 'query', + 'schema' => [ + 'title' => '用户登录、登出，加入、离开群组等事件回调地址，若为空则不开启事件回调', + 'description' => '客户端登录、登出、加入、离开群组等事件回调地址，若为空则不开启事件回调。触发回调接口见[客户端接入](~~2672836~~)。事件回调地址以http://或https://开头，不包含私有IP，不允许带端口号。事件回调格式和回调鉴权逻辑见下文。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://demo.aliyundoc.com/examplecallback', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，枚举值：'."\n" + .'- cn-shanghai：默认值，上海。'."\n" + .'- ap-southeast-1：新加坡。'."\n" + ."\n" + .'> 调用直播互动其他接口时，需要与当前创建直播互动应用的数据中心一致。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'MsgLifeCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'App内群组消息的存储时效档位，取值：'."\n" + .'- 0：默认值，存储30天。'."\n" + .'- 1：存储90天。'."\n" + .'- 2：存储180天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '65EEDBEB-43FE-1E15-976F-3DDD753A****', + ], + 'AppId' => [ + 'description' => '应用ID，用于后续加入群等流程。', + 'type' => 'string', + 'example' => 'demo', + ], + 'AppKey' => [ + 'description' => 'AppKey，用于生成与该AppId相关的各种操作鉴权。', + 'type' => 'string', + 'example' => '**********************************', + ], + 'AppSign' => [ + 'description' => '应用签名，互动消息服务SDK需要该信息。', + 'type' => 'string', + 'example' => '**************************************************************************', + ], + 'DataCenter' => [ + 'description' => '数据中心。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'ErrorInvalidAppName', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'ErrorTooManyApps', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'ErrorInvalidEventCallbackUrl', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'ErrorInvalidAuditUrl', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65EEDBEB-43FE-1E15-976F-3DDD753A****\\",\\n \\"AppId\\": \\"demo\\",\\n \\"AppKey\\": \\"**********************************\\",\\n \\"AppSign\\": \\"**************************************************************************\\",\\n \\"DataCenter\\": \\"cn-shanghai\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateLiveMessageAppResponse>\\n <RequestId>65EEDBEB-43FE-1E15-976F-3DDD753A****</RequestId>\\n <AppId>demo</AppId>\\n <AppKey>**********************************</AppKey>\\n <AppSign>**************************************************************************</AppSign>\\n</CreateLiveMessageAppResponse>","errorExample":""}]', + 'title' => '创建互动消息应用', + 'description' => '- 调用互动消息其他接口时，需要与当前创建互动消息应用的数据中心一致。'."\n" + .'- 单个阿里云账号下最多可创建300个互动消息应用。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '### 自定义安全审核内容说明：'."\n" + .'- 请求协议：HTTP'."\n" + .'- 请求Method：POST'."\n" + .'- 请求示例：'."\n" + .'```'."\n" + .'{'."\n" + .' "content": "testaudit"'."\n" + .'}'."\n" + .'```'."\n" + .'- 响应示例：'."\n" + .'```'."\n" + .'{'."\n" + .' "pass": true,'."\n" + .' "reason":"****" |pass为true表示通过，否则不通过。reason为不通过的原因'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'> HTTP status code为200表示成功；非200时，认为服务不可用，降级为不再对该消息进行审核。'."\n" + ."\n" + .'### 事件回调'."\n" + .' http/https post， body为以下标例格式内容的"json utf-8 string bytes"。事件回调示例如下：'."\n" + .'```'."\n" + .'{'."\n" + .' "appid":"demo",'."\n" + .' "eves":[{'."\n" + .' "uid":"uid1",'."\n" + .' "sid":"sessionid",'."\n" + .' "events":[{'."\n" + .' "e": 3, |事件类型，枚举。1：登录，2：登出，3：joingroup，4：leavegroup，5：客户端断网重连了'."\n" + .' "r": 1, |登出原因，其他事件无该属性，枚举。1：正常调用，3：超时离开，4：在其他端登录'."\n" + .' "g": "testgroup", |群组ID，入离群有该值；登录、登出等事件回调无该属性'."\n" + .' "gs":["testgroupid"] | 群组ID列表，客户端断网重连时，客户端加入的群组信息，其他事件无该属性'."\n" + .' }]'."\n" + .' }]'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'> HTTP status code为200表示成功；其他表示失败，会重试发送。'."\n" + ."\n" + .'### 回调鉴权说明'."\n" + .'服务发起请求时在HTTP(S)请求头中包含Ali-Live-Timestamp和Ali-Live-Signature字段，供回调消息接收服务端进行签名认证。Ali-Live-Signature值计算方式为：Ali-Live-Signature=sha256(CONTENT)。其中，CONTENT=回调域名+Ali-Live-Timestamp取值+鉴权Key；回调域名指配置回调URL的域名，鉴权Key指用户创建AppId时生成的AppKey。', + ], + 'CreateLiveMessageGroup' => [ + 'summary' => '调用CreateLiveMessageGroup创建互动消息群组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要创建的群组ID，业务应保证群组ID唯一，由大小写字母、数字组成，长度不超过64字节。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '群组名', + 'description' => '群组名，长度不超过128字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'mytestgroup', + ], + ], + [ + 'name' => 'GroupInfo', + 'in' => 'query', + 'schema' => [ + 'title' => '群组扩展信息', + 'description' => '群组扩展信息，长度不超过32KB。', + 'type' => 'string', + 'required' => false, + 'example' => 'testgroupinfo', + ], + ], + [ + 'name' => 'Administrators', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'title' => '管理员用户ID列表，不能超过3个', + 'description' => '管理员用户ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '管理员用户ID，由大小写字母、数字组成，长度不超过64字节。多个用半角逗号（,）隔开，最多不超过3个。', + 'type' => 'string', + 'required' => false, + 'example' => 'uid1', + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'CreatorId', + 'in' => 'query', + 'schema' => [ + 'title' => '群创建者ID', + 'description' => '群组创建者ID，由大小写字母、数字组成，长度不超过64字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'uid1', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2593195~~)中的数据中心一致, 当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A8C7B033-B339-1A58-B0E0-7B9197BA****', + ], + 'GroupId' => [ + 'description' => '创建的群组ID。', + 'type' => 'string', + 'example' => 'grouptest', + ], + 'AlreadyExists' => [ + 'title' => '是否已经存在', + 'description' => '是否已经存在。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AlreadyDelete' => [ + 'description' => '是否已删除。如果已存在，且被删除了，那么群组ID是处于不可用状态，建议重新创建。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'ErrorTooManyGroups', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A8C7B033-B339-1A58-B0E0-7B9197BA****\\",\\n \\"GroupId\\": \\"grouptest\\",\\n \\"AlreadyExists\\": true,\\n \\"AlreadyDelete\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateLiveMessageGroupResponse>\\n <RequestId>A8C7B033-B339-1A58-B0E0-7B9197BA****</RequestId>\\n <GroupId>grouptest</GroupId>\\n <AlreadyExists>true</AlreadyExists>\\n <AlreadyDelete>true</AlreadyDelete>\\n</CreateLiveMessageGroupResponse>","errorExample":""}]', + 'title' => '创建直播互动群组', + 'description' => '- 调用本接口前，您必须已经调用[CreateLiveMessageApp](~~2848162~~)创建互动消息应用。'."\n" + .'- 单个互动消息应用下最多可创建5000个互动消息群组。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveMessageGroup' => [ + 'summary' => '查询直播互动群组详细信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194284', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1815A27D-BAE2-10E6-89FD-D477951C****', + ], + 'GroupId' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'example' => 'grouptest', + ], + 'CreatorId' => [ + 'description' => '创建者ID。', + 'type' => 'string', + 'example' => 'uid1', + ], + 'AdminList' => [ + 'description' => '管理员列表。', + 'type' => 'array', + 'items' => [ + 'description' => '管理员。', + 'type' => 'string', + 'example' => '["uid1","uid2"]', + ], + ], + 'Createtime' => [ + 'description' => '创建时间，用UNIX时间戳表示，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698305471', + ], + 'GroupName' => [ + 'description' => '群组名。', + 'type' => 'string', + 'example' => 'mytestgroup', + ], + 'GroupInfo' => [ + 'description' => '群组扩展信息。', + 'type' => 'string', + 'example' => 'testgroupinfo', + ], + 'Delete' => [ + 'description' => '是否已删除。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TotalTimes' => [ + 'description' => '总Session次数。群组存在时才有此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'OnlineUserCounts' => [ + 'description' => '当前在线的群用户数。群组存在时才有此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'MsgAmount' => [ + 'description' => '消息数分类统计。群组存在时才有此参数。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'integer', + 'format' => 'int64', + 'example' => '{1 : 20, 2 : 30}', + 'description' => '消息数。', + ], + ], + 'Deletatime' => [ + 'description' => '删除时间。群组已被删除时才有此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698299827', + ], + 'Deletor' => [ + 'description' => '删除者。群组已被删除时才有此参数。', + 'type' => 'string', + 'example' => 'uid1', + ], + 'SuperLargeGroup' => [ + 'description' => '群组是否为超级大群。'."\n" + .'- True：是。'."\n" + .'- False：否。', + 'type' => 'boolean', + 'example' => 'False', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1815A27D-BAE2-10E6-89FD-D477951C****\\",\\n \\"GroupId\\": \\"grouptest\\",\\n \\"CreatorId\\": \\"uid1\\",\\n \\"AdminList\\": [\\n \\"[\\\\\\"uid1\\\\\\",\\\\\\"uid2\\\\\\"]\\"\\n ],\\n \\"Createtime\\": 1698305471,\\n \\"GroupName\\": \\"mytestgroup\\",\\n \\"GroupInfo\\": \\"testgroupinfo\\",\\n \\"Delete\\": false,\\n \\"TotalTimes\\": 50,\\n \\"OnlineUserCounts\\": 2,\\n \\"MsgAmount\\": {\\n \\"key\\": 0\\n },\\n \\"Deletatime\\": 1698299827,\\n \\"Deletor\\": \\"uid1\\",\\n \\"SuperLargeGroup\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveMessageGroupResponse>\\n <RequestId>1815A27D-BAE2-10E6-89FD-D477951C****</RequestId>\\n <GroupId>grouptest</GroupId>\\n <CreatorId>uid1</CreatorId>\\n <AdminList>[\\"uid1\\",\\"uid2\\"]</AdminList>\\n <Createtime>1698305471</Createtime>\\n <GroupName>mytestgroup</GroupName>\\n <GroupInfo>testgroupinfo</GroupInfo>\\n <Delete>false</Delete>\\n <TotalTimes>50</TotalTimes>\\n <OnlineUserCounts>2</OnlineUserCounts>\\n <MsgAmount>{1:20,2:30}</MsgAmount>\\n</DescribeLiveMessageGroupResponse>","errorExample":""}]', + 'title' => '查询直播互动群组详细信息', + 'description' => '调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848162~~)创建互动消息群组。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ModifyLiveMessageGroup' => [ + 'summary' => '调用ModifyLiveMessageGroup修改互动消息群组信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'ModifyAdmin', + 'in' => 'query', + 'schema' => [ + 'description' => '是否修改群组管理员。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AdminList', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '修改后的管理员列表。多个用半角逗号（,）隔开，最多不超过3个。', + 'type' => 'array', + 'items' => [ + 'description' => '管理员用户ID，由大小写字母、数字组成，长度不超过64字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'uid1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ModifyInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '是否修改群组扩展信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'GroupInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '修改后的群组扩展信息，长度不超过32KB。', + 'type' => 'string', + 'required' => false, + 'example' => 'newmeta', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '84AF36BF-0B39-1F8A-A416-FAC7C484****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"84AF36BF-0B39-1F8A-A416-FAC7C484****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyLiveMessageGroupResponse>\\n <RequestId>84AF36BF-0B39-1F8A-A416-FAC7C484****</RequestId>\\n</ModifyLiveMessageGroupResponse>","errorExample":""}]', + 'title' => '修改直播互动群组信息', + 'description' => '调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848163~~)创建互动消息群组。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteLiveMessageGroup' => [ + 'summary' => '调用DeleteLiveMessageGroup删除互动消息群组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'OperatorId', + 'in' => 'query', + 'schema' => [ + 'description' => '操作者ID，由大小写字母、数字组成，长度不超过64字节，后台会记录操作者ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'uid1', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B95BE680-5A6A-1CAD-8AB1-09DFF5D6****', + ], + 'GroupId' => [ + 'description' => '已删除的或者不存在的群组ID。', + 'type' => 'string', + 'example' => 'grouptest', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B95BE680-5A6A-1CAD-8AB1-09DFF5D6****\\",\\n \\"GroupId\\": \\"grouptest\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveMessageGroupResponse>\\n <RequestId>B95BE680-5A6A-1CAD-8AB1-09DFF5D6****</RequestId>\\n <GroupId>grouptest</GroupId>\\n</DeleteLiveMessageGroupResponse>","errorExample":""}]', + 'title' => '删除直播互动群组', + 'description' => '- 调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848163~~)创建互动消息群组。'."\n" + .'- 群组删除后，不再可用，正在群组中的所有人，会被通知群已结束。'."\n" + .'- 群组删除后，消息在一段时间之内还是可以查询的，当前为三十天。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListLiveMessageGroups' => [ + 'summary' => '调用ListLiveMessageGroups查询互动消息群组列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194270', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方式，1为正序，2为逆序', + 'description' => '排序方式，按群组创建时间先后进行排序。取值：'."\n" + .'- 1：正序。'."\n" + .'- 2：逆序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '2', + 'minimum' => '1', + 'example' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'title' => '查询页的起始位置，若为空或者 -1 则默认为首页', + 'description' => '查询页的起始位置，若为空或-1，则默认为首页。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1001', + ], + ], + [ + 'name' => 'GroupStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '群组状态，默认值为0。取值：'."\n" + .'- 0：查询全部群组。'."\n" + .'- 1：查询未被删除群组。'."\n" + .'- 2：查询已删除群组。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => [ + '0', + '1', + '2', + ], + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B5D95365-5A46-1A6A-BBF5-C7B6BDED****', + ], + 'Hasmore' => [ + 'title' => '是否有下一页', + 'description' => '是否有下一页。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'NextpageToken' => [ + 'description' => '下一页的起始位置，当Hasmore为false时，不返回该字段。', + 'type' => 'string', + 'example' => '1001', + ], + 'GroupList' => [ + 'description' => '群组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '群组数据。', + 'type' => 'object', + 'properties' => [ + 'GroupId' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'example' => 'cU9MeBqf****', + ], + 'CreatorId' => [ + 'description' => '创建者ID。', + 'type' => 'string', + 'example' => 'user_77', + ], + 'AdminList' => [ + 'description' => '管理员列表。', + 'type' => 'array', + 'items' => [ + 'description' => '管理员。', + 'type' => 'string', + 'example' => 'uid1', + ], + ], + 'Createtime' => [ + 'description' => '创建时间，用UNIX时间戳表示，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698299727', + ], + 'GroupName' => [ + 'description' => '群组名。', + 'type' => 'string', + 'example' => 'mytestgroup', + ], + 'GroupInfo' => [ + 'description' => '群组扩展信息。', + 'type' => 'string', + 'example' => 'testgroupinfo', + ], + 'Delete' => [ + 'description' => '是否已删除。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B5D95365-5A46-1A6A-BBF5-C7B6BDED****\\",\\n \\"Hasmore\\": false,\\n \\"NextpageToken\\": \\"1001\\",\\n \\"GroupList\\": [\\n {\\n \\"GroupId\\": \\"cU9MeBqf****\\",\\n \\"CreatorId\\": \\"user_77\\",\\n \\"AdminList\\": [\\n \\"uid1\\"\\n ],\\n \\"Createtime\\": 1698299727,\\n \\"GroupName\\": \\"mytestgroup\\",\\n \\"GroupInfo\\": \\"testgroupinfo\\",\\n \\"Delete\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListLiveMessageGroupsResponse>\\n <RequestId>B5D95365-5A46-1A6A-BBF5-C7B6BDED****</RequestId>\\n <Hasmore>false</Hasmore>\\n <GroupList>\\n <GroupId>cU9MeBqf****</GroupId>\\n <CreatorId>user_77</CreatorId>\\n <AdminList>uid1</AdminList>\\n <Createtime>1698299727</Createtime>\\n <GroupName>mytestgroup</GroupName>\\n <GroupInfo>testgroupinfo</GroupInfo>\\n <Delete>true</Delete>\\n </GroupList>\\n</ListLiveMessageGroupsResponse>","errorExample":""}]', + 'title' => '查询直播互动群组列表', + 'description' => '调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848163~~)创建互动消息群组。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListLiveMessageGroupByPage' => [ + 'summary' => '查询互动消息群组列表，并支持翻页功能。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '222094', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式，按群组创建时间先后进行排序。取值：'."\n" + .'- 1：正序。'."\n" + .'- 2：逆序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '2', + 'minimum' => '1', + 'example' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，取值范围为：\\[1,50\\]。'."\n" + ."\n" + .'默认值为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '取第几页，取值范围为：\\[1,10000\\]。'."\n" + ."\n" + .'默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'GroupStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '群组状态，默认值为0。取值：'."\n" + .'- 0：查询全部群组。'."\n" + .'- 1：查询未被删除群组。'."\n" + .'- 2：查询已删除群组。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => [ + '0', + '1', + '2', + ], + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B5D95365-5A46-1A6A-BBF5-C7B6BDED****', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'PageNumber' => [ + 'description' => '返回数据的当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'GroupList' => [ + 'description' => '群组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '群组对象。', + 'type' => 'object', + 'properties' => [ + 'GroupId' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'example' => 'cU9MeBqf****', + ], + 'CreatorId' => [ + 'description' => '创建者ID。', + 'type' => 'string', + 'example' => 'user_77', + ], + 'AdminList' => [ + 'description' => '管理员用户ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '管理员用户ID。', + 'type' => 'string', + 'example' => 'uid1', + ], + ], + 'Createtime' => [ + 'description' => '创建时间，用UNIX时间戳表示，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698299727', + ], + 'GroupName' => [ + 'description' => '群组名。', + 'type' => 'string', + 'example' => 'mytestgroup', + ], + 'GroupInfo' => [ + 'description' => '群组扩展信息。', + 'type' => 'string', + 'example' => 'testgroupinfo', + ], + 'Delete' => [ + 'description' => '是否已删除。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B5D95365-5A46-1A6A-BBF5-C7B6BDED****\\",\\n \\"TotalCount\\": 50,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"GroupList\\": [\\n {\\n \\"GroupId\\": \\"cU9MeBqf****\\",\\n \\"CreatorId\\": \\"user_77\\",\\n \\"AdminList\\": [\\n \\"uid1\\"\\n ],\\n \\"Createtime\\": 1698299727,\\n \\"GroupName\\": \\"mytestgroup\\",\\n \\"GroupInfo\\": \\"testgroupinfo\\",\\n \\"Delete\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListLiveMessageGroupByPageResponse>\\n <RequestId>B5D95365-5A46-1A6A-BBF5-C7B6BDED****</RequestId>\\n <TotalCount>50</TotalCount>\\n <PageNumber>1</PageNumber>\\n <PageSize>20</PageSize>\\n <GroupList>\\n <GroupId>cU9MeBqf****</GroupId>\\n <CreatorId>user_77</CreatorId>\\n <AdminList>uid1</AdminList>\\n <Createtime>1698299727</Createtime>\\n <GroupName>mytestgroup</GroupName>\\n <GroupInfo>testgroupinfo</GroupInfo>\\n <Delete>true</Delete>\\n </GroupList>\\n</ListLiveMessageGroupByPageResponse>","errorExample":""}]', + 'title' => '查询互动消息群组列表（支持翻页）', + 'description' => '调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848163~~)创建互动消息群组。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ModifyLiveMessageGroupBand' => [ + 'summary' => '修改用户禁言状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'BannedAll', + 'in' => 'query', + 'schema' => [ + 'title' => '是否全员禁言', + 'description' => '是否全员禁言。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'BannnedUsers', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'title' => '被禁言的用户', + 'description' => '被禁言的用户列表。多个用半角逗号（,）隔开，最多不超过30个。', + 'type' => 'array', + 'items' => [ + 'description' => '被禁言的用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'uid1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ExceptUsers', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'title' => '不被禁言的用户', + 'description' => '当开启全员禁言时不被禁言的用户列表。多个用半角逗号（,）隔开，最多不超过30个。', + 'type' => 'array', + 'items' => [ + 'description' => '当开启全员禁言时不被禁言的用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'uid3', + ], + 'required' => false, + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '84AF36BF-0B39-1F8A-A416-FAC7C484****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"84AF36BF-0B39-1F8A-A416-FAC7C484****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyLiveMessageGroupBandResponse>\\n <RequestId>84AF36BF-0B39-1F8A-A416-FAC7C484****</RequestId>\\n</ModifyLiveMessageGroupBandResponse>","errorExample":""}]', + 'title' => '修改用户禁言状态', + 'description' => '调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848163~~)创建互动消息群组。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveMessageGroupBand' => [ + 'summary' => '调用DescribeLiveMessageGroupBand查询用户禁言状态信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '021D1FE7-2E87-16AC-9364-4E7EA47C****', + ], + 'GroupId' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'example' => 'grouptest', + ], + 'BannedUserList' => [ + 'description' => '非全员禁言时，被禁言的用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '非全员禁言时，被禁言的用户。', + 'type' => 'string', + 'example' => '["uid1","uid2"]', + ], + ], + 'UnbannedUserList' => [ + 'description' => '全员禁言时，不被禁言的用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '全员禁言时，不被禁言的用户。', + 'type' => 'string', + 'example' => '["uid3"]', + ], + ], + 'IsbannedAll' => [ + 'description' => '是否全员禁言。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"021D1FE7-2E87-16AC-9364-4E7EA47C****\\",\\n \\"GroupId\\": \\"grouptest\\",\\n \\"BannedUserList\\": [\\n \\"[\\\\\\"uid1\\\\\\",\\\\\\"uid2\\\\\\"]\\"\\n ],\\n \\"UnbannedUserList\\": [\\n \\"[\\\\\\"uid3\\\\\\"]\\"\\n ],\\n \\"IsbannedAll\\": false\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveMessageGroupBandResponse>\\n <RequestId>021D1FE7-2E87-16AC-9364-4E7EA47C****</RequestId>\\n <GroupId>grouptest</GroupId>\\n <BannedUserList>[\\"uid1\\",\\"uid2\\"]</BannedUserList>\\n <UnbannedUserList>[\\"uid3\\"]</UnbannedUserList>\\n <IsbannedAll>false</IsbannedAll>\\n</DescribeLiveMessageGroupBandResponse>","errorExample":""}]', + 'title' => '查询用户禁言状态信息', + 'description' => '调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848163~~)创建互动消息群组。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CheckLiveMessageUsersOnline' => [ + 'summary' => '调用CheckLiveMessageUsersOnline查询指定的用户是否在线。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'UserIds', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'title' => '需要查询的用户，范围为1-10个', + 'description' => '需要查询的用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '需要查询的用户ID。多个用半角逗号（,）隔开。单次查询用户数量范围\\[1,10\\]。', + 'type' => 'string', + 'required' => false, + 'example' => 'uid', + ], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '178F572F-AECF-100B-937A-B8047B4D****', + ], + 'UserList' => [ + 'description' => '查询的用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户信息。', + 'type' => 'object', + 'properties' => [ + 'Online' => [ + 'description' => '用户是否在线。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'uid1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"178F572F-AECF-100B-937A-B8047B4D****\\",\\n \\"UserList\\": [\\n {\\n \\"Online\\": false,\\n \\"UserId\\": \\"uid1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CheckLiveMessageUsersOnlineResponse>\\n <RequestId>178F572F-AECF-100B-937A-B8047B4D****</RequestId>\\n <UserList>\\n <UserId>uid1</UserId>\\n <Online>false</Online>\\n </UserList>\\n</CheckLiveMessageUsersOnlineResponse>","errorExample":""}]', + 'title' => '查询指定的用户是否在线', + 'description' => '本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CheckLiveMessageUsersInGroup' => [ + 'summary' => '调用CheckLiveMessageUsersInGroup查询指定用户是否在群组中。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'UserIds', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'title' => '需要查询的UserId，查询个数范围为1-10', + 'description' => '需要查询的用户ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '需要查询的用户ID。多个用半角逗号（,）隔开。单次查询用户数量范围\\[1,10\\]。', + 'type' => 'string', + 'required' => true, + 'example' => 'uid', + ], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F1F68D81-1543-1FE4-B56E-82200DD2****', + ], + 'Users' => [ + 'description' => '查询的用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户信息。', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'uid1', + ], + 'Online' => [ + 'description' => '用户是否在群组中。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F1F68D81-1543-1FE4-B56E-82200DD2****\\",\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"uid1\\",\\n \\"Online\\": false\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CheckLiveMessageUsersInGroupResponse>\\n <RequestId>F1F68D81-1543-1FE4-B56E-82200DD2****</RequestId>\\n <Users>\\n <UserId>uid1</UserId>\\n <Online>false</Online>\\n </Users>\\n</CheckLiveMessageUsersInGroupResponse>","errorExample":""}]', + 'title' => '查询指定用户是否在群组中', + 'description' => '调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848163~~)创建互动消息群组。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListLiveMessageGroupUsers' => [ + 'summary' => '调用ListLiveMessageGroupUsers查询群组用户列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194318', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的直播互动应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的群组的GroupID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '一次显示的用户数量，最小值10，最大值50', + 'description' => '一次显示的用户数量，取值范围**[10，50]**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '30', + 'minimum' => '10', + 'example' => '10', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方式，1为正序，2为逆序', + 'description' => '排序方式，按用户加入群组时间先后进行排序。取值：'."\n" + ."\n" + .'- 1：正序'."\n" + ."\n" + .'- 2：逆序', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '2', + 'minimum' => '1', + 'example' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'title' => '查询页的起始位置，若为空则默认为首页', + 'description' => '查询页的起始位置，若为空则默认为首页。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A1D75BEA-1329-116F-B29C-76F3F200****', + ], + 'GroupId' => [ + 'description' => '需要查询的群组的GroupID。', + 'type' => 'string', + 'example' => 'grouptest', + ], + 'NextPageToken' => [ + 'title' => '下一页的起始位置，若没有下一页则为0', + 'description' => '下一页的起始位置，若没有下一页则为0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Hasmore' => [ + 'title' => '是否有下一页', + 'description' => '是否有下一页。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'UserList' => [ + 'description' => '对象数组。', + 'type' => 'array', + 'items' => [ + 'description' => '数组详情。', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '查询的用户Id', + 'description' => '查询的用户ID。', + 'type' => 'string', + 'example' => 'uid1', + ], + 'UserInfo' => [ + 'title' => '用户扩展信息', + 'description' => '用户扩展信息。', + 'type' => 'string', + 'example' => 'info1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 420 => [ + [ + 'errorCode' => 'SuperLargeGroup', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A1D75BEA-1329-116F-B29C-76F3F200****\\",\\n \\"GroupId\\": \\"grouptest\\",\\n \\"NextPageToken\\": 0,\\n \\"Hasmore\\": false,\\n \\"UserList\\": [\\n {\\n \\"UserId\\": \\"uid1\\",\\n \\"UserInfo\\": \\"info1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListLiveMessageGroupUsersResponse>\\n <RequestId>A1D75BEA-1329-116F-B29C-76F3F200****</RequestId>\\n <GroupId>grouptest</GroupId>\\n <NextPageToken>0</NextPageToken>\\n <Hasmore>false</Hasmore>\\n <UserList>\\n <UserId>uid1</UserId>\\n <UserInfo>info1</UserInfo>\\n </UserList>\\n</ListLiveMessageGroupUsersResponse>","errorExample":""}]', + 'title' => '查询群组用户列表', + 'description' => '- 调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848163~~)创建互动消息群组。'."\n" + .'- 对于超级大群（超过2000人的群组），不再提供成员列表查询。并且群成员进出群组通知之间会至少间隔5s，通知中不显示全部进出用户列表，但显示精确群人数。群组一旦升级为超级大群，群成员列表会马上清空，无法再恢复为普通群组，直到所有群成员退出群组（群组关闭），重新开启时才会恢复为普通群组。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListLiveMessageGroupMessages' => [ + 'summary' => '调用ListLiveMessageGroupMessages查询群组消息列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的群组的GroupID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '一次显示的消息数量，最小10，最大50', + 'description' => '一次显示的消息数量，取值范围**[10,50]**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '50', + 'minimum' => '10', + 'example' => '10', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方式，1为正序，2为逆序', + 'description' => '排序方式，按消息发送时间先后进行排序。取值：'."\n" + ."\n" + .'- 1：正序'."\n" + ."\n" + .'- 2：逆序', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '2', + 'minimum' => '1', + 'example' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'title' => '查询页的起始位置，若为空则默认为首页', + 'description' => '查询页的起始位置，若为空则默认为首页。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MsgType', + 'in' => 'query', + 'schema' => [ + 'title' => '需要查询的消息类型，若为空则默认为全部类型', + 'description' => '需要查询的消息类型，若为空则默认为全部类型。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询起始时间，若为空则默认为最早时间', + 'description' => '查询起始时间，用UNIX时间戳表示，单位：秒。若为空则默认为最早时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1697783235', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询结束时间，若为空则默认为最晚时间', + 'description' => '查询结束时间，用UNIX时间戳表示，单位：秒。若为空则默认为最晚时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1698301635', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1668FDC3-63D7-102F-B5D4-3D2F91D1****', + ], + 'GroupId' => [ + 'description' => '需要查询的群组的GroupID。', + 'type' => 'string', + 'example' => 'grouptest', + ], + 'NextPageToken' => [ + 'title' => '下一页的起始位置，若没有下一页则为0', + 'description' => '下一页的起始位置，若没有下一页则为0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Hasmore' => [ + 'title' => '是否有下一页', + 'description' => '是否有下一页。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MessageList' => [ + 'description' => '消息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表详情。', + 'type' => 'object', + 'properties' => [ + 'Sender' => [ + 'description' => '消息参数详情。', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '消息发送用户的ID。', + 'type' => 'string', + 'example' => 'uid2', + ], + 'UserInfo' => [ + 'description' => '消息发送用户的扩展信息。', + 'type' => 'string', + 'example' => 'testusermeta2', + ], + ], + ], + 'Body' => [ + 'description' => '消息体。', + 'type' => 'string', + 'example' => 'step2 helo, cc group', + ], + 'Timestamp' => [ + 'description' => '消息创建时间。用UNIX时间戳表示，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1697081134', + ], + 'MsgTid' => [ + 'description' => '消息标识。', + 'type' => 'string', + 'example' => 'c-1-1-0', + ], + 'MsgType' => [ + 'description' => '消息类型。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'SeqNumber' => [ + 'description' => '消息序列号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalMessages' => [ + 'description' => '总消息数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1668FDC3-63D7-102F-B5D4-3D2F91D1****\\",\\n \\"GroupId\\": \\"grouptest\\",\\n \\"NextPageToken\\": 0,\\n \\"Hasmore\\": false,\\n \\"MessageList\\": [\\n {\\n \\"Sender\\": {\\n \\"UserId\\": \\"uid2\\",\\n \\"UserInfo\\": \\"testusermeta2\\"\\n },\\n \\"Body\\": \\"step2 helo, cc group\\",\\n \\"Timestamp\\": 1697081134,\\n \\"MsgTid\\": \\"c-1-1-0\\",\\n \\"MsgType\\": 2,\\n \\"SeqNumber\\": 1,\\n \\"TotalMessages\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListLiveMessageGroupMessagesResponse>\\n <RequestId>1668FDC3-63D7-102F-B5D4-3D2F91D1****</RequestId>\\n <GroupId>grouptest</GroupId>\\n <NextPageToken>0</NextPageToken>\\n <Hasmore>false</Hasmore>\\n <MessageList>\\n <Sender>\\n <UserId>uid2</UserId>\\n <UserInfo>testusermeta2</UserInfo>\\n </Sender>\\n <Body>step2 helo, cc group</Body>\\n <Timestamp>1697081134</Timestamp>\\n <MsgTid>c-1-1-0</MsgTid>\\n <MsgType>2</MsgType>\\n <SeqNumber>1</SeqNumber>\\n <TotalMessages>1</TotalMessages>\\n </MessageList>\\n</ListLiveMessageGroupMessagesResponse>","errorExample":""}]', + 'title' => '查询群组消息列表', + 'description' => '调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848163~~)创建互动消息群组。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UnbanLiveMessageGroup' => [ + 'summary' => '调用UnbanLiveMessageGroup新增禁言用户。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '237380', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致。'."\n" + .'> 当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '84AF36BF-0B39-1F8A-A416-FAC7C484****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"84AF36BF-0B39-1F8A-A416-FAC7C484****\\"\\n}","errorExample":""},{"type":"xml","example":"<UnbanLiveMessageGroupResponse>\\n <RequestId>84AF36BF-0B39-1F8A-A416-FAC7C484****</RequestId>\\n</UnbanLiveMessageGroupResponse>","errorExample":""}]', + 'title' => '解除群组全员禁言', + 'description' => '- 调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848163~~)创建互动消息群组。'."\n" + .'- 调用解除全员禁言接口后，若是被单独禁言的，则依然是禁言状态，无法解除禁言。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'RecoverLiveMessageDeletedGroup' => [ + 'summary' => '调用RecoverLiveMessageDeletedGroup恢复已删除的互动消息群组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227785', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要恢复的群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)创建时的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B95BE680-5A6A-1CAD-8AB1-09DFF5D6****', + ], + 'GroupId' => [ + 'description' => '已恢复的群组ID。', + 'type' => 'string', + 'example' => 'grouptest', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'ErrorTooManyGroups', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B95BE680-5A6A-1CAD-8AB1-09DFF5D6****\\",\\n \\"GroupId\\": \\"grouptest\\"\\n}","errorExample":""},{"type":"xml","example":"<RecoverLiveMessageDeletedGroupResponse>\\n <RequestId>B95BE680-5A6A-1CAD-8AB1-09DFF5D6****</RequestId>\\n <GroupId>grouptest</GroupId>\\n</RecoverLiveMessageDeletedGroupResponse>","errorExample":""}]', + 'title' => '恢复已删除的互动消息群组', + 'description' => '- 调用[DeleteLiveMessageGroup](~~2848163~~)删除互动消息群组之后三十天内，可以调用本接口恢复已被删除的群组。'."\n" + .'- 群组恢复后，被删除之前存储的消息依旧可以查询。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'BanLiveMessageGroup' => [ + 'summary' => '调用BanLiveMessageGroup新增禁言用户。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '237378', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'ExceptUsers', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '当开启全员禁言时不被禁言的用户。多个用半角逗号（,）隔开，最多不超过30个。', + 'type' => 'array', + 'items' => [ + 'description' => '当开启全员禁言时不被禁言的用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'uid3', + ], + 'required' => false, + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致。'."\n" + .'> 当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '84AF36BF-0B39-1F8A-A416-FAC7C484****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"84AF36BF-0B39-1F8A-A416-FAC7C484****\\"\\n}","errorExample":""},{"type":"xml","example":"<BanLiveMessageGroupResponse>\\n <RequestId>84AF36BF-0B39-1F8A-A416-FAC7C484****</RequestId>\\n</BanLiveMessageGroupResponse>","errorExample":""}]', + 'title' => '群组全员禁言', + 'description' => '调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848163~~)创建互动消息群组。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'AddLiveMessageGroupBand' => [ + 'summary' => '调用AddLiveMessageGroupBand新增禁言用户。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235183', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'BannedUsers', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '被禁言的用户列表。多个用半角逗号（,）隔开，最多不超过30个。', + 'type' => 'array', + 'items' => [ + 'description' => '被禁言的用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'uid1', + ], + 'required' => true, + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致。'."\n" + .'> 当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '84AF36BF-0B39-1F8A-A416-FAC7C484****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"84AF36BF-0B39-1F8A-A416-FAC7C484****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddLiveMessageGroupBandResponse>\\n <RequestId>84AF36BF-0B39-1F8A-A416-FAC7C484****</RequestId>\\n</AddLiveMessageGroupBandResponse>","errorExample":""}]', + 'title' => '新增禁言用户', + 'description' => '调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848163~~)创建互动消息群组。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'RemoveLiveMessageGroupBand' => [ + 'summary' => '解除直播互动群组用户禁言', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235211', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'UnbannedUsers', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '移除被禁言的用户列表。多个用半角逗号（,）隔开，最多不超过30个。', + 'type' => 'array', + 'items' => [ + 'description' => '移除被禁言的用户。'."\n" + .'- 传 "*"表示恢复所有的被禁言用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'uid1', + ], + 'required' => true, + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致。'."\n" + .'> 当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '84AF36BF-0B39-1F8A-A416-FAC7C484****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"84AF36BF-0B39-1F8A-A416-FAC7C484****\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveLiveMessageGroupBandResponse>\\n <RequestId>84AF36BF-0B39-1F8A-A416-FAC7C484****</RequestId>\\n</RemoveLiveMessageGroupBandResponse>","errorExample":""}]', + 'title' => '解除禁言用户', + 'description' => '调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848163~~)创建互动消息群组。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteLiveMessageGroupMessage' => [ + 'summary' => '调用DeleteLiveMessageGroupMessage删除（撤回）某条群组消息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'MessageId', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的消息ID，与发送消息中的MsgTid对应。由大小写字母、数字组成，长度不超过64字节。', + 'type' => 'string', + 'required' => true, + 'example' => 'a74a8fbd3cfe4b2daa8517e4e3******', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DeleterId', + 'in' => 'query', + 'schema' => [ + 'description' => '发起删除消息的用户ID，由大小写字母、数字组成，长度不超过64字节。', + 'type' => 'string', + 'required' => false, + 'example' => '169830****', + ], + ], + [ + 'name' => 'DeleterInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '发起删除消息的用户扩展信息，长度不超过512字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'testname', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B95BE680-5A6A-1CAD-8AB1-09DFF5D6****', + ], + 'GroupId' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'example' => 'grouptest', + ], + 'MessageId' => [ + 'description' => '已删除的或者不存在的消息ID。', + 'type' => 'string', + 'example' => 'a74a8fbd3cfe4b2daa8517e4e3******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B95BE680-5A6A-1CAD-8AB1-09DFF5D6****\\",\\n \\"GroupId\\": \\"grouptest\\",\\n \\"MessageId\\": \\"a74a8fbd3cfe4b2daa8517e4e3******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveMessageGroupMessageResponse>\\n <RequestId>B95BE680-5A6A-1CAD-8AB1-09DFF5D6****</RequestId>\\n <GroupId>grouptest</GroupId>\\n <MessageId>a74a8fbd3cfe4b2daa8517e4e3******</MessageId>\\n</DeleteLiveMessageGroupMessageResponse>","errorExample":""}]', + 'title' => '删除（撤回）某条群组消息', + 'description' => '本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteLiveMessageUserMessage' => [ + 'summary' => '调用DeleteLiveMessageUserMessage删除（撤回）某条单聊消息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'ReceiverId', + 'in' => 'query', + 'schema' => [ + 'description' => '接收删除消息的用户ID，由大小写字母、数字组成，长度不超过64字节。', + 'type' => 'string', + 'required' => true, + 'example' => '169830****', + ], + ], + [ + 'name' => 'MessageId', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的消息ID，与发送消息中的MsgTid对应。由大小写字母、数字组成，长度不超过64字节。', + 'type' => 'string', + 'required' => true, + 'example' => '**********', + ], + ], + [ + 'name' => 'DeleterId', + 'in' => 'query', + 'schema' => [ + 'description' => '发起删除消息的用户ID，由大小写字母、数字组成，长度不超过64字节。', + 'type' => 'string', + 'required' => false, + 'example' => '169830****', + ], + ], + [ + 'name' => 'DeleterInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '发起删除消息的用户扩展信息，长度不超过512字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'username', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致, 当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6CFDE7AB-571A-14EA-B072-989FF753****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6CFDE7AB-571A-14EA-B072-989FF753****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveMessageUserMessageResponse>\\n <RequestId>6CFDE7AB-571A-14EA-B072-989FF753****</RequestId>\\n</DeleteLiveMessageUserMessageResponse>","errorExample":""}]', + 'title' => '删除（撤回）某条单聊消息', + 'description' => '本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'SendLiveMessageGroup' => [ + 'summary' => '发送消息到群组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '198196', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的GroupId。'."\n" + .'> 请确保传入的GroupId是存在的！否则会返回ResourceNotExist错误。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + 'minLength' => 1, + ], + ], + [ + 'name' => 'SenderId', + 'in' => 'query', + 'schema' => [ + 'description' => '发送消息的用户ID，由大小写字母、数字组成，长度不超过64字节。', + 'type' => 'string', + 'required' => true, + 'example' => 'uid1', + ], + ], + [ + 'name' => 'SenderMetaInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '发送消息用户的扩展信息，长度不超过512字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'uid1meta1', + ], + ], + [ + 'name' => 'Body', + 'in' => 'query', + 'schema' => [ + 'description' => '消息体，长度不超过15KB。', + 'type' => 'string', + 'required' => false, + 'example' => 'hello,group', + ], + ], + [ + 'name' => 'MsgType', + 'in' => 'query', + 'schema' => [ + 'description' => '消息类型，单群内发送消息的总类型数不超过30种。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MsgTid', + 'in' => 'query', + 'schema' => [ + 'description' => '消息唯一标识，可作为删除消息的依据。由大小写字母、数字组成，长度不超过64字节。', + 'type' => 'string', + 'required' => false, + 'example' => '169830****', + ], + ], + [ + 'name' => 'StaticsIncrease', + 'in' => 'query', + 'schema' => [ + 'title' => '该消息对于该类消息数量的统计增长值贡献，默认值为1', + 'description' => '该消息对于该类消息数量的统计增长值贡献，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Weight', + 'in' => 'query', + 'schema' => [ + 'title' => '消息权重，权重越高，缓存优先级越高，缓存时间越长，默认值为1', + 'description' => '消息权重，默认值为 1。'."\n" + .'- 对于点赞等低优消息，可设置权重为 1；'."\n" + .'- 对于弹幕等普通文本消息，可设置权重为 5；'."\n" + .'- 对于红包、礼物等高优消息，可设置权重为 1000000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NoStorage', + 'in' => 'query', + 'schema' => [ + 'title' => '是否要存储消息，默认为false表示需要存储。', + 'description' => '设置不存储该消息。默认为 false，表示存储（当前时效30天），可以通过获取查询群组消息查到该消息。如果您的业务不需要存储该消息，请设置为true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NoCache', + 'in' => 'query', + 'schema' => [ + 'title' => '是否要缓存消息，默认为false表示需要缓存。', + 'description' => '设置不缓存该消息到最近消息列表中。默认为false，表示缓存到群组最近消息列表中。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E4C1245F-597B-1BD1-B9BB-9D220E99****', + ], + 'MsgTid' => [ + 'description' => '消息唯一标识，可作为删除消息的依据。由大小写字母、数字组成，长度不超过64字节。', + 'type' => 'string', + 'example' => '169830****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'ErrorTooManyMsgTypes', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4C1245F-597B-1BD1-B9BB-9D220E99****\\",\\n \\"MsgTid\\": \\"169830****\\"\\n}","errorExample":""},{"type":"xml","example":"<SendLiveMessageGroupResponse>\\n <RequestId>E4C1245F-597B-1BD1-B9BB-9D220E99****</RequestId>\\n</SendLiveMessageGroupResponse>","errorExample":""}]', + 'title' => '发送消息到群组', + 'description' => '调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848163~~)创建互动消息群组。发送消息到群组，目标群组需要是激活状态，即当前群组中有用户已加入，才能正常往群组发送消息。不支持离线消息，如果遇到发送消息失败，请先确认当前群组中是否有用户。若需离线发送，建议将先消息存在本地，待用户上线后重新发送。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'SendLiveMessageUser' => [ + 'summary' => '发送消息给指定用户，用户身份由ReceiverId标识。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194332', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '发送消息的互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'ReceiverId', + 'in' => 'query', + 'schema' => [ + 'title' => '消息接收用户的Id', + 'description' => '接收消息的用户ID，由大小写字母、数字组成，长度不超过64字节。'."\n" + ."\n" + .'> 请确保接收消息的用户的状态为在线！可以通过调用CheckLiveMessageUsersOnline来查询该用户状态。', + 'type' => 'string', + 'required' => true, + 'example' => 'uid2', + ], + ], + [ + 'name' => 'SenderId', + 'in' => 'query', + 'schema' => [ + 'title' => '消息发送用户的Id', + 'description' => '发送消息的用户ID，由大小写字母、数字组成，长度不超过64字节。', + 'type' => 'string', + 'required' => true, + 'example' => 'uid1', + ], + ], + [ + 'name' => 'SenderInfo', + 'in' => 'query', + 'schema' => [ + 'title' => '消息发送用户扩展信息', + 'description' => '发送消息用户的扩展信息，长度不超过512字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'uid1meta1', + ], + ], + [ + 'name' => 'Body', + 'in' => 'query', + 'schema' => [ + 'title' => '消息体', + 'description' => '消息体，长度不超过15KB。', + 'type' => 'string', + 'required' => false, + 'example' => 'hello, user', + ], + ], + [ + 'name' => 'MsgType', + 'in' => 'query', + 'schema' => [ + 'title' => '消息类型', + 'description' => '消息类型。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'MsgTid', + 'in' => 'query', + 'schema' => [ + 'title' => '消息标识', + 'description' => '消息唯一标识，可作为删除消息的依据。由大小写字母、数字组成，长度不超过64字节。', + 'type' => 'string', + 'required' => false, + 'example' => '169830****', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'HighReliability', + 'in' => 'query', + 'schema' => [ + 'description' => '设置该条消息是否为高可靠消息。高可靠消息确保接收方已收到该条消息并响应才会返回成功，如果接收方在3s内未响应会返回发送失败。'."\n" + .'- true：表示高可靠消息。'."\n" + .'- false（默认）：表示非高可靠消息。'."\n" + ."\n" + .'> 客户端SDK v1.5.1 及以上版本才支持此参数，发消息给老版本客户端时不等待ACK直接返回成功。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Storage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置存储该消息。'."\n" + .'- true：表示存储该消息。'."\n" + .'- false（默认），表示不需要存储。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6CFDE7AB-571A-14EA-B072-989FF753****', + ], + 'MsgTid' => [ + 'description' => '消息唯一标识，可作为删除消息的依据。由大小写字母、数字组成，长度不超过64字节。', + 'type' => 'string', + 'example' => '169830****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 408 => [ + [ + 'errorCode' => 'UserNotAck', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6CFDE7AB-571A-14EA-B072-989FF753****\\",\\n \\"MsgTid\\": \\"169830****\\"\\n}","errorExample":""},{"type":"xml","example":"<SendLiveMessageUserResponse>\\n <RequestId>6CFDE7AB-571A-14EA-B072-989FF753****</RequestId>\\n</SendLiveMessageUserResponse>","errorExample":""}]', + 'title' => '发送消息给指定用户', + 'description' => '本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListLiveMessageApps' => [ + 'summary' => '调用ListLiveMessageApps查询互动消息应用列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '193889', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'SortType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '排序方式，按创建时间先后，1为顺序，2为逆序', + 'description' => '排序方式，按创建时间先后进行排序。取值：'."\n" + .'- 1：顺序'."\n" + .'- 2：逆序', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '2', + 'minimum' => '1', + 'example' => '1', + 'enum' => [ + '1', + '2', + ], + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '查询页的起始位置，若为空或者-1则默认为首页。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B8EB4994-1368-1458-B9F3-5B88D76D734C', + ], + 'HasMore' => [ + 'description' => '是否有下一页。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NextPageToken' => [ + 'description' => '下一页的起始位置，Hasmore为true时返回。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AppList' => [ + 'description' => '互动消息应用列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表详细信息。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '所查询的互动消息应用ID。', + 'type' => 'string', + 'example' => 'demo', + ], + 'AppKey' => [ + 'description' => '互动消息应用的AppKey，在该互动消息应用ID的相关操作鉴权时需要该信息。', + 'type' => 'string', + 'example' => '**********************************', + ], + 'AppSign' => [ + 'description' => '互动消息应用签名，互动消息服务SDK需要该信息。', + 'type' => 'string', + 'example' => '**************************************************************************', + ], + 'Disable' => [ + 'description' => '该互动消息应用是否被禁用。', + 'type' => 'string', + 'example' => 'false', + ], + 'AppName' => [ + 'description' => 'App名称。', + 'type' => 'string', + 'example' => 'testApp', + ], + 'CreateTime' => [ + 'description' => '创建时间，用UNIX时间戳表示，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698305471', + ], + 'ModifyTime' => [ + 'description' => '修改时间，用UNIX时间戳表示，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698305471', + ], + 'MsgLifeCycle' => [ + 'description' => 'App内群组消息的存储时效档位，取值：'."\n" + ."\n" + .'- 0：默认值，存储30天。'."\n" + .'- 1：存储90天。'."\n" + .'- 2：存储180天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DataCenter' => [ + 'description' => '数据中心。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B8EB4994-1368-1458-B9F3-5B88D76D734C\\",\\n \\"HasMore\\": true,\\n \\"NextPageToken\\": 1,\\n \\"AppList\\": [\\n {\\n \\"AppId\\": \\"demo\\",\\n \\"AppKey\\": \\"**********************************\\",\\n \\"AppSign\\": \\"**************************************************************************\\",\\n \\"Disable\\": \\"false\\",\\n \\"AppName\\": \\"testApp\\",\\n \\"CreateTime\\": 1698305471,\\n \\"ModifyTime\\": 1698305471,\\n \\"MsgLifeCycle\\": 1,\\n \\"DataCenter\\": \\"cn-shanghai\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListLiveMessageAppsResponse>\\n <RequestId>B8EB4994-1368-1458-B9F3-5B88D76D734C</RequestId>\\n <HasMore>true</HasMore>\\n <NextPageToken>1</NextPageToken>\\n <AppList>\\n <AppId>demo</AppId>\\n <AppKey>**********************************</AppKey>\\n <AppSign>**************************************************************************</AppSign>\\n <Disable>false</Disable>\\n <AppName>testApp</AppName>\\n <CreateTime>1698305471</CreateTime>\\n <ModifyTime>1698305471</ModifyTime>\\n <MsgLifeCycle>1</MsgLifeCycle>\\n <DataCenter>cn-shanghai</DataCenter>\\n </AppList>\\n</ListLiveMessageAppsResponse>","errorExample":""}]', + 'title' => '查询直播互动应用列表', + 'description' => '本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveMessageApp' => [ + 'summary' => '调用DescribeLiveMessageApp查询互动消息应用信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '193804', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '待查询的AppID', + 'description' => '待查询的互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9FB68B5B-ED07-18F0-A3CF-083F4E74****', + ], + 'AppId' => [ + 'description' => '所查询的互动消息应用ID。', + 'type' => 'string', + 'example' => 'demo', + ], + 'AppName' => [ + 'description' => 'App名称。', + 'type' => 'string', + 'example' => 'testApp', + ], + 'AppKey' => [ + 'description' => '互动消息应用的AppKey，在进行与该互动消息应用ID相关的各种鉴权操作时需要该信息。', + 'type' => 'string', + 'example' => '**********************************', + ], + 'AppSign' => [ + 'description' => '互动消息应用签名，互动消息服务SDK需要该信息。', + 'type' => 'string', + 'example' => '**************************************************************************', + ], + 'AuditType' => [ + 'description' => '安全审核方式。取值：'."\n" + .'- 0：不开启安全审核。'."\n" + .'- 1：内置安全审核。'."\n" + .'- 2：自定义安全审核。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AuditUrl' => [ + 'description' => 'AuditType取值为2时提供的安全审核地址。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/exampleaudit', + ], + 'EventCallbackUrl' => [ + 'description' => '用户登录、登出、加入、离开群组等事件的回调地址，若为空则不开启事件回调。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/examplecallback', + ], + 'Disable' => [ + 'description' => '是否禁用互动消息应用。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CreateTime' => [ + 'description' => '创建时间，用UNIX时间戳表示，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698305471', + ], + 'ModifyTime' => [ + 'description' => '修改时间，用UNIX时间戳表示，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698305471', + ], + 'MsgLifeCycle' => [ + 'description' => 'App内群组消息的存储时效档位，取值：'."\n" + ."\n" + .'- 0：默认值，存储30天。'."\n" + .'- 1：存储90天。'."\n" + .'- 2：存储180天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DataCenter' => [ + 'description' => '数据中心。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FB68B5B-ED07-18F0-A3CF-083F4E74****\\",\\n \\"AppId\\": \\"demo\\",\\n \\"AppName\\": \\"testApp\\",\\n \\"AppKey\\": \\"**********************************\\",\\n \\"AppSign\\": \\"**************************************************************************\\",\\n \\"AuditType\\": 2,\\n \\"AuditUrl\\": \\"http://example.aliyundoc.com/exampleaudit\\",\\n \\"EventCallbackUrl\\": \\"http://example.aliyundoc.com/examplecallback\\",\\n \\"Disable\\": false,\\n \\"CreateTime\\": 1698305471,\\n \\"ModifyTime\\": 1698305471,\\n \\"MsgLifeCycle\\": 1,\\n \\"DataCenter\\": \\"cn-shanghai\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveMessageAppResponse>\\n <RequestId>9FB68B5B-ED07-18F0-A3CF-083F4E74****</RequestId>\\n <AppId>demo</AppId>\\n <AppName>testApp</AppName>\\n <AppKey>**********************************</AppKey>\\n <AppSign>**************************************************************************</AppSign>\\n <AuditType>2</AuditType>\\n <AuditUrl>http://example.aliyundoc.com/exampleaudit</AuditUrl>\\n <EventCallbackUrl>http://example.aliyundoc.com/examplecallback</EventCallbackUrl>\\n <Disable>false</Disable>\\n <CreateTime>1698305471</CreateTime>\\n <ModifyTime>1698305471</ModifyTime>\\n <MsgLifeCycle>1</MsgLifeCycle>\\n <DataCenter>cn-shanghai</DataCenter>\\n</DescribeLiveMessageAppResponse>","errorExample":""}]', + 'title' => '查询直播互动应用信息', + 'description' => '本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ModifyLiveMessageAppDisable' => [ + 'summary' => '修改App禁用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改信息的互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'Disable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否禁用互动消息应用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6AA1AE11-EA78-1FD4-A966-6BA84307****', + ], + 'AppId' => [ + 'description' => '需要修改信息的互动消息应用ID。', + 'type' => 'string', + 'example' => 'demo', + ], + 'AppSign' => [ + 'description' => '互动消息应用签名，互动消息服务SDK需要该信息。', + 'type' => 'string', + 'example' => '********************', + ], + 'Disable' => [ + 'description' => '该互动消息应用是否禁用。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6AA1AE11-EA78-1FD4-A966-6BA84307****\\",\\n \\"AppId\\": \\"demo\\",\\n \\"AppSign\\": \\"********************\\",\\n \\"Disable\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyLiveMessageAppDisableResponse>\\n <RequestId>6AA1AE11-EA78-1FD4-A966-6BA84307****</RequestId>\\n <AppId>demo</AppId>\\n <AppSign>********************</AppSign>\\n <Disable>true</Disable>\\n</ModifyLiveMessageAppDisableResponse>","errorExample":""}]', + 'title' => '修改直播互动应用禁用信息', + 'description' => '本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ModifyLiveMessageAppAudit' => [ + 'summary' => '修改互动消息应用安全审核设置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改信息的互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'AuditType', + 'in' => 'query', + 'schema' => [ + 'title' => '安全审核方式：0为不进行安全审核，1为内置安全审核， 2为自定义安全审核', + 'description' => '安全审核方式。取值：'."\n" + .'- 0：不进行安全审核'."\n" + .'- 1：内置安全审核'."\n" + .'- 2：自定义安全审核', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'enum' => [ + '0', + '1', + '2', + ], + ], + ], + [ + 'name' => 'AuditUrl', + 'in' => 'query', + 'schema' => [ + 'title' => '如果是自定义安全审核，则需要提供安全审核的地址', + 'description' => '如果是自定义安全审核（AuditType=2），则需要提供安全审核的地址。安全审核地址以http://或https://开头，不包含私有IP，不允许带端口号。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example.aliyundoc.com/exampleaudit', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4C4E8440-3838-1831-9BDE-AFC15803****', + ], + 'AppId' => [ + 'description' => '需要修改的互动消息应用ID。', + 'type' => 'string', + 'example' => 'demo', + ], + 'AppSign' => [ + 'description' => '互动消息应用签名，互动消息服务SDK需要该信息。', + 'type' => 'string', + 'example' => '**************************************************************************', + ], + 'AuditType' => [ + 'description' => '安全审核方式。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AuditUrl' => [ + 'description' => 'AuditType为2时提供的安全审核地址。', + 'type' => 'string', + 'example' => 'http: //example.aliyundoc.com/exampleaudit', + ], + 'AuditNeedAuthentication' => [ + 'description' => '调用鉴权。如果是自定义安全审核，则默认为true开启调用鉴权。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'ErrorInvalidAuditUrl', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4C4E8440-3838-1831-9BDE-AFC15803****\\",\\n \\"AppId\\": \\"demo\\",\\n \\"AppSign\\": \\"**************************************************************************\\",\\n \\"AuditType\\": 2,\\n \\"AuditUrl\\": \\"http: //example.aliyundoc.com/exampleaudit\\",\\n \\"AuditNeedAuthentication\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyLiveMessageAppAuditResponse>\\n <RequestId>4C4E8440-3838-1831-9BDE-AFC15803****</RequestId>\\n <AppId>demo</AppId>\\n <AppSign>**************************************************************************</AppSign>\\n <AuditType>2</AuditType>\\n <AuditUrl>http: //example.aliyundoc.com/exampleaudit</AuditUrl>\\n <AuditNeedAuthentication>true</AuditNeedAuthentication>\\n</ModifyLiveMessageAppAuditResponse>","errorExample":""}]', + 'title' => '修改直播互动应用鉴权信息', + 'description' => '本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ModifyLiveMessageAppCallback' => [ + 'summary' => '修改互动消息应用回调信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改的互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'EventCallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '用户登录、登出、加入、离开群组等事件回调地址。若为空则不开启回调。事件回调地址以http://或https://开头，不包含私有IP，不允许带端口号。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example.aliyundoc.com/examplecallback', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai)、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1F0FFEAD-B7D5-1D4A-A6B9-8C63ADF6****', + ], + 'AppId' => [ + 'description' => '修改回调的互动消息应用ID。', + 'type' => 'string', + 'example' => 'demo', + ], + 'AppSign' => [ + 'description' => '互动消息应用签名，互动消息服务SDK需要该信息。', + 'type' => 'string', + 'example' => '**************************************************************************', + ], + 'EventCallbackUrl' => [ + 'description' => '用户登录、登出、加入、离开群组等事件回调地址。若为空则不返回。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/examplecallback', + ], + 'EventCallbackNeedAuthentication' => [ + 'description' => '事件回调是否需要鉴权。默认为true。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'ErrorInvalidEventCallbackUrl', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1F0FFEAD-B7D5-1D4A-A6B9-8C63ADF6****\\",\\n \\"AppId\\": \\"demo\\",\\n \\"AppSign\\": \\"**************************************************************************\\",\\n \\"EventCallbackUrl\\": \\"http://example.aliyundoc.com/examplecallback\\",\\n \\"EventCallbackNeedAuthentication\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyLiveMessageAppCallbackResponse>\\n <RequestId>1F0FFEAD-B7D5-1D4A-A6B9-8C63ADF6****</RequestId>\\n <AppId>demo</AppId>\\n <AppSign>**************************************************************************</AppSign>\\n <EventCallbackUrl>http://example.aliyundoc.com/examplecallback</EventCallbackUrl>\\n <EventCallbackNeedAuthentication>true</EventCallbackNeedAuthentication>\\n</ModifyLiveMessageAppCallbackResponse>","errorExample":""}]', + 'title' => '修改直播互动应用回调信息', + 'description' => '本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'KickLiveMessageGroupUser' => [ + 'summary' => '踢出互动消息群组用户。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要踢人的互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要处理的群组的GroupID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grouptest', + ], + ], + [ + 'name' => 'KickoffUser', + 'in' => 'query', + 'schema' => [ + 'description' => '需要踢出去的用户。', + 'type' => 'string', + 'required' => true, + 'example' => 'uid1', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai）、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '97168878-5288-10CE-AE56-E2D1627F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"97168878-5288-10CE-AE56-E2D1627F****\\"\\n}","errorExample":""},{"type":"xml","example":"<KickLiveMessageGroupUserResponse>\\n <RequestId>97168878-5288-10CE-AE56-E2D1627F****</RequestId>\\n</KickLiveMessageGroupUserResponse>","errorExample":""}]', + 'title' => '将指定用户从群组中踢出去', + 'description' => '调用本接口前，您必须已经调用[CreateLiveMessageGroup](~~2848163~~)创建互动消息群组。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ModifyLiveMessageUserInfo' => [ + 'summary' => '修改用户信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '198649', + 'abilityTreeNodes' => [ + 'FEATUREliveSL6Y07', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改用户信息的互动消息应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改的用户ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'uid2', + ], + ], + [ + 'name' => 'UserMetaInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '修改后的用户扩展信息，长度不超过512字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'uid2meta2', + ], + ], + [ + 'name' => 'DataCenter', + 'in' => 'query', + 'schema' => [ + 'description' => '数据中心，需要与[CreateLiveMessageApp](~~2848162~~)中的数据中心一致，当前支持上海（取值为cn-shanghai）、新加坡（取值为ap-southeast-1）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。如果修改用户信息成功，或用户不存在，则接口返回成功。', + 'type' => 'object', + 'properties' => [ + 'FailList' => [ + 'description' => '对象数组。', + 'type' => 'array', + 'items' => [ + 'description' => '对象数组。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '440', + ], + 'GroupId' => [ + 'description' => '用户所在的群组ID。若修改失败，则在查询群组用户列表时用户信息不会同步更新。可根据失败原因检查后重新尝试。', + 'type' => 'string', + 'example' => 'grouptest2', + ], + 'Reason' => [ + 'description' => '群组修改失败的原因。', + 'type' => 'string', + 'example' => 'group not exists or already deleted', + ], + 'Success' => [ + 'description' => '群组修改失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3271ACD2-F143-1204-AFDB-9A87C131****', + ], + 'SuccessList' => [ + 'description' => '对象数组。', + 'type' => 'array', + 'items' => [ + 'description' => '对象数组。', + 'type' => 'object', + 'properties' => [ + 'GroupId' => [ + 'description' => '用户所在的群组ID。若修改成功，则在查询群组用户列表时用户信息会同步更新。', + 'type' => 'string', + 'example' => 'grouptest1', + ], + 'Success' => [ + 'description' => '群组修改成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"FailList\\": [\\n {\\n \\"Code\\": 440,\\n \\"GroupId\\": \\"grouptest2\\",\\n \\"Reason\\": \\"group not exists or already deleted\\",\\n \\"Success\\": false\\n }\\n ],\\n \\"RequestId\\": \\"3271ACD2-F143-1204-AFDB-9A87C131****\\",\\n \\"SuccessList\\": [\\n {\\n \\"GroupId\\": \\"grouptest1\\",\\n \\"Success\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ModifyLiveMessageUserInfoResponse>\\n <RequestId>3271ACD2-F143-1204-AFDB-9A87C131****</RequestId>\\n <SuccessList>\\n <GroupId>grouptest1</GroupId>\\n <Success>true</Success>\\n </SuccessList>\\n <FailList>\\n <GroupId>grouptest2</GroupId>\\n <Success>false</Success>\\n <Reason>group not exists or already deleted</Reason>\\n <Code>440</Code>\\n </FailList>\\n</ModifyLiveMessageUserInfoResponse>","errorExample":""}]', + 'title' => '修改用户信息', + 'description' => '本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'StartRtcCloudRecording' => [ + 'summary' => '启动rtc云端录制任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '269297', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '待录制的频道所属app的id。该app需要归属于当前调用接口账号所属的主账号。', + 'type' => 'string', + 'required' => true, + 'example' => '********-7074-****-9ef5-85c19a4*****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '待录制的频道对应的id。需要确保调用本接口时，该频道内有用户，否则会创建录制任务失败。', + 'type' => 'string', + 'required' => true, + 'example' => 'room1024', + ], + ], + [ + 'name' => 'SubscribeParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '订阅相关参数。', + 'type' => 'object', + 'properties' => [ + 'SubscribeUserIdList' => [ + 'description' => '订阅的UserId信息列表，单流录制模式下，会对其中每个UserId分别进行录制；混流录制模式下，会将所有UserId的音视频混合到一组音视频中。'."\n" + .'> - 数组不能为空，并且最多支持17个元素。', + 'type' => 'array', + 'items' => [ + 'description' => '订阅的UserId的信息。', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '订阅的UserId。', + 'type' => 'string', + 'required' => true, + 'example' => 'userA', + ], + 'StreamType' => [ + 'description' => '订阅的UserId的媒体类型。取值：'."\n" + ."\n" + .'- 0：原始流，即包括音频和视频。（默认值）'."\n" + ."\n" + .'- 1：仅音频流。'."\n" + ."\n" + .'- 2：仅视频流（混流录制模式下有效）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + '2', + ], + ], + 'SourceType' => [ + 'description' => '该UserId的视频输入流类型，仅订阅非纯音频流时（StreamType!=1）有效。取值：'."\n" + ."\n" + .'- 0：摄像头。（默认值）'."\n" + ."\n" + .'- 1：屏幕共享。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 17, + 'minItems' => 1, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'RecordParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '录制相关参数。', + 'type' => 'object', + 'properties' => [ + 'RecordMode' => [ + 'description' => '录制模式。取值：'."\n" + ."\n" + .'- 0：单流录制模式，对于订阅的每个UserId，各自生成录制文件。'."\n" + ."\n" + .'- 1：混流录制模式，对于订阅的UserId，将这些用户的流进行混合转码后，仅生成一组录制文件。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + 'StreamType' => [ + 'description' => '录制的输出流的媒体类型。取值：'."\n" + ."\n" + .'- 0：原始流，即包括音频和视频。（默认值）'."\n" + ."\n" + .'- 1：仅音频流。'."\n" + ."\n" + .'- 2：仅视频流。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + '2', + ], + ], + 'MaxFileDuration' => [ + 'description' => '录制文件最大时长（秒）。超过该时长的录制文件会被分割。取值范围须在[180,7200]内，即最大2小时。不指定时，则默认2小时。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '7200', + 'minimum' => '180', + 'example' => '7200', + 'default' => '7200', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'StorageParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '存储相关参数。', + 'type' => 'object', + 'properties' => [ + 'StorageType' => [ + 'description' => '存储方式。取值：'."\n" + ."\n" + .'- 0：VOD'."\n" + .'- 1：OSS', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'enum' => [ + '0', + '1', + ], + ], + 'FileInfo' => [ + 'description' => '文件存储信息，用于指定录制文件的格式、存储位置和命名，仅在StorageType为OSS时有效。'."\n" + ."\n" + .'> 对于数组中每个元素，会分别生成对应配置的录制文件。不设置时，默认包含HLS格式的配置；设置时，如果未包含HLS格式的配置，会自动生成HLS格式的默认配置。', + 'type' => 'array', + 'items' => [ + 'description' => '不同文件格式的存储配置。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'description' => '文件存储格式。取值：'."\n" + ."\n" + .'- HLS'."\n" + .'- MP4'."\n" + .'- MP3', + 'type' => 'string', + 'required' => true, + 'example' => 'HLS', + 'enum' => [ + 'HLS', + 'MP4', + 'MP3', + ], + ], + 'FileNamePattern' => [ + 'description' => '文件命名格式。可以由以下变量按任意顺序选择并组合：'."\n" + ."\n" + .'- AppId'."\n" + .'- ChannelId'."\n" + .'- UserId（单流模式下必选；混流模式下无效，选择的话会保留为{UserId}字符串）'."\n" + .' - RecordMode'."\n" + .' - 值为0时对应Single'."\n" + .' - 值为1时对应Mix'."\n" + ."\n" + .'- SourceType'."\n" + .' - 单流模式下，当流类型为纯视频流时，配置生效，SourceType可配置为：'."\n" + .' - 当值为0时，对应C（Camera）摄像头视频流。'."\n" + .' - 当值为1时，对应S（Screen）屏幕共享视频流。'."\n" + .' - 单流模式下，当流类型为纯音频流时，SourceType自动配置为A（Audio），用于标识该录制内容为纯音频流。'."\n" + .' - 单流模式下，当流类型为原始流时，配置生效，SourceType可配置为：'."\n" + .' - 当值为0时，对应OC（Original Camera）摄像头原始流。'."\n" + .' - 当值为1时，对应OS（Original Screen）屏幕共享原始流。'."\n" + .' - 其他场景下，SourceType配置无效，若用户手动配置了SourceType，系统将会保留{SourceType}占位符字符串。'."\n" + ."\n" + .'- StreamType（使用RecordParams参数下的StreamType参数）'."\n" + .' - 当值为0时对应AV（Audio Video）音频流与视频流。'."\n" + .' - 当值为1时对应A（Audio）音频流。'."\n" + .' - 当值为2时对应V（Video）视频流。'."\n" + ."\n" + .'- StartTime：开始录制的时间，为东八区时区，格式类似2025-03-25-11:27:28。（不使用默认值时必选）'."\n" + ."\n" + .'默认值如下：'."\n" + .'- 单流录制模式'."\n" + .' - {AppId}\\_{ChannelId}\\_{UserId}\\_{StartTime}'."\n" + .' - 如果同时订阅了同一个UserId的不同StreamType或不同SourceType，则默认值为{AppId}\\_{ChannelId}\\_{UserId}\\_{SourceType}\\_{StartTime}'."\n" + .'- 混流录制模式'."\n" + .' - {AppId}\\_{ChannelId}\\_{StartTime}'."\n" + ."\n" + .'> - 字符串只能由以上变量组成，变量名需要用{}包裹，变量名之间用一个下划线（_）分隔，每个变量至多在字符串内出现一次。'."\n" + .'> - 当命名为xxx后，文件最终会保存为类似TaskId/xxx.m3u8的形式，其中TaskId是在启动云端录制任务时生成的任务id，会自动添加到存储路径中。', + 'type' => 'string', + 'required' => false, + 'example' => '{AppId}_{ChannelId}_{StartTime}_{UserId}', + ], + 'SliceNamePattern' => [ + 'description' => '切片命名格式，仅在HLS格式下有效。与FileNamePattern类似，只是可选变量多出了Sequence：'."\n" + ."\n" + .'- AppId'."\n" + .'- ChannelId'."\n" + .'- UserId（单流模式下必选；混流模式下无效，选择的话会保留为{UserId}字符串）'."\n" + .'- RecordMode'."\n" + .' - 值为0时对应Single'."\n" + .' - 值为1时对应Mix'."\n" + ."\n" + .'- SourceType'."\n" + .' - 单流模式下，当流类型为纯视频流时此参数生效，SourceType可配置为：'."\n" + .' - 取值为0，对应C（Camera）摄像头视频流。'."\n" + .' - 取值为1，对应S（Screen）屏幕共享流。'."\n" + .' - 单流模式下，当流类型为纯音频流时，SourceType自动配置为A（Audio），用于标识该录制内容为纯音频流。'."\n" + .' - 单流模式下，当流类型为原始流时，配置生效，SourceType可配置为：'."\n" + .' - 当值为0时，对应OC（Original Camera）摄像头原始流。'."\n" + .' - 当值为1时，对应OS（Original Screen）屏幕共享原始流。'."\n" + .' - 其他场景下，SourceType配置无效，若用户手动配置该参数，系统将保留`{SourceType}`占位符字符串。'."\n" + ."\n" + .'- StreamType（使用RecordParams参数下的StreamType参数）'."\n" + .' - 当值为0时对应AV（Audio Video）包含音频流与视频流。'."\n" + .' - 当值为1时对应A（Audio ）音频流。'."\n" + .' - 当值为2时对应V（Video）视频流。'."\n" + .'- StartTime：开始录制的时间，为东八区时区，格式类似2025-03-25-11:27:28。（不使用默认值时必选）。'."\n" + ."\n" + .'- Sequence：HLS格式下，ts文件名中包含Sequence，其他格式下无效。（不使用默认值时必选）。'."\n" + ."\n" + .'默认值如下：'."\n" + .'- 单流录制模式'."\n" + .' - {AppId}\\_{ChannelId}\\_{UserId}\\_{StartTime}\\_{Sequence}'."\n" + .' - 如果同时订阅了同一个UserId的不同StreamType或不同SourceType，则默认值为{AppId}\\_{ChannelId}\\_{UserId}\\_{SourceType}\\_{StartTime}\\_{Sequence}'."\n" + .'- 混流录制模式'."\n" + .' - {AppId}\\_{ChannelId}\\_{StartTime}\\_{Sequence}'."\n" + ."\n" + .'> - 字符串只能由以上变量组成，变量名需要用{}包裹，变量名之间用一个下划线（_）分隔，每个变量至多在字符串内出现一次。'."\n" + .'> - 当命名为xxx后，切片文件最终会保存为类似TaskId/xxx.ts的形式，其中TaskId是在启动云端录制任务时生成的任务id，会自动添加到存储路径中。', + 'type' => 'string', + 'required' => false, + 'example' => '{AppId}_{ChannelId}_{StartTime}_{Sequence}', + ], + 'FilePathPrefix' => [ + 'description' => '文件存储路径。数组中的元素对应每一级目录，例如参数值为["dir1","dir2"]时，xxx.m3u8文件将被保存为dir1/dir2/TaskId/xxx.m3u8。该参数为空时，上述例子将直接保存为TaskId/xxx.m3u8。'."\n" + .'- 路径结尾会自动补充任务的TaskId，以避免不同任务的录制文件混在一起。'."\n" + .'- 如果设置了FilePathPrefix，那么数组中每个元素，只能由英文字母（a-zA-Z）、数字（0-9）、短横线（-）、下划线（_）组成，并且不能为空字符串。'."\n" + .'- 数组中各层路径拼接好后，总长度不能超过128个字符（包括连接的\'/\'，不包括自动填入的TaskId）。例如参数值为["dir1","dir2"]，那么拼接好的路径就是"dir1/dir2/"，也即数组中所有元素的总字符数与数组长度之和（对应每层路径后的"/"），不得超过128。'."\n" + .'- 数组中元素个数不得超过5，即最多自定义5层路径。', + 'type' => 'array', + 'items' => [ + 'description' => '每一级目录名。', + 'type' => 'string', + 'required' => false, + 'example' => 'dir1', + ], + 'required' => false, + ], + 'SliceDuration' => [ + 'title' => '指定切片时长，单位为秒，仅HLS格式下有效。取值范围在[10,30]内', + 'description' => '指定切片时长，单位为秒，仅HLS格式下有效，取值范围须在[10,30]内。（默认值为30）'."\n" + ."\n" + .'没有特殊需求时，建议直接使用默认值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'OSSParams' => [ + 'description' => 'OSS存储配置。当存储方式为OSS时必须配置，当存储方式为VOD时无效。', + 'type' => 'object', + 'properties' => [ + 'OSSEndpoint' => [ + 'description' => 'OSS存储的Endpoint名称。所对应的regionId需要与选择的服务接入点一致。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss-cn-shanghai.aliyuncs.com', + ], + 'OSSBucket' => [ + 'description' => 'OSS存储的Bucket名称。该Bucket需要归属于当前调用接口账号所属的主账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'mytest-bucket', + ], + ], + 'required' => false, + ], + 'VodParams' => [ + 'description' => 'VOD存储配置。当存储方式为VOD时必须配置，当存储方式为OSS时无效。', + 'type' => 'object', + 'properties' => [ + 'StorageLocation' => [ + 'description' => '点播控制台->媒资管理配置->存储管理中包含的存储地址，录制文件会先保存到这里，再上传到VOD。', + 'type' => 'string', + 'required' => false, + 'example' => 'mytest.oss-cn-shenzhen.aliyuncs.com', + ], + 'VodTranscodeGroupId' => [ + 'description' => '点播转码模板组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '****8a914d3989e9825eb90530b2****', + ], + 'AutoCompose' => [ + 'description' => '自动合并。取值：'."\n" + .'- 0：关闭自动合并。（默认值）'."\n" + .'- 1：开启自动合并。开启时必须设置参数ComposeVodTranscodeGroupId。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + 'ComposeVodTranscodeGroupId' => [ + 'description' => '对自动合成出来的新视频在点播服务中进行一次转码，所使用的点播转码模板组ID。'."\n" + ."\n" + .'> - 当AutoCompose（是否开启自动合并）设为1时，本参数才必填。'."\n" + .'> - 自动合成和转码常见问题，请参见[直播转点播常见问题FAQ](~~99726~~)。'."\n" + .'> - 点播转码计费详情，请参见[媒资转码计费](~~188308~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '****4c34112cfe68248f2f77759c****', + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'MixTranscodeParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '转码相关参数，单流录制模式下不填，混流录制模式下必填。', + 'type' => 'object', + 'properties' => [ + 'FrameFillType' => [ + 'description' => '断流补帧类型。取值：'."\n" + .'- 0：补最后一帧。（默认值）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + ], + ], + 'AudioBitrate' => [ + 'description' => '音频码率（kbps），取值范围须在[8, 500]内。混流模式下必填。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '500', + 'minimum' => '8', + 'example' => '300', + ], + 'AudioChannels' => [ + 'description' => '音频声道数。取值：'."\n" + .'- 1：单通道。'."\n" + .'- 2：双通道。'."\n" + ."\n" + .'混流模式下必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '2', + 'enum' => [ + '1', + '2', + ], + ], + 'AudioSampleRate' => [ + 'description' => '音频采样率（Hz）。取值：'."\n" + .'- 8000'."\n" + .'- 16000'."\n" + .'- 32000'."\n" + .'- 44100'."\n" + .'- 48000'."\n" + ."\n" + .'混流模式下必填。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '32000', + 'enum' => [ + '8000', + '16000', + '32000', + '44100', + '48000', + ], + ], + 'VideoCodec' => [ + 'description' => '视频编码格式。取值：'."\n" + .'- H.264（默认值）'."\n" + .'- H.265', + 'type' => 'string', + 'required' => false, + 'example' => 'H.264', + 'default' => 'H.264', + 'enum' => [ + 'H.264', + 'H.265', + ], + ], + 'VideoBitrate' => [ + 'description' => '视频码率（kbps），取值范围须在[1,10000]内。'."\n" + .'混流模式下，期望录制输出包含画面时必填，其他情况下无效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '5000', + ], + 'VideoFramerate' => [ + 'description' => '视频帧率（fps），取值范围须在[1,60]内。'."\n" + .'混流模式下，期望录制输出包含画面时必填，其他情况下无效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '60', + 'minimum' => '1', + 'example' => '30', + ], + 'VideoGop' => [ + 'description' => '视频GOP，每VideoGop帧存在一个I帧，取值范围须在[1,60]内。'."\n" + .'混流模式下，期望录制输出包含画面时必填，其他情况下无效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '60', + 'minimum' => '1', + 'example' => '30', + ], + 'VideoHeight' => [ + 'description' => '视频高度（px），取值范围须在[0,1920]内。（默认值为0）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1920', + 'minimum' => '0', + 'example' => '480', + 'default' => '0', + ], + 'VideoWidth' => [ + 'description' => '视频宽度（px），取值范围须在[0,1920]内。（默认值为0）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1920', + 'minimum' => '0', + 'example' => '640', + 'default' => '0', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'MixLayoutParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '布局相关参数，单流录制模式下不填，混流录制模式下期望录制出非纯音频文件时必填。', + 'type' => 'object', + 'properties' => [ + 'MixBackground' => [ + 'description' => '混流全局背景图。', + 'type' => 'object', + 'properties' => [ + 'RenderMode' => [ + 'description' => '画面输出时的显示模式。取值：'."\n" + .'- 0：裁剪。（默认值）'."\n" + .'- 1：缩放并显示黑底。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + 'Url' => [ + 'description' => '背景图URL，最大长度不超过2048个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://xxxx.com/photos/my-test-picture.png', + 'maxLength' => 2048, + ], + ], + 'required' => false, + ], + 'UserPanes' => [ + 'description' => '用于指定订阅的用户的窗口布局信息，只有设置了布局信息的UserId，才会被放到画面中。混流模式且录制非纯音频文件时必填。', + 'type' => 'array', + 'items' => [ + 'description' => '画面中窗口配置。', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '该窗口对应的UserId。'."\n" + .'- 不设置UserId时，会按照订阅的用户进入频道的顺序依次填入窗口。'."\n" + .'- 这里设置的UserId与SourceType的组合必须包含在SubscribeUserIdList中。'."\n" + .'- 订阅纯音频流是不能加入到布局中的', + 'type' => 'string', + 'required' => false, + 'example' => 'userA', + ], + 'SourceType' => [ + 'description' => '该UserId的视频输入流类型。不填写UserId时，此处设置SourceType无效。取值：'."\n" + .'- 0：摄像头。（默认值）'."\n" + .'- 1：屏幕共享。'."\n" + ."\n" + .'这里设置的UserId与SourceType的组合必须包含在SubscribeUserIdList中。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + 'Height' => [ + 'description' => '窗格高度，归一化百分比。取值范围须在[0,1]内。(默认为0)', + 'type' => 'string', + 'required' => false, + 'example' => '0.5', + 'default' => '0', + ], + 'Width' => [ + 'description' => '窗格宽度，归一化百分比。取值范围须在[0,1]内。(默认为0)', + 'type' => 'string', + 'required' => false, + 'example' => '0.5', + 'default' => '0', + ], + 'X' => [ + 'description' => '坐标X，归一化百分比。取值范围须在[0,1]内。(默认为0)', + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + 'Y' => [ + 'description' => '坐标Y，归一化百分比。取值范围须在[0,1]内。(默认为0)', + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + 'ZOrder' => [ + 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。(默认为0)', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + 'SubBackground' => [ + 'description' => '子画面背景图，当用户关闭摄像头、或入会后未推流、或入会后中途离会时，会在布局位置填充为对应的图片。', + 'type' => 'object', + 'properties' => [ + 'RenderMode' => [ + 'description' => '子画面输出时的显示模式。取值：'."\n" + .'- 0：裁剪。（默认值）'."\n" + .'- 1：缩放并显示黑底。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + 'Url' => [ + 'description' => '背景图URL，最大长度不超过2048个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://xxxx.com/photos/my-test-pane-picture.png', + 'maxLength' => 2048, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'NotifyUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '接受回调消息地址。任务状态消息会通过POST方式，以Json格式推送到该地址，最大长度不超过2048个字符。'."\n" + ."\n" + .'回调消息说明参考[文档](https://help.aliyun.com/zh/live/on-cloud-recording-callback-message)。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://xxxx/test/mycallback', + ], + ], + [ + 'name' => 'NotifyAuthKey', + 'in' => 'query', + 'schema' => [ + 'description' => '回调消息鉴权key，默认不填，即不做鉴权。如果填写，长度需要在[16,64]个字符内，且只由大小写英文字母和数字组成。'."\n" + .'- 当NotifyUrl未填写时，NotifyAuthKey也无效。'."\n" + .'- 当设置有效的NotifyAuthKey时，会在回调消息内携带鉴权内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'mytestkeymytestkey', + ], + ], + [ + 'name' => 'NotifyFileUploadedFormat', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '指定在录制文件上传后，需要触发回调的格式', + 'description' => '指定的格式，在触发录制文件生成事件（RecordFileUploaded）时，将发送回调消息。', + 'type' => 'array', + 'items' => [ + 'title' => '需要回调的具体文件格式', + 'description' => '需要接收回调的具体文件格式。取值（可忽略大小写）：'."\n" + ."\n" + .'- SLICE'."\n" + .'- HLS'."\n" + .'- MP4'."\n" + .'- MP3'."\n" + ."\n" + .'暂不支持VOD存储模式。'."\n" + .'对于OSS存储模式，选择的格式要包含在StorageParams.FileInfo的文件格式中。', + 'type' => 'string', + 'required' => false, + 'example' => 'MP4', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'MaxIdleTime', + 'in' => 'query', + 'schema' => [ + 'description' => '空闲超时时间，当任务处于空闲状态的时长超过MaxIdleTime时，自动停止任务。单位为秒，范围须在[10,14400]内，即最大4小时。（默认为300秒）'."\n" + .'- 对于混流录制模式，当所有订阅的用户流都停止推流时算作空闲'."\n" + .'- 对于单流录制模式，订阅的流之间彼此独立，任意一路流停止推流都算作空闲，达到MaxIdleTime后会停止该路流的录制，当所有订阅流都空闲超时后，会停止整个云端录制任务。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '86400', + 'minimum' => '10', + 'example' => '600', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回内容。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id。', + 'type' => 'string', + 'example' => '******58-5876-****-83CA-B56278******', + ], + 'TaskId' => [ + 'description' => '任务id。', + 'type' => 'string', + 'example' => '******73-8501-****-8ac1-72295a******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.NotifyUrl', + 'errorMessage' => '%s, please check the notifyUrl.', + ], + [ + 'errorCode' => 'InvalidParameter.StorageParams.FileInfo', + 'errorMessage' => '%s, please check the fileInfo of storageParams.', + ], + [ + 'errorCode' => 'InvalidParameter.StorageParams.OSSParams', + 'errorMessage' => '%s, please check the ossParams of storageParams.', + ], + [ + 'errorCode' => 'NotFound.OSSBucket', + 'errorMessage' => '%s, please check the ossBucket of storageParams.', + ], + [ + 'errorCode' => 'InvalidParameter.SubscribeParams.SubscribeUserIdList', + 'errorMessage' => '%s, please check the subscribeUserIdList of subscribeParams.', + ], + [ + 'errorCode' => 'InvalidParameter.MixLayoutParams.UserPanes', + 'errorMessage' => '%s, please check the userPanes of mixLayoutParams.', + ], + [ + 'errorCode' => 'InvalidParameter.MixTranscodeParams', + 'errorMessage' => '%s, please check the transcodeParams.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidParameter.UserId', + 'errorMessage' => '%s, please check the UserId.', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameter.ChannelId', + 'errorMessage' => '%s, please check the channelId.', + ], + [ + 'errorCode' => 'InvalidParameter.AppId', + 'errorMessage' => '%s, please check the appId.', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameter.StorageParams.VodParams', + 'errorMessage' => '%s, please check the vodParams of storageParams.', + ], + [ + 'errorCode' => 'InvalidParameter.NotifyAuthKey', + 'errorMessage' => '%s, please check the notifyAuthKey.', + ], + [ + 'errorCode' => 'InvalidParameter.MaxIdleTime', + 'errorMessage' => '%s, please check the maxIdleTime.', + ], + [ + 'errorCode' => 'InvalidParameter.RecordParams', + 'errorMessage' => '%s, please check the recordParams.', + ], + [ + 'errorCode' => 'InvalidParameter.StorageParams.StorageType', + 'errorMessage' => '%s, please check the storageType of storageParams.', + ], + [ + 'errorCode' => 'InvalidParameter.NotifyFileUploadedFormat', + 'errorMessage' => '%s, please check the notifyFileUploadedFormat.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******58-5876-****-83CA-B56278******\\",\\n \\"TaskId\\": \\"******73-8501-****-8ac1-72295a******\\"\\n}","type":"json"}]', + 'title' => '启动Rtc云端录制任务', + 'description' => '云端录制属于收费功能，收费详情请参见[云端录制费用](~~2976391~~)。'."\n" + .'## 服务接入点'."\n" + .'本接口可用的服务接入点包括：'."\n" + ."\n" + .' |地域名称 |地域ID | 公网接入地址 |'."\n" + .' | --- | --- | --- |'."\n" + .' | 上海 | cn-shanghai | live.aliyuncs.com |'."\n" + .' | 新加坡 | ap-southeast-1 | live.ap-southeast-1.aliyuncs.com |'."\n" + .' | 美国（弗吉尼亚） | us-east-1 | live.us-east-1.aliyuncs.com |'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '- 对于单流录制模式：'."\n" + .' - 支持同时订阅同一个 UserId 的摄像头和屏幕共享，但FileNamePattern和SliceNamePattern参数中必须包含 SourceType 变量（避免出现录制文件互相覆盖的情况）。'."\n" + .' - 目前不支持只订阅某个 UserId 的纯视频流。即在单流模式下，UserInfo.StreamType 的值不能设置为2。'."\n" + ."\n" + .'- 在单流录制模式下：'."\n" + .' - 如果 RecordParams.StreamType 是纯音频流（取值为 1），那么 SubscribeParams 中不能存在订阅纯视频的情况（即SubscribeParams取值为2）。'."\n" + .' - 如果 RecordParams.StreamType 是纯视频流（值为 2），那么 SubscribeParams 中不能存在订阅纯音频的情况（即SubscribeParams取值为1）。'."\n" + ."\n" + .'- 在混流录制模式下：'."\n" + .' - 如果 RecordParams.StreamType 是纯音频流（值为 1），那么 SubscribeParams 中不能所有 UserId 都只订阅纯视频（即所有SubscribeParams取值为2）。'."\n" + .' - 如果 RecordParams.StreamType 是纯视频流（值为 2），那么 SubscribeParams 中不能所有 UserId 都只订阅纯音频（即所有SubscribeParams取值为1）。'."\n" + ."\n" + .'- 录制过程中，如果中途channel关闭，需要在空闲时长内重新入会推流，否则任务将自动停止。', + 'extraInfo' => '- UserId实际推流与订阅的流的对应关系要符合下表中为"✅"的场景：'."\n" + ."\n" + .' | |订阅音频流 | 订阅视频流 | 订阅音视频流 |'."\n" + .' | --- |--- | --- | --- |'."\n" + .' | 推音频流 | ✅ | ❌ | ❌ |'."\n" + .' | 推视频流 | ❌ | ✅ | ✅ |'."\n" + .' | 推音视频流 | ✅ | ✅ | ✅ |'."\n" + ."\n" + .'- 否则，录制出的文件可能与预期不符，或者暂时无文件生成。'."\n" + ."\n" + .'- 在单流录制模式下，如果某个UserId的源流在推流过程中发生分辨率变化，并且要求录制mp4文件，可能导致兼容性问题。具体表现为：当使用不支持动态分辨率切换的播放器打开该mp4文件时，从分辨率变更时刻起的画面可能停滞。'."\n" + ."\n" + .'- 当选择录制到VOD，在收到STOPPED回调时，只能表示文件开始上传到VOD，而不代表文件已上传完毕，这与录制到OSS是不同的。'."\n" + ."\n" + .'- 当选择录制到VOD，开启自动合并后，当录制结束时，至少要有两个媒体资源文件，才会进行自动合并，即如果结束录制时只有一个录制文件，那么不会生成合并文件。'."\n" + ."\n" + .' - 回调相关信息：'."\n" + .' - 在rtc云端录制任务的生命周期中，当任务的状态发生变化时，便会向用户推送回调信息，推送地址为创建录制任务时传入的NotifyUrl。'."\n" + .' - rtc云端录制任务会通过POST方式向NotifyUrl发送回调，Content-Type为application/json'."\n" + .' - 回调内容'."\n" + .' - Header'."\n" + .' - 当创建云端录制任务时，如果传入的NotifyAuthKey为有效值，在发送给用户端的回调中，Header会携带ALI-LIVE-TIMESTAMP和ALI-LIVE-SIGNATURE字段，供回调消息接收服务端进行签名认证。其中，ALI-LIVE-SIGNATURE的值由如下计算而得： ALI-LIVE-SIGNATURE=MD5SUM(MD5CONTENT); MD5CONTENT=ALI-LIVE-TIMESTAMP|NotifyAuthKey'."\n" + .'回调消息接收服务端在接收回调消息时，将ALI-LIVE-TIMESTAMP、NotifyAuthKey 进行拼接后计算 MD5 值，得到加密字符串，再将计算出的加密字符串与视频直播发起的 HTTP(S)请求头中的 ALI-LIVE-SIGNATURE 字段值进行对比。如果不一致，则请求非法。（注意，竖线\'|\'分隔符也需要拼接到MD5CONTENT中）'."\n" + ."\n" + .' |参数名 | 描述 |'."\n" + .' |--- | --- |'."\n" + .' | Content-Type | application/json; charset=utf-8 |'."\n" + .' | ALI-LIVE-TIMESTAMP | 仅当NotifyAuthKey有效时传递，示例值：1748417138 |'."\n" + .' | ALI-LIVE-SIGNATURE | 仅当NotifyAuthKey有效时传递，示例值：abcdefgxxx |'."\n" + ."\n" + .' - Body'."\n" + ."\n" + .' |参数名 | 类型 | 描述 |'."\n" + .' |--- | --- | --- |'."\n" + .' | appId | string | 应用Id。 |'."\n" + .' | channelId | string | 频道Id。 |'."\n" + .' | taskId | string | 录制任务Id。 |'."\n" + .' | eventType | string | 事件类型。取值： <br> TaskCreated（任务已创建） <br> TaskStarting（任务启动中） <br> TaskRunning（任务运行中） <br> TaskRecovering（异常恢复中） <br> TaskStopping（任务停止中） <br> TaskStopped（任务已停止） <br> TaskStartFailed（启动失败） <br> TaskUpdated（更新成功） <br> TaskUpdateFailed（更新失败） <br> RecordStart（录制正式开始） <br> RecordFailed（录制异常恢复超时） |'."\n" + .' | callbackTs | integer | 发送回调的时间，为毫秒级时间戳，如1744774345595。 |'."\n" + .' | payload | json string | 其他信息。 |'."\n" + .' - payload'."\n" + ."\n" + .' |参数名 | 类型 | 描述 |'."\n" + .' |--- | --- | --- |'."\n" + .' | eventTs | integer | 事件发生的时间，为毫秒级时间戳，如1744774345595。 |'."\n" + .' | taskStatus | string | 任务状态。取值： <br> CREATED（任务已创建） <br> STARTING（任务启动中） <br> RUNNING（任务运行中） <br> RECOVERING（异常恢复中） <br> STOPPING（任务停止中） <br> STOPPED（任务已停止） <br> FAILED（启动失败) | '."\n" + .' | errorCode | string | 错误码，仅当eventType为TaskRecovering、TaskStartFailed以及TaskUpdateFailed时不为空。取值： <br> StartTaskError（对应TaskStartFailed） <br> RunTaskError（对应TaskRecovering） <br> UpdateTaskError（对应TaskUpdateFailed） | '."\n" + .' | errorMessage | string | 错误信息，与errorCode类似。取值： <br> Channel already closed（对应TaskStartFailed，频道已关闭） <br> Start task error（对应TaskStartFailed的其他原因） <br> The rms task failed（对应TaskRecovering，rms任务运行异常） <br> The record task failed（对应TaskRecovering，record任务运行异常） <br> Update task error（对应TaskUpdateFailed）<br> Recovering status timeout（对应RecordFailed，异常恢复超时） | '."\n" + .' | recordFileList | FileList | 录制文件列表，详细见DescribeRtcCloudRecordingFiles的出参。仅当eventType为TaskRunning、TaskStopping、TaskStopped时会返回。 |'."\n" + .' - 期望回调接收方返回'."\n" + .' |参数名 | 类型 |'."\n" + .' |--- | --- |'."\n" + .' | Header | Content-Type: application/json |'."\n" + .' | HttpStatus | 200 |'."\n" + .' | Body | { <br> "Code": 0, <br> "Msg": "Success" <br> } |'."\n" + .' - 如果回调接收端的返回结果与期望结果不符，回调发送端会重复发送一次回调。', + ], + 'UpdateRtcCloudRecording' => [ + 'summary' => '更新rtc云端录制任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '269333', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '启动Rtc云端录制时返回的任务id。', + 'type' => 'string', + 'required' => true, + 'example' => '******73-8501-****-8ac1-72295a******'."\n", + ], + ], + [ + 'name' => 'SubscribeParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '更新后的订阅相关参数。', + 'type' => 'object', + 'properties' => [ + 'SubscribeUserIdList' => [ + 'description' => '订阅的UserId信息列表，单流录制模式下，会对其中每个UserId分别进行录制；混流录制模式下，会将所有UserId的音视频混合到一组音视频中。'."\n" + .'> '."\n" + .'> - 数组内最多支持17个元素。', + 'type' => 'array', + 'items' => [ + 'description' => '订阅的UserId的信息', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '订阅的UserId。', + 'type' => 'string', + 'required' => true, + 'example' => 'userA', + ], + 'StreamType' => [ + 'description' => '订阅的UserId的媒体类型。取值：'."\n" + ."\n" + .'- 0：原始流，即包括音频和视频。（默认值）'."\n" + ."\n" + .'- 1：仅音频流。'."\n" + ."\n" + .'- 2：仅视频流。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + '2', + ], + ], + 'SourceType' => [ + 'description' => '该UserId的视频输入流类型，仅针对订阅视频流时（StreamType=2）有效。取值：'."\n" + ."\n" + .'- 0：摄像头。（默认值）'."\n" + ."\n" + .'- 1：屏幕共享。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 17, + 'minItems' => 1, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'MixLayoutParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '更新后的布局相关参数，单流录制模式下不填，混流录制模式下非纯音频转码时必填。', + 'type' => 'object', + 'properties' => [ + 'MixBackground' => [ + 'description' => '混流全局背景图。', + 'type' => 'object', + 'properties' => [ + 'RenderMode' => [ + 'description' => '画面输出时的显示模式。取值：'."\n" + .'- 0：裁剪。（默认值）'."\n" + .'- 1：缩放并显示黑底。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + 'Url' => [ + 'description' => '背景图URL，最大长度不超过2048个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://xxxx.com/photos/my-test-picture.png'."\n", + 'maxLength' => 2048, + ], + ], + 'required' => false, + ], + 'UserPanes' => [ + 'description' => '用于指定订阅的用户的窗口布局信息，只有设置了布局信息的UserId，才会被放到画面中。混流模式且录制非纯音频文件时必填。', + 'type' => 'array', + 'items' => [ + 'description' => '画面中窗口配置。', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '该窗口对应的UserId。'."\n" + .'- 不设置UserId时，会按照订阅的用户进入频道的顺序依次填入窗口。'."\n" + .'- 这里设置的UserId与SourceType的组合必须包含在SubscribeUserIdList中。'."\n" + .'- 订阅纯音频流是不能加入到布局中的', + 'type' => 'string', + 'required' => false, + 'example' => 'userA', + ], + 'SourceType' => [ + 'description' => '该UserId的视频输入流类型。不填写UserId时，此处设置SourceType无效。取值：'."\n" + .'- 0：摄像头。（默认值）'."\n" + .'- 1：屏幕共享。'."\n" + .'这里设置的UserId与SourceType的组合必须包含在SubscribeUserIdList中。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + 'Height' => [ + 'description' => '窗格高度，归一化百分比。取值范围须在[0,1]内。(默认为0)', + 'type' => 'string', + 'required' => false, + 'example' => '0.5', + 'default' => '0', + ], + 'Width' => [ + 'description' => '窗格宽度，归一化百分比。取值范围须在[0,1]内。(默认为0)', + 'type' => 'string', + 'required' => false, + 'example' => '0.5', + 'default' => '0', + ], + 'X' => [ + 'description' => '坐标X，归一化百分比。取值范围须在[0,1]内。(默认为0)', + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + 'Y' => [ + 'description' => '坐标Y，归一化百分比。取值范围须在[0,1]内。(默认为0)', + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + 'ZOrder' => [ + 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。(默认为0)', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + 'SubBackground' => [ + 'description' => '子画面背景图，当用户关闭摄像头、或入会后未推流、或入会后中途离会时，会在布局位置填充为对应的图片。', + 'type' => 'object', + 'properties' => [ + 'RenderMode' => [ + 'description' => '子画面输出时的显示模式。取值：'."\n" + .'- 0：裁剪。（默认值）'."\n" + .'- 1：缩放并显示黑底。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + 'Url' => [ + 'description' => '背景图URL，最大长度不超过2048个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://xxxx.com/photos/my-test-pane-picture.png'."\n", + 'maxLength' => 2048, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id。', + 'type' => 'string', + 'example' => '******58-5876-****-83CA-B56278******'."\n", + ], + 'TaskId' => [ + 'description' => '任务id。', + 'type' => 'string', + 'example' => '******73-8501-****-8ac1-72295a******'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotFound.Task', + 'errorMessage' => '%s, please check the TaskId.', + ], + [ + 'errorCode' => 'InvalidParameter.TaskId', + 'errorMessage' => '%s, please check the TaskId.', + ], + [ + 'errorCode' => 'InvalidParameter.SubscribeParams.SubscribeUserIdList', + 'errorMessage' => '%s, please check the subscribeUserIdList of subscribeParams.', + ], + [ + 'errorCode' => 'InvalidParameter.MixLayoutParams.UserPanes', + 'errorMessage' => '%s, please check the userPanes of mixLayoutParams.', + ], + [ + 'errorCode' => 'InvalidParameter.MixTranscodeParams', + 'errorMessage' => '%s, please check the transcodeParams.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidParameter.UserId', + 'errorMessage' => '%s, please check the UserId.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******58-5876-****-83CA-B56278******\\\\n\\",\\n \\"TaskId\\": \\"******73-8501-****-8ac1-72295a******\\\\n\\"\\n}","type":"json"}]', + 'title' => '更新Rtc云端录制任务', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '- 支持同时订阅同一个UserId的摄像头和屏幕共享。对于单流录制模式，如果要同时订阅同一个UserId的摄像头和屏幕共享，FileNamePattern和SliceNamePattern中必须包含SourceType变量（避免出现录制文件互相覆盖的情况）。'."\n" + ."\n" + .'- 对于单流录制模式，目前不支持只订阅某个UserId的纯视频流。即在单流模式下，UserInfo.StreamType的值不能设置为2。'."\n" + ."\n" + .'- 如果只希望录制某个UserId的屏幕流，而不录制音频流，要么订阅该UserId的纯视频流并设置SourceType为1（单流录制模式下暂时不支持），要么订阅该UserId的原始流并在推流时视频流只推屏幕流，且不推音频流或静音；如果希望录制某个UserId的屏幕流和音频流，要么订阅该UserId的原始流并在推流时视频流只推屏幕流，且同时推音频流，要么订阅该UserId的纯视频流并设置SourceType为1（单流录制模式下暂时不支持），同时订阅该UserId的纯音频流。'."\n" + ."\n" + .'- 在单流录制模式下，如果RecordParams.StreamType是纯音频流（值为1），那么SubscribeParams中不能存在订阅纯视频的情况（值为2）；如果RecordParams.StreamType是纯视频流（值为2），那么SubscribeParams中不能存在订阅纯音频的情况（值为1）。'."\n" + ."\n" + .'- 在混流录制模式下，如果RecordParams.StreamType是纯音频流（值为1），那么SubscribeParams中不能所有UserId都只订阅纯视频（值为2）；如果RecordParams.StreamType是纯视频流（值为2），那么SubscribeParams中不能所有UserId都只订阅纯音频（值为1）。', + ], + 'StopRtcCloudRecording' => [ + 'summary' => '停止rtc云端录制任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '269331', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '启动Rtc云端录制时返回的任务id。', + 'type' => 'string', + 'required' => true, + 'example' => '******73-8501-****-8ac1-72295a******'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回内容。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id。', + 'type' => 'string', + 'example' => '******58-5876-****-83CA-B56278******', + ], + 'TaskId' => [ + 'description' => '任务id。', + 'type' => 'string', + 'example' => '******73-8501-****-8ac1-72295a******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotFound.Task', + 'errorMessage' => '%s, please check the TaskId.', + ], + [ + 'errorCode' => 'InvalidParameter.TaskId', + 'errorMessage' => '%s, please check the TaskId.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidParameter.UserId', + 'errorMessage' => '%s, please check the UserId.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******58-5876-****-83CA-B56278******\\",\\n \\"TaskId\\": \\"******73-8501-****-8ac1-72295a******\\"\\n}","type":"json"}]', + 'title' => '停止Rtc云端录制任务', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeRtcCloudRecordingFiles' => [ + 'summary' => '查询rtc云端录制文件与任务信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '269336', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '启动Rtc云端录制时返回的任务id。', + 'type' => 'string', + 'required' => true, + 'example' => '******73-8501-****-8ac1-72295a******'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回内容。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id。', + 'type' => 'string', + 'example' => '******58-5876-****-83CA-B56278******'."\n", + ], + 'TaskInfo' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务id。', + 'type' => 'string', + 'example' => '******73-8501-****-8ac1-72295a******'."\n", + ], + 'Status' => [ + 'description' => '任务状态：'."\n" + .'- RUNNING'."\n" + .'- RECOVERING'."\n" + .'- STOPPING'."\n" + .'- STOPPED', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'RecordFileList' => [ + 'description' => '录制文件列表。', + 'type' => 'object', + 'properties' => [ + 'Mp3FileList' => [ + 'description' => 'mp3格式录制文件名数组。', + 'type' => 'array', + 'items' => [ + 'description' => 'mp3格式录制文件名。', + 'type' => 'string', + 'example' => '******73-8501-****-8ac1-72295a******/myappid_testroom_userA_2025-05-06-14:37:22.mp3', + ], + ], + 'Mp4FileList' => [ + 'description' => 'mp4格式录制文件名数组。', + 'type' => 'array', + 'items' => [ + 'description' => 'mp4格式录制文件名。', + 'type' => 'string', + 'example' => '******73-8501-****-8ac1-72295a******/myappid_testroom_userA_2025-05-06-14:37:22.mp4', + ], + ], + 'HlsFileList' => [ + 'description' => 'hls格式录制文件名数组。', + 'type' => 'array', + 'items' => [ + 'description' => 'hls格式录制文件名。', + 'type' => 'string', + 'example' => '******73-8501-****-8ac1-72295a******/myappid_testroom_userA_2025-05-06-14:37:22.m3u8', + ], + ], + 'VodMediaList' => [ + 'description' => 'VOD媒体资源数组。录制到VOD时，订阅的各个流的录制文件集合，其中每一项对应着一个订阅流。', + 'type' => 'array', + 'items' => [ + 'description' => '对应订阅的某条流的媒体资源信息。', + 'type' => 'object', + 'properties' => [ + 'Stream' => [ + 'description' => '表示订阅的流'."\n" + .' - 对于混流录制，值统一为Mix'."\n" + .' - 对于单流录制，值为Single::{UserId}::{Suffix}'."\n" + .' - UserId为这条流对应的UserId'."\n" + .' - Suffix与订阅时填写的StreamType和SourceType有关'."\n" + .' - 当StreamType为0时：如果SourceType为0，那么Suffix为AV::C；如果SourceType为1，那么Suffix为AV::S'."\n" + .' - 当StreamType为1时：Suffix只能为A'."\n" + .' - 当StreamType为2时（单流录制暂不支持）：如果SourceType为0，那么Suffix为V::C；如果SourceType为1，那么Suffix为V::S', + 'type' => 'string', + 'example' => 'Single::UserA::AV::C', + ], + 'MediaIds' => [ + 'description' => '录制过程中生成的媒体资源id数组。', + 'type' => 'array', + 'items' => [ + 'description' => '录制过程中生成的媒体资源id。', + 'type' => 'string', + 'example' => '****bbd9f59c71ee80065017f0f8****', + ], + ], + 'MergedIds' => [ + 'description' => '录制结束后生成的自动合并的媒体资源id数组。', + 'type' => 'array', + 'items' => [ + 'description' => '录制结束后生成的自动合并的媒体资源id。', + 'type' => 'string', + 'example' => '****d2f9f59c71ee8006501790g7****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotFound.Task', + 'errorMessage' => '%s, please check the TaskId.', + ], + [ + 'errorCode' => 'InvalidParameter.TaskId', + 'errorMessage' => '%s, please check the TaskId.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidParameter.UserId', + 'errorMessage' => '%s, please check the UserId.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******58-5876-****-83CA-B56278******\\\\n\\",\\n \\"TaskInfo\\": {\\n \\"TaskId\\": \\"******73-8501-****-8ac1-72295a******\\\\n\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"RecordFileList\\": {\\n \\"Mp3FileList\\": [\\n \\"******73-8501-****-8ac1-72295a******/myappid_testroom_userA_2025-05-06-14:37:22.mp3\\"\\n ],\\n \\"Mp4FileList\\": [\\n \\"******73-8501-****-8ac1-72295a******/myappid_testroom_userA_2025-05-06-14:37:22.mp4\\"\\n ],\\n \\"HlsFileList\\": [\\n \\"******73-8501-****-8ac1-72295a******/myappid_testroom_userA_2025-05-06-14:37:22.m3u8\\"\\n ],\\n \\"VodMediaList\\": [\\n {\\n \\"Stream\\": \\"Single::UserA::AV::C\\",\\n \\"MediaIds\\": [\\n \\"****bbd9f59c71ee80065017f0f8****\\"\\n ],\\n \\"MergedIds\\": [\\n \\"****d2f9f59c71ee8006501790g7****\\"\\n ]\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询Rtc云端录制文件及任务状态', + 'description' => '## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeChannelParticipants' => [ + 'summary' => '查询频道内在线用户列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '169451', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，仅支持传单个ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aec****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '加入的频道，仅支持传单个ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testId', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示用户数量，默认每页显示10条用户数据。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式，取值：'."\n" + ."\n" + .'- **asc**：递增。'."\n" + ."\n" + .'- **desc**（默认值）：递减。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6159ba01-6687-4fb2-a831-f0cd8d1******', + ], + 'Times' => [ + 'description' => '返回结果时间，使用UNIX时间戳表示，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1557909133', + ], + 'TotalNum' => [ + 'description' => '返回结果数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TotalPage' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '返回分页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UserList' => [ + 'description' => '用户ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户ID列表，多个用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '27f9****,bb87****,df82****', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6159ba01-6687-4fb2-a831-f0cd8d1******\\",\\n \\"Times\\": 1557909133,\\n \\"TotalNum\\": 3,\\n \\"TotalPage\\": 1,\\n \\"UserList\\": [\\n \\"27f9****,bb87****,df82****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeChannelParticipantsResponse>\\n <RequestId>6159ba01-6687-4fb2-a831-f0cd8d188648</RequestId>\\n <Timestamp>1557909133</Timestamp>\\n <TotalNum>3</TotalNum>\\n <TotalPage>1</TotalPage>\\n <UserList>\\n <User>27f9****</User>\\n <User>bb87****</User>\\n <User>df82****</User>\\n </UserList>\\n</DescribeChannelParticipantsResponse>","errorExample":""}]', + 'title' => '查询频道内在线用户列表', + 'description' => '本接口用于查询频道内在线用户列表，不包含用户详细信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeChannelUsers' => [ + 'summary' => '查询频道内在线用户列表的详细信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，仅支持传单个ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aec****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '已加入的频道ID，仅支持传单个ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AD86847D-1F36-18C8-A995-5EEA34******', + ], + 'Timestamp' => [ + 'description' => '当前时刻的时间戳（UTC时间）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1691027655', + ], + 'IsChannelExists' => [ + 'description' => '频道是否存在，取值：'."\n" + ."\n" + .'- **true**：存在。'."\n" + ."\n" + .'- **false**：不存在。'."\n" + ."\n" + .'>频道无人后，会有若干秒的缓存，此时接口返回true，但互动者与观众人数都为0。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InteractiveUserNumber' => [ + 'description' => '互动者用户总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LiveUserNumber' => [ + 'description' => '频道内的观众总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InteractiveUserList' => [ + 'description' => '互动用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '互动用户列表。', + 'type' => 'string', + 'example' => 'aaa', + ], + ], + 'LiveUserList' => [ + 'description' => '观众列表。', + 'type' => 'array', + 'items' => [ + 'description' => '观众列表，最多返回1000人。', + 'type' => 'string', + 'example' => 'bbb', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '400', + 'errorMessage' => 'InvalidInput', + ], + ], + [ + [ + 'errorCode' => '401', + 'errorMessage' => 'InvalidAuth', + ], + ], + 404 => [ + [ + 'errorCode' => '404', + 'errorMessage' => 'AppOrChannelNotExists', + ], + ], + 500 => [ + [ + 'errorCode' => '500', + 'errorMessage' => 'SystemError, Please Check App And Channel Exists, RETRY', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AD86847D-1F36-18C8-A995-5EEA34******\\",\\n \\"Timestamp\\": 1691027655,\\n \\"IsChannelExists\\": true,\\n \\"InteractiveUserNumber\\": 1,\\n \\"LiveUserNumber\\": 1,\\n \\"InteractiveUserList\\": [\\n \\"aaa\\"\\n ],\\n \\"LiveUserList\\": [\\n \\"bbb\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeChannelUsersResponse>\\n <RequestId>AD86847D-1F36-18C8-A995-5EEA340B3202</RequestId>\\n <Timestamp>1691027655</Timestamp>\\n <IsChannelExists>true</IsChannelExists>\\n <InteractiveUserNumber>1</InteractiveUserNumber>\\n <LiveUserNumber>1</LiveUserNumber>\\n <InteractiveUserList>aaa</InteractiveUserList>\\n <LiveUserList>bbb</LiveUserList>\\n</DescribeChannelUsersResponse>","errorExample":""}]', + 'title' => '查询频道内在线用户列表', + 'description' => '本接口用于查询频道内在线用户列表的详细信息。例如：您可以查询直播模式下的用户总数。'."\n" + ."\n\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'RemoveTerminals' => [ + 'summary' => '从频道中踢出指定终端用户。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '178423', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，仅支持传单个ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aec****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '已加入的频道ID，仅支持传单个ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'testId', + ], + ], + [ + 'name' => 'TerminalIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用户列表ID。', + 'type' => 'array', + 'items' => [ + 'description' => '用户ID列表，N的取值：**1~30**。格式如下所示：'."\n" + ."\n" + .'```'."\n" + .'TerminalIds.1=****'."\n" + .'TerminalIds.2=****'."\n" + .'......'."\n" + .'```', + 'type' => 'string', + 'required' => false, + 'example' => '1811****', + ], + 'required' => true, + 'maxItems' => 30, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4AF8', + ], + 'Terminals' => [ + 'description' => '用户ID信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户ID信息列表。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码，成功返回0，失败返回错误码描述。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Message' => [ + 'description' => '删除终端操作结果。取值：'."\n" + ."\n" + .'- Success：成功。'."\n" + ."\n" + .'- Failed：失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Id' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '1811****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4AF8\\",\\n \\"Terminals\\": [\\n {\\n \\"Code\\": 0,\\n \\"Message\\": \\"Success\\",\\n \\"Id\\": \\"1811****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RemoveTerminalsResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4AF8</RequestId>\\n <Terminals>\\n <Code>0</Code>\\n <Message>Success</Message>\\n <Id>1811****</Id>\\n </Terminals>\\n</RemoveTerminalsResponse>","errorExample":""}]', + 'title' => '从频道中踢出指定终端用户', + 'description' => '本接口用于将指定终端用户从频道踢出。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CreateRTCWhipStreamAddress' => [ + 'summary' => '调用CreateRTCWhipStreamAddress创建RTC频道WHIP推流地址', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '幂等参数。'."\n" + .'> 用于区分多次请求是不是同一个请求的标识，针对本接口不建议填写。', + 'type' => 'string', + 'required' => false, + 'example' => '58E73333-xxxx-xxxx-xxxx', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用AppID', + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => '6a0**6dcc-xxxx-xxxx-xxxx-e**e3exxxxxx ', + 'maxLength' => 64, + 'minLength' => 1, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '频道号', + 'description' => '加入的频道ID。', + 'type' => 'string', + 'required' => true, + 'example' => ' ch00000****001', + 'maxLength' => 64, + 'minLength' => 1, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户ID，不要与其他进频道的用户重合。', + 'description' => '用户ID，不能与频道中的其他用户 ID 重复。', + 'type' => 'string', + 'required' => true, + 'example' => 'zb0000****0001', + 'maxLength' => 64, + 'minLength' => 1, + 'pattern' => '^[0-9a-zA-Z_-]+$', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'title' => '在频道内显示的名称', + 'description' => '在频道中显示的用户名称。'."\n" + .'> 支持填写中文等字符，为避免名称过长，大小建议小于32个byte。', + 'type' => 'string', + 'required' => true, + 'example' => '主播小二', + 'maxLength' => 40, + 'minLength' => 1, + ], + ], + [ + 'name' => 'ExpireTime', + 'in' => 'query', + 'schema' => [ + 'description' => '推流有效时长，单位：秒，默认为43200秒。'."\n" + .'> 若超过设置的有效期，则正在使用由本接口所生成地址进行的推流不受影响，但是用该地址重新推流则会失败。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '43200', + 'default' => '43200', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '58E7**D4-xxxx-xxxx-xxxx-6B5**6Cxxxxx', + ], + 'WhipAddress' => [ + 'title' => 'whip协议推流服务地址', + 'description' => 'WHIP协议URL。', + 'type' => 'string', + 'example' => 'https://xxxxxx.media-sh.xxxxx.com/xxxxxxxxxxxx/3723a3xxxxxxxxx223c606b***5f7a2bc7c56ea5cdd0xxxxe?auth_key=17495xxxxx-xxxx-0-f013003067c78c4053f9cd0xxxxxxx&qqzr=H4sIAAAAAAAC_6pWSlayUkrOMxxxxxxrPyCxQ0lFKQTCLlKyUjM2Nj**NDQ1TEy2Mjc3xxxxxxxxxxqRYAAAD__xxxxx__xxxxxxxx', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58E7**D4-xxxx-xxxx-xxxx-6B5**6Cxxxxx\\",\\n \\"WhipAddress\\": \\"https://xxxxxx.media-sh.xxxxx.com/xxxxxxxxxxxx/3723a3xxxxxxxxx223c606b***5f7a2bc7c56ea5cdd0xxxxe?auth_key=17495xxxxx-xxxx-0-f013003067c78c4053f9cd0xxxxxxx&qqzr=H4sIAAAAAAAC_6pWSlayUkrOMxxxxxxrPyCxQ0lFKQTCLlKyUjM2Nj**NDQ1TEy2Mjc3xxxxxxxxxxqRYAAAD__xxxxx__xxxxxxxx\\"\\n}","type":"json"}]', + 'title' => '创建RTC频道WHIP推流地址', + 'description' => '## 使用说明'."\n" + .'1. 通过调用CreateRTCWhipStreamAddress接口，创建在对应RTC房间（频道）的WhipAddress推流地址。'."\n" + .'2. 使用OBS工具，通过whip协议进行推流。'."\n" + .' - 运行OBS推流工具。'."\n" + .' - 在菜单栏中选择**文件>设置**。'."\n" + .' - 在设置页面选择**直播**，配置如下信息，单击**确定**。'."\n" + ."\n" + .' | 参数 | 描述 | '."\n" + .' | ------ | ------| '."\n" + .' | 服务| 选择**WHIP**。| '."\n" + .' | 服务器 | 使用步骤1中通过接口生成的WhipAddress地址。| '."\n" + .' | Bearer Token| 串流密钥为空。 | '."\n" + ."\n" + .' '."\n" + ."\n" + .'3. 其他用户，进入相应房间（频道）观看。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户 QPS 限制为 40 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CreateRoomRealTimeStreamAddress' => [ + 'summary' => '创建RTMP流在房间中的推流地址。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '198619', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '实时音视频应用ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '往哪个频道中推', + 'description' => '要加入的房间ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourChannelId', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => 'rtmp在房间中的userid,请不要与房间中的其他用户重复', + 'description' => '向RTMP地址推流的用户ID，不能和房间中的其他用户ID重复。由大小写字母、数字、下划线、短划线（-）组成，最大64字符。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp-uuid', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'title' => 'rtmp在频道中的显示名称，长度1~40，必填', + 'description' => 'RTMP流在房间中显示的名称，最大40字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp-dname', + 'maxLength' => 40, + 'minLength' => 1, + ], + ], + [ + 'name' => 'ExpireTime', + 'in' => 'query', + 'schema' => [ + 'title' => '地址有效时长，单位秒，默认10个小时', + 'description' => 'RTMP地址有效时长，单位：秒，默认值36000，即10小时。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '43200', + 'default' => '43200', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F8DB7E25-6A35-161A-AA41-B7A658AF****', + ], + 'RtmpAddress' => [ + 'description' => 'RTMP推流地址。', + 'type' => 'string', + 'example' => 'rtmp://rtcpush****.rtmp.alivecdn.com/rtcdev****/H4sIAAAA****_6pWSlayUipJLS5R0lEqRTBTEMwiJSul1CRTMxNjsyQTM****-PUZCMz8yTDZLNkAwMDA6M0I0ulWgA****__wEAAP__a_e7YkkAAAA?auth_key=1700492701-6e33-0-c6d7e3a93dc2dbe3af42f6259ccd****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F8DB7E25-6A35-161A-AA41-B7A658AF****\\",\\n \\"RtmpAddress\\": \\"rtmp://rtcpush****.rtmp.alivecdn.com/rtcdev****/H4sIAAAA****_6pWSlayUipJLS5R0lEqRTBTEMwiJSul1CRTMxNjsyQTM****-PUZCMz8yTDZLNkAwMDA6M0I0ulWgA****__wEAAP__a_e7YkkAAAA?auth_key=1700492701-6e33-0-c6d7e3a93dc2dbe3af42f6259ccd****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateRoomRealTimeStreamAddressResponse>\\n <RequestId>F8DB7E25-6A35-161A-AA41-B7A658AF0635</RequestId>\\n <RtmpAddress>rtmp://rtcpush****.rtmp.alivecdn.com/rtcdev****/H4sIAAAA****_6pWSlayUipJLS5R0lEqRTBTEMwiJSul1CRTMxNjsyQTM****-PUZCMz8yTDZLNkAwMDA6M0I0ulWgA****__wEAAP__a_e7YkkAAAA?auth_key=1700492701-6e33-0-c6d7e3a93dc2dbe3af42f6259ccd****</RtmpAddress>\\n</CreateRoomRealTimeStreamAddressResponse>","errorExample":""}]', + 'title' => '创建RTMP流在房间中的推流地址', + 'description' => '1. 调用此接口生成RTMP推流地址。'."\n" + .'2. 向RTMP地址推流，房间中的其他用户可以看到此路流。'."\n" + .'3. 停止推流，房间中的其他用户看到推RTMP流的用户离开房间。'."\n" + ."\n" + .'> - 在RTMP地址有效期内可以重复步骤2、3。'."\n" + .'>- 建议配合调用[DescribeChannelParticipants](~~2848193~~)查询频道用户列表，定时间隔的检查推RTMP流的用户是否还在房间中。如果不在，可能推流中断，建议停止推流再转到步骤2重推。'."\n" + ."\n" + .'## 注意事项'."\n" + ."\n" + .'在使用实时音视频时，需要通过阿里云ARTC SDK进行入会并推送RTC的流。但在部分特殊场景下，阿里云允许您使用RTMP协议推流（如OBS推流），并由阿里云将RTMP转换成RTC流进行推送和实现用户入会。您可以通过本接口实现该能力，本接口将为您生成RTMP推流地址，当您完成推流后阿里云将自动将流转换成RTC流。'."\n" + .'若您的业务是纯直播场景时，请勿使用该接口，您可以参见[生成推流地址和播放地址](~~198676~~)快速实现RTMP推流和直播播放。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteChannel' => [ + 'summary' => '关闭频道将使所有当前频道内的成员退出，但不影响后续重新使用该频道。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '169448', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，仅支持传单个ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'eo85****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '已入会的频道ID，仅支持传单个ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'testid', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '400', + 'errorMessage' => 'InvalidInput', + ], + ], + [ + [ + 'errorCode' => '401', + 'errorMessage' => 'InvalidAuth', + ], + ], + 404 => [ + [ + 'errorCode' => '404', + 'errorMessage' => 'AppOrChannelNotExists', + ], + ], + 500 => [ + [ + 'errorCode' => '500', + 'errorMessage' => 'ServerError, Check App And Channel Exists,Retry', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteChannelResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CF8</RequestId>\\n</DeleteChannelResponse>","errorExample":""}]', + 'title' => '关闭频道', + 'description' => '本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListRTCLiveRooms' => [ + 'summary' => '获取在线频道列表', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '需要前置客户端入会等操作', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用AppID', + 'description' => '应用AppID', + 'type' => 'string', + 'required' => true, + 'example' => 'a494caec-***-695ef345db77', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小，取值【10，100】，默认50', + 'description' => '分页大小，取值【10，100】，默认50', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '50', + 'default' => '50', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '当前分页，从1开始', + 'description' => '当前分页，从1开始', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64-af62-20e91b96****', + ], + 'Total' => [ + 'description' => '查询结果总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Rooms' => [ + 'title' => '活跃房间列表', + 'description' => '活跃房间列表', + 'type' => 'array', + 'items' => [ + 'description' => '房间号', + 'type' => 'string', + 'example' => 'room1', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5c6a2a0df228-4a64-af62-20e91b96****\\",\\n \\"Total\\": 2,\\n \\"Rooms\\": [\\n \\"room1\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询ARTC在线频道列表', + ], + 'StartLiveMPUTask' => [ + 'summary' => '创建混流转推任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '178410', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '频道ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourChannelId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字符。此ID为旁路转推的标识，需保证唯一。'."\n" + .'启动任务时，如果同ID任务还在，未被清理，会返回InvalidParam。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourTaskId', + ], + ], + [ + 'name' => 'MixMode', + 'in' => 'query', + 'schema' => [ + 'description' => '混流模式。取值：'."\n" + .'- **0**：单路转推，不混流转码，仅转推原始单路流，无需配置混流转码参数。'."\n" + .'- **1（默认值）**：混流转码转推。', + 'type' => 'string', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'StreamURL', + 'in' => 'query', + 'schema' => [ + 'description' => '直播推流地址，仅支持RTMP协议，仅支持传单个地址，最大长度不超过2048个字符。生成规则请参见[推流地址和播放地址](~~199339~~)。'."\n" + ."\n" + .'>- 对已开防盗链鉴权的域名，需要在推流地址中包含鉴权串。'."\n" + .'- 禁止同一个StreamURL在不同任务中同时使用。'."\n" + .'- 任务停止10S之内，禁止使用同一个StreamURL。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://example.com/live/stream', + ], + ], + [ + 'name' => 'MultiStreamURL', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '多地址转推参数，可填写多个直播推流地址。'."\n" + .'> 在设置任务的转推地址时，StreamURL参数与MultiStreamURL参数，只能配置其中一个参数，且必须配置其中一个参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'URL' => [ + 'description' => '直播推流地址，仅支持RTMP协议，最大长度不超过2048个字符。生成规则请参见[推流地址和播放地址](~~199339~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://example.com/live/stream****', + ], + 'IsAliCdn' => [ + 'description' => '是否转推到阿里云CDN。'."\n" + .'- false为转推非阿里云CDN。'."\n" + .'- true为转推阿里云CDN。'."\n" + ."\n" + .'> 该参数默认为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '请求的混流服务所在区域。取值：'."\n" + ."\n" + .'- **CN-Shanghai<props="china"><ph>（默认值）</ph></props>**：上海。'."\n" + .'- **AP-Singapore<props="intl"><ph>（默认值）</ph></props>**：新加坡。'."\n" + .'- **EMAA-Saudi**：沙特。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CN-Shanghai', + ], + ], + [ + 'name' => 'MaxIdleTime', + 'in' => 'query', + 'schema' => [ + 'description' => '空闲超时时间；单位为秒，取值范围为\\[10,86400\\]。'."\n" + .' > 设置此参数后，会在任务处于空闲状态的时长大于 MaxIdleTime 时，自动停止该任务；若不设置此参数，则会在房间关闭后，立刻停止该任务。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SingleSubParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '单流转推参数，单流转推（MixMode=0）时必填。需要混流转码时不填。', + 'type' => 'object', + 'properties' => [ + 'SourceType' => [ + 'description' => '单流转推模式下视频输入流类型，仅针对视频流（StreamType=2）有效。取值：'."\n" + .'- **camera（默认值）**：摄像头。'."\n" + .'- **shareScreen**：屏幕共享。', + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + ], + 'StreamType' => [ + 'description' => '单流转推模式下转推流类型。取值：'."\n" + .'- **0（默认值）**：转推原始流。'."\n" + .'- **1**：仅转推音频流。'."\n" + .'- **2**：仅转推视频流。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'UserId' => [ + 'description' => '单流转推的用户ID，一次只能转推一路流。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourSubUserId', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'TranscodeParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '混流转码转推参数，混流转码转推（MixMode=1）时必填。需要单流转推时不填。', + 'type' => 'object', + 'properties' => [ + 'Background' => [ + 'description' => '混流全局背景图。', + 'type' => 'object', + 'properties' => [ + 'RenderMode' => [ + 'description' => '子画面输出时的显示模式：'."\n" + .'- **0**：缩放并显示黑底。'."\n" + .'- **1**（默认）：裁剪。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'URL' => [ + 'description' => '全局背景图URL，最大长度不超过2048个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourImageUrl', + ], + ], + 'required' => false, + ], + 'EncodeParams' => [ + 'description' => '转推输出的编码参数。', + 'type' => 'object', + 'properties' => [ + 'AudioOnly' => [ + 'description' => '是否为纯音频，取值：'."\n" + .'- **true**：纯音频，仅需要设置音频相关参数。'."\n" + .'- **false（默认值）**：非纯音频，除VideoCodec参数与EnhancedParam参数外，其它参数均不能为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + 'AudioBitrate' => [ + 'description' => '音频码率，取值范围：\\[8, 500\\]，单位：kbps。', + 'type' => 'string', + 'required' => false, + 'example' => '128', + ], + 'AudioChannels' => [ + 'description' => '音频声道数，取值：1、2。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + 'AudioSampleRate' => [ + 'description' => '音频采样率，取值：8000、16000、32000、44100、48000，单位：Hz。', + 'type' => 'string', + 'required' => false, + 'example' => '44100', + ], + 'VideoCodec' => [ + 'description' => '视频编码格式。取值：'."\n" + .'- H.264（默认值）。'."\n" + .'- H.265。', + 'type' => 'string', + 'required' => false, + 'example' => 'H.264', + ], + 'VideoBitrate' => [ + 'description' => '视频码率，取值范围：\\[1, 10000\\]，单位：kbps。', + 'type' => 'string', + 'required' => false, + 'example' => '3500', + ], + 'VideoFramerate' => [ + 'description' => '视频帧率，取值范围：\\[1, 60\\]，单位：fps。', + 'type' => 'string', + 'required' => false, + 'example' => '25', + ], + 'VideoGop' => [ + 'description' => '视频GOP，取值范围：\\[1, 60\\]。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + 'VideoHeight' => [ + 'description' => '视频高，取值范围：\\[0, 1920\\]，单位：px。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + 'VideoWidth' => [ + 'description' => '视频宽，取值范围：\\[0, 1920\\]，单位：px。', + 'type' => 'string', + 'required' => false, + 'example' => '1920', + ], + 'EnhancedParam' => [ + 'description' => '编码增强参数，JSON字符串，目前支持的可选配置包括profile与preset。'."\n" + .'- profile：编码级别。当视频编码格式为H.264时，profile支持的可选值包括："baseline", "main", "high"；当视频编码格式为H.265时，profile支持的可选值包括："main"。'."\n" + ."\n" + .'- preset：调节编码速度和质量的平衡。preset支持的可选值包括："ultrafast", "superfast", "veryfast", "faster", "fast", "medium", "slow", "slower", "veryslow" "placebo"。每个值代表了一种编码速度与输出视频质量的策略，从"ultrafast"（极快，编码速度优先）到"placebo"（追求极致质量，编码极慢）。'."\n" + ."\n" + .'> 例如设置superfast，主要用于实时通讯领域。建议非编码器专业技术人员，不设置该选项。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"profile": "high", "preset": "veryfast"}', + ], + ], + 'required' => false, + ], + 'Layout' => [ + 'description' => '视频布局信息。'."\n" + .'> 视频转码时，需要指定视频布局信息，包括布局坐标(X，Y)，布局窗格(Width，Height)，叠放顺序(ZOrder)；纯音频转码时，禁止填写视频布局信息。'."\n", + 'type' => 'object', + 'properties' => [ + 'UserPanes' => [ + 'description' => '混流用户窗格信息。', + 'type' => 'array', + 'items' => [ + 'description' => '混流用户窗格信息。', + 'type' => 'object', + 'properties' => [ + 'UserInfo' => [ + 'description' => '该窗格对应的混流用户信息，不填时后台按照上行主播的进房顺序自动填充。'."\n" + .'>- 如果指定混流用户信息，该用户信息需要已在TranscodeParams.UserInfos参数中配置。 '."\n" + .'- 仅针对原始流和视频流有效。', + 'type' => 'object', + 'properties' => [ + 'SourceType' => [ + 'description' => '混流转码模式下视频输入流类型，仅针对视频流（StreamType=2）有效。取值：'."\n" + .'- **camera（默认值）**：摄像头。'."\n" + .'- **shareScreen**：屏幕共享。', + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + ], + 'ChannelId' => [ + 'description' => '混流用户所在的频道ID，同频道内混流的用户可不填，跨频道混流时建议填写该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourChannelId', + ], + 'UserId' => [ + 'description' => '混流用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourSubUserId', + ], + ], + 'required' => false, + ], + 'Height' => [ + 'description' => '窗格高，归一化百分比。', + 'type' => 'string', + 'required' => false, + 'example' => '0.2632', + ], + 'Width' => [ + 'description' => '窗格宽，归一化百分比。', + 'type' => 'string', + 'required' => false, + 'example' => '0.3564', + ], + 'X' => [ + 'description' => '坐标X，归一化百分比。', + 'type' => 'string', + 'required' => false, + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '坐标Y，归一化百分比。', + 'type' => 'string', + 'required' => false, + 'example' => '0.3789', + ], + 'ZOrder' => [ + 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'BackgroundImageUrl' => [ + 'description' => '子画面的背景图URL，最大长度不超过2048个字符。当用户关闭摄像头或未进入房间时，会在布局位置填充为此图片。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourImageUrl', + ], + 'RenderMode' => [ + 'description' => '子画面输出时的显示模式，取值：'."\n" + .'- **0**：缩放并显示黑底。'."\n" + .'- **1（默认值）**：裁剪。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'UserInfos' => [ + 'description' => '混流时订阅的用户信息，不指定用户则所有用户混流。', + 'type' => 'array', + 'items' => [ + 'description' => '混流用户信息。', + 'type' => 'object', + 'properties' => [ + 'SourceType' => [ + 'description' => '混流时订阅的视频输入流类型，仅针对视频流（StreamType=2）有效。取值：'."\n" + .'- **camera（默认值）**：摄像头。'."\n" + .'- **shareScreen**：屏幕共享。', + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + ], + 'StreamType' => [ + 'description' => '混流时订阅的转推流类型。取值：'."\n" + .'- **0（默认值）**：转推原始流。'."\n" + .'- **1**：仅转推音频流。'."\n" + .'- **2**：仅转推视频流。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'ChannelId' => [ + 'description' => '混流时订阅用户所在的频道ID，同频道内混流的用户可不填，跨频道混流时建议填写该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourChannelId', + ], + 'UserId' => [ + 'description' => '混流时订阅的用户ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourSubUserId', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'SeiParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'SEI配置参数。', + 'type' => 'object', + 'properties' => [ + 'LayoutVolume' => [ + 'description' => '布局和音量SEI，该参数内容可以为空，表示携带默认的布局和音量SEI。', + 'type' => 'object', + 'properties' => [ + 'FollowIdr' => [ + 'description' => '发送IDR关键帧时是否确保携带SEI，取值：'."\n" + .'- **0**：不确保带SEI。'."\n" + .'- **1**：确保带SEI。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'Interval' => [ + 'description' => 'SEI发送间隔，取值范围：\\[1000, 5000\\]，单位：毫秒。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + 'required' => false, + ], + 'PassThrough' => [ + 'description' => '透传SEI。', + 'type' => 'object', + 'properties' => [ + 'FollowIdr' => [ + 'description' => '发送IDR关键帧时是否确保携带SEI，取值：'."\n" + .'- **0**：不确保带SEI。'."\n" + .'- **1**：确保带SEI。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'Interval' => [ + 'description' => 'SEI发送间隔，取值范围：\\[1000, 5000\\]，单位：毫秒。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + 'PayloadContent' => [ + 'description' => '透传SEI的payload内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourPayloadContent', + ], + 'PayloadContentKey' => [ + 'description' => '透传SEI的payload内容对应的key值。不设置时，key为默认值udd。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourPayloadContentKey', + ], + ], + 'required' => false, + ], + 'PayloadType' => [ + 'description' => 'SEI消息的自定义payload_type，取值范围100-254。不设置时，SEI的payload_type为默认值为5。', + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求ID。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0F72851F-5DC1-1979-9B2C-450040316C3E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidAppId', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the Live service', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'InternalError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0F72851F-5DC1-1979-9B2C-450040316C3E\\"\\n}","errorExample":""},{"type":"xml","example":"<StartLiveMPUTaskResponse>\\n <RequestId>0F72851F-5DC1-1979-9B2C-450040316C3E</RequestId>\\n</StartLiveMPUTaskResponse>","errorExample":""}]', + 'title' => '创建混流转推任务（新）', + 'description' => '单个应用ID默认支持单路转推任务上限为200个，混流转码转推任务上限为40。如果您需要提升配额，请[提交工单](https://smartservice.console.aliyun.com/service/create-ticket)。'."\n" + .'### 混流任务生命周期'."\n" + .'**启动**'."\n" + .'- 主播首次开播，可以调用StartLiveMPUTask启动旁路。'."\n" + .' '."\n" + .' - 若无用户入会，会返回channel不存在错误。'."\n" + .' - 用户开始推流时才会输出旁路流。若单路任务用户未推流，则旁路流无法播放。'."\n" + .' - 混流任务需保证至少有一个用户有推流，旁路流才可播放。未推流的用户对应的布局画面会展示黑屏。'."\n" + ."\n" + .'- 客户业务服务器建议记录旁路任务状态、任务类型、任务参数。'."\n" + .' - 任务状态：启动、停止。'."\n" + .' - 任务类型：单路、混流。'."\n" + .' - 任务参数：即最新的入参，例如：调用UpdateLiveMPUTask成功后，记录最新任务参数。'."\n" + .'- 在连麦或者PK场景下，此时任务已经被更新为混流。若当前主播异常退出重新入会后，客户业务服务器可以根据保存的最新的任务类型和任务参数，直接调用StartLiveMPUTask启动混流任务。'."\n" + .' - 如果启动前任务未被系统自动清理，则直接启动成功。'."\n" + .' - 如果任务还未被系统自动清理，则会返回**任务已存在**错误码。'."\n" + ."\n" + .'**结束**'."\n" + .'- 主播离会，需要主动调用[StopLiveMPUTask](~~2362742~~)停止旁路任务。'."\n" + .'- 若任务所指定的所有用户均已离会但未主动调用StopLiveMPUTask，系统会在2分钟后对旁路任务进行停止。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为500次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '### 布局和音量SEI'."\n" + ."\n" + .'| 参数 | 说明 |'."\n" + .'| ----- | --------- |'."\n" + .'| canvas | 画布信息，参数信息：<br>- w：画布宽，单位：像素。<br>- h：画布高，单位：像素。<br>- bgnd：画布的背景颜色，格式为RGB定义下的十六进制整数。 |'."\n" + .'| stream | 视频流信息，参数信息：<br>- uid：主播的用户ID。<br>- paneid：该区域在窗格编号，取值[0,8]。<br>- zorder：该区域的叠放层级，取值范围 [0,99]。<br>- x：该区域在画布中对应的x坐标，归一化百分比。<br>- y：该区域在画布中对应的y坐标，归一化百分比。<br>- w：该区域的宽度，归一化百分比。<br>- h：该区域的高度，归一化百分比。<br>- type：该区域视频流的类型，取值：0：摄像头；1：屏幕共享。<br>- status：该区域视频流的状态，取值：0：还未拉取到；1：已拉取到。<br>- muted：主播被静音状态，取值：0：未被静音；1：被静音。主播PK时，A主播将B主播静音，B主播muted字段将显示被静音状态。<br>- vol：主播的音量（分贝），取值：[0,255]。<br>- vad ：语音检测，取值：[0,150]，150是有人声，非150就是从有人声到无声的拖尾时间。 |'."\n" + .'| ts | 生成该信息时的操作系统时间戳，单位为毫秒。 |'."\n" + .'| ver | SEI格式版本信息，如当前版本为1.0.0.20220915。 |'."\n" + .'| udd | 客户自定义的场景化事件，通过PassThrough参数下发，内容由PayloadContent参数指定。 |'."\n" + ."\n" + .'> 用户拉取转推流时，转推流的流媒体数据会包含SEI信息，用户可借助此功能传递一些自定义信息。SEI信息在解码视频流时可以从视频帧数据中获取，具体格式参考参数说明表PassThrough参数。'."\n" + ."\n" + .'**以直播连麦场景为例：**'."\n" + ."\n" + .'如果只是单主播，观众端接收的SEI信息里stream集合只有一个成员信息；如果是主播正在连麦或者PK，观众端接收的SEI信息里stream集合会有多个成员信息。'."\n" + .'例如，当主播111单主播推流时，观众端收到的SEI帧格式如下：<br>`{"canvas":{"w":1920,"h":1080,"bgnd":0},"stream":[{"uid":"111","paneid":-1,"zorder":0,"x":0,"y":0,"w":0,"h":0,"type":0,"status":1,"muted":0,"vol":0,"vad":0}],"ver":"1.0.0.20220915","ts":1697696105170}`'."\n" + .'当主播111和观众222进行连麦时，观众端收到的SEI帧格式如下：<br>`{"canvas":{"w":1920,"h":1080,"bgnd":0},"stream":[{"uid":"111","paneid":0,"zorder":1,"x":0,"y":0.25,"w":0.5,"h":0.5,"type":0,"status":1,"muted":0,"vol":1,"vad":119},{"uid":"222","paneid":1,"zorder":1,"x":0.5018382,"y":0.25,"w":0.5,"h":0.5,"type":0,"status":1,"muted":0,"vol":60,"vad":123}],"ver":"1.0.0.20220915","ts":1697696106230}`'."\n" + .'判断stream数组的个数可以知道当前直播布局是否发生切换，stream数组的个数为1时，则是单主播推流；stream数组的个数大于1，则主播在连麦或PK中。通过成员的布局信息，知道每个成员在混流布局中的具体位置。'."\n" + ."\n" + .'### 透传SEI'."\n" + .'- 自定义SEI，通过StartLiveMPUTask命令启动混流转推任务，在PassThrough参数中，指定PayloadContent内容；也可以在UpdateLiveMPUTask命令更新混流转推任务时，在PassThrough参数中，指定PayloadContent内容。'."\n" + .'- 自定义SEI可以周期性发送，通过PassThrough参数中的Interval来设定周期，单位为ms；'."\n" + .'- 自定义SEI也可以跟随关键帧发送，通过PassThrough参数中的FollowIdr来设定。'."\n" + .' - 既可以按照Interval来周期性发送，也可以将SEI跟随关键帧来发送，如Interval:1000，FollowIdr: 1 表示每隔1000ms发送一次自定义SEI，并且在发送关键帧时携带自定义SEI。'."\n" + .' - 当不携带Interval以及不携带FollowIdr时，表示该自定义SEI只在调用时发送一次。'."\n" + ."\n" + .'例如，当主播111单主播推流时，调用UpdateLiveMPUTask命令下发周期性SEI，PassThrough参数中的Interval设置为1000，FollowIdr设置为0，PayloadContent设置为"hello world"，那么每隔1000ms将发送一次自定义SEI，观众端收到的SEI帧格式如下：<br>`{"canvas":{"w":1920,"h":1080,"bgnd":0},"stream":[{"uid":"111","paneid":-1,"zorder":0,"x":0,"y":0,"w":0,"h":0,"type":0,"status":1,"muted":0,"vol":0,"vad":0}],"ver":"1.0.0.20220915","ts":1697696109876,"udd":"hello world"}`'."\n" + .'### 跨频道多用户混流'."\n" + .'若您需要将跨多个频道中的多个主播进行混流布局并转推到直播服务时，您需要将发起跨频道通话的主播的UserID、ChannelID，以及对端的UserID作为入参创建混流任务。示例如下：'."\n" + .'在直播PK场景中，频道channelA的主播userA，通过客户端接口发起了和频道channelB主播userB的跨频道PK，并将两个主播的混流画面输出给频道channelA的麦下观众观看。则，此时创建混流任务时关于频道和用户参数的指定示范如下：'."\n" + .'- ChannelID： 指定为channelA'."\n" + .'- UserInfos->UserId ：分别指定userA和userB'."\n" + ."\n" + .'> 创建跨频道多用户的混流任务的前提是，已经通过客户端SDK接口发起了跨频道通话。如果不同频道的用户没有进行通话，则无法创建跨房间混流任务。如何发起跨房间通话，请参见[跨房间订阅功能](~~2642837~~)。', + ], + 'UpdateLiveMPUTask' => [ + 'summary' => '更新混流转推任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '178411', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '频道ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourChannelId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字符。此ID为旁路转推的标识，需保证唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourTaskId', + ], + ], + [ + 'name' => 'MixMode', + 'in' => 'query', + 'schema' => [ + 'description' => '混流模式。取值：'."\n" + .'- **0**：单路转推，不混流转码，仅转推原始单路流，无需配置混流转码参数。'."\n" + .'- **1（默认值）**：混流转码转推。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'StreamURL', + 'in' => 'query', + 'schema' => [ + 'description' => '直播推流地址，仅支持RTMP协议，仅支持传单个地址，最大长度不超过2048个字符。生成规则请参见[推流地址和播放地址](~~199339~~)。'."\n" + .'>- 对已开防盗链鉴权的域名，需要在推流地址中包含鉴权串。'."\n" + .'- 禁止同一个StreamURL在不同任务中同时使用。'."\n" + .'- 任务停止10S之内，禁止使用同一个StreamURL。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://example.com/live/stream', + ], + ], + [ + 'name' => 'MultiStreamURL', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '多地址转推参数，可填写多个直播推流地址。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'URL' => [ + 'description' => '直播推流地址，仅支持RTMP协议，最大长度不超过2048个字符。生成规则请参见[推流地址和播放地址](~~199339~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://example.com/live/stream****', + ], + 'IsAliCdn' => [ + 'description' => '是否转推到阿里云CDN。'."\n" + .'- false为转推非阿里云CDN。'."\n" + .'- true为转推阿里云CDN。'."\n" + .'> 该参数默认为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'SingleSubParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '单流转推参数，单流转推（MixMode=0）时必填。', + 'type' => 'object', + 'properties' => [ + 'SourceType' => [ + 'description' => '单流转推模式下视频输入流类型，仅针对视频流（StreamType=2）有效。取值：'."\n" + .'- **camera（默认值）**：摄像头。'."\n" + .'- **shareScreen**：屏幕共享。', + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + ], + 'StreamType' => [ + 'description' => '单流转推模式下转推流类型。取值：'."\n" + .'- **0（默认值）**：转推原始流。'."\n" + .'- **1**：仅转推音频流。'."\n" + .'- **2**：仅转推视频流。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'UserId' => [ + 'description' => '转推用户ID，一次只能转推一路流。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourSubUserId', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'TranscodeParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '混流转码转推参数，混流转码转推（MixMode=1）时必填。', + 'type' => 'object', + 'properties' => [ + 'Background' => [ + 'description' => '混流全局背景图。', + 'type' => 'object', + 'properties' => [ + 'RenderMode' => [ + 'description' => '子画面输出时的显示模式：'."\n" + .'- **0**：缩放并显示黑底。'."\n" + .'- **1（默认）**：裁剪。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'URL' => [ + 'description' => '全局背景图URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourImageUrl', + ], + ], + 'required' => false, + ], + 'EncodeParams' => [ + 'description' => '转推输出的编码参数。', + 'type' => 'object', + 'properties' => [ + 'AudioOnly' => [ + 'description' => '是否为纯音频，取值：'."\n" + .'- **true**：纯音频，仅需要设置音频相关参数。'."\n" + .'- **false（默认值）**：非纯音频，除VideoCodec参数与EnhancedParam参数外，其它参数均不能为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + 'AudioBitrate' => [ + 'description' => '音频码率，取值范围：\\[8, 500\\]，单位：kbps。', + 'type' => 'string', + 'required' => false, + 'example' => '128', + ], + 'AudioChannels' => [ + 'description' => '音频声道数，取值：1、2。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + 'AudioSampleRate' => [ + 'description' => '音频采样率，取值：8000、16000、32000、44100、48000，单位：Hz。', + 'type' => 'string', + 'required' => false, + 'example' => '44100', + ], + 'VideoCodec' => [ + 'description' => '视频编码格式。取值：'."\n" + .'- H.264（默认值）。'."\n" + .'- H.265。', + 'type' => 'string', + 'required' => false, + 'example' => 'H.264', + ], + 'VideoBitrate' => [ + 'description' => '视频码率，取值范围：\\[1, 10000\\]，单位：kbps。', + 'type' => 'string', + 'required' => false, + 'example' => '3500', + ], + 'VideoFramerate' => [ + 'description' => '视频帧率，取值范围：\\[1, 60\\]，单位：fps。', + 'type' => 'string', + 'required' => false, + 'example' => '25', + ], + 'VideoGop' => [ + 'description' => '视频GOP，取值范围：\\[1, 60\\]。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + 'VideoHeight' => [ + 'description' => '视频高，取值范围：\\[0, 1920\\]，单位：px。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + 'VideoWidth' => [ + 'description' => '视频宽，取值范围：\\[0, 1920\\]，单位：px。', + 'type' => 'string', + 'required' => false, + 'example' => '1920', + ], + 'EnhancedParam' => [ + 'description' => '编码增强参数，JSON字符串，目前支持的可选配置包括profile与preset。'."\n" + .'- profile：编码级别。当视频编码格式为H.264时，profile支持的可选值包括："baseline", "main", "high"；当视频编码格式为H.265时，profile支持的可选值包括："main"。'."\n" + ."\n" + .'- preset：调节编码速度和质量的平衡。preset支持的可选值包括："ultrafast", "superfast", "veryfast", "faster", "fast", "medium", "slow", "slower", "veryslow" "placebo"。每个值代表了一种编码速度与输出视频质量的策略，从"ultrafast"（极快，编码速度优先）到"placebo"（追求极致质量，编码极慢）。'."\n" + ."\n" + .'> 例如设置superfast，主要用于实时通讯领域。建议非编码器专业技术人员，不设置该选项。', + 'type' => 'string', + 'required' => false, + 'example' => '{"profile": "high", "preset": "veryfast"}', + ], + ], + 'required' => false, + ], + 'Layout' => [ + 'description' => '视频布局信息。'."\n" + .'> 视频转码时，需要指定视频布局信息，包括布局坐标(X，Y)，布局窗格(Width，Height)，叠放顺序(ZOrder)；纯音频转码时，禁止填写视频布局信息。', + 'type' => 'object', + 'properties' => [ + 'UserPanes' => [ + 'description' => '混流用户窗格信息。', + 'type' => 'array', + 'items' => [ + 'description' => '混流用户窗格信息。', + 'type' => 'object', + 'properties' => [ + 'UserInfo' => [ + 'description' => '该窗格对应的混流用户信息，不填时后台按照上行主播的进房顺序自动填充。'."\n" + ."\n" + .'> - 如果指定混流用户信息，该用户信息需要已在TranscodeParams.UserInfos参数中配置。'."\n" + .'- 仅针对原始流和视频流有效。', + 'type' => 'object', + 'properties' => [ + 'SourceType' => [ + 'description' => '混流转码模模式下视频输入流类型，仅针对视频流（StreamType=2）有效。取值：'."\n" + .'- **camera（默认值）**：摄像头。'."\n" + .'- **shareScreen**：屏幕共享。', + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + ], + 'ChannelId' => [ + 'description' => '混流用户所在的频道ID，同频道内混流的用户可不填，跨频道混流时建议填写该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourChannelId', + ], + 'UserId' => [ + 'description' => '混流用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourSubUserId', + ], + ], + 'required' => false, + ], + 'Height' => [ + 'description' => '窗格高，归一化百分比。', + 'type' => 'string', + 'required' => false, + 'example' => '0.2632', + ], + 'Width' => [ + 'description' => '窗格宽，归一化百分比。', + 'type' => 'string', + 'required' => false, + 'example' => '0.3564', + ], + 'X' => [ + 'description' => '坐标X，归一化百分比。', + 'type' => 'string', + 'required' => false, + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '坐标Y，归一化百分比。', + 'type' => 'string', + 'required' => false, + 'example' => '0.3789', + ], + 'ZOrder' => [ + 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'BackgroundImageUrl' => [ + 'description' => '子画面的背景图URL。当用户关闭摄像头或未进入房间时，会在布局位置填充为此图片。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourImageUrl', + ], + 'RenderMode' => [ + 'description' => '子画面输出时的显示模式，取值：'."\n" + .'- **0**：缩放并显示黑底。'."\n" + .'- **1（默认值）**：裁剪。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'UserInfos' => [ + 'description' => '混流时订阅的用户信息，不指定用户则所有用户混流。', + 'type' => 'array', + 'items' => [ + 'description' => '混流用户信息。', + 'type' => 'object', + 'properties' => [ + 'SourceType' => [ + 'description' => '混流时订阅的视频输入流类型，仅针对视频流（StreamType=2）有效。取值：'."\n" + .'- **camera（默认值）**：摄像头。'."\n" + .'- **shareScreen**：屏幕共享。', + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + ], + 'StreamType' => [ + 'description' => '混流时订阅的转推流类型。取值：'."\n" + .'- **0（默认值）**：转推原始流。'."\n" + .'- **1**：仅转推音频流。'."\n" + .'- **2**：仅转推视频流。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'ChannelId' => [ + 'description' => '混流时订阅用户所在的频道ID，同频道内混流的用户可不填，跨频道混流时建议填写该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourChannelId', + ], + 'UserId' => [ + 'description' => '混流时订阅的用户ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourSubUserId', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'SeiParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'SEI配置参数。', + 'type' => 'object', + 'properties' => [ + 'LayoutVolume' => [ + 'description' => '布局和音量SEI，该参数内容可以为空，表示携带默认的布局和音量SEI。', + 'type' => 'object', + 'properties' => [ + 'FollowIdr' => [ + 'description' => '发送IDR关键帧时是否确保携带SEI，取值：'."\n" + .'- **0**：不确保带SEI。'."\n" + .'- **1**：确保带SEI。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'Interval' => [ + 'description' => 'SEI发送间隔，取值范围：\\[1000, 5000\\]，单位：毫秒。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + 'required' => false, + ], + 'PassThrough' => [ + 'description' => '透传SEI。', + 'type' => 'object', + 'properties' => [ + 'FollowIdr' => [ + 'description' => '发送IDR关键帧时是否确保携带SEI，取值：'."\n" + .'- **0**：不确保带SEI。'."\n" + .'- **1**：确保带SEI。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'Interval' => [ + 'description' => 'SEI发送间隔，取值范围：\\[1000, 5000\\]，单位：毫秒。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + 'PayloadContent' => [ + 'description' => '透传SEI的payload内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourPayloadContent', + ], + 'PayloadContentKey' => [ + 'description' => '透传SEI的payload内容对应的key值。不设置时，key为默认值udd。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourPayloadContentKey', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0F72851F-5DC1-1979-9B2C-450040316C3E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidAppId', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the Live service', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'InternalError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0F72851F-5DC1-1979-9B2C-450040316C3E\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveMPUTaskResponse>\\n <RequestId>0F72851F-5DC1-1979-9B2C-450040316C3E</RequestId>\\n</UpdateLiveMPUTaskResponse>","errorExample":""}]', + 'title' => '更新混流转推任务（新）', + 'description' => '调用本接口前，您必须已经调用[StartLiveMPUTask](~~2848199~~)创建混流转推任务。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为500次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'StopLiveMPUTask' => [ + 'summary' => '停止混流转推任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '178700', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID，仅支持传单个ID。由大小写字母、数字、下划线、短划线（-）组成，最大55字符。此ID为旁路转推的标识，需保证唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourTaskId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0F72851F-5DC1-1979-9B2C-450040316C3E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidAppId', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the Live service', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'InternalError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0F72851F-5DC1-1979-9B2C-450040316C3E\\"\\n}","errorExample":""},{"type":"xml","example":"<StopLiveMPUTaskResponse>\\n <RequestId>0F72851F-5DC1-1979-9B2C-450040316C3E</RequestId>\\n</StopLiveMPUTaskResponse>","errorExample":""}]', + 'title' => '停止混流转推任务（新）', + 'description' => '- 调用本接口前，您必须已经调用[StartLiveMPUTask](~~2848199~~)开始混流转推任务。'."\n" + .'- 如果需要停止混流转推任务时，此时混流转推任务异常（未调用StopLiveMPUTask停止任务），本次混流转推任务会在最后一个人离开频道2分钟后自动停止任务。停止后如果需要恢复混流转推，您需要重新调用[StartLiveMPUTask](~~2848199~~)接口。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为500次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListRtcMPUTaskDetail' => [ + 'summary' => '查询混流转推任务参数明细。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226001', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + .'> 应用ID由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。'."\n" + ."\n\n" + .'>- 任务ID由大小写字母、数字、下划线、短划线（-）组成，最大55字符。'."\n" + .'- 指定任务ID时，优先按任务ID查询，返回结果为指定任务ID的旁路转推任务的参数明细。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourTaskId', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '单页显示记录的数量，取值范围：1~100。'."\n" + .'> 未指定任务ID时，需要指定PageSize与PageNo参数，此时会返回指定应用ID下所有旁路转推任务参数明细的分页查询结果。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'MPUTasks' => [ + 'description' => '任务参数明细，参数明细格式与调用创建混流任务时的参数格式一致。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '应用ID。'."\n", + 'type' => 'string', + 'example' => 'yourAppId', + ], + 'ChannelId' => [ + 'description' => '频道ID。', + 'type' => 'string', + 'example' => 'yourChannelId', + ], + 'TaskId' => [ + 'description' => '任务ID，此ID为旁路转推任务的标识。', + 'type' => 'string', + 'example' => 'yourTaskId', + ], + 'MixMode' => [ + 'description' => '混流模式。取值：'."\n" + .'- 0：单路转推，不混流转码，仅转推原始单路流，无需配置混流转码参数。'."\n" + .'- 1（默认值）：混流转码转推。', + 'type' => 'string', + 'example' => '0', + ], + 'StreamURL' => [ + 'description' => '直播推流地址。'."\n", + 'type' => 'string', + 'example' => 'rtmp://example.com/live/stream****', + ], + 'MultiStreamURL' => [ + 'description' => '多地址转推参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'URL' => [ + 'description' => '直播推流地址。', + 'type' => 'string', + 'example' => 'rtmp://example.com/live/stream****', + ], + 'IsAliCdn' => [ + 'description' => '是否转推到阿里云CDN。'."\n" + .'- false为转推非阿里云CDN。'."\n" + .'- true为转推阿里云CDN。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'Region' => [ + 'description' => '请求的混流服务所在区域。取值：'."\n" + .'- **CN-Shanghai<props="china"><ph>（默认值）</ph></props>**：上海。'."\n" + .'- **AP-Singapore<props="intl"><ph>（默认值）</ph></props>**：新加坡。'."\n" + .'- **EMAA-Saudi**：沙特。', + 'type' => 'string', + 'example' => 'CN-Shanghai', + ], + 'MaxIdleTime' => [ + 'description' => '空闲超时时间，单位：秒'."\n" + .'> 若设置了此参数，则会在任务处于空闲状态的时长大于 MaxIdleTime 时，自动停止该任务；若未设置此参数，则会在房间关闭后，立刻停止该任务。', + 'type' => 'string', + 'example' => '10', + ], + 'SingleSubParams' => [ + 'description' => '单流转推参数。', + 'type' => 'object', + 'properties' => [ + 'SourceType' => [ + 'description' => '单流转推模式下视频输入流类型，当视频流（StreamType=2）时有效。取值：'."\n" + .'- camera（默认值）：摄像头。'."\n" + .'- shareScreen：屏幕共享。', + 'type' => 'string', + 'example' => 'camera', + ], + 'StreamType' => [ + 'description' => '单流转推模式下转推流类型。取值：'."\n" + .'- 0（默认值）：转推原始流。'."\n" + .'- 1：仅转推音频流。'."\n" + .'- 2：仅转推视频流。', + 'type' => 'string', + 'example' => '0', + ], + 'UserId' => [ + 'description' => '转推用户ID，一次只能转推一路流。', + 'type' => 'string', + 'example' => 'yourSubUserId', + ], + ], + ], + 'TranscodeParams' => [ + 'description' => '混流转码转推参数。', + 'type' => 'object', + 'properties' => [ + 'Background' => [ + 'description' => '混流全局背景图。', + 'type' => 'object', + 'properties' => [ + 'RenderMode' => [ + 'description' => '子画面输出时的显示模式：'."\n" + .'- 0：缩放并显示黑底。'."\n" + .'- 1（默认）：裁剪。', + 'type' => 'string', + 'example' => '1', + ], + 'URL' => [ + 'description' => '全局背景图URL。', + 'type' => 'string', + 'example' => 'yourImageUrl', + ], + ], + ], + 'EncodeParams' => [ + 'description' => '转推输出的编码参数。', + 'type' => 'object', + 'properties' => [ + 'AudioOnly' => [ + 'description' => '是否为纯音频，取值：'."\n" + .'- true：纯音频。'."\n" + .'- false（默认值）：非纯音频。', + 'type' => 'string', + 'example' => 'false', + ], + 'AudioBitrate' => [ + 'description' => '音频码率，单位：kbps。', + 'type' => 'string', + 'example' => '128', + ], + 'AudioChannels' => [ + 'description' => '音频声道数，取值：1、2。', + 'type' => 'string', + 'example' => '2', + ], + 'AudioSampleRate' => [ + 'description' => '音频采样率，单位：Hz。', + 'type' => 'string', + 'example' => '44100', + ], + 'VideoCodec' => [ + 'description' => '视频编码格式。默认值H.264。', + 'type' => 'string', + 'example' => 'H.264', + ], + 'VideoBitrate' => [ + 'description' => '视频码率，单位：kbps。', + 'type' => 'string', + 'example' => '3500', + ], + 'VideoFramerate' => [ + 'description' => '视频帧率，单位：fps。', + 'type' => 'string', + 'example' => '25', + ], + 'VideoGop' => [ + 'description' => '视频GOP。', + 'type' => 'string', + 'example' => '20', + ], + 'VideoHeight' => [ + 'description' => '视频高，单位：px。', + 'type' => 'string', + 'example' => '1000', + ], + 'VideoWidth' => [ + 'description' => '视频宽，单位：px。', + 'type' => 'string', + 'example' => '1920', + ], + 'EnhancedParam' => [ + 'description' => '编码增强参数，JSON字符串，目前支持的可选配置包括profile与preset。'."\n" + .'- profile：编码级别。当视频编码格式为H.264时，profile支持的可选值包括："baseline", "main", "high"。'."\n" + .'- preset：调节编码速度和质量的平衡。preset支持的可选值包括："ultrafast", "superfast", "veryfast", "faster", "fast", "medium", "slow", "slower", "veryslow" "placebo"。每个值代表了一种编码速度与输出视频质量的策略，从"ultrafast"（极快，编码速度优先）到"placebo"（追求极致质量，编码极慢）。', + 'type' => 'string', + 'example' => '{"profile": "high", "preset": "veryfast"}', + ], + ], + ], + 'Layout' => [ + 'description' => '视频布局信息。'."\n" + .'> 视频转码时所指定的视频布局信息，包括布局坐标(X，Y)，布局窗格(Width，Height)，叠放顺序(ZOrder)；纯音频转码时，不包含视频布局信息。', + 'type' => 'object', + 'properties' => [ + 'UserPanes' => [ + 'description' => '混流用户窗格信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserInfo' => [ + 'description' => '混流用户信息。'."\n", + 'type' => 'object', + 'properties' => [ + 'SourceType' => [ + 'description' => '混流转码模模式下视频输入流类型，仅针对视频流（StreamType=2）有效。取值：'."\n" + .'- camera（默认值）：摄像头。'."\n" + .'- shareScreen：屏幕共享。', + 'type' => 'string', + 'example' => 'camera', + ], + 'ChannelId' => [ + 'description' => '混流用户所在的频道ID。', + 'type' => 'string', + 'example' => 'yourChannelId', + ], + 'UserId' => [ + 'description' => '混流用户ID。', + 'type' => 'string', + 'example' => 'yourSubUserId', + ], + ], + ], + 'Height' => [ + 'description' => '窗格高，归一化百分比。', + 'type' => 'string', + 'example' => '0.2632', + ], + 'Width' => [ + 'description' => '窗格宽，归一化百分比。', + 'type' => 'string', + 'example' => '0.3564', + ], + 'X' => [ + 'description' => '坐标X，归一化百分比。', + 'type' => 'string', + 'example' => '0.2456', + ], + 'Y' => [ + 'description' => '坐标Y，归一化百分比。', + 'type' => 'string', + 'example' => '0.3789', + ], + 'ZOrder' => [ + 'description' => '叠放顺序，0为最底层，1层在0层之上，以此类推。', + 'type' => 'string', + 'example' => '0', + ], + 'BackgroundImageUrl' => [ + 'description' => '子画面的背景图URL。当用户关闭摄像头或未进入房间时，会在布局位置填充为此图片。', + 'type' => 'string', + 'example' => 'yourImageUrl', + ], + 'RenderMode' => [ + 'description' => '子画面输出时的显示模式，取值：'."\n" + .'- 0：缩放并显示黑底。'."\n" + .'- 1（默认值）：裁剪。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'UserInfos' => [ + 'description' => '混流用户信息，不指定用户则所有用户混流。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ChannelId' => [ + 'description' => '混流用户所在的频道ID。', + 'type' => 'string', + 'example' => 'yourChannelId', + ], + 'UserId' => [ + 'description' => '混流用户ID。', + 'type' => 'string', + 'example' => 'yourSubUserId', + ], + 'SourceType' => [ + 'description' => '混流转码模模式下视频输入流类型，仅针对视频流（StreamType=2）有效。取值：'."\n" + .'- camera（默认值）：摄像头'."\n" + .'- shareScreen：屏幕共享。', + 'type' => 'string', + 'example' => 'camera', + ], + 'StreamType' => [ + 'description' => '混流转码模式下转推流类型。取值：'."\n" + .'- 0（默认值）：转推原始流。'."\n" + .'- 1：仅转推音频流。'."\n" + .'- 2：仅转推视频流。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + 'SeiParams' => [ + 'description' => 'SEI配置参数。', + 'type' => 'object', + 'properties' => [ + 'LayoutVolume' => [ + 'description' => '布局和音量SEI，该参数内容为空则表示携带默认的布局和音量SEI。', + 'type' => 'object', + 'properties' => [ + 'FollowIdr' => [ + 'description' => '发送IDR关键帧时是否确保携带SEI，取值：'."\n" + .'- 0：不确保带SEI。'."\n" + .'- 1：确保带SEI。', + 'type' => 'string', + 'example' => '0', + ], + 'Interval' => [ + 'description' => 'SEI发送间隔，单位：毫秒。', + 'type' => 'string', + 'example' => '1000', + ], + ], + ], + 'PassThrough' => [ + 'description' => '透传SEI。', + 'type' => 'object', + 'properties' => [ + 'FollowIdr' => [ + 'description' => '发送IDR关键帧时是否确保携带SEI，取值：'."\n" + .'- 0：不确保带SEI。'."\n" + .'- 1：确保带SEI。', + 'type' => 'string', + 'example' => '0', + ], + 'Interval' => [ + 'description' => 'SEI发送间隔，单位：毫秒。', + 'type' => 'string', + 'example' => '1000', + ], + 'PayloadContent' => [ + 'description' => '透传SEI的payload内容。', + 'type' => 'string', + 'example' => 'yourPayloadContent', + ], + 'PayloadContentKey' => [ + 'description' => '透传SEI的payload内容对应的key值。不设置时，key为默认值udd。', + 'type' => 'string', + 'example' => 'yourPayloadContentKey', + ], + ], + ], + 'PayloadType' => [ + 'description' => 'SEI消息的自定义payload_type，取值范围100-254。不设置时，SEI的payload_type为默认值为5。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidAppId', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the Live service', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"MPUTasks\\": [\\n {\\n \\"AppId\\": \\"yourAppId\\",\\n \\"ChannelId\\": \\"yourChannelId\\",\\n \\"TaskId\\": \\"yourTaskId\\",\\n \\"MixMode\\": \\"0\\",\\n \\"StreamURL\\": \\"rtmp://example.com/live/stream****\\",\\n \\"MultiStreamURL\\": [\\n {\\n \\"URL\\": \\"rtmp://example.com/live/stream****\\",\\n \\"IsAliCdn\\": false\\n }\\n ],\\n \\"Region\\": \\"CN-Shanghai\\",\\n \\"MaxIdleTime\\": \\"10\\",\\n \\"SingleSubParams\\": {\\n \\"SourceType\\": \\"camera\\",\\n \\"StreamType\\": \\"0\\",\\n \\"UserId\\": \\"yourSubUserId\\"\\n },\\n \\"TranscodeParams\\": {\\n \\"Background\\": {\\n \\"RenderMode\\": \\"1\\",\\n \\"URL\\": \\"yourImageUrl\\"\\n },\\n \\"EncodeParams\\": {\\n \\"AudioOnly\\": \\"false\\",\\n \\"AudioBitrate\\": \\"128\\",\\n \\"AudioChannels\\": \\"2\\",\\n \\"AudioSampleRate\\": \\"44100\\",\\n \\"VideoCodec\\": \\"H.264\\",\\n \\"VideoBitrate\\": \\"3500\\",\\n \\"VideoFramerate\\": \\"25\\",\\n \\"VideoGop\\": \\"20\\",\\n \\"VideoHeight\\": \\"1000\\",\\n \\"VideoWidth\\": \\"1920\\",\\n \\"EnhancedParam\\": \\"{\\\\\\"profile\\\\\\": \\\\\\"high\\\\\\", \\\\\\"preset\\\\\\": \\\\\\"veryfast\\\\\\"}\\"\\n },\\n \\"Layout\\": {\\n \\"UserPanes\\": [\\n {\\n \\"UserInfo\\": {\\n \\"SourceType\\": \\"camera\\",\\n \\"ChannelId\\": \\"yourChannelId\\",\\n \\"UserId\\": \\"yourSubUserId\\"\\n },\\n \\"Height\\": \\"0.2632\\",\\n \\"Width\\": \\"0.3564\\",\\n \\"X\\": \\"0.2456\\",\\n \\"Y\\": \\"0.3789\\",\\n \\"ZOrder\\": \\"0\\",\\n \\"BackgroundImageUrl\\": \\"yourImageUrl\\",\\n \\"RenderMode\\": \\"1\\"\\n }\\n ]\\n },\\n \\"UserInfos\\": [\\n {\\n \\"ChannelId\\": \\"yourChannelId\\",\\n \\"UserId\\": \\"yourSubUserId\\",\\n \\"SourceType\\": \\"camera\\",\\n \\"StreamType\\": \\"0\\"\\n }\\n ]\\n },\\n \\"SeiParams\\": {\\n \\"LayoutVolume\\": {\\n \\"FollowIdr\\": \\"0\\",\\n \\"Interval\\": \\"1000\\"\\n },\\n \\"PassThrough\\": {\\n \\"FollowIdr\\": \\"0\\",\\n \\"Interval\\": \\"1000\\",\\n \\"PayloadContent\\": \\"yourPayloadContent\\",\\n \\"PayloadContentKey\\": \\"yourPayloadContentKey\\"\\n },\\n \\"PayloadType\\": \\"100\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRtcMPUTaskDetailResponse>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n <MPUTasks>\\n <AppId>yourAppId</AppId>\\n <ChannelId>yourChannelId</ChannelId>\\n <TaskId>yourTaskId</TaskId>\\n <MixMode>0</MixMode>\\n <StreamURL>rtmp://example.com/live/stream****</StreamURL>\\n <MultiStreamURL>\\n <URL>rtmp://example.com/live/stream****</URL>\\n </MultiStreamURL>\\n <Region>CN-Shanghai</Region>\\n <SingleSubParams>\\n <SourceType>camera</SourceType>\\n <StreamType>0</StreamType>\\n <UserId>yourSubUserId</UserId>\\n </SingleSubParams>\\n <TranscodeParams>\\n <Background>\\n <RenderMode>1</RenderMode>\\n <URL>yourImageUrl</URL>\\n </Background>\\n <EncodeParams>\\n <AudioOnly>false</AudioOnly>\\n <AudioBitrate>128</AudioBitrate>\\n <AudioChannels>2</AudioChannels>\\n <AudioSampleRate>44100</AudioSampleRate>\\n <VideoCodec>H.264</VideoCodec>\\n <VideoBitrate>3500</VideoBitrate>\\n <VideoFramerate>25</VideoFramerate>\\n <VideoGop>20</VideoGop>\\n <VideoHeight>1000</VideoHeight>\\n <VideoWidth>1920</VideoWidth>\\n <EnhancedParam>{\\"profile\\": \\"high\\", \\"preset\\": \\"veryfast\\"}</EnhancedParam>\\n </EncodeParams>\\n <Layout>\\n <UserPanes>\\n <UserInfo>\\n <SourceType>camera</SourceType>\\n <ChannelId>yourChannelId</ChannelId>\\n <UserId>yourSubUserId</UserId>\\n </UserInfo>\\n <Height>0.2632</Height>\\n <Width>0.3564</Width>\\n <X>0.2456</X>\\n <Y>0.3789</Y>\\n <ZOrder>0</ZOrder>\\n <BackgroundImageUrl>yourImageUrl</BackgroundImageUrl>\\n <RenderMode>1</RenderMode>\\n </UserPanes>\\n </Layout>\\n <UserInfos>\\n <ChannelId>yourChannelId</ChannelId>\\n <UserId>yourSubUserId</UserId>\\n <SourceType>camera</SourceType>\\n <StreamType>0</StreamType>\\n </UserInfos>\\n </TranscodeParams>\\n <SeiParams>\\n <LayoutVolume>\\n <FollowIdr>0</FollowIdr>\\n <Interval>1000</Interval>\\n </LayoutVolume>\\n <PassThrough>\\n <FollowIdr>0</FollowIdr>\\n <Interval>1000</Interval>\\n <PayloadContent>yourPayloadContent</PayloadContent>\\n <PayloadContentKey>yourPayloadContentKey</PayloadContentKey>\\n </PassThrough>\\n <PayloadType>100</PayloadType>\\n </SeiParams>\\n </MPUTasks>\\n</ListRtcMPUTaskDetailResponse>","errorExample":""}]', + 'title' => '查询混流转推任务参数明细', + 'description' => '- 本接口用于查询混流转推任务的参数明细，仅可查询通过API创建的混流转推任务。'."\n" + ."\n" + .'- 分页查询时，查询结果默认按照任务的更新时间倒序排列。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'SetLiveMpuTaskSei' => [ + 'summary' => '设置连麦旁路自定义sei。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '167350', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅的应用ID。'."\n" + .'> 应用ID由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。'."\n" + .'> 任务ID由大小写字母、数字、下划线、短划线（-）组成，最大55字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourTaskId', + ], + ], + [ + 'name' => 'CustomSei', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义SEI。'."\n" + .'> 自定义SEI为json字符串，不超过4096个字符。', + 'type' => 'string', + 'required' => true, + 'example' => '{"key": "value"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidAppId', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the Live service', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'InternalError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","errorExample":""},{"type":"xml","example":"<SetLiveMpuTaskSeiResponse>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n</SetLiveMpuTaskSeiResponse>","errorExample":""}]', + 'title' => '设置自定义SEI', + 'description' => '## 使用说明'."\n" + .'本接口用于设置混流转推任务的自定义SEI信息。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CreateEventSub' => [ + 'summary' => '创建订阅房间消息的回调。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅的应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => '9qb1****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '要监听的频道，不填表示全部，每个appid 只允许1个全频道订阅', + 'description' => '订阅的频道ID。您可通过调用[ListEventSub](~~2848210~~)接口查询订阅的频道ID。'."\n" + ."\n" + .'>- 如果Users.N参数不为空，则此参数必填。'."\n" + .'>- ChannelId为*或者不填，表示为全频道订阅，每个AppId只允许1个全频道订阅。'."\n" + .'>- 每个AppId最多同时允许创建20个订阅。', + 'type' => 'string', + 'required' => false, + 'example' => '123333', + ], + ], + [ + 'name' => 'Users', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '只监听哪些用户，不填表示全部；与ChannelId过滤同时使用才生效', + 'description' => '订阅哪些用户的消息，参数为空表示订阅该房间全部用户（包含主播和观众）。格式如下所示：'."\n" + ."\n" + .'```'."\n" + .'Users.1=****'."\n" + .'Users.2=****'."\n" + .'......'."\n" + .'```', + 'type' => 'array', + 'items' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + 'required' => false, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'Events', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => 'ChannelEvent, UserEvent', + 'description' => '订阅事件。', + 'type' => 'array', + 'items' => [ + 'description' => '订阅的事件，取值：'."\n" + ."\n" + .'- **ChannelEvent**：频道事件。'."\n" + ."\n" + .'- **UserEvent**：频道内用户事件。', + 'type' => 'string', + 'required' => true, + 'example' => 'ChannelEvent', + ], + 'required' => true, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'title' => '回调地址', + 'description' => '回调地址。回调内容请参见以下回调内容示例。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://****.com/callback', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b****', + ], + 'SubscribeId' => [ + 'description' => '创建的订阅ID。', + 'type' => 'string', + 'example' => 'ad53276431c****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'QuotaLimitError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'ErrorInvalidCallBackUrl', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b****\\",\\n \\"SubscribeId\\": \\"ad53276431c****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateEventSubResponse>\\n <RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\n <SubscribeId>ad53276431c****</SubscribeId>\\n</CreateEventSubResponse>","errorExample":""}]', + 'title' => '创建订阅房间消息回调', + 'description' => '本接口用于创建订阅房间消息的回调。例如：在创建回调时，您可以配置回调地址、事件类型等参数。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '## CallBack'."\n" + .'通过用户传入的CallbackUrl，回调用户的内容，示例如下所示：'."\n" + ."\n" + .'```'."\n" + .'Request:'."\n" + ."\n" + .'POST /callbackURL'."\n" + ."\n" + .'Body'."\n" + .'application/json'."\n" + ."\n" + .'{'."\n" + .' "MsgId": "消息ID",'."\n" + .' "MsgTimestamp": 12312324, // 消息发送时的Unix时间戳'."\n" + .' "SubscribeID": "订阅ID",'."\n" + .' "AppId":"", // 产生该消息的appid '."\n" + .' "ChannelID":"", // 产生该消息的频道'."\n" + .' "Contents": ['."\n" + .' {'."\n" + .' "Event": "UserEvent",//订阅的事件：频道内用户事件'."\n" + .' "UserEvent": {'."\n" + .' "UserId": "80331631628*****", // 用户ID'."\n" + .' "EventTag": "Publish", // 事件，包括Join, Leave, Publish, Unpublish, Roleupdate'."\n" + .' "SessionId": "0dr15rrnhkz0jnvz6o8sxo0*****", // 产生该事件的SessionID'."\n" + .' "Timestamp": 1609854786, // 事件发生Unix 时间戳'."\n" + .' "Reason": 1, // 入会、离会原因，仅Join事件有'."\n" + .' "Role": 1, // 角色类型, 主播，观众'."\n" + .' "CurrentMedias":"1,2,3"// 推流类型：用户推了哪些流'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "Event": "ChannelEvent",//订阅的事件：频道事件'."\n" + .' "ChannelEvent": {'."\n" + .' "ChannelId": "88888****",'."\n" + .' "EventTag": "Open", // 频道事件，包括开启与关闭Open, Close'."\n" + .' "Timestamp": 1609854530 // 事件发生Unix 时间戳'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + ."\n" + .'Response '."\n" + .'HTTP STATUS 200'."\n" + .'```'."\n" + .'## UserEvent用户事件'."\n" + ."\n" + .'| 参数 | 类型 | 是否必填|描述|'."\n" + .'| ------ | ------ | ------ | ----- |'."\n" + .'| UserId |string | 是 |用户ID。 |'."\n" + .'| SessionId | string | 是 |用户SessionID。 |'."\n" + .'| EventTag | string | 是 |事件类型，取值：<br>Join：入会。<br>Leave：离会。<br>PublishVideo：开始推视频流。<br> PublishAudio：开始推音频流。<br>PublishScreen：开始屏幕共享。<br>UnpublishVideo：停止推视频流。<br>UnpublishAudio：停止推音频流。<br>UnpublishScreen：停止屏幕共享。<br>Roleupdate：角色切换。 |'."\n" + .'| Timestamp |number | 是 |事件发生的时间戳。 |'."\n" + .'| Reason | integer | 是 |入会、离会原因（仅Join事件有），取值：<br>1：正常入会、离会。<br> 2：重连入会（当前会中已有该用户实例，该用户再次入会）。<br>3：跨频道转推。<br>4：超时离会。<br>5：用户启用新的会话，当前会话被挤下线。<br>6：被踢出。<br>7：频道解散。|'."\n" + .'| Role | integer | 是 |角色类型，取值：<br>1：主播。<br>2：观众。 |'."\n" + .'| CurrentMedias| integer | 是 |推流类型，取值：<br>1：音频。<br>2：视频。<br>3：屏幕共享。 |'."\n" + ."\n" + .'## ChannelEvent频道事件'."\n" + .'| 参数 | 类型 | 是否必填|描述|'."\n" + .'| ------ | ------ | ------ | ------- |'."\n" + .'| EventTag |string | 是 |事件类型，取值：<br>Open：会议开始。<br>Close：会议结束。 |'."\n" + .'| Timestamp| number | 是 |事件发生的时间戳。 |'."\n" + ."\n" + .'## 回调鉴权说明'."\n" + .'事件回调鉴权功能默认开启，鉴权逻辑如下所示：'."\n" + ."\n" + .'- 阿里云视频直播服务发起回调请求时在HTTP(S)请求头中包含Ali-Rtc-Timestamp和Ali-Rtc-Signature字段，供回调消息接收服务端进行签名认证。Ali-Rtc-Timestamp值计算方式为：Ali-Rtc-Signature=MD5SUM(MD5CONTENT)。其中，MD5CONTENT=回调域名|Ali-Rtc-Timestamp取值|鉴权Key；回调域名指配置回调URL的域名，鉴权Key指用户创建AppId时生成的AppKey。'."\n" + .'- 回调消息接收服务端接收回调消息时，将回调域名、Ali-Rtc-Timestamp取值、鉴权Key进行拼接后计算MD5值，得到加密字符串，再将计算出的加密字符串与音视频通信服务发起的HTTP(S)请求头中的Ali-Rtc-Signature字段值进行对比，如果不一致，则请求非法。'."\n" + .'## 回调异常重试'."\n" + .'阿里云发起回调请求时，仅当您的业务服务器响应HTTP状态码为200时认定为回调成功。若回调失败，阿里云会重试7次，分别间隔1秒、2秒、5秒、10秒、1分钟、2分钟、5分钟。每次重试请求均会产生对应的回调记录。'."\n" + .'## 异常处理'."\n" + .'已经入会或者推流的客户端和阿里云的服务端有心跳保活机制，当客户端因为断网、App关闭异常等原因导致心跳保活失败（90秒未收到客户端心跳信息则认定为失败），服务端会判定客户端异常超时离开，并产生用户停止推流和离会的事件回调。', + ], + 'ListEventSub' => [ + 'summary' => '查询订阅房间消息列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '198164', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => '9qb1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08', + ], + 'Subscribers' => [ + 'description' => '订阅事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '订阅事件详情。', + 'type' => 'object', + 'properties' => [ + 'SubId' => [ + 'title' => '订阅ID', + 'description' => '订阅事件ID。', + 'type' => 'string', + 'example' => '09be0d2254cb5a89f4cbd86403ec****', + ], + 'ChannelId' => [ + 'description' => '订阅的频道ID。', + 'type' => 'string', + 'example' => 'testmodify', + ], + 'Events' => [ + 'title' => 'ChannelEvent表示频道事件，包括频道开启与关闭；'."\n" + .'UserEvent表示用户事件，包括用户入离会等', + 'description' => '订阅的事件，取值：'."\n" + ."\n" + .'- ChannelEvent：频道事件，包括频道开启与关闭。'."\n" + .'- UserEvent：用户事件，包括用户入离会等。', + 'type' => 'array', + 'items' => [ + 'description' => '订阅的事件，取值：'."\n" + ."\n" + .'- ChannelEvent：频道事件，包括频道开启与关闭。'."\n" + .'- UserEvent：用户事件，包括用户入离会等。', + 'type' => 'string', + 'example' => 'ChannelEvent', + ], + ], + 'CallbackUrl' => [ + 'description' => '回调地址。', + 'type' => 'string', + 'example' => 'http://****.com/callback', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建订阅时间。东八区时间，是UTC+8时区的时间。格式：yyyy-MM-dd hh:mm:ss。', + 'type' => 'string', + 'example' => '2023-08-18 10:14:49', + ], + 'ModifyTime' => [ + 'title' => '修改时间', + 'description' => '修改订阅时间。东八区时间，是UTC+8时区的时间。格式：yyyy-MM-dd hh:mm:ss。', + 'type' => 'string', + 'example' => '2023-08-18 10:14:49', + ], + 'Users' => [ + 'title' => '只回调指定userid的事件；不建议与role同用；'."\n" + .'指定此参数必须同时指定ChannelId', + 'description' => '只回调此用户的事件，不建议与Roles同用。', + 'type' => 'array', + 'items' => [ + 'description' => '只回调此用户的事件，不建议与Roles同用。', + 'type' => 'string', + 'example' => 'testUser', + ], + ], + 'Roles' => [ + 'title' => '1只回调主播事件，2只回调观众事件；'."\n" + .'无值、0、其他值表示回调所有用户事件', + 'description' => '回调哪个角色的事件，取值：'."\n" + ."\n" + .'- 1：只回调主播事件。'."\n" + .'- 2：只回调观众事件。'."\n" + ."\n" + .'无值或其他值表示回调所有用户事件。'."\n" + .'> 创建订阅不再支持此参数，此参数已废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => true, + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08\\",\\n \\"Subscribers\\": [\\n {\\n \\"SubId\\": \\"09be0d2254cb5a89f4cbd86403ec****\\",\\n \\"ChannelId\\": \\"testmodify\\",\\n \\"Events\\": [\\n \\"ChannelEvent\\"\\n ],\\n \\"CallbackUrl\\": \\"http://****.com/callback\\",\\n \\"CreateTime\\": \\"2023-08-18 10:14:49\\",\\n \\"ModifyTime\\": \\"2023-08-18 10:14:49\\",\\n \\"Users\\": [\\n \\"testUser\\"\\n ],\\n \\"Roles\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListEventSubResponse>\\n <RequestId>AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08</RequestId>\\n <Subscribers>\\n <SubId>09be0d2254cb5a89f4cbd86403ec****</SubId>\\n <ChannelId>testmodify</ChannelId>\\n <Events>ChannelEvent</Events>\\n <CallbackUrl>http://****.com/callback</CallbackUrl>\\n <CreateTime>2023-08-18 10:14:49</CreateTime>\\n <ModifyTime>2023-08-18 10:14:49</ModifyTime>\\n <Users>testUser</Users>\\n <Roles>1</Roles>\\n </Subscribers>\\n</ListEventSubResponse>","errorExample":""}]', + 'title' => '查询订阅房间消息列表', + 'description' => '本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListEventSubEvent' => [ + 'summary' => '查询回调记录。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅的应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => '9qb1****', + ], + ], + [ + 'name' => 'SubscribeId', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅ID。您可通过[CreateEventSub](~~2848209~~)接口的返回参数查询订阅ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ad53276431c****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间，用UNIX时间戳表示，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '2234313863', + 'minimum' => '0', + 'example' => '1698195600', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，用UNIX时间戳表示，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '2234313863', + 'minimum' => '0', + 'example' => '1698201013', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '单页显示记录的数量，取值范围：1~100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。取值范围：大于等于1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '9999999999', + 'minimum' => '1', + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CC8CB656-A7BA-1811-9D6B-4CC187E988BD', + ], + 'Count' => [ + 'description' => '当前页返回的回调记录总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'HasMore' => [ + 'description' => '是否有下一页。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Logs' => [ + 'description' => '回调记录。', + 'type' => 'array', + 'items' => [ + 'description' => '回调记录。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '订阅的应用ID。', + 'type' => 'string', + 'example' => '9qb1****', + ], + 'SubId' => [ + 'description' => '订阅事件ID。', + 'type' => 'string', + 'example' => 'ad53276431c****', + ], + 'MessageId' => [ + 'description' => '回调记录ID。', + 'type' => 'string', + 'example' => '875d5266cbabb1834cc84a105cf6****', + ], + 'Data' => [ + 'description' => '回调内容详情。', + 'type' => 'string', + 'example' => '{\\"MsgId\\":\\"875d5266cbabb1834cc84a105cf68454\\",\\"MsgTimestamp\\":1697545591,\\"SubscribeId\\":\\"09be0d2254cb5a89f4cbd86403ec5343\\",\\"AppId\\":\\"xxx\\",\\"ChannelId\\":\\"9099\\",\\"Contents\\":[{\\"Event\\":\\"UserEvent\\",\\"UserEvent\\":{\\"UserId\\":\\"linux_test\\",\\"EventTag\\":\\"Leave\\",\\"SessionId\\":\\"je7y2sBZJZQ0VBJZrh4LnBkxvGH2WyVs\\",\\"Timestamp\\":1697545591,\\"ChannelProfile\\":\\"interactive_live\\",\\"US\\":5068748604047364,\\"Reason\\":1,\\"Role\\":1,\\"TerminalType\\":6,\\"UserType\\":2}}]}', + ], + 'Cost' => [ + 'description' => '回调时长，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + 'Time' => [ + 'description' => '产生回调记录的时间。', + 'type' => 'string', + 'example' => '2023-10-17 20:26:31.988', + ], + 'Url' => [ + 'description' => '回调地址。', + 'type' => 'string', + 'example' => 'http://****.com/callback', + ], + 'Code' => [ + 'description' => '错误码，200为回调成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CC8CB656-A7BA-1811-9D6B-4CC187E988BD\\",\\n \\"Count\\": 1,\\n \\"HasMore\\": false,\\n \\"Logs\\": [\\n {\\n \\"AppId\\": \\"9qb1****\\",\\n \\"SubId\\": \\"ad53276431c****\\",\\n \\"MessageId\\": \\"875d5266cbabb1834cc84a105cf6****\\",\\n \\"Data\\": \\"{\\\\\\\\\\\\\\"MsgId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"875d5266cbabb1834cc84a105cf68454\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"MsgTimestamp\\\\\\\\\\\\\\":1697545591,\\\\\\\\\\\\\\"SubscribeId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"09be0d2254cb5a89f4cbd86403ec5343\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AppId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ChannelId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"9099\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Contents\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Event\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"UserEvent\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"UserEvent\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"UserId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"linux_test\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EventTag\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Leave\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SessionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"je7y2sBZJZQ0VBJZrh4LnBkxvGH2WyVs\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Timestamp\\\\\\\\\\\\\\":1697545591,\\\\\\\\\\\\\\"ChannelProfile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"interactive_live\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"US\\\\\\\\\\\\\\":5068748604047364,\\\\\\\\\\\\\\"Reason\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"Role\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"TerminalType\\\\\\\\\\\\\\":6,\\\\\\\\\\\\\\"UserType\\\\\\\\\\\\\\":2}}]}\\",\\n \\"Cost\\": 22,\\n \\"Time\\": \\"2023-10-17 20:26:31.988\\",\\n \\"Url\\": \\"http://****.com/callback\\",\\n \\"Code\\": 200\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListEventSubEventResponse>\\n <RequestId>CC8CB656-A7BA-1811-9D6B-4CC187E988BD</RequestId>\\n <Count>1</Count>\\n <HasMore>false</HasMore>\\n <Logs>\\n <AppId>9qb1****</AppId>\\n <SubId>ad53276431c****</SubId>\\n <MessageId>875d5266cbabb1834cc84a105cf6****</MessageId>\\n <Data>{\\\\\\"MsgId\\\\\\":\\\\\\"875d5266cbabb1834cc84a105cf68454\\\\\\",\\\\\\"MsgTimestamp\\\\\\":1697545591,\\\\\\"SubscribeId\\\\\\":\\\\\\"09be0d2254cb5a89f4cbd86403ec5343\\\\\\",\\\\\\"AppId\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"ChannelId\\\\\\":\\\\\\"9099\\\\\\",\\\\\\"Contents\\\\\\":[{\\\\\\"Event\\\\\\":\\\\\\"UserEvent\\\\\\",\\\\\\"UserEvent\\\\\\":{\\\\\\"UserId\\\\\\":\\\\\\"linux_test\\\\\\",\\\\\\"EventTag\\\\\\":\\\\\\"Leave\\\\\\",\\\\\\"SessionId\\\\\\":\\\\\\"je7y2sBZJZQ0VBJZrh4LnBkxvGH2WyVs\\\\\\",\\\\\\"Timestamp\\\\\\":1697545591,\\\\\\"ChannelProfile\\\\\\":\\\\\\"interactive_live\\\\\\",\\\\\\"US\\\\\\":5068748604047364,\\\\\\"Reason\\\\\\":1,\\\\\\"Role\\\\\\":1,\\\\\\"TerminalType\\\\\\":6,\\\\\\"UserType\\\\\\":2}}]}</Data>\\n <Cost>22</Cost>\\n <Time>2023-10-17 20:26:31.988</Time>\\n <Url>http://****.com/callback</Url>\\n <Code>200</Code>\\n </Logs>\\n</ListEventSubEventResponse>","errorExample":""}]', + 'title' => '查询回调记录', + 'description' => '- 最大查询跨度：7天。'."\n" + .'- 最小查询粒度：1分钟。'."\n" + .'- 最大查询范围：最近7天的数据。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateEventSub' => [ + 'summary' => '更新订阅房间消息回调。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅的应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => '9qb1****', + ], + ], + [ + 'name' => 'SubscribeId', + 'in' => 'query', + 'schema' => [ + 'title' => '订阅ID', + 'description' => '订阅事件ID。您可通过[CreateEventSub](~~2848209~~)接口的返回参数查询订阅ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ad53276431c****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅的频道ID。订阅的频道ID。您可通过调用[ListEventSub](~~2848210~~)接口查询订阅的频道ID。'."\n" + ."\n" + .'>- 如果Users.N参数不为空，则此参数必填。'."\n" + .'> - ChannelId为*或者不填，表示为全频道订阅，每个AppId只允许1个全频道订阅。'."\n" + .'> - 每个AppId最多同时允许创建20个订阅事件。', + 'type' => 'string', + 'required' => false, + 'example' => '123333', + ], + ], + [ + 'name' => 'Users', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '只监听指定用户的事件，必须同时指定ChannelId才有效。', + 'description' => '订阅哪些用户的消息。', + 'type' => 'array', + 'items' => [ + 'description' => '订阅哪些用户的消息，参数为空表示订阅该房间全部用户（包含主播和观众）。格式如下所示：'."\n" + ."\n" + .'```'."\n" + .'Users.1=****'."\n" + .'Users.2=****'."\n" + .'......'."\n" + .'```', + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + 'required' => false, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'Events', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => 'ChannelEvent, UserEvent', + 'description' => '订阅事件。', + 'type' => 'array', + 'items' => [ + 'description' => '订阅的事件，取值：'."\n" + ."\n" + .'- **ChannelEvent**：频道事件。'."\n" + .'- **UserEvent**：频道内用户事件。', + 'type' => 'string', + 'required' => true, + 'example' => 'ChannelEvent', + ], + 'required' => true, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'title' => '回调地址，因为安全需求，回调地址必须是域名，用标准端号，回调地址不允许包含端口号。示例： http(s)://xxxx.com/xxxx', + 'description' => '回调地址。回调内容请参见[CallBack](~~610983~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://****.com/callback', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'QuotaLimitError', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'ErrorInvalidCallBackUrl', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateEventSubResponse>\\n <RequestId>AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08</RequestId>\\n</UpdateEventSubResponse>","errorExample":""}]', + 'title' => '更新订阅房间消息回调', + 'description' => '- 调用本接口前，您必须已经调用[CreateEventSub](~~2848209~~)创建订阅房间消息回调。'."\n" + .'- 已有关联频道，依然使用原规则。频道关闭20分钟以上，再次开启才会适用新规则。'."\n" + .'- 如果只想更新某些字段，则其他字段也需要用原有内容进行填充。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteEventSub' => [ + 'summary' => '删除订阅房间消息的回调。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => '9qb1****', + ], + ], + [ + 'name' => 'SubscribeId', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅ID。您可通过[CreateEventSub](~~2848209~~)接口的返回参数查询订阅ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ad53276431c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '760bad53276431c499e30dc36f6b26be', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InputInvalid', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoAuth', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotExist', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"760bad53276431c499e30dc36f6b26be\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteEventSubResponse>\\n <RequestId>760bad53276431c499e30dc36f6b26be</RequestId>\\n</DeleteEventSubResponse>","errorExample":""}]', + 'title' => '删除订阅房间消息回调', + 'description' => '调用本接口前，您必须已经调用[CreateEventSub](~~2848209~~)创建订阅房间消息的回调。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CreateRtcMPUEventSub' => [ + 'summary' => '创建混流转推事件订阅。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219222', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅的应用ID。'."\n" + .'> 应用ID由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'ChannelIds', + 'in' => 'query', + 'schema' => [ + 'description' => '指定接收回调的混流任务的频道ID，可以同时填多个频道ID，多个频道ID之间采用英文逗号“,”隔开。'."\n" + .'> - 如果不填，则默认接收该AppId下所有混流转推任务的回调事件。'."\n" + .'> - 同时填多个频道ID时，不能填写重复的频道ID，最多同时填20个频道ID。'."\n" + .'> - 每个频道ID由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourChannelIds', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '回调地址。地址格式请参见以下回调内容规范。'."\n" + .'> 回调地址协议头为HTTP、HTTPS等，仅可包含以下字符：a-z 、A-Z、0-9、-、_、?、%、=、#、.、/ 和 +，不超过2083个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://****.com/callback', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'SubId' => [ + 'description' => '订阅ID。', + 'type' => 'string', + 'example' => 'Sub-******9799B2C4500******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidAppId', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the Live service', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'InternalError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"SubId\\": \\"Sub-******9799B2C4500******\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateRtcMPUEventSubResponse>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n <SubId>Sub-******9799B2C4500******</SubId>\\n</CreateRtcMPUEventSubResponse>","errorExample":""}]', + 'title' => '创建混流转推事件订阅', + 'description' => '本接口用于创建混流转推事件订阅。在创建订阅时，您可以配置回调地址、订阅应用与频道信息等参数。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '## 回调内容示例'."\n" + .'回调内容以**HTTP/HTTPS POST**请求发送到您的业务服务器，字符编码格式为**UTF-8**格式，请求体为**JSON**结构体，当您的业务服务器响应**HTTP状态码为200**时，认定为回调成功。回调内容示例如下：'."\n" + ."\n" + .'> 建议在判断混流转推是否正常时，不仅需要根据回调通知判断，也要同时配合接入的对应CDN厂商提供的在线流状态判断是否正常。'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "EventType": 1,'."\n" + .' "MsgId": "42bba8b5-94ab-468c-9dae-9b501dd****",'."\n" + .' "AppId": "rtcdev",'."\n" + .' "SubId": "Sub-9799B2C45009799B2*****",'."\n" + .' "TaskId": "mpucallbacktest",'."\n" + .' "CallbackTs": 1712656430476,'."\n" + .' "Payload": {'."\n" + .' "DstUrl": "rtmp://domain/app/stream?auth",'."\n" + .' "EventTs": 1712656430384,'."\n" + .' "EventCode": 1,'."\n" + .' "ErrorCode": 0,'."\n" + .' "ErrorMessage": ""'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'### 回调信息'."\n" + .'回调信息的header包括如下字段：'."\n" + ."\n" + .'| 属性 | 描述 |'."\n" + .'| ------ | ----- |'."\n" + .'| Content-Type | 数据类型，固定值：application/json |'."\n" + .'| Ali-Rtc-Timestamp | 时间戳 |'."\n" + .'| Ali-Rtc-Signature | 签名值 |'."\n" + ."\n" + .'回调信息的回调内容包括如下字段：'."\n" + .'| 属性 | 类型| 描述 | 示例值 |'."\n" + .'| ------ | ----- | ----- | -----|'."\n" + .'| EventType | Integer| 回调事件类型，对于混流转推回调，类型为固定值：1| 1 |'."\n" + .'| MsgId| String| 回调ID，唯一表示本次回调 | \\*\\*\\*\\*\\*973C-4529-A334\\*\\*\\*\\*\\*|'."\n" + .'| AppId| String| 订阅的应用ID | yourAppId |'."\n" + .'| SubId| String| 订阅ID | Sub-\\*\\*\\*\\*\\*\\*9799B2C4500\\*\\*\\*\\*\\*\\* |'."\n" + .'| TaskId| String| 旁路任务ID | yourTaskId |'."\n" + .'| CallbackTs| Integer| 发起回调请求的毫秒时间戳 | 1712656430476 |'."\n" + .'| Payload| JSON Object| 回调事件信息 | - |'."\n" + ."\n" + .'* 回调事件信息（Payload）'."\n" + ."\n" + .'| 属性 | 类型| 描述 | 示例值 |'."\n" + .'| ------ | ----- | ----- | -----|'."\n" + .'| DstUrl | String | 转推目的URL地址 | rtmp://domain/app/stream?auth |'."\n" + .'| EventTs | Integer | 回调事件发生的毫秒时间戳 | 1712656430384 |'."\n" + .'| EventCode | Integer | 回调事件Code | 1 |'."\n" + .'| ErrorCode | Integer | 回调事件的错误码 | 10001 |'."\n" + .' | ErrorMessage | String| 回调事件的错误原因 | rtmp server init failed |'."\n" + ."\n" + .'## 回调事件Code'."\n" + .'| 字段名 | 值| 含义 | 回调频率 |'."\n" + .'| ------ | ----- | ----- | -----|'."\n" + .'| MPU_STATE_PREPARING | 0 | 旁路转推任务创建成功，任务被触发 | 仅回调1次 |'."\n" + .'| MPU_STATE_ESTABLISHING | 1 | 旁路转推任务建联中 | 每5秒回调1次 |'."\n" + .'| MPU_STATE_RUNNING | 2 | 旁路转推任务运行中 | 仅回调1次 |'."\n" + .'| MPU_STATE_RECOVERING | 3 | 旁路转推异常中断，正在恢复中 | 每5秒回调1次 |'."\n" + .'| MPU_STATE_TERMINATED | 4 | 旁路转推任务结束，包括正常停止、启动失败、异常退出等，通过ErrorCode与ErrorMessage区分 | 仅回调1次 |'."\n" + ."\n" + .'回调事件的状态转移示例如下：'."\n" + .''."\n" + .'**注意：** '."\n" + .'1. 回调信息有可能会乱序到达您的业务服务器，您可以根据 Payload 中的 EventTs 做事件排序，如果您只关心回调事件的最新状态，可以忽略后续到达的过期事件。'."\n" + .'2. 对于通过API[创建混流转推任务（新）](~~2848199~~)创建的混流转推任务，当房间内所有用户均离开房间后一段时间，任务会自动停止，停止时会发送一个MPU_STATE_TERMINATED的回调。'."\n" + .'3. 回调配置只影响增量任务，不影响存量任务。即：'."\n" + ."\n" + .' a. 开启回调配置前已启动的任务，不发送回调；'."\n" + ."\n" + .' b. 开启回调配置后启动的任务，会发送回调；'."\n" + ."\n" + .' c. 删除回调配置前已启动的任务，会继续发送回调直到任务结束；'."\n" + ."\n" + .' d. 删除回调配置后启动的任务，不发送回调。'."\n" + ."\n" + .'### 回调错误码'."\n" + .'当旁路转推任务结束时，通过ErrorCode与ErrorMessage标识结束的原因。'."\n" + ."\n" + .'| 错误码 | 错误信息 | 含义 |'."\n" + .'| ------ | ----- | ----- |'."\n" + .'| 0 | | 任务正常停止 |'."\n" + .'| 10001 | rtmp server init failed | 建联失败，任务异常结束 |'."\n" + .'| 10002 | rtmp server internal error| 服务内部错误，任务异常结束 |'."\n" + .'| 10003 | task idle timeout | 任务空闲超时后结束 |'."\n" + ."\n" + .'## 回调鉴权说明'."\n" + .'事件回调鉴权功能默认开启，鉴权逻辑如下所示：'."\n" + .'- 阿里云视频直播服务发起回调请求时，在HTTP(S)请求头中包含Ali-Rtc-Timestamp和Ali-Rtc-Signature字段，供回调消息接收服务端进行签名认证。Ali-Rtc-Signature值计算方式为：Ali-Rtc-Signature=MD5SUM(MD5CONTENT)。其中，MD5CONTENT=回调域名|Ali-Rtc-Timestamp取值|鉴权Key；回调域名指配置回调URL的域名，鉴权Key指用户创建AppId时生成的AppKey。'."\n" + .'- 回调消息接收服务端接收回调消息时，将回调域名、Ali-Rtc-Timestamp取值、鉴权Key进行拼接后计算MD5值，得到加密字符串，再将计算出的加密字符串与音视频通信服务发起的HTTP(S)请求头中的Ali-Rtc-Signature字段值进行对比，如果不一致，则请求非法。'."\n" + .'## 回调异常重试'."\n" + .'阿里云发起回调请求时，仅当您的业务服务器响应HTTP状态码为200时认定为回调成功。若回调失败，阿里云会重试7次，分别间隔1秒、2秒、5秒、10秒、1分钟、2分钟、5分钟。每次重试请求均会产生对应的回调记录。', + ], + 'UpdateRtcMPUEventSub' => [ + 'summary' => '更新混流转推事件订阅。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219223', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅的应用ID。'."\n" + .'> 应用ID由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'ChannelIds', + 'in' => 'query', + 'schema' => [ + 'description' => '指定接收回调的混流任务的频道ID，可以同时填多个频道ID，多个频道ID之间采用英文逗号“,”隔开。'."\n" + .'> - 如果不填，则默认接收该AppId下的所有混流转推的回调事件。'."\n" + .'- 同时填多个频道ID时，不能填写重复的频道ID，最多同时填20个频道ID。'."\n" + .'- 每个频道ID由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourChannelIds', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '回调地址。'."\n" + .'> 回调地址协议头为HTTP、HTTPS等，仅可包含以下字符：a-z 、A-Z、0-9、-、_、?、%、=、#、.、/ 和 +，不超过2083个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://****.com/callback', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidAppId', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the Live service', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'InternalError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateRtcMPUEventSubResponse>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n</UpdateRtcMPUEventSubResponse>","errorExample":""}]', + 'title' => '更新混流转推事件订阅', + 'description' => '- 本接口用于更新混流转推事件订阅。您可以更新回调地址、订阅频道信息等参数。'."\n" + .'- 调用本接口前，您必须已经调用CreateRtcMPUEventSub创建混流转推事件订阅。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteRtcMPUEventSub' => [ + 'summary' => '删除混流转推事件订阅。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219225', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅的应用ID。'."\n" + .'> 应用ID由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidAppId', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the Live service', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'InternalError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteRtcMPUEventSubResponse>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n</DeleteRtcMPUEventSubResponse>","errorExample":""}]', + 'title' => '删除混流转推事件订阅', + 'description' => '- 本接口用于删除混流转推事件订阅。'."\n" + .'- 调用本接口前，您必须已经调用CreateRtcMPUEventSub创建混流转推事件订阅。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeRtcMPUEventSub' => [ + 'summary' => '查询混流转推事件订阅。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219226', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅的应用ID。'."\n" + .'> 应用ID由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'SubInfo' => [ + 'description' => '事件回调信息', + 'type' => 'object', + 'properties' => [ + 'SubId' => [ + 'description' => '事件回调ID', + 'type' => 'string', + 'example' => 'Sub-******9799B2C4500******', + ], + 'AppId' => [ + 'description' => '订阅的应用ID', + 'type' => 'string', + 'example' => 'yourAppId', + ], + 'ChannelIds' => [ + 'description' => '指定接收回调的混流任务的频道ID，用英文逗号“,”隔开。如果为空，表示所有频道都接收回调', + 'type' => 'string', + 'example' => 'yourCh1,yourCh2', + ], + 'CreateTime' => [ + 'description' => '事件回调的创建时间，格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）', + 'type' => 'string', + 'example' => '2024-04-09 18:00:00Z', + ], + 'CallbackUrl' => [ + 'description' => '回调地址', + 'type' => 'string', + 'example' => 'http://testcallback***.com/callback', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidAppId', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the Live service', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'InternalError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"SubInfo\\": {\\n \\"SubId\\": \\"Sub-******9799B2C4500******\\",\\n \\"AppId\\": \\"yourAppId\\",\\n \\"ChannelIds\\": \\"yourCh1,yourCh2\\",\\n \\"CreateTime\\": \\"2024-04-09 18:00:00Z\\",\\n \\"CallbackUrl\\": \\"http://testcallback***.com/callback\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRtcMPUEventSubResponse>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n <SubInfo>\\n <SubId>Sub-******9799B2C4500******</SubId>\\n <AppId>yourAppId</AppId>\\n <ChannelIds>yourCh1,yourCh2</ChannelIds>\\n <CreateTime>2024-04-09 18:00:00Z</CreateTime>\\n <CallbackUrl>http://testcallback***.com/callback</CallbackUrl>\\n </SubInfo>\\n</DescribeRtcMPUEventSubResponse>","errorExample":""}]', + 'title' => '查询混流转推事件订阅', + 'description' => '- 本接口用于查询混流转推事件订阅。'."\n" + .'- 调用本接口前，您必须已经调用CreateRtcMPUEventSub创建混流转推事件订阅。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListRtcMPUEventSubRecord' => [ + 'summary' => '查询混流转推事件订阅记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225589', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅的应用ID。'."\n" + .'> 应用ID由大小写字母、数字、下划线、短划线（-）组成，最大64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'yourAppId', + ], + ], + [ + 'name' => 'SubId', + 'in' => 'query', + 'schema' => [ + 'description' => '订阅的回调ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourSubId', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询记录的开始时间。'."\n" + .'格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）', + 'type' => 'string', + 'required' => true, + 'example' => '1970-01-01T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询记录的结束时间。'."\n" + .'格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）', + 'type' => 'string', + 'required' => true, + 'example' => '1970-01-01T00:00:00Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '单页显示记录的数量，取值范围：1~100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'Count' => [ + 'description' => '当前页返回的回调记录总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'HasMore' => [ + 'description' => '是否有下一页。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Logs' => [ + 'description' => '回调记录。', + 'type' => 'array', + 'items' => [ + 'description' => '回调记录。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '订阅的应用ID。', + 'type' => 'string', + 'example' => 'yourAppId', + ], + 'SubId' => [ + 'description' => '事件回调ID。', + 'type' => 'string', + 'example' => 'Sub-******9799B2C4500******', + ], + 'MsgId' => [ + 'description' => '回调记录ID。', + 'type' => 'string', + 'example' => '42bba8b5-********-9b501dd6cb6e', + ], + 'Data' => [ + 'description' => '回调内容，详见[创建混流转推事件回调](~~2804583~~)。', + 'type' => 'string', + 'example' => '{\\"EventType\\":1,\\"MsgId\\":\\"42bba8b5-94ab-468c-9dae-9b501dd6c***\\",\\"AppId\\":\\"rtcdev\\",\\"SubId\\":\\"Sub-9799B2C45009799B2C4***\\",\\"TaskId\\":\\"mpucallbacktest\\",\\"CallbackTs\\":1712656430***,\\"Payload\\":{\\"DstUrl\\":\\"rtmp://domain/app/stream?auth\\",\\"EventTs\\":1712656430***,\\"EventCode\\":1,\\"ErrorCode\\":0,\\"ErrorMessage\\":\\"\\"}}', + ], + 'Time' => [ + 'description' => '回调调用时间。'."\n" + .'格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）', + 'type' => 'string', + 'example' => '1970-01-01T00:00:00Z', + ], + 'Cost' => [ + 'description' => '回调时长，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22', + ], + 'CallbackUrl' => [ + 'description' => '回调地址。', + 'type' => 'string', + 'example' => 'http://testcallback***.com/callback', + ], + 'HTTPCode' => [ + 'description' => '错误码，200为回调成功。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidAppId', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParam', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the Live service', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'InternalError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Count\\": 1,\\n \\"HasMore\\": false,\\n \\"Logs\\": [\\n {\\n \\"AppId\\": \\"yourAppId\\",\\n \\"SubId\\": \\"Sub-******9799B2C4500******\\",\\n \\"MsgId\\": \\"42bba8b5-********-9b501dd6cb6e\\",\\n \\"Data\\": \\"{\\\\\\\\\\\\\\"EventType\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"MsgId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"42bba8b5-94ab-468c-9dae-9b501dd6c***\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AppId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rtcdev\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SubId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Sub-9799B2C45009799B2C4***\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TaskId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"mpucallbacktest\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CallbackTs\\\\\\\\\\\\\\":1712656430***,\\\\\\\\\\\\\\"Payload\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"DstUrl\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rtmp://domain/app/stream?auth\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EventTs\\\\\\\\\\\\\\":1712656430***,\\\\\\\\\\\\\\"EventCode\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"ErrorCode\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"ErrorMessage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}}\\",\\n \\"Time\\": \\"1970-01-01T00:00:00Z\\",\\n \\"Cost\\": 22,\\n \\"CallbackUrl\\": \\"http://testcallback***.com/callback\\",\\n \\"HTTPCode\\": \\"200\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRtcMPUEventSubRecordResponse>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n <Count>1</Count>\\n <HasMore>false</HasMore>\\n <Logs>\\n <AppId>yourAppId</AppId>\\n <SubId>Sub-******9799B2C4500******</SubId>\\n <MsgId>42bba8b5-********-9b501dd6cb6e</MsgId>\\n <Data>{\\\\\\"EventType\\\\\\":1,\\\\\\"MsgId\\\\\\":\\\\\\"42bba8b5-94ab-468c-9dae-9b501dd6c***\\\\\\",\\\\\\"AppId\\\\\\":\\\\\\"rtcdev\\\\\\",\\\\\\"SubId\\\\\\":\\\\\\"Sub-9799B2C45009799B2C4***\\\\\\",\\\\\\"TaskId\\\\\\":\\\\\\"mpucallbacktest\\\\\\",\\\\\\"CallbackTs\\\\\\":1712656430***,\\\\\\"Payload\\\\\\":{\\\\\\"DstUrl\\\\\\":\\\\\\"rtmp://domain/app/stream?auth\\\\\\",\\\\\\"EventTs\\\\\\":1712656430***,\\\\\\"EventCode\\\\\\":1,\\\\\\"ErrorCode\\\\\\":0,\\\\\\"ErrorMessage\\\\\\":\\\\\\"\\\\\\"}}</Data>\\n <Time>1970-01-01T00:00:00Z</Time>\\n <Cost>22</Cost>\\n <CallbackUrl>http://testcallback***.com/callback</CallbackUrl>\\n <HTTPCode>200</HTTPCode>\\n </Logs>\\n</ListRtcMPUEventSubRecordResponse>","errorExample":""}]', + 'title' => '查询混流转推事件订阅记录', + 'description' => '本接口用于查询混流转推事件订阅记录，查询范围为近7天的数据。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveInteractionMetricData' => [ + 'summary' => '调用DescribeLiveInteractionMetricData查询实时音视频指标数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '193672', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => [ + 'description' => '指标类型。取值：'."\n" + .'- JoinChannelSucRate：5秒加入频道成功率。'."\n" + .'- VideoStuckRate：视频卡顿率。'."\n" + .'- AudioStuckRate：音频卡顿率。'."\n" + .'- FirstFrameCost：首帧耗时。', + 'type' => 'string', + 'required' => true, + 'example' => 'FirstFrameCost', + ], + ], + [ + 'name' => 'BeginTs', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，用UNIX时间戳表示，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1698195600000', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，用UNIX时间戳表示，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1698201013000', + ], + ], + [ + 'name' => 'Os', + 'in' => 'query', + 'schema' => [ + 'description' => '操作系统。取值：iOS、Android。', + 'type' => 'string', + 'required' => false, + 'example' => 'Android', + ], + ], + [ + 'name' => 'TerminalType', + 'in' => 'query', + 'schema' => [ + 'description' => '终端类型。取值：web、mobile。', + 'type' => 'string', + 'required' => false, + 'example' => 'mobile', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'e4d7f08a-01fe-41b5-a091-fe41060a****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '管道ID'."\n" + .'频道标识', + 'description' => '管道ID', + 'type' => 'string', + 'required' => false, + 'example' => '770513', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => '节点数据。', + 'type' => 'array', + 'items' => [ + 'description' => '节点数据。', + 'type' => 'object', + 'properties' => [ + 'Timestamp' => [ + 'description' => '查询时间，用UNIX时间戳表示，单位：毫秒。', + 'type' => 'string', + 'example' => '1548670257000', + ], + 'Value' => [ + 'description' => '指标对应的值。', + 'type' => 'string', + 'example' => '66.670000', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A01C98C5-25AE-124A-83FE-514DF5C5BE36', + ], + 'SummaryData' => [ + 'description' => '汇总数据。', + 'type' => 'string', + 'example' => '2000', + ], + ], + ], + ], + ], + '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' => '[{"type":"json","example":"{\\n \\"Nodes\\": [\\n {\\n \\"Timestamp\\": \\"1548670257000\\",\\n \\"Value\\": \\"66.670000\\"\\n }\\n ],\\n \\"RequestId\\": \\"A01C98C5-25AE-124A-83FE-514DF5C5BE36\\",\\n \\"SummaryData\\": \\"2000\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveInteractionMetricDataResponse>\\n <RequestId>A01C98C5-25AE-124A-83FE-514DF5C5BE36</RequestId>\\n <SummaryData>2000</SummaryData>\\n <Nodes>\\n <Timestamp>1548670257000</Timestamp>\\n <Value>66.670000</Value>\\n </Nodes>\\n</DescribeLiveInteractionMetricDataResponse>","errorExample":""}]', + 'title' => '查询实时音视频指标数据', + 'description' => '- 可以查询最近30天内的数据，查询时间跨度不能超过24小时。'."\n" + .'- 查询粒度：5分钟。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CreateRtcAsrTask' => [ + 'summary' => '创建一个新的实时字幕任务，用于实时转录音频流为文本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219527', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => '流模式，live或者rtc。live为正常直播流如rtmp。', + 'type' => 'string', + 'required' => true, + 'example' => 'live', + 'enum' => [ + 'rtc', + 'live', + ], + ], + ], + [ + 'name' => 'SDKAppID', + 'in' => 'query', + 'schema' => [ + 'description' => 'ARTC应用ID。'."\n" + .'> 当参数Mode取值为rtc时，此参数必填，否则不生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'appId', + ], + ], + [ + 'name' => 'ChannelID', + 'in' => 'query', + 'schema' => [ + 'description' => '房间号。'."\n" + .'> 参数Mode取值为rtc时，此参数必填，否则不生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'channelId', + ], + ], + [ + 'name' => 'RtcUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '推流用户ID。'."\n" + .'> 参数Mode取值为rtc时，此参数必填，且只能填写一个，否则不生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + ], + [ + 'name' => 'StreamURL', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流地址。'."\n" + .'> 参数Mode取值为live时，此参数必填，否则不生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://xxx', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '原音频语言，取值：'."\n" + .'- 日语：ja。'."\n" + .'- 粤语：yue。'."\n" + .'- 中英文自由说：fspk。'."\n" + .'- 英文：en。'."\n" + .'- 中文：cn。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn', + ], + ], + [ + 'name' => 'CallbackURL', + 'in' => 'query', + 'schema' => [ + 'description' => '回调地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://xxx.com', + ], + ], + [ + 'name' => 'AuthKey', + 'in' => 'query', + 'schema' => [ + 'description' => '校验AuthKey，用于生成回调信息的MD5签名。'."\n" + .'> 回调时会在请求头中加两个鉴权字段，"SIG-TIME"表示当前时间戳，"ASR-SIG"表示md5鉴权字段，"ASR-SIG"字段的生成规则为md5(`${SIG-TIME}/${callbackurl}/${authKey}`)', + 'type' => 'string', + 'required' => false, + 'example' => 'abcd', + ], + ], + [ + 'name' => 'TranslateEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => '开启翻译。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TargetLanguages', + 'in' => 'query', + 'schema' => [ + 'description' => '目标翻译语种，取值：'."\n" + .'- 中文：cn。'."\n" + .'- 英文：en。'."\n" + .'- 日文：ja。', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'AutoTerminateEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => '断流最大延迟，超过则自动关闭任务。默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AutoTerminateDelay', + 'in' => 'query', + 'schema' => [ + 'description' => '自动断流延时，单位秒，取值：1~10秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'ReportInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '回调上报间隔，单位毫秒，取值范围：-1~500毫秒。'."\n" + .'- -1：不接受中间结果，只接受整句回调。'."\n" + .'- 0或不设置：实时上报回调结果。'."\n" + .'- <=500毫秒：周期性间隔上报回调结果。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '结果描述，为success时成功，有错误信息则返回。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '网关请求ID。', + 'type' => 'string', + 'example' => '7FF5417D-06E9-5A2C-9A70-581F6149E6C1', + ], + 'RetCode' => [ + 'description' => '状态码。返回2000表示成功，返回其他表示异常。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2000', + ], + 'TaskId' => [ + 'description' => '生成的任务ID。', + 'type' => 'string', + 'example' => 'asr-a6ac15e0-9118-4b4c-9e64-306163a0****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Description\\": \\"success\\",\\n \\"RequestId\\": \\"7FF5417D-06E9-5A2C-9A70-581F6149E6C1\\",\\n \\"RetCode\\": 2000,\\n \\"TaskId\\": \\"asr-a6ac15e0-9118-4b4c-9e64-306163a0****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateRtcAsrTaskResponse>\\n <Description>success</Description>\\n <RequestId>7FF5417D-06E9-5A2C-9A70-581F6149E6C1</RequestId>\\n <RetCode>2000</RetCode>\\n <TaskId>asr-a6ac15e0-9118-4b4c-9e64-306163a0****</TaskId>\\n</CreateRtcAsrTaskResponse>","errorExample":""}]', + 'title' => '创建实时语音转文字或翻译', + 'description' => '本接口用于创建一个新的实时字幕任务，用于实时转录音频流为文本。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '## 回调示例'."\n" + .'通过用户提供的 CallbackUrl，以 HTTP POST 请求的形式将 JSON 格式的数据放在请求体（Request Body）中回调至指定地址。回调参数Content详细说明及回调流程请参见：[交互流程与实现](~~2609586~~)，示例如下所示：'."\n" + .'```'."\n" + .'{'."\n" + .' "task_id": "asr-cf8c70d7-3b8d-496c-98f8-4785******",'."\n" + .' "sdk_app_id": "",'."\n" + .' "channel_id": "",'."\n" + .' "rtc_user_id": "",'."\n" + .' "callback_time_stamp": 1723433155645,'."\n" + .' "language": "cn",'."\n" + .' "content": "{\\"header\\":{\\"nls_task_id\\":\\"af95c5cc332549f689f3153bc9******\\",\\"task_key\\":\\"tl_2977564_17234*****\\",\\"namespace\\":\\"SpeechTranscriber\\",\\"name\\":\\"TranscriptionResultChanged\\",\\"task_id\\":\\"413937911b874146b5796******\\",\\"message_id\\":\\"abfc9e9994e748a38499e1******\\",\\"status_text\\":\\"Success.\\",\\"status\\":20000000},\\"payload\\":{\\"result\\":\\"在这里与各位相聚\\",\\"confidence\\":0.0,\\"words\\":[{\\"startTime\\":0,\\"text\\":\\"在这\\",\\"endTime\\":510},{\\"startTime\\":510,\\"text\\":\\"里与\\",\\"endTime\\":1020},{\\"startTime\\":1020,\\"text\\":\\"各位\\",\\"endTime\\":1530},{\\"startTime\\":1530,\\"text\\":\\"相聚\\",\\"endTime\\":2040}],\\"index\\":0,\\"time\\":2040,\\"fixed_result\\":\\"\\",\\"unfixed_result\\":\\"\\",\\"status\\":0}}"'."\n" + .' }'."\n" + .'```', + ], + 'QueryRtcAsrTasks' => [ + 'summary' => '查询当前已创建的实时语音转文字或翻译任务的状态信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219787', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的任务ID，不填写则查询用户uid下所有运行中的任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'asr-a6ac15e0-9118-4b4c-9e64-306163a0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '结果描述，为success时成功，失败则返回错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '网关请求ID。', + 'type' => 'string', + 'example' => 'D8ADAB55-1BB8-5C01-8434-C45D353BB1FD', + ], + 'RetCode' => [ + 'description' => '状态码。返回2000表示成功，返回其他表示异常。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2000', + ], + 'Tasks' => [ + 'description' => 'Task结果集合。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '"asr-a7bdde0a-0939-4288-973e-170082aa****": { "createdAt": "2024-05-14T11:52:02+08:00", "updatedAt": "2024-05-14T11:52:03+08:00", "mode": "live", "taskId": "asr-a7bdde0a-0939-4288-973e-170082aa****", "language": "cn", "callbackUrl": "default", "autoTerminateDelay": "10", "streamUrl": "http://pull-lveditor.alivecdn.com/caster/9c6c26281a6f4da29af7d3ec84d2****.flv?auth_key=1715745062-0-0-fbc68f2ccebb4d46b5ab6d4801ed****", "status": 1, "reportInterval": "0", "aliUid": "1119309225474343", "tag": "" }', + 'description' => 'Task结果集合。', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Description\\": \\"success\\",\\n \\"RequestId\\": \\"D8ADAB55-1BB8-5C01-8434-C45D353BB1FD\\",\\n \\"RetCode\\": 2000,\\n \\"Tasks\\": {\\n \\"key\\": \\"\\\\\\"asr-a7bdde0a-0939-4288-973e-170082aa****\\\\\\": { \\\\\\"createdAt\\\\\\": \\\\\\"2024-05-14T11:52:02+08:00\\\\\\", \\\\\\"updatedAt\\\\\\": \\\\\\"2024-05-14T11:52:03+08:00\\\\\\", \\\\\\"mode\\\\\\": \\\\\\"live\\\\\\", \\\\\\"taskId\\\\\\": \\\\\\"asr-a7bdde0a-0939-4288-973e-170082aa****\\\\\\", \\\\\\"language\\\\\\": \\\\\\"cn\\\\\\", \\\\\\"callbackUrl\\\\\\": \\\\\\"default\\\\\\", \\\\\\"autoTerminateDelay\\\\\\": \\\\\\"10\\\\\\", \\\\\\"streamUrl\\\\\\": \\\\\\"http://pull-lveditor.alivecdn.com/caster/9c6c26281a6f4da29af7d3ec84d2****.flv?auth_key=1715745062-0-0-fbc68f2ccebb4d46b5ab6d4801ed****\\\\\\", \\\\\\"status\\\\\\": 1, \\\\\\"reportInterval\\\\\\": \\\\\\"0\\\\\\", \\\\\\"aliUid\\\\\\": \\\\\\"1119309225474343\\\\\\", \\\\\\"tag\\\\\\": \\\\\\"\\\\\\" }\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryRtcAsrTasksResponse>\\n <Description>success</Description>\\n <RequestId>D8ADAB55-1BB8-5C01-8434-C45D353BB1FD</RequestId>\\n <RetCode>2000</RetCode>\\n <Tasks>\\n <key>\\"asr-a7bdde0a-0939-4288-973e-170082aa****\\": { \\"createdAt\\": \\"2024-05-14T11:52:02+08:00\\", \\"updatedAt\\": \\"2024-05-14T11:52:03+08:00\\", \\"mode\\": \\"live\\", \\"taskId\\": \\"asr-a7bdde0a-0939-4288-973e-170082aa****\\", \\"language\\": \\"cn\\", \\"callbackUrl\\": \\"default\\", \\"autoTerminateDelay\\": \\"10\\", \\"streamUrl\\": \\"http://pull-lveditor.alivecdn.com/caster/9c6c26281a6f4da29af7d3ec84d2****.flv?auth_key=1715745062-0-0-fbc68f2ccebb4d46b5ab6d4801ed****\\", \\"status\\": 1, \\"reportInterval\\": \\"0\\", \\"aliUid\\": \\"1119309225474343\\", \\"tag\\": \\"\\" }</key>\\n </Tasks>\\n</QueryRtcAsrTasksResponse>","errorExample":""}]', + 'title' => '查询实时语音转文字或翻译', + 'description' => '本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'StopRtcAsrTask' => [ + 'summary' => '调用StopRtcAsrTask停止实时字幕任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219794', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'asr-d794cc89-a63e-4d08-8b44-242a6597****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '结果描述，为success时成功，失败则返回错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '网关请求ID。', + 'type' => 'string', + 'example' => '3D208CC1-27C9-51E9-82B8-A6682D466421', + ], + 'RetCode' => [ + 'description' => '状态码。返回2000表示成功，返回其他表示异常。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2000', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Description\\": \\"success\\",\\n \\"RequestId\\": \\"3D208CC1-27C9-51E9-82B8-A6682D466421\\",\\n \\"RetCode\\": 2000\\n}","errorExample":""},{"type":"xml","example":"<StopRtcAsrTaskResponse>\\n <Description>success</Description>\\n <RequestId>3D208CC1-27C9-51E9-82B8-A6682D466421</RequestId>\\n <RetCode>2000</RetCode>\\n</StopRtcAsrTaskResponse>","errorExample":""}]', + 'title' => '停止实时语音转文字或翻译', + 'description' => '本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteRtcAsrTask' => [ + 'summary' => '调用DeleteRtcAsrTask删除实时语音转文字或翻译任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219798', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。您可通过调用[CreateRtcAsrTask](~~2848217~~)接口获取任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'asr-51c72******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '结果描述，为success时成功，失败则返回错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '网关请求ID。', + 'type' => 'string', + 'example' => '85F94125-B695-1FB8-A7E7-3BE7CE******', + ], + 'RetCode' => [ + 'description' => '状态码。返回2000表示成功，返回其他表示异常。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2000', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConfigNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Description\\": \\"success\\",\\n \\"RequestId\\": \\"85F94125-B695-1FB8-A7E7-3BE7CE******\\",\\n \\"RetCode\\": 2000\\n}","errorExample":""},{"type":"xml","example":"<DeleteRtcAsrTaskResponse>\\n <Description>success</Description>\\n <RequestId>85F94125-B695-1FB8-A7E7-3BE7CE07EF31</RequestId>\\n <RetCode>2000</RetCode>\\n</DeleteRtcAsrTaskResponse>","errorExample":""}]', + 'title' => '删除实时语音转文字或翻译任务', + 'description' => '本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteLiveAIProduceRules' => [ + 'summary' => '删除字幕规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219079', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'RulesId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '字幕规则ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '445409ec-7eaa-461d -8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'SuffixName', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕后缀。'."\n" + .'> 传值为SubtitleName字幕模板名称设置的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'et', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播放域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'AppName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64- af62-20e91b96****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'IncorrectSubtitleStatus.%s', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0df228-4a64- af62-20e91b96****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveAIProduceRulesResponse>\\n <RequestId>5c6a2a0df228-4a64- af62-20e91b96****</RequestId>\\n</DeleteLiveAIProduceRulesResponse>","errorExample":""}]', + 'title' => '删除字幕规则', + 'description' => '本接口支持删除指定的字幕规则。'."\n" + ."\n" + .'><notice>当前实时字幕功能处于邀测阶段，单个用户最多可添加300个字幕模板。'."\n" + .'></notice>'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveAIProduceRules' => [ + 'summary' => '查询字幕规则列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219166', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播放域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'AppName', + ], + ], + [ + 'name' => 'SuffixName', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕后缀。'."\n" + .'> 传值为SubtitleName字幕模板名称设置的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'sub01', + ], + ], + [ + 'name' => 'RulesId', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕规则ID。', + 'type' => 'string', + 'required' => false, + 'example' => '445409ec-7eaa-461d-8f29-4bec****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分⻚的⻚数，取值范围【1,100】。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分⻚每⻚个数，取值范围【1,100】。', + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64- af62-20e91b96****', + ], + 'RuleInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleInfo' => [ + 'description' => '字幕规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '字幕规则对象。', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'example' => 'demo.aliyundoc.com', + ], + 'App' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'example' => 'App Name', + ], + 'SubtitleName' => [ + 'description' => '字幕模板名称。', + 'type' => 'string', + 'example' => 'sub1', + ], + 'IsLazy' => [ + 'description' => '是否拉流触发。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RulesId' => [ + 'description' => '字幕规则ID。', + 'type' => 'string', + 'example' => '72fba656-2cc2-40fd-923c-2a10c3b9****', + ], + 'LiveTemplate' => [ + 'description' => '字幕输出规格。', + 'type' => 'string', + 'example' => 'lp_ld', + ], + 'GmtModifyTime' => [ + 'description' => '最近修改时间（时间戳）。', + 'type' => 'string', + 'example' => '1715594344000', + ], + 'SuffixName' => [ + 'description' => '字幕后缀。', + 'type' => 'string', + 'example' => 'test0506', + ], + 'StudioName' => [ + 'description' => '虚拟背景模板名称', + 'type' => 'string', + 'example' => 'test0708', + ], + 'Description' => [ + 'description' => '规则描述。', + 'type' => 'string', + 'example' => 'live AI subtitle template', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'IncorrectSubtitleStatus.%s', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0df228-4a64- af62-20e91b96****\\",\\n \\"RuleInfoList\\": {\\n \\"RuleInfo\\": [\\n {\\n \\"Domain\\": \\"demo.aliyundoc.com\\",\\n \\"App\\": \\"App Name\\",\\n \\"SubtitleName\\": \\"sub1\\",\\n \\"IsLazy\\": true,\\n \\"RulesId\\": \\"72fba656-2cc2-40fd-923c-2a10c3b9****\\",\\n \\"LiveTemplate\\": \\"lp_ld\\",\\n \\"GmtModifyTime\\": \\"1715594344000\\",\\n \\"SuffixName\\": \\"test0506\\",\\n \\"StudioName\\": \\"test0708\\",\\n \\"Description\\": \\"live AI subtitle template\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveAIProduceRulesResponse>\\n <RequestId>5c6a2a0df228-4a64- af62-20e91b96****</RequestId>\\n <RuleInfoList>\\n <Domain>demo.aliyundoc.com</Domain>\\n <App>App Name</App>\\n <SubtitleName>sub1</SubtitleName>\\n <IsLazy>true</IsLazy>\\n <IsOrigin>true</IsOrigin>\\n <RulesId>72fba656-2cc2-40fd-923c-2a10c3b9****</RulesId>\\n <LiveTemplate>lp_ld</LiveTemplate>\\n <GmtModifyTime>1715594344000</GmtModifyTime>\\n <SuffixName>test0506</SuffixName>\\n <Description>live AI subtitle template</Description>\\n </RuleInfoList>\\n</DescribeLiveAIProduceRulesResponse>","errorExample":""}]', + 'title' => '查询字幕规则', + 'description' => '本接口支持查询字幕规则列表信息，调用时请保证参数设置符合要求。'."\n" + .'><notice>当前实时字幕功能处于邀测阶段，单个用户最多可添加300个字幕模板。'."\n" + .'></notice>'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateLiveAIProduceRules' => [ + 'summary' => '更新字幕规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218935', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播放域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'AppName', + ], + ], + [ + 'name' => 'Suffix', + 'in' => 'query', + 'schema' => [ + 'description' => '后缀匹配', + 'type' => 'string', + 'required' => false, + 'example' => 'test01', + ], + ], + [ + 'name' => 'SubtitleName', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕模板名称', + 'type' => 'string', + 'required' => false, + 'example' => 'sub01', + ], + ], + [ + 'name' => 'StudioName', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟背景模板名称', + 'type' => 'string', + 'required' => false, + 'example' => 'sub02', + ], + ], + [ + 'name' => 'IsLazy', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拉流触发。取值：'."\n" + .'- true：拉流时启动字幕，若5分钟内没有拉流则会断掉字幕，后续再有拉流才会启动。'."\n" + .'- false：只要有推流就启动字幕，与是否有拉流无关。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RulesId', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕规则ID。', + 'type' => 'string', + 'required' => false, + 'example' => '445409ec-7eaa-461d -8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'LiveTemplate', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕输出规格，取值：'."\n" + .'- 横屏流畅360P 640x360：`lp_ld`'."\n" + .'- 竖屏流畅 360P 360x640：`lp_ld_v`'."\n" + .'- 横屏标清 480P 854x480：`lp_sd`'."\n" + .'- 竖屏标清 480P 480x854：`lp_sd_v`'."\n" + .'- 横屏高清 720P 1280x720：`lp_hd`'."\n" + .'- 竖屏高清 720P 720x1280：`lp_hd_v`'."\n" + .'- 横屏超清 1080P 1920x1080：`lp_ud`'."\n" + .'- 竖屏超清 1080P 1080x1920：`lp_ud_v`', + 'type' => 'string', + 'required' => false, + 'example' => 'lp_ld', + ], + ], + [ + 'name' => 'SubtitleId', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕规则描述。可包含中英文、数字、字符，不超过128位。', + 'type' => 'string', + 'required' => false, + 'example' => 'live AI subtitle template', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64-af62-20e91b96****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0df228-4a64-af62-20e91b96****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveAIProduceRulesResponse>\\n <RequestId>5c6a2a0df228-4a64-af62-20e91b96****</RequestId>\\n</UpdateLiveAIProduceRulesResponse>","errorExample":""}]', + 'title' => '更新实时字幕规则', + 'description' => '本接口支持对指定字幕规则各项参数进⾏更新调整。'."\n" + ."\n" + .'><notice>当前实时字幕功能处于邀测阶段，单个用户最多可添加300个字幕模板。'."\n" + .'></notice>'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'AddLiveAIProduceRules' => [ + 'summary' => '添加字幕规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218952', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流应用名称。不超过256字符，支持数字、大小写字母、短划线（-）、下划线（_）AppName名称与推流地址中的AppName名称对应，模板才能生效。', + 'type' => 'string', + 'required' => true, + 'example' => 'AppName', + ], + ], + [ + 'name' => 'Suffix', + 'in' => 'query', + 'schema' => [ + 'description' => '后缀匹配', + 'type' => 'string', + 'required' => false, + 'example' => 'test01', + ], + ], + [ + 'name' => 'SubtitleName', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕模板名称', + 'type' => 'string', + 'required' => false, + 'example' => 'sub01', + ], + ], + [ + 'name' => 'StudioName', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟背景模板名称', + 'type' => 'string', + 'required' => false, + 'example' => 'sub02', + ], + ], + [ + 'name' => 'IsLazy', + 'in' => 'query', + 'schema' => [ + 'description' => '拉流触发。取值：'."\n" + .'- true：拉流时启动字幕，若5分钟内没有拉流则会断掉字幕，后续再有拉流才会启动。'."\n" + .'- false：只要有推流就启动字幕，与是否有拉流无关。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'LiveTemplate', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕输出规格，取值：'."\n" + .'- 横屏流畅 360P 640x360：`lp_ld`'."\n" + .'- 竖屏流畅 360P 360x640：`lp_ld_v`'."\n" + .'- 横屏标清 480P 854x480：`lp_sd`'."\n" + .'- 竖屏标清 480P 480x854：`lp_sd_v`'."\n" + .'- 横屏高清 720P 1280x720：`lp_hd`'."\n" + .'- 竖屏高清 720P 720x1280：`lp_hd_v`'."\n" + .'- 横屏超清 1080P 1920x1080：`lp_ud`'."\n" + .'- 竖屏超清 1080P 1080x1920：`lp_ud_v`', + 'type' => 'string', + 'required' => true, + 'example' => 'lp_ld', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕规则描述。可包含中英文、数字、字符，不超过128位。', + 'type' => 'string', + 'required' => false, + 'example' => 'live AI subtitle template', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64-af62-20e91b96****', + ], + 'RulesId' => [ + 'description' => '字幕规则ID。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0df228-4a64-af62-20e91b96****\\",\\n \\"RulesId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddLiveAIProduceRulesResponse>\\n <RequestId>5c6a2a0df228-4a64-af62-20e91b96****</RequestId>\\n <RulesId>445409ec-7eaa-461d-8f29-4bec2eb9****</RulesId>\\n</AddLiveAIProduceRulesResponse>","errorExample":""}]', + 'title' => '添加实时字幕规则', + 'description' => '- 调用[AddLiveAISubtitle](~~2848222~~)接口添加字幕模板后，可使用本接口添加字幕规则。'."\n" + ."\n" + .'- 播放字幕流需要在播放地址的StreamName后加_{字幕模板名称}：'."\n" + .' - RTMP：rtmp://example.aliyundoc.com/app/stream_{字幕模板名称}?auth_key={鉴权串}'."\n" + .' - FLV：http://example.aliyundoc.com/app/stream_{字幕模板名称}.flv?auth_key={鉴权串}'."\n" + .' - M3U8：http://example.aliyundoc.com/app/stream_{字幕模板名称}.m3u8?auth_key={鉴权串}'."\n" + ."\n" + .'><notice>当前实时字幕功能处于邀测阶段，单个用户最多可添加300个字幕模板。'."\n" + .'></notice>'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'AddLiveAISubtitle' => [ + 'summary' => '调用AddLiveAISubtitle添加字幕模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220749', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'SubtitleName', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕模板名称，仅支持数字、大小写字母或短横线-，短横线不和位于首位。', + 'type' => 'string', + 'required' => true, + 'example' => 'sub01', + ], + ], + [ + 'name' => 'SrcLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '源语言，取值：'."\n" + .'- 英文：en-US'."\n" + .'- 中文：zh-CN'."\n" + .'- 俄文：ru-RU', + 'type' => 'string', + 'required' => true, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'DstLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '翻译目标语言，取值：'."\n" + .'- 英文：en-US'."\n" + .'- 中文：zh-CN'."\n" + .'- 西班牙文：es-ES'."\n" + .'- 俄文：ru-RU', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'FontColor', + 'in' => 'query', + 'schema' => [ + 'description' => '字体颜色，RGBA值。', + 'type' => 'string', + 'required' => false, + 'example' => '0xFFFFFF', + ], + ], + [ + 'name' => 'FontName', + 'in' => 'query', + 'schema' => [ + 'description' => '字体，取值：'."\n" + .'- KaiTi-楷体，默认'."\n" + .'- AlibabaPuHuiTi-Regular-阿里巴巴普惠体-常规'."\n" + .'- AlibabaPuHuiTi-Bold-阿里巴巴普惠体-粗体'."\n" + .'- AlibabaPuHuiTi-Light-阿里巴巴普惠体-细体'."\n" + .'- NotoSansHans-Regular-思源黑体-常规'."\n" + .'- NotoSansHans-Bold-思源黑体-粗体'."\n" + .'- NotoSansHans-Light-思源黑体-细体', + 'type' => 'string', + 'required' => false, + 'example' => 'KaiTi', + ], + ], + [ + 'name' => 'BgColor', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕背景颜色，RGBA值。', + 'type' => 'string', + 'required' => false, + 'example' => '0xFF0000', + ], + ], + [ + 'name' => 'PositionNormalized', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '字幕位置信息', + 'type' => 'array', + 'items' => [ + 'description' => '字幕位置。以屏幕左下角为起点的x,y轴。'."\n" + .'> x,y需要进行归一化计算。实际数值需要乘以画面高度。如画面高度为720p设置的PositionNormalized为[0.1,0.5] ，则字幕的实际位置是 x轴为72，y轴为360。 ', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '[0.32,0.27]', + ], + 'required' => true, + ], + ], + [ + 'name' => 'ShowSourceLan', + 'in' => 'query', + 'schema' => [ + 'description' => '是否显示源语言，ShowSourceLan默认为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MaxLines', + 'in' => 'query', + 'schema' => [ + 'description' => '显示行数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'WordPerLine', + 'in' => 'query', + 'schema' => [ + 'description' => '每行显示字数，取值范围：支持输入【1,500】内的整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'FontSizeNormalized', + 'in' => 'query', + 'schema' => [ + 'description' => '字体尺寸，取值范围：【0,1】', + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '0.037', + ], + ], + [ + 'name' => 'BorderWidthNormalized', + 'in' => 'query', + 'schema' => [ + 'description' => '字体粗细，取值范围：【0,1】', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.05', + ], + ], + [ + 'name' => 'BgWidthNormalized', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕背景尺寸，取值范围：【0,1】', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.09', + ], + ], + [ + 'name' => 'CopyFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '复制的字幕模板，传值SubtitleName', + 'type' => 'string', + 'required' => false, + 'example' => 'sub01', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义字幕描述信息。可包含中英文、数字、字符，不超过128位。', + 'type' => 'string', + 'required' => false, + 'example' => 'live AI subtitle template', + ], + ], + [ + 'name' => 'Width', + 'in' => 'query', + 'schema' => [ + 'description' => '预览画面宽度，单位：px', + 'type' => 'string', + 'required' => false, + 'example' => '1280', + ], + ], + [ + 'name' => 'Height', + 'in' => 'query', + 'schema' => [ + 'description' => '预览画面高度，单位：px'."\n" + ."\n" + .'预览画面宽度x高度仅支持以下规格： '."\n" + .'- 横屏流畅 360P 640x360 '."\n" + .'- 竖屏流畅 360P 360x640'."\n" + .'- 横屏标清 480P 854x480'."\n" + .'- 竖屏标清 480P 480x854'."\n" + .'- 横屏高清 720P 1280x720'."\n" + .'- 竖屏高清 720P 720x1280'."\n" + .'- 横屏超清 1080P 1920x1080'."\n" + .'- 竖屏超清 1080P 1080x1920', + 'type' => 'string', + 'required' => false, + 'example' => '720', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64-af62-20e91b96****', + ], + 'SubtitleId' => [ + 'description' => '字幕模板ID。', + 'type' => 'string', + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0df228-4a64-af62-20e91b96****\\",\\n \\"SubtitleId\\": \\"445409ec-7eaa-461d-8f29-4bec2eb9****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddLiveAISubtitleResponse>\\n <RequestId>5c6a2a0df228-4a64-af62-20e91b96****</RequestId>\\n <SubtitleId>445409ec-7eaa-461d-8f29-4bec2eb9****</SubtitleId>\\n</AddLiveAISubtitleResponse>","errorExample":""}]', + 'title' => '添加直播字幕模板', + 'description' => '## 使用说明'."\n" + ."\n" + .'- 本接口支持添加直播字幕模板配置，模板配置支持描述字幕内容、布局等信息。'."\n" + .'- 添加字幕模板后，您还需要调用[AddLiveAIProduceRules](~~2799676~~)接口添加字幕规则，重新推流后，播流中才能带字幕。'."\n" + .'- 实时字幕仅支持北京、上海、新加坡、印尼、沙特区域。'."\n" + ."\n" + .'><notice>当前实时字幕功能处于公测阶段，单个用户最多可添加300个字幕模板。暂时免费使用，公测结束后将正常收费，具体时间另行通知。'."\n" + .'></notice>'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'DeleteLiveAISubtitle' => [ + 'summary' => '调用DeleteLiveAISubtitle删除指定字幕模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218856', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'SubtitleId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '字幕模板ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'SubtitleName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '字幕模板名称，仅支持数字、大小写字母或短横线-，短横线不和位于首位。', + 'type' => 'string', + 'required' => false, + 'example' => 'sub01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64-af62-20e91b96****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0df228-4a64-af62-20e91b96****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveAISubtitleResponse>\\n <RequestId>5c6a2a0df228-4a64-af62-20e91b96****</RequestId>\\n</DeleteLiveAISubtitleResponse>","errorExample":""}]', + 'title' => '删除字幕模板', + 'description' => '本接口支持删除直播指定的字幕模板。'."\n" + ."\n" + .'><notice>当前实时字幕功能处于邀测阶段，单个用户最多可添加300个字幕模板。'."\n" + .'></notice>'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'UpdateLiveAISubtitle' => [ + 'summary' => '调用UpdateLiveAISubtitle更新字幕模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218740', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'SubtitleName', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕模板名称，仅支持数字、大小写字母或短横线-，短横线不和位于首位。', + 'type' => 'string', + 'required' => false, + 'example' => 'live AI subtitle template', + ], + ], + [ + 'name' => 'SrcLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '源语言，取值：'."\n" + .'- 英文：en-US'."\n" + .'- 中文：zh-CN'."\n" + .'- 俄文：ru-RU', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'DstLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '翻译目标语言，取值：'."\n" + .'- 英文：en-US'."\n" + .'- 中文：zh-CN'."\n" + .'- 西班牙文：es-ES'."\n" + .'- 俄文：ru-RU', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'FontColor', + 'in' => 'query', + 'schema' => [ + 'description' => '字体颜色，RGBA值。', + 'type' => 'string', + 'required' => false, + 'example' => '0xFFFFFF', + ], + ], + [ + 'name' => 'FontName', + 'in' => 'query', + 'schema' => [ + 'description' => '字体，取值：'."\n" + .'- KaiTi-楷体，默认'."\n" + .'- AlibabaPuHuiTi-Regular-阿里巴巴普惠体-常规'."\n" + .'- AlibabaPuHuiTi-Bold-阿里巴巴普惠体-粗体'."\n" + .'- AlibabaPuHuiTi-Light-阿里巴巴普惠体-细体'."\n" + .'- NotoSansHans-Regular-思源黑体-常规'."\n" + .'- NotoSansHans-Bold-思源黑体-粗体'."\n" + .'- NotoSansHans-Light-思源黑体-细体', + 'type' => 'string', + 'required' => false, + 'example' => 'KaiTi', + ], + ], + [ + 'name' => 'BgColor', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕背景颜色，RGBA值。', + 'type' => 'string', + 'required' => false, + 'example' => '0xFF0000', + ], + ], + [ + 'name' => 'PositionNormalized', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '字幕位置信息', + 'type' => 'array', + 'items' => [ + 'description' => '字幕位置，以屏幕左下角为起点的x,y轴。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '[0.32,0.27]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ShowSourceLan', + 'in' => 'query', + 'schema' => [ + 'description' => '是否显示源语言，ShowSourceLan默认为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MaxLines', + 'in' => 'query', + 'schema' => [ + 'description' => '显示行数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'WordPerLine', + 'in' => 'query', + 'schema' => [ + 'description' => '每行显示字数，取值范围：支持输入【1,500】内的整数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'FontSizeNormalized', + 'in' => 'query', + 'schema' => [ + 'description' => '字体尺寸，取值范围：【0,1】', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.037', + ], + ], + [ + 'name' => 'BorderWidthNormalized', + 'in' => 'query', + 'schema' => [ + 'description' => '字体粗细，取值范围：【0,1】', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.05', + ], + ], + [ + 'name' => 'BgWidthNormalized', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕背景尺寸，取值范围：【0,1】', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.09', + ], + ], + [ + 'name' => 'SubtitleId', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕模板ID', + 'type' => 'string', + 'required' => true, + 'example' => '597991f3-6ef9-4100-9238-82951de1****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义字幕描述信息。可包含中英文、数字、字符，不超过128位。', + 'type' => 'string', + 'required' => false, + 'example' => 'live AI subtitle template', + ], + ], + [ + 'name' => 'Width', + 'in' => 'query', + 'schema' => [ + 'description' => '预览画面宽度，单位：px', + 'type' => 'string', + 'required' => false, + 'example' => '1280', + ], + ], + [ + 'name' => 'Height', + 'in' => 'query', + 'schema' => [ + 'description' => '预览画面高度，单位：px'."\n" + ."\n" + .'预览画面宽度x高度仅支持以下规格：'."\n" + .'- 横屏流畅 360P 640x360'."\n" + .'- 竖屏流畅 360P 360x640'."\n" + .'- 横屏标清 480P 854x480'."\n" + .'- 竖屏标清 480P 480x854'."\n" + .'- 横屏高清 720P 1280x720'."\n" + .'- 竖屏高清 720P 720x1280'."\n" + .'- 横屏超清 1080P 1920x1080'."\n" + .'- 竖屏超清 1080P 1080x1920', + 'type' => 'string', + 'required' => false, + 'example' => '720', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'String 5c6a2a0df228-4a64- af62-20e91b96****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"String\\\\t5c6a2a0df228-4a64- af62-20e91b96****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveAISubtitleResponse>\\n <RequestId>String\\t5c6a2a0df228-4a64- af62-20e91b96****</RequestId>\\n</UpdateLiveAISubtitleResponse>","errorExample":""}]', + 'title' => '更新字幕模板', + 'description' => '## 使用说明'."\n" + ."\n" + .'本接口支持对指定字幕模板各项参数进⾏更新调整。'."\n" + ."\n" + .'><notice>当前实时字幕功能处于邀测阶段，单个用户最多可添加300个字幕模板。'."\n" + .'></notice>'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'DescribeLiveAISubtitle' => [ + 'summary' => '调用DescribeLiveAISubtitle查询字幕模板列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218857', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'SubtitleId', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => '445409ec-7eaa-461d-8f29-4bec2eb9****', + ], + ], + [ + 'name' => 'SubtitleName', + 'in' => 'query', + 'schema' => [ + 'description' => '字幕模板名称，仅支持数字、大小写字母或短横线-，短横线不和位于首位。', + 'type' => 'string', + 'required' => false, + 'example' => 'sub01', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页数。取值范围【1,100】', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页模板数值。取值范围【1,100】', + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'IsDefault', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询字幕默认模版，取值范围：'."\n" + .'- true，查询。'."\n" + .'- false，不查询。'."\n" + .'> 默认模版：系统预先内置的参数集，用户可以通过AddLiveAISubtitle接口的copyFrom参数使用。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64- af62-20e91b96****', + ], + 'SubtitleConfigs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubtitleConfig' => [ + 'description' => '字幕模板信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '字幕模板信息对象', + 'type' => 'object', + 'properties' => [ + 'DstLanguage' => [ + 'description' => '翻译目标语言', + 'type' => 'string', + 'example' => 'zh-CN', + ], + 'SrcLanguage' => [ + 'description' => '源语言', + 'type' => 'string', + 'example' => 'zh-CN', + ], + 'FontColor' => [ + 'description' => '字体颜色', + 'type' => 'string', + 'example' => '0xFFFFFF', + ], + 'FontName' => [ + 'description' => '字体', + 'type' => 'string', + 'example' => 'AlibabaPuHuiTi-Regular', + ], + 'ShowSourceLan' => [ + 'description' => '是否显示源语言', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'true', + ], + 'MaxLines' => [ + 'description' => '显示行数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'WordPerline' => [ + 'description' => '每行显示字数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PositionNormalized' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Position' => [ + 'description' => '字幕位置信息', + 'type' => 'array', + 'items' => [ + 'description' => '字幕位置', + 'type' => 'number', + 'format' => 'float', + 'example' => '[0.3,0.35]', + ], + ], + ], + ], + 'BgColor' => [ + 'description' => '字幕背景颜色', + 'type' => 'string', + 'example' => '0xFF0000', + ], + 'BgWidthNormalized' => [ + 'description' => '字幕背景尺寸', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.09', + ], + 'BorderWidthNormalized' => [ + 'description' => '字体粗细', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.05', + ], + 'Width' => [ + 'description' => '预览画面宽度', + 'type' => 'string', + 'example' => '1280', + ], + 'Height' => [ + 'description' => '预览画面高度', + 'type' => 'string', + 'example' => '720', + ], + 'SubtitleName' => [ + 'description' => '字幕模板名称', + 'type' => 'string', + 'example' => 'sub1', + ], + 'SubtitleId' => [ + 'description' => '字幕模板ID', + 'type' => 'string', + 'example' => '597991f3-6ef9-4100-9238-82951de1****', + ], + 'RulesRefer' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RulesId' => [ + 'description' => '字幕规则信息', + 'type' => 'array', + 'items' => [ + 'description' => '字幕规则ID', + 'type' => 'string', + 'example' => '1419783e-0dd2-4485-a298-6e4a0e4e****', + ], + ], + ], + ], + 'FontSizeNormalized' => [ + 'description' => '字体尺寸', + 'type' => 'string', + 'example' => '0.037', + ], + 'Description' => [ + 'description' => '描述信息', + 'type' => 'string', + 'example' => 'live AI subtitle template', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5c6a2a0df228-4a64- af62-20e91b96****\\",\\n \\"SubtitleConfigs\\": {\\n \\"SubtitleConfig\\": [\\n {\\n \\"DstLanguage\\": \\"zh-CN\\",\\n \\"SrcLanguage\\": \\"zh-CN\\",\\n \\"FontColor\\": \\"0xFFFFFF\\",\\n \\"FontName\\": \\"AlibabaPuHuiTi-Regular\\",\\n \\"ShowSourceLan\\": 0,\\n \\"MaxLines\\": 2,\\n \\"WordPerline\\": 20,\\n \\"PositionNormalized\\": {\\n \\"Position\\": [\\n 0\\n ]\\n },\\n \\"BgColor\\": \\"0xFF0000\\",\\n \\"BgWidthNormalized\\": 0.09,\\n \\"BorderWidthNormalized\\": 0.05,\\n \\"Width\\": \\"1280\\",\\n \\"Height\\": \\"720\\",\\n \\"SubtitleName\\": \\"sub1\\",\\n \\"SubtitleId\\": \\"597991f3-6ef9-4100-9238-82951de1****\\",\\n \\"RulesRefer\\": {\\n \\"RulesId\\": [\\n \\"1419783e-0dd2-4485-a298-6e4a0e4e****\\"\\n ]\\n },\\n \\"FontSizeNormalized\\": \\"0.037\\",\\n \\"Description\\": \\"live AI subtitle template\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveAISubtitleResponse>\\n <RequestId>5c6a2a0df228-4a64- af62-20e91b96****</RequestId>\\n <SubtitleConfigs>\\n <DstLanguage>zh-CN</DstLanguage>\\n <SrcLanguage>zh-CN</SrcLanguage>\\n <FontColor>0xFFFFFF</FontColor>\\n <FontName>AlibabaPuHuiTi-Regular</FontName>\\n <MaxLines>2</MaxLines>\\n <WordPerline>20</WordPerline>\\n <PositionNormalized>[0.3,0.35]</PositionNormalized>\\n <BgColor>0xFF0000</BgColor>\\n <BgWidthNormalized>0.09</BgWidthNormalized>\\n <BorderWidthNormalized>0.05</BorderWidthNormalized>\\n <Width>1280</Width>\\n <Height>720</Height>\\n <SubtitleName>sub1</SubtitleName>\\n <SubtitleId>597991f3-6ef9-4100-9238-82951de1****</SubtitleId>\\n <RulesRefer>1419783e-0dd2-4485-a298-6e4a0e4e****</RulesRefer>\\n <FontSizeNormalized>0.037</FontSizeNormalized>\\n <Description>live AI subtitle template</Description>\\n </SubtitleConfigs>\\n</DescribeLiveAISubtitleResponse>","errorExample":""}]', + 'title' => '查询字幕模板', + 'description' => '本接口支持指定分页参数查询字幕模板列表信息，调用时请保证参数设置符合要求。'."\n" + ."\n" + .'><notice>当前实时字幕功能处于邀测阶段，单个用户最多可添加300个字幕模板。'."\n" + .'></notice>'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'CreateLiveAIStudio' => [ + 'summary' => '本接口用于创建轻量化虚拟演播模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250868', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StudioName', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟演播模板名称，不可重复', + 'type' => 'string', + 'required' => true, + 'example' => 'stu02', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义描述信息。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'template 1080', + ], + ], + [ + 'name' => 'Width', + 'in' => 'query', + 'schema' => [ + 'description' => '预览画面宽度，单位：px', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1920', + ], + ], + [ + 'name' => 'Height', + 'in' => 'query', + 'schema' => [ + 'description' => '预览画面高度，单位：px'."\n" + ."\n" + .'预览画面宽度x高度仅支持以下规格：'."\n" + ."\n" + .'- 横屏流畅 360P 640x360'."\n" + .'- 竖屏流畅 360P 360x640'."\n" + .'- 横屏标清 480P 854x480'."\n" + .'- 竖屏标清 480P 480x854'."\n" + .'- 横屏高清 720P 1280x720'."\n" + .'- 竖屏高清 720P 720x1280'."\n" + .'- 横屏超清 1080P 1920x1080'."\n" + .'- 竖屏超清 1080P 1080x1920', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1080', + ], + ], + [ + 'name' => 'BackgroundType', + 'in' => 'query', + 'schema' => [ + 'description' => '背景素材类型：'."\n" + .'- VOD 点播视频'."\n" + .'- PIC 图片'."\n" + .'- LIVE 直播流', + 'type' => 'string', + 'required' => false, + 'example' => 'VOD', + 'enum' => [ + 'VOD', + 'LIVE', + 'PIC', + ], + ], + ], + [ + 'name' => 'BackgroundResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '背景素材的点播资源id，从点播控制台获取', + 'type' => 'string', + 'required' => false, + 'example' => 'd0eb493192c771efba644531858c0102', + 'enum' => [], + ], + ], + [ + 'name' => 'BackgroundResourceUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '背景素材的资源访问url，与资源id二选一传入', + 'type' => 'string', + 'required' => false, + 'example' => 'https://xxx.com/1.mp4', + 'enum' => [], + ], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => [ + 'description' => '多媒体素材类型：'."\n" + .'- VOD 点播视频'."\n" + .'- PIC 图片'."\n" + .'- LIVE 直播流', + 'type' => 'string', + 'required' => false, + 'example' => 'VOD', + 'enum' => [ + 'VOD', + 'LIVE', + 'PIC', + ], + ], + ], + [ + 'name' => 'MediaResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '多媒体素材的点播资源id，从点播控制台获取', + 'type' => 'string', + 'required' => false, + 'example' => 'd0eb493192c771efba644531858c0102', + 'enum' => [], + ], + ], + [ + 'name' => 'MediaResourceUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '多媒体素材的资源访问url，与资源id二选一传入', + 'type' => 'string', + 'required' => false, + 'example' => 'https://xxx.com/2.mp4', + 'enum' => [], + ], + ], + [ + 'name' => 'MediaLayout', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '多媒体素材的布局位置信息', + 'type' => 'object', + 'properties' => [ + 'PositionX' => [ + 'description' => '位置参数，坐标x。取值：**0~1**。素材位置以左上角为基准点。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'PositionY' => [ + 'description' => '位置参数，坐标y。取值：**0~1**。素材位置以左上角为基准点。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'HeightNormalized' => [ + 'description' => '素材的高度归一化值。即素材与背景的高度比。取值：**0~1**。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.5', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'MattingType', + 'in' => 'query', + 'schema' => [ + 'description' => '抠图类型：'."\n" + .'- green 绿幕抠图'."\n" + .'- blue 蓝幕抠图'."\n" + .'- complex 实景抠图', + 'type' => 'string', + 'required' => true, + 'example' => 'complex', + 'enum' => [ + 'green', + 'blue', + 'complex', + ], + ], + ], + [ + 'name' => 'MattingLayout', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '源流抠图后的布局位置信息', + 'type' => 'object', + 'properties' => [ + 'PositionX' => [ + 'description' => '位置参数，坐标x。取值：**0~1**。素材位置以左上角为基准点。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.3', + ], + 'PositionY' => [ + 'description' => '位置参数，坐标y。取值：**0~1**。素材位置以左上角为基准点。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.3', + ], + 'HeightNormalized' => [ + 'description' => '素材的高度归一化值。即素材与背景的高度比。取值：**0~1**。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.5', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => '17D7526C-69AD-5761-8037-071C27358345', + ], + 'StudioId' => [ + 'title' => 'Id of the request', + 'description' => '演播模版id', + 'type' => 'string', + 'example' => '369ced1f-c33a-49e5-91da-bdaae3d6c1c2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'LiveServiceNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.PurchaseTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.ExpireTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidChargeType.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidChargeType.PostSupport', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterTemplate.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidParameter.ChargeType', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidPeriod.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidClientToken.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectCasterStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'CasterNumberExceed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDenied', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameter.NormType', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidConfiguration.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 408 => [ + [ + 'errorCode' => 'CreateLiveAIStudio.Timeout', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17D7526C-69AD-5761-8037-071C27358345\\",\\n \\"StudioId\\": \\"369ced1f-c33a-49e5-91da-bdaae3d6c1c2\\"\\n}","type":"json"}]', + 'title' => '创建虚拟演播模版', + 'description' => '><notice>轻量化虚拟演播功能处于公测阶段，单个用户最多创建300个模板。暂时免费使用，公测结束后将正常收费，具体时间另行通知。></notice>', + ], + 'DeleteLiveAIStudio' => [ + 'summary' => '删除虚拟演播模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239775', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StudioId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID，由CreateLiveAIStudio接口返回', + 'type' => 'string', + 'required' => true, + 'example' => '369ced1f-c33a-49e5-91da-bdaae3d6c1c2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => '40A4F36D-A7CC-473A-88E7-154F92242566', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'LiveServiceNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.PurchaseTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParameter.ExpireTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidChargeType.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidChargeType.PostSupport', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterTemplate.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidParameter.ChargeType', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidPeriod.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidClientToken.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectStudioStatus.Inuse', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'CasterNumberExceed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDenied', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameter.NormType', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidConfiguration.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 408 => [ + [ + 'errorCode' => 'DeleteLiveAIStudio.Timeout', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40A4F36D-A7CC-473A-88E7-154F92242566\\"\\n}","type":"json"}]', + 'title' => '删除虚拟演播模板', + 'description' => '删除虚拟演播模板，删除前必须解绑规则，否则报错'."\n" + ."\n\n" + .'><notice>当前虚拟演播轻量化功能处于邀测阶段，单个用户最多可添加300个模板。></notice>', + ], + 'ModifyLiveAIStudio' => [ + 'summary' => '本接口用于修改指定的虚拟演播模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250887', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StudioName', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟演播模板名称，与创建接口中的入参StudioName相同', + 'type' => 'string', + 'required' => true, + 'example' => 'stu02', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom', + ], + ], + [ + 'name' => 'Width', + 'in' => 'query', + 'schema' => [ + 'description' => '预览画面宽度，单位：px', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1920', + ], + ], + [ + 'name' => 'Height', + 'in' => 'query', + 'schema' => [ + 'description' => '预览画面高度，单位：px'."\n" + ."\n" + .'预览画面宽度x高度仅支持以下规格：'."\n" + ."\n" + .'- 横屏流畅 360P 640x360'."\n" + .'- 竖屏流畅 360P 360x640'."\n" + .'- 横屏标清 480P 854x480'."\n" + .'- 竖屏标清 480P 480x854'."\n" + .'- 横屏高清 720P 1280x720'."\n" + .'- 竖屏高清 720P 720x1280'."\n" + .'- 横屏超清 1080P 1920x1080'."\n" + .'- 竖屏超清 1080P 1080x1920', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1080', + ], + ], + [ + 'name' => 'BackgroundType', + 'in' => 'query', + 'schema' => [ + 'description' => '背景素材类型：'."\n" + .'- VOD 点播视频'."\n" + .'- PIC 图片'."\n" + .'- LIVE 直播流', + 'type' => 'string', + 'required' => false, + 'example' => 'VOD'."\n", + 'enum' => [ + 'VOD', + 'LIVE', + 'PIC', + ], + ], + ], + [ + 'name' => 'BackgroundResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '背景素材的点播资源id，从点播控制台获取', + 'type' => 'string', + 'required' => false, + 'example' => 'd0eb493192c771efba644531858c0102', + 'enum' => [], + ], + ], + [ + 'name' => 'BackgroundResourceUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '背景素材的资源访问url', + 'type' => 'string', + 'required' => false, + 'example' => 'https://xxx.com/2.mp4'."\n", + 'enum' => [], + ], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => [ + 'description' => '多媒体素材类型：'."\n" + .'- VOD 点播视频'."\n" + .'- PIC 图片'."\n" + .'- LIVE 直播流', + 'type' => 'string', + 'required' => false, + 'example' => 'VOD', + 'enum' => [ + 'VOD', + 'LIVE', + 'PIC', + ], + ], + ], + [ + 'name' => 'MediaResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '多媒体素材的点播资源id，从点播控制台获取', + 'type' => 'string', + 'required' => false, + 'example' => 'd0eb493192c771efba644531858c01102', + 'enum' => [], + ], + ], + [ + 'name' => 'MediaResourceUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '多媒体素材的资源访问url，与资源id二选一传入', + 'type' => 'string', + 'required' => false, + 'example' => 'https://xxx.com/1.mp4'."\n", + 'enum' => [], + ], + ], + [ + 'name' => 'MediaLayout', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '多媒体素材的位置布局信息', + 'type' => 'object', + 'properties' => [ + 'PositionX' => [ + 'description' => '位置参数，坐标x。取值：**0~1**。素材位置以左上角为基准点。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'PositionY' => [ + 'description' => '位置参数，坐标y。取值：**0~1**。素材位置以左上角为基准点。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'HeightNormalized' => [ + 'description' => '素材的高度归一化值。即素材与背景的高度比。取值：**0~1**。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.5', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'MattingType', + 'in' => 'query', + 'schema' => [ + 'description' => '抠图类型：'."\n" + .'- green 绿幕抠图'."\n" + .'- blue 蓝幕抠图'."\n" + .'- complex 实景抠图', + 'type' => 'string', + 'required' => true, + 'example' => 'complex', + 'enum' => [ + 'green', + 'blue', + 'complex', + ], + ], + ], + [ + 'name' => 'MattingLayout', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '源流抠图后的布局位置信息', + 'type' => 'object', + 'properties' => [ + 'PositionX' => [ + 'description' => '位置参数，坐标x。取值：**0~1**。素材位置以左上角为基准点。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'PositionY' => [ + 'description' => '位置参数，坐标y。取值：**0~1**。素材位置以左上角为基准点。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0', + ], + 'HeightNormalized' => [ + 'description' => '高度归一化值。即抠出的人像与背景的高度比。取值：**0~1**。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.5', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => '0BA6B3C4-525A-5381-A2B0-5351323F31C5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'LiveServiceNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.PurchaseTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.ExpireTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidChargeType.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidChargeType.PostSupport', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterTemplate.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidParameter.ChargeType', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidPeriod.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidClientToken.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectCasterStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'CasterNumberExceed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDenied', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameter.NormType', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidConfiguration.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 408 => [ + [ + 'errorCode' => 'ModifyLiveAIStudio.Timeout', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0BA6B3C4-525A-5381-A2B0-5351323F31C5\\"\\n}","type":"json"}]', + 'title' => '修改虚拟演播模板', + ], + 'DescribeLiveAIStudio' => [ + 'summary' => '查询用户账号下的虚拟演播模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239765', + 'abilityTreeNodes' => [ + 'FEATUREliveY7SMJ1', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StudioId', + 'in' => 'query', + 'schema' => [ + 'description' => '可选参数，指定筛选模板Id', + 'type' => 'string', + 'required' => false, + 'example' => 'dbe61b87-db9a-448f-8757-a875edb3f944', + ], + ], + [ + 'name' => 'StudioName', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟背景模板名称', + 'type' => 'string', + 'required' => false, + 'example' => 'sub02', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '单页显示应用的数量，默认值：10。取值范围：1~50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'Total' => [ + 'description' => '总模板数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '单页显示应用的数量，默认值：10。取值范围：1~50。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'StudioConfigs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubtitleConfig' => [ + 'description' => '虚拟演播厅模板信息', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟演播厅模板信息', + 'type' => 'object', + 'properties' => [ + 'MediaType' => [ + 'description' => '多媒体素材类型：VOD,PIC,LIVE 三选一'."\n" + ."\n\n" + .'- VOD, 点播视频文件'."\n" + .'- PIC，图片'."\n" + .'- LIVE，直播流', + 'type' => 'string', + 'example' => 'VOD', + ], + 'MediaLayout' => [ + 'description' => '多媒体布局信息', + 'type' => 'string', + 'example' => '"{\\"positionY\\":\\"0.0\\",\\"positionX\\":\\"0.0\\",\\"heightNormalized\\":\\"0.5\\"}"', + ], + 'MediaResourceUrl' => [ + 'description' => '多媒体素材链接url', + 'type' => 'string', + 'example' => 'https://testbucket.xx.com/2.jpg', + ], + 'MediaResourceId' => [ + 'description' => '多媒体素材点播资源id', + 'type' => 'string', + 'example' => ' '."\n" + .'d0eb493192c771efba644531858c0102'."\n", + ], + 'BackgroundType' => [ + 'description' => '背景素材类型：VOD,PIC,LIVE 三选一'."\n" + ."\n" + .'- VOD, 点播视频文件'."\n" + .'- PIC，图片'."\n" + .'- LIVE，直播流', + 'type' => 'string', + 'example' => 'VOD', + ], + 'BackgroundResourceUrl' => [ + 'description' => '背景素材外部访问地址，需要保证公网可用，与BackgroundResourceId二选一即可。', + 'type' => 'string', + 'example' => 'https://testbucket.xx.com/2.jpg', + ], + 'BackgroundResourceId' => [ + 'description' => '背景素材资源ID。', + 'type' => 'string', + 'example' => 'd0eb493192c771efba644531858c0102', + ], + 'Description' => [ + 'description' => '自定义规则描述信息。', + 'type' => 'string', + 'example' => 'user defined description', + ], + 'TemplateId' => [ + 'description' => '虚拟演播模板ID。', + 'type' => 'string', + 'example' => '24654384-f5ac-40ea-823b-74e85a61dd9f', + ], + 'TemplateName' => [ + 'description' => '虚拟演播模板名称。与AddLiveAiStudio中的StudioName参数相同', + 'type' => 'string', + 'example' => 'studio1', + ], + 'MattingLayout' => [ + 'description' => '多媒体素材位置布局信息。', + 'type' => 'string', + 'example' => '"{\\"positionY\\":\\"0.0\\",\\"positionX\\":\\"0.0\\",\\"heightNormalized\\":\\"0.5\\"}"', + ], + 'MattingType' => [ + 'description' => '源流抠图类型，对用户推流进行抠图处理'."\n" + ."\n" + .'- green 绿幕背景人像抠图'."\n" + .'- blue 蓝幕背景人像抠图'."\n" + .'- complex 实景人像抠图', + 'type' => 'string', + 'example' => 'complex', + ], + 'Height' => [ + 'description' => '预览画面高度，单位：px'."\n" + ."\n" + .'预览画面宽度x高度仅支持以下规格： '."\n" + .'- 横屏流畅 360P 640x360 '."\n" + .'- 竖屏流畅 360P 360x640'."\n" + .'- 横屏标清 480P 854x480'."\n" + .'- 竖屏标清 480P 480x854'."\n" + .'- 横屏高清 720P 1280x720'."\n" + .'- 竖屏高清 720P 720x1280'."\n" + .'- 横屏超清 1080P 1920x1080'."\n" + .'- 竖屏超清 1080P 1080x1920', + 'type' => 'string', + 'example' => '1080', + ], + 'Width' => [ + 'description' => '预览画面宽度。', + 'type' => 'string', + 'example' => '1920', + ], + 'RuleIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ruleId' => [ + 'description' => '绑定的策略ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '规则ID。', + 'type' => 'string', + 'example' => '2414378f-541a-48d3-be0c-535212f9a6b4', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'LiveServiceNotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.PurchaseTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.ExpireTime', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidChargeType.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidChargeType.PostSupport', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidCasterTemplate.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidParameter.Malformed', + 'errorMessage' => 'There are invalid parameters: %s.', + ], + [ + 'errorCode' => 'InvalidParameter.ChargeType', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidPeriod.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidUserId.Malformed', + 'errorMessage' => '%s, please check userId.', + ], + [ + 'errorCode' => 'InvalidClientToken.Malformed', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'IncorrectCasterStatus', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'CasterNumberExceed', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 403 => [ + [ + 'errorCode' => 'PermissionDenied', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameter.NormType', + 'errorMessage' => '%s, please check and try again later.', + ], + [ + 'errorCode' => 'InvalidConfiguration.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 408 => [ + [ + 'errorCode' => 'DescribeLiveAIStudio.Timeout', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"Total\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"StudioConfigs\\": {\\n \\"SubtitleConfig\\": [\\n {\\n \\"MediaType\\": \\"VOD\\",\\n \\"MediaLayout\\": \\"\\\\\\"{\\\\\\\\\\\\\\"positionY\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"positionX\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"heightNormalized\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.5\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"MediaResourceUrl\\": \\"https://testbucket.xx.com/2.jpg\\",\\n \\"MediaResourceId\\": \\"\\\\t\\\\nd0eb493192c771efba644531858c0102\\\\n\\",\\n \\"BackgroundType\\": \\"VOD\\",\\n \\"BackgroundResourceUrl\\": \\"https://testbucket.xx.com/2.jpg\\",\\n \\"BackgroundResourceId\\": \\"d0eb493192c771efba644531858c0102\\",\\n \\"Description\\": \\"user defined description\\",\\n \\"TemplateId\\": \\"24654384-f5ac-40ea-823b-74e85a61dd9f\\",\\n \\"TemplateName\\": \\"studio1\\",\\n \\"MattingLayout\\": \\"\\\\\\"{\\\\\\\\\\\\\\"positionY\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"positionX\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"heightNormalized\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.5\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"MattingType\\": \\"complex\\",\\n \\"Height\\": \\"1080\\",\\n \\"Width\\": \\"1920\\",\\n \\"RuleIds\\": {\\n \\"ruleId\\": [\\n \\"2414378f-541a-48d3-be0c-535212f9a6b4\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询虚拟演播模板', + ], + 'CreateLivePullToPush' => [ + 'summary' => '调用CreateLivePullToPush创建拉流转推任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240052', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '指定任务启动所在区域，取值：'."\n" + ."\n" + .'- ap-southeast-1（新加坡）'."\n" + .'- ap-southeast-5（印度尼西亚）'."\n" + .'- cn-beijing（北京）'."\n" + .'- cn-shanghai（上海）'."\n" + .'- cn-shenzhen（深圳）', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + 'enum' => [ + 'ap-northeast-1', + 'ap-southeast-1', + 'ap-southeast-5', + 'eu-central-1', + 'me-central-1', + 'cn-beijing', + 'cn-shanghai', + 'cn-shenzhen', + 'cn-qingdao', + 'preregion', + ], + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称，用于支持模糊查询，默认值为""。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间。'."\n" + ."\n" + .'> - 格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-08-26T10:30:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务结束时间。'."\n" + ."\n" + .'> - 格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'> - EndTime必须大于StartTime。'."\n" + .'> - EndTime必须大于当前时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-08-27T14:30:00Z', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '源流类型，枚举值：'."\n" + ."\n" + .'- live，直播流。'."\n" + .'- vod，阿里云视频点播资源。'."\n" + .'- url，第三方视频文件资源。', + 'type' => 'string', + 'required' => true, + 'example' => 'live', + 'enum' => [ + 'live', + 'vod', + 'url', + ], + ], + ], + [ + 'name' => 'SourceProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '源流协议名。'."\n" + ."\n" + .'取值范围'."\n" + .'- rtmp'."\n" + .'- srt'."\n" + .'- http-flv'."\n" + .'- hls'."\n" + .'> 此参数仅当**sourcetype参数取值为live时必填**，取值为vod、url时无效。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp', + 'enum' => [], + ], + ], + [ + 'name' => 'SourceUrls', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '源流URL地址列表。'."\n" + ."\n" + .'> - live类型仅支持填写1个完整直播播放URL。'."\n" + .'> - vod、url类型可填写最多30个。'."\n" + .'> - live类型支持：rtmp、rtsp、srt、http-flv协议。'."\n" + .'> - vod类型填写阿里云视频点播媒资ID。'."\n" + .'> - url类型支持：mp4、http-flv协议。', + 'type' => 'array', + 'items' => [ + 'description' => '源流URL地址。'."\n" + ."\n" + .'> - live类型仅支持填写1个完整直播播放URL。'."\n" + .'> - vod、url类型可填写最多30个。'."\n" + .'> - live类型支持：rtmp、rtsp、srt、http-flv协议。'."\n" + .'> - vod类型填写阿里云视频点播媒资ID。'."\n" + .'> - url类型支持：mp4、http-flv协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434', + ], + 'required' => true, + 'example' => 'testurls', + ], + ], + [ + 'name' => 'DstUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '推流目标URL地址。'."\n" + ."\n" + .'> - 支持rtmp协议。'."\n" + .'> - 最大长度为2000个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434', + ], + ], + [ + 'name' => 'RepeatNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '播放完后重复继续播放的次数。取值：'."\n" + ."\n" + .'- 0（默认值）：不重复播放。'."\n" + .'- -1：一直循环重复。'."\n" + .'- 其他正整数：播放完后重复继续播放的次数。'."\n" + ."\n" + .'> 此参数仅针对点播或第三方视频流。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [], + ], + ], + [ + 'name' => 'FileIndex', + 'in' => 'query', + 'schema' => [ + 'description' => '文件索引，从第n个文件开始播放起。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => [ + 'description' => '启动偏移，视频文件起始偏移值。单位：秒。取值：大于0。'."\n" + ."\n" + .'> - 表示从相对于首帧的偏差时间作为开始读取的位置（指第一个视频）。'."\n" + .'> - 此参数仅针对点播或第三方视频流。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP回调地址，默认为空。'."\n" + ."\n" + .'> - 接收任务相关回调的地址。'."\n" + .'> - 最大长度为 2000 个字符。'."\n" + .'> - 不指定本参数则不会回调相关任务事件。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://callback*****.com', + ], + ], + [ + 'name' => 'RetryInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '重试间隔，单位秒，取值区间[60,300]，默认60秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '300', + 'minimum' => '60', + 'example' => '60', + 'default' => '60', + ], + ], + [ + 'name' => 'RetryCount', + 'in' => 'query', + 'schema' => [ + 'description' => '重试次数，默认值为3。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + 'default' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68*****', + ], + 'RetCode' => [ + 'description' => '返回码。'."\n" + ."\n" + .'> - 正常情况返回“0”。'."\n" + .'> - 异常情况请参考下文错误码列表。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Description' => [ + 'description' => '错误描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'fd245384-4067-4f91-9d75-9666a6bc9****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParam.CodeIllegalDuration', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'CodeInvalidAliUid', + 'errorMessage' => 'This aliuid does not have a live domain name.', + ], + [ + 'errorCode' => 'CodeNotEnoughResource', + 'errorMessage' => 'Exceeded configuration limits or insufficient resources.', + ], + [ + 'errorCode' => 'CodeConfigAlreadyExists', + 'errorMessage' => 'Code Config Already Exists', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68*****\\",\\n \\"RetCode\\": 0,\\n \\"Description\\": \\"OK\\",\\n \\"TaskId\\": \\"fd245384-4067-4f91-9d75-9666a6bc9****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateLivePullToPushResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68*****</RequestId>\\n <RetCode>0</RetCode>\\n <Description>OK</Description>\\n <TaskId>fd245384-4067-4f91-9d75-9666a6bc9****</TaskId>\\n</CreateLivePullToPushResponse>","errorExample":""}]', + 'title' => '创建拉流转推任务', + 'description' => '><notice>拉流转推属于收费功能，于 2025年12月05日 00:00 起正式计费。></notice>'."\n" + .'- 费用详情请参见[拉流转推费用](~~2997901~~)。'."\n" + .'- 调用本接口创建拉流转推任务。'."\n" + .'- 支持创建直播拉流任务，也支持创建点播拉流任务。'."\n" + .'- 任务创建后，到了设置的开始时间，会真正开始运行，到了设置的结束时间，会自动停止并删除清理。'."\n" + .'- 任务中设置的推流目标地址需要确保未被其他任务使用，不然会因为多个任务同时转推相同地址导致推流失败。'."\n" + .'- 拉流转推回调事件包括拉流转推任务运行状态变化回调和拉流转推任务已退出回调。更多信息，请参见[拉流转推事件回调](~~2846768~~)。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateLivePullToPush' => [ + 'summary' => '调用UpdateLivePullToPush更新拉流转推任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240074', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'fd245384-4067-4f91-9d75-9666a6bc****', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '指定任务启动所在区域，取值：'."\n" + ."\n" + .'- ap-southeast-1（新加坡）'."\n" + .'- ap-southeast-5（印度尼西亚）'."\n" + .'- cn-beijing（北京）'."\n" + .'- cn-shanghai（上海）', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + 'enum' => [ + 'ap-northeast-1', + 'ap-southeast-1', + 'ap-southeast-5', + 'eu-central-1', + 'me-central-1', + 'cn-beijing', + 'cn-shanghai', + 'cn-shenzhen', + 'cn-qingdao', + 'preregion', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间。'."\n" + .'> - 格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'> - 若任务已经启动运行则更新无效。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-08-23T15:30:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务结束时间。'."\n" + .'> - 格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'> - EndTime必须大于StartTime。'."\n" + .'> - EndTime必须大于当前时间。'."\n" + .'> - 若任务已结束退出则更新无效。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-08-27T14:30:00Z', + ], + ], + [ + 'name' => 'SourceUrls', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '源流URL地址列表。'."\n" + ."\n" + .'> - live类型仅支持填写1个完整直播播放URL。'."\n" + .'> - vod、url类型可填写最多30个。'."\n" + .'> - live类型支持：rtmp、rtsp、srt、http-flv协议。'."\n" + .'> - vod类型填写阿里云视频点播媒资ID。'."\n" + .'> - url类型支持：mp4、http-flv协议。'."\n" + .'> - 针对直播源流可立即生效；针对视频文件源流，需要等当前正在播放视频结束后生效，生效后基于最新视频列表从头开始播放。'."\n" + .'> - 需要在任务停止运行的状态下更新，重启后生效。', + 'type' => 'array', + 'items' => [ + 'description' => '源流URL地址。'."\n" + ."\n" + .'> - live类型仅支持填写1个完整直播播放URL。'."\n" + .'> - vod、url类型可填写最多30个。'."\n" + .'> - live类型支持：rtmp、rtsp、srt、http-flv协议。'."\n" + .'> - vod类型填写阿里云视频点播媒资ID。'."\n" + .'> - url类型支持：mp4、http-flv协议。'."\n" + .'> - 针对直播源流可立即生效；针对视频文件源流，需要等当前正在播放视频结束后生效，生效后基于最新视频列表从头开始播放。'."\n" + .'> - 需要在任务停止运行的状态下更新，重启后生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434', + ], + 'required' => false, + 'example' => 'changedtesturl', + ], + ], + [ + 'name' => 'RepeatNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '播放完后重复继续播放的次数。取值：'."\n" + ."\n" + .'- 0（默认值）：不重复播放。'."\n" + .'- -1：一直循环重复。'."\n" + .'- 其他正整数：播放完后重复继续播放的次数。'."\n" + ."\n" + .'> - 此参数仅针对点播或第三方视频流。'."\n" + .'> - 更新后可以立即生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '-5', + 'enum' => [], + ], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => [ + 'description' => '启动偏移，视频文件起始偏移值。单位：秒。取值：大于0。'."\n" + .'> - 表示从相对于首帧的偏差时间作为开始读取的位置。'."\n" + .'> - 此参数仅针对点播或第三方视频流。'."\n" + .'> - 仅当播放视频列表第一个视频时有效。'."\n" + .'> - 需要在任务停止运行的状态下更新，重启后生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '回调地址，默认为空。'."\n" + .'> - 接收任务相关回调的地址。'."\n" + .'> - 最大长度为 2000 个字符。'."\n" + .'> - 不指定本参数则不会回调相关任务事件。'."\n" + .'> - 仅当下一次事件触发时开始生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://callback*****.com', + ], + ], + [ + 'name' => 'FileIndex', + 'in' => 'query', + 'schema' => [ + 'description' => '视频索引，默认值为0。'."\n" + .'> 需要在任务停止运行的状态下更新，重启后生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68*****', + ], + 'RetCode' => [ + 'description' => '返回码。'."\n" + ."\n" + .'> - 正常情况返回“0”。'."\n" + .'> - 异常情况请参考下文错误码列表。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Description' => [ + 'description' => '错误描述。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParam.CodeIllegalDuration', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'CodeInvalidAliUid', + 'errorMessage' => 'This aliuid does not have a live domain name.', + ], + [ + 'errorCode' => 'CodeTaskNotExist', + 'errorMessage' => 'Task does not exist.', + ], + [ + 'errorCode' => 'CodeTaskHasStarted', + 'errorMessage' => 'The task has already started.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68*****\\",\\n \\"RetCode\\": 0,\\n \\"Description\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLivePullToPushResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68*****</RequestId>\\n <RetCode>0</RetCode>\\n <Description>OK</Description>\\n</UpdateLivePullToPushResponse>","errorExample":""}]', + 'title' => '更新拉流转推任务', + 'description' => '- 调用本接口更新拉流转推任务。'."\n" + .'- 任务未到设置的开始时间，支持更新SourceType、Region和DstUrl。'."\n" + .'- 任务运行中（含异常重试状态）仅支持更新CallbackUrl和RepeatTime且更新会立即生效。'."\n" + .'- 任务已停止，除SourceType、Region和DstUrl，其他参数均允许更新。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteLivePullToPush' => [ + 'summary' => '调用DeleteLivePullToPush删除拉流转推任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238152', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '3efb43c5-18ff-49eb-92a6-005f6521****', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '指定任务启动所在区域，取值：'."\n" + ."\n" + .'- ap-southeast-1（新加坡）'."\n" + .'- ap-southeast-5（印度尼西亚）'."\n" + .'- cn-beijing（北京）'."\n" + .'- cn-shanghai（上海）', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + 'enum' => [ + 'ap-northeast-1', + 'ap-southeast-1', + 'ap-southeast-5', + 'eu-central-1', + 'me-central-1', + 'cn-beijing', + 'cn-shanghai', + 'cn-shenzhen', + 'cn-qingdao', + 'preregion', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68*****', + ], + 'RetCode' => [ + 'description' => '返回码。'."\n" + ."\n" + .'> - 正常情况返回“0”。'."\n" + .'> - 异常情况请参考下文错误码列表。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Description' => [ + 'description' => '错误描述。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + [], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'CodeInvalidAliUid', + 'errorMessage' => 'This aliuid does not have a live domain name.', + ], + [ + 'errorCode' => 'CodeTaskNotExist', + 'errorMessage' => 'Task does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68*****\\",\\n \\"RetCode\\": 0,\\n \\"Description\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLivePullToPushResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68*****</RequestId>\\n <RetCode>0</RetCode>\\n <Description>OK</Description>\\n</DeleteLivePullToPushResponse>","errorExample":""}]', + 'title' => '删除拉流转推任务', + 'description' => '- 调用本接口删除拉流转推任务。'."\n" + .'- 删除任务即清理任务，任务运行中会被立刻停止，任务无法重新启动。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLivePullToPush' => [ + 'summary' => '调用DescribeLivePullToPush查询拉流转推任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238179', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'fd245384-4067-4f91-9d75-9666a6bc****', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '指定任务启动所在区域，取值：'."\n" + .'- ap-southeast-1（新加坡）'."\n" + .'- ap-southeast-5（印度尼西亚）'."\n" + .'- cn-beijing（北京）'."\n" + .'- cn-shanghai（上海）', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + 'enum' => [ + 'ap-northeast-1', + 'ap-southeast-1', + 'ap-southeast-5', + 'eu-central-1', + 'me-central-1', + 'cn-beijing', + 'cn-shanghai', + 'cn-shenzhen', + 'cn-qingdao', + 'preregion', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'a05e6b15-15af-405b-a4a2-0152245d****', + ], + 'RetCode' => [ + 'description' => '返回码。'."\n" + .'> - 正常情况返回“0”。'."\n" + .'> - 异常情况请参考下文错误码列表。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Description' => [ + 'description' => '错误描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'TaskId' => [ + 'description' => '新建任务ID。', + 'type' => 'string', + 'example' => 'fb0d4ac7-c7e3-4978-9743-0bf2f6e8****', + ], + 'TaskStatus' => [ + 'description' => '任务当前状态：'."\n" + .'- 0：未启动（未到开始时间）。'."\n" + .'- 1：正常运行（拉流和转推正常）。'."\n" + .'- 2：异常运行。'."\n" + .'- 3：已停止（拉流或转推异常，也有可能是主动调用接口停止）.'."\n" + .'- -1：已退出。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TaskInvalidReason' => [ + 'description' => '任务停止运行原因：'."\n" + ."\n" + .'- PullStreamFailed：源流拉流异常，重试中。'."\n" + .'- PushStreamFailed：目标流推流异常，重试中。'."\n" + .'- UnknownError：未知异常。'."\n" + ."\n" + .'> 仅停止运行状态下返回。', + 'type' => 'string', + 'example' => 'PullStreamFailed', + ], + 'TaskExitTime' => [ + 'description' => '任务退出时间，Unix 秒级时间戳。'."\n" + .'> 仅已退出状态下返回。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1726354625', + ], + 'TaskExitReason' => [ + 'description' => '任务退出原因：'."\n" + ."\n" + .'- TriggerByUser：用户主动结束。'."\n" + .'- OverEndTime：超过预设结束时间。'."\n" + ."\n" + .'> 仅已退出状态下返回。', + 'type' => 'string', + 'example' => 'TriggerByUser', + ], + 'CurrentOffset' => [ + 'description' => '当前生效的视频播放偏移。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CurrentFileIndex' => [ + 'description' => '当前生效的节目单序列偏移。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TaskInfo' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'fd245384-4067-4f91-9d75-9666a6bc9****', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'StartTime' => [ + 'description' => '任务开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2024-08-26T10:30:00Z', + ], + 'EndTime' => [ + 'description' => '任务结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2024-08-27T14:30:00Z', + ], + 'SourceType' => [ + 'description' => '源流类型，枚举值：'."\n" + ."\n" + .'- live，直播流。'."\n" + .'- vod，阿里云视频点播资源。'."\n" + .'- url，第三方视频文件资源。', + 'type' => 'string', + 'example' => 'vod', + ], + 'SourceProtocol' => [ + 'description' => '源流协议名。', + 'type' => 'string', + 'example' => 'RTMP', + ], + 'SourceUrls' => [ + 'description' => '源流URL地址。', + 'type' => 'array', + 'items' => [ + 'description' => '源流URL地址。', + 'type' => 'string', + 'example' => 'rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434', + ], + 'example' => 'rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434', + ], + 'DstUrl' => [ + 'description' => '推流目标地址。', + 'type' => 'string', + 'example' => 'rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434', + ], + 'CallbackURL' => [ + 'description' => 'HTTP回调地址。', + 'type' => 'string', + 'example' => 'https://callback*****.com', + ], + 'Offset' => [ + 'description' => '启动偏移，视频文件起始偏移值。单位：秒。取值：大于0。'."\n" + .'> - 表示从相对于首帧的偏差时间作为开始读取的位置。'."\n" + .'> - 仅对点播资源或视频文件有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FileIndex' => [ + 'description' => '文件索引，从第n个文件开始播放起。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RetryCount' => [ + 'description' => '重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RetryInterval' => [ + 'description' => '重试间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'RepeatNumber' => [ + 'description' => '播放完后重复继续播放的次数。取值：'."\n" + .'- 0（默认值）：不重复播放。'."\n" + .'- -1：一直循环重复。'."\n" + .'- 其他正整数：播放完后重复继续播放的次数。'."\n" + ."\n" + .'> 此参数仅针对点播或第三方视频流。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'CodeInvalidAliUid', + 'errorMessage' => 'This aliuid does not have a live domain name.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"a05e6b15-15af-405b-a4a2-0152245d****\\",\\n \\"RetCode\\": 0,\\n \\"Description\\": \\"OK\\",\\n \\"TaskId\\": \\"fb0d4ac7-c7e3-4978-9743-0bf2f6e8****\\",\\n \\"TaskStatus\\": 0,\\n \\"TaskInvalidReason\\": \\"PullStreamFailed\\",\\n \\"TaskExitTime\\": 1726354625,\\n \\"TaskExitReason\\": \\"TriggerByUser\\",\\n \\"CurrentOffset\\": 0,\\n \\"CurrentFileIndex\\": 0,\\n \\"TaskInfo\\": {\\n \\"TaskId\\": \\"fd245384-4067-4f91-9d75-9666a6bc9****\\",\\n \\"TaskName\\": \\"test\\",\\n \\"StartTime\\": \\"2024-08-26T10:30:00Z\\",\\n \\"EndTime\\": \\"2024-08-27T14:30:00Z\\",\\n \\"SourceType\\": \\"vod\\",\\n \\"SourceProtocol\\": \\"RTMP\\",\\n \\"SourceUrls\\": [\\n \\"rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434\\"\\n ],\\n \\"DstUrl\\": \\"rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434\\",\\n \\"CallbackURL\\": \\"https://callback*****.com\\",\\n \\"Offset\\": 0,\\n \\"FileIndex\\": 0,\\n \\"RetryCount\\": 3,\\n \\"RetryInterval\\": 60,\\n \\"RepeatNumber\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeLivePullToPushResponse>\\n <RequestId>3271ACD2-F143-1204-AFDB-9A87C131****</RequestId>\\n <RetCode>0</RetCode>\\n <Description>OK</Description>\\n <TaskId>fd245384-4067-4f91-9d75-9666a6bc9****</TaskId>\\n <TaskStatus>1</TaskStatus>\\n <TaskInvalidReason>UnknownError</TaskInvalidReason>\\n <TaskExitTime>1724740200</TaskExitTime>\\n <TaskExitReason>TriggerByUser</TaskExitReason>\\n <TaskInfo>\\n <TaskId>fd245384-4067-4f91-9d75-9666a6bc9****</TaskId>\\n <SourceType>live</SourceType>\\n <Offset>2</Offset>\\n <CallbackURL>https://callback*****.com</CallbackURL>\\n <SourceUrls>rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434</SourceUrls>\\n <DstUrl>rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434</DstUrl>\\n <StartTime>2024-08-26T10:30:00Z</StartTime>\\n <EndTime>2024-08-27T14:30:00Z</EndTime>\\n </TaskInfo>\\n</DescribeLivePullToPushResponse>","errorExample":""}]', + 'title' => '查询拉流转推任务', + 'description' => '- 调用本接口查询拉流转推任务。'."\n" + .'- 支持查询指定ID的任务配置信息和状态信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLivePullToPushList' => [ + 'summary' => '模糊查询拉流转推任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257040', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '指定直播中心查询。取值：'."\n" + .'- ap-southeast-1（新加坡）'."\n" + .'- ap-southeast-5（印度尼西亚）'."\n" + .'- cn-beijing（北京）'."\n" + .'- cn-shanghai（上海）', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + 'enum' => [ + 'ap-northeast-1', + 'ap-southeast-1', + 'ap-southeast-5', + 'eu-central-1', + 'me-central-1', + 'cn-beijing', + 'cn-shanghai', + 'cn-shenzhen', + 'cn-qingdao', + 'preregion', + ], + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID，根据任务ID模糊搜索。'."\n" + .'> 任务ID由大小写字母、数字、下划线、短划线（-）组成，最大55字符。', + 'type' => 'string', + 'required' => false, + 'example' => '861009', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称，根据任务名称模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'task', + ], + ], + [ + 'name' => 'DstUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '目标推流地址，根据目标推流地址模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://qd', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + .'> 该参数取值大于 0 且不超过 Integer 数据类型的最大值，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页可展示的记录数。'."\n" + .'> 默认值为 10，取值范围[1,100]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id。', + 'type' => 'string', + 'example' => 'a05e6b15-15af-405b-a4a2-0152245*****', + ], + 'Total' => [ + 'description' => '查询结果总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PageNumber' => [ + 'description' => '分页页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的查询记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TaskList' => [ + 'description' => '任务信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务信息列表', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'fb0d4ac7-c7e3-4978-9743-0bf2f6e8****', + ], + 'TaskStatus' => [ + 'description' => '任务当前状态：'."\n" + .'- 0：未启动（未到开始时间）。'."\n" + .'- 1：正常运行（拉流和转推正常）。'."\n" + .'- 2：异常运行。'."\n" + .'- 3：已停止（拉流或转推异常，也有可能是主动调用接口停止）.'."\n" + .'- -1：已退出。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TaskInvalidReason' => [ + 'description' => '任务停止运行原因：'."\n" + ."\n" + .'- PullStreamFailed：源流拉流异常，重试中。'."\n" + .'- PushStreamFailed：目标流推流异常，重试中。'."\n" + .'- UnknownError：未知异常。'."\n" + ."\n" + .'> 仅停止运行状态下返回。', + 'type' => 'string', + 'example' => 'PullStreamFailed', + ], + 'TaskExitTime' => [ + 'description' => '任务退出时间，Unix 秒级时间戳。'."\n" + .'> 仅已退出状态下返回。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1726354625', + ], + 'TaskExitReason' => [ + 'description' => '任务退出原因：'."\n" + ."\n" + .'- TriggerByUser：用户主动结束。'."\n" + .'- OverEndTime：超过预设结束时间。'."\n" + ."\n" + .'> 仅已退出状态下返回。', + 'type' => 'string', + 'example' => 'TriggerByUser', + ], + 'CurrentOffset' => [ + 'description' => '当前生效的视频播放偏移。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CurrentFileIndex' => [ + 'description' => '当前生效的节目单序列偏移。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TaskInfo' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'fb0d4ac7-c7e3-4978-9743-0bf2f6e8****', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'taskname', + ], + 'StartTime' => [ + 'description' => '任务开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2024-12-04T09:16:00Z', + ], + 'EndTime' => [ + 'description' => '任务结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2024-12-30T14:30:00Z', + ], + 'SourceType' => [ + 'description' => '源流类型，枚举值：'."\n" + ."\n" + .'- live，直播流。'."\n" + .'- vod，阿里云视频点播资源。'."\n" + .'- url，第三方视频文件资源。', + 'type' => 'string', + 'example' => 'vod', + ], + 'SourceProtocol' => [ + 'description' => '源流协议名。', + 'type' => 'string', + 'example' => 'flv', + ], + 'SourceUrls' => [ + 'description' => '源流URL地址。', + 'type' => 'array', + 'items' => [ + 'description' => '源流URL地址。', + 'type' => 'string', + 'example' => 'rtmp://118.178.***.*5:****/wwtestlive1/pulltest.jiugong.aliyunlive.com_livelight2?vhost=pulltest.jiugong.aliyun*******', + ], + ], + 'DstUrl' => [ + 'description' => '推流目标地址。', + 'type' => 'string', + 'example' => 'rtmp://qd.push.lgg.alivecdn.com/testhsc/streamhsc?live_rtmp_*******', + ], + 'CallbackURL' => [ + 'description' => 'HTTP回调地址。', + 'type' => 'string', + 'example' => 'hahaha.com', + ], + 'Offset' => [ + 'description' => '启动偏移，视频文件起始偏移值。单位：秒。取值：大于0。'."\n" + .'> - 表示从相对于首帧的偏差时间作为开始读取的位置。'."\n" + .'> - 仅对点播资源或视频文件有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FileIndex' => [ + 'description' => '文件索引，从第n个文件开始播放起。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RetryCount' => [ + 'description' => '重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RetryInterval' => [ + 'description' => '重试间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'RepeatNumber' => [ + 'description' => '播放完后重复继续播放的次数。取值：'."\n" + .'- 0（默认值）：不重复播放。'."\n" + .'- -1：一直循环重复。'."\n" + .'- 其他正整数：播放完后重复继续播放的次数。'."\n" + ."\n" + .'> 此参数仅针对点播或第三方视频流。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'LiveServiceNotFound', + 'errorMessage' => 'Your account does not open Live service yet', + ], + [ + 'errorCode' => 'CodeInvalidAliUid', + 'errorMessage' => 'This aliuid does not have a live domain name.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"a05e6b15-15af-405b-a4a2-0152245*****\\",\\n \\"Total\\": 3,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TaskList\\": [\\n {\\n \\"TaskId\\": \\"fb0d4ac7-c7e3-4978-9743-0bf2f6e8****\\",\\n \\"TaskStatus\\": 0,\\n \\"TaskInvalidReason\\": \\"PullStreamFailed\\",\\n \\"TaskExitTime\\": 1726354625,\\n \\"TaskExitReason\\": \\"TriggerByUser\\",\\n \\"CurrentOffset\\": 0,\\n \\"CurrentFileIndex\\": 0,\\n \\"TaskInfo\\": {\\n \\"TaskId\\": \\"fb0d4ac7-c7e3-4978-9743-0bf2f6e8****\\",\\n \\"TaskName\\": \\"taskname\\",\\n \\"StartTime\\": \\"2024-12-04T09:16:00Z\\",\\n \\"EndTime\\": \\"2024-12-30T14:30:00Z\\",\\n \\"SourceType\\": \\"vod\\",\\n \\"SourceProtocol\\": \\"flv\\",\\n \\"SourceUrls\\": [\\n \\"rtmp://118.178.***.*5:****/wwtestlive1/pulltest.jiugong.aliyunlive.com_livelight2?vhost=pulltest.jiugong.aliyun*******\\"\\n ],\\n \\"DstUrl\\": \\"rtmp://qd.push.lgg.alivecdn.com/testhsc/streamhsc?live_rtmp_*******\\",\\n \\"CallbackURL\\": \\"hahaha.com\\",\\n \\"Offset\\": 0,\\n \\"FileIndex\\": 0,\\n \\"RetryCount\\": 3,\\n \\"RetryInterval\\": 60,\\n \\"RepeatNumber\\": 0\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '模糊查询拉转推任务', + 'description' => '- 调用本接口查询拉流转推任务列表。'."\n" + .'- 支持分页查询任务列表，支持以任务ID、任务名称和目标推流地址进行模糊搜索。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'StopLivePullToPush' => [ + 'summary' => '停止任务接口。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257294', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '指定直播中心查询。取值：'."\n" + .'- ap-southeast-1（新加坡）'."\n" + .'- ap-southeast-5（印度尼西亚）'."\n" + .'- cn-beijing（北京）'."\n" + .'- cn-shanghai（上海）', + 'type' => 'string', + 'required' => true, + 'example' => 'preregion', + 'enum' => [ + 'ap-northeast-1', + 'ap-southeast-1', + 'ap-southeast-5', + 'eu-central-1', + 'me-central-1', + 'cn-beijing', + 'cn-shanghai', + 'cn-shenzhen', + 'cn-qingdao', + 'preregion', + ], + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '根据任务ID查询。', + 'type' => 'string', + 'required' => true, + 'example' => '3bb44350-0c34-49c7-8c5e-cba5e6c0****', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'a05e6b15-15af-405b-a4a2-0152245d****', + ], + 'TaskId' => [ + 'description' => '新建任务id。', + 'type' => 'string', + 'example' => 'fb0d4ac7-c7e3-4978-9743-0bf2f6e8****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'LiveServiceNotFound', + 'errorMessage' => 'Your account does not open Live service yet', + ], + [ + 'errorCode' => 'CodeInvalidAliUid', + 'errorMessage' => 'This aliuid does not have a live domain name.', + ], + [ + 'errorCode' => 'InvalidParam.CodeIllegalDuration', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'CodeTaskNotExist', + 'errorMessage' => 'Task does not exist.', + ], + [ + 'errorCode' => 'CodeTaskHasStopped', + 'errorMessage' => 'The task has been stopped.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"a05e6b15-15af-405b-a4a2-0152245d****\\",\\n \\"TaskId\\": \\"fb0d4ac7-c7e3-4978-9743-0bf2f6e8****\\"\\n}","type":"json"}]', + 'title' => '停止拉流转推任务', + 'description' => '- 调用本接口停止拉流转推任务。'."\n" + .'- 支持强制停止运行中（含异常重试状态）的任务，对未运行的任务无效。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'RestartLivePullToPush' => [ + 'summary' => '重启任务接口。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257299', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '指定直播中心查询。取值：'."\n" + .'- ap-southeast-1（新加坡）'."\n" + .'- ap-southeast-5（印度尼西亚）'."\n" + .'- cn-beijing（北京）'."\n" + .'- cn-shanghai（上海）', + 'type' => 'string', + 'required' => true, + 'example' => 'preregion', + 'enum' => [ + 'ap-northeast-1', + 'ap-southeast-1', + 'ap-southeast-5', + 'eu-central-1', + 'me-central-1', + 'cn-beijing', + 'cn-shanghai', + 'cn-shenzhen', + 'cn-qingdao', + 'preregion', + ], + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '根据任务ID查询。', + 'type' => 'string', + 'required' => true, + 'example' => '6f869419-0692-4fd5-8cf0-66cab659****', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => 'a05e6b15-15af-405b-a4a2-01522450****', + ], + 'TaskId' => [ + 'description' => '新建任务id。', + 'type' => 'string', + 'example' => 'fb0d4ac7-c7e3-4978-9743-0bf2f6e8****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'LiveServiceNotFound', + 'errorMessage' => 'Your account does not open Live service yet', + ], + [ + 'errorCode' => 'InvalidParam.CodeIllegalDuration', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'CodeInvalidAliUid', + 'errorMessage' => 'This aliuid does not have a live domain name.', + ], + [ + 'errorCode' => 'CodeTaskNotExist', + 'errorMessage' => 'Task does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"a05e6b15-15af-405b-a4a2-01522450****\\",\\n \\"TaskId\\": \\"fb0d4ac7-c7e3-4978-9743-0bf2f6e8****\\"\\n}","type":"json"}]', + 'title' => '重启拉流转推任务', + 'description' => '- 调用本接口重启拉流转推任务。'."\n" + .'- 支持重启运行中（含异常重试状态）或已停止的任务，运行中任务会被停止再启动，未运行中任务会被直接启动。'."\n" + .'- 任务未到设置的开始时间，重启无效。'."\n" + .'- 任务重启会根据任务最新配置执行，会造成推流中断。'."\n" + .'- 点播类型任务被重启后，是根据最新播放列表从头开始播放，用户可以通过调用更新接口设置视频索引和视频播放进度实现续播。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'SetLiveDomainMultiStreamConfig' => [ + 'summary' => '调用 SetLiveDomainMultiStreamConfig 设置开启双流灾备开关。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250492', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播放域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Switch', + 'in' => 'query', + 'schema' => [ + 'description' => '功能开关。取值：'."\n" + .'- **on**：开启'."\n" + .'- **off**：关闭', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64-af62-20e91b96****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'CodeGetPushbackDomainError', + 'errorMessage' => 'Unable to get the push domain name, please check the domain name mapping configuration.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5c6a2a0df228-4a64-af62-20e91b96****\\"\\n}","type":"json"}]', + 'title' => '设置双流灾备开关', + 'description' => '调用本接口开启双流灾备功能，支持向相同的直播流名进行推流。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'SetLiveDomainMultiStreamOptimalMode' => [ + 'summary' => '设置双流灾备自动模式开关。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250499', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播放域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'App名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testapp', + 'enum' => [], + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名。', + 'type' => 'string', + 'required' => true, + 'example' => 'teststream', + ], + ], + [ + 'name' => 'OptimalMode', + 'in' => 'query', + 'schema' => [ + 'description' => '自动模式开关。取值：'."\n" + .'- **on**：开启'."\n" + .'- **off**：关闭', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-****-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'CodeTaskNotExist', + 'errorMessage' => 'Task does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-****-CB92E68F4CD8\\"\\n}","type":"json"}]', + 'title' => '设置双流灾备自动模式开关', + ], + 'SetLiveDomainMultiStreamMaster' => [ + 'summary' => '手动切换双流灾备主流。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250500', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播放域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.aliyundoc.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testapp', + 'enum' => [], + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播播流流名', + 'type' => 'string', + 'required' => true, + 'example' => 'teststream', + ], + ], + [ + 'name' => 'UpstreamSequence', + 'in' => 'query', + 'schema' => [ + 'description' => '推流唯一标识。通过[QueryLiveDomainMultiStreamList - 查询双流灾备在线记录](~~2871872~~)获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'teststream_***', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4E*****43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'LiveServiceNotFound', + 'errorMessage' => 'Your account does not open Live service yet', + ], + [ + 'errorCode' => 'CodeTaskNotExist', + 'errorMessage' => 'Task does not exist.', + ], + [ + 'errorCode' => 'CodeTaskNotStarted', + 'errorMessage' => 'Task not started, cannot operate.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4E*****43-CB92E68F4CD8\\"\\n}","type":"json"}]', + 'title' => '手动切换双流灾备主流', + ], + 'DescribeLiveDomainMultiStreamConfig' => [ + 'summary' => '查询双流灾备配置状态。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250493', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播放域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'pliveplay.gstv.com.cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F486A44F-6B35-5A96-BF2C-************', + ], + 'Switch' => [ + 'description' => '功能开关。取值：'."\n" + .'- **on**：开启'."\n" + .'- **off**：关闭', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'CodeGetPushbackDomainError', + 'errorMessage' => 'Unable to get the push domain name, please check the domain name mapping configuration.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F486A44F-6B35-5A96-BF2C-************\\",\\n \\"Switch\\": \\"on\\"\\n}","type":"json"}]', + 'title' => '查询双流灾备配置状态', + ], + 'QueryLiveDomainMultiStreamList' => [ + 'summary' => '查询双流灾备在线记录。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250498', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '主播放域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。用于做过滤，精确搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'teststream', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询范围的起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'StartTime和EndTime时间间隔在 7 天内。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-12-01T01:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'结束时间需大于起始时间。起止时间和结束时间，间隔不超过 7 天。'."\n" + .'默认最近 24 小时。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-12-02T01:00:00Z', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '单页显示的数量，默认值：10。'."\n" + ."\n" + .'取值范围：1~100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CF60DB6A-7FD6-426E-9288-122CC1A5****', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '19', + ], + 'OnlineStreams' => [ + 'description' => '在线记录数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '主播流域名。', + 'type' => 'string', + 'example' => 'play.***.com', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'apptest', + ], + 'StreamName' => [ + 'description' => '直播流名称。', + 'type' => 'string', + 'example' => 'teststream', + ], + 'OptimalMode' => [ + 'description' => '功能开关。取值：'."\n" + .'- **on**：开启'."\n" + .'- **off**：关闭', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'UpstreamList' => [ + 'description' => '表示所有备选的流。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UpstreamSequence' => [ + 'description' => '推流唯一标识。', + 'type' => 'string', + 'example' => '***test_Alirewrite1', + ], + 'UpstreamIp' => [ + 'description' => '推流客户端IP。', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'UpstreamTime' => [ + 'description' => '推流时间。', + 'type' => 'string', + 'example' => '2024-11-13T09:20:47Z', + ], + 'MasterFlag' => [ + 'description' => '主备标记。'."\n" + .'> 用于标记当前合流分发的是哪个流。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + ], + ], + ], + 'ChangeLogs' => [ + 'description' => '切流记录。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ChangeTime' => [ + 'description' => '切流时间。', + 'type' => 'string', + 'example' => '2024-11-13T09:20:47Z', + ], + 'ChangeReason' => [ + 'description' => '切流原因'."\n" + .'* 用户手动切流 merge cut manually'."\n" + .'* 主流没有数据 master stream no data'."\n" + .'* 主流质量劣化 master stream low quality。', + 'type' => 'string', + 'example' => 'merge cut manually', + ], + 'MasterUpstream' => [ + 'description' => '切流后实际使用的流。', + 'type' => 'string', + 'example' => 'rtmp://118.178.168.35:1936/wwMultitest/pull.livetest2.aliyunlive.com_wwMultitest428_AliRewrite_2?vhost=pull.livetest2.aliyunlive.com&live_rtmp_test=on', + ], + 'UpstreamSequence' => [ + 'description' => '切流后的流标识。', + 'type' => 'string', + 'example' => '***test_AliRewrite_2', + ], + 'UpstreamIp' => [ + 'description' => '切流后使用的ip。', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'InvalidParam.CodeIllegalDuration', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF60DB6A-7FD6-426E-9288-122CC1A5****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 19,\\n \\"OnlineStreams\\": [\\n {\\n \\"Domain\\": \\"play.***.com\\",\\n \\"AppName\\": \\"apptest\\",\\n \\"StreamName\\": \\"teststream\\",\\n \\"OptimalMode\\": \\"on\\",\\n \\"UpstreamList\\": [\\n {\\n \\"UpstreamSequence\\": \\"***test_Alirewrite1\\",\\n \\"UpstreamIp\\": \\"1.1.1.1\\",\\n \\"UpstreamTime\\": \\"2024-11-13T09:20:47Z\\",\\n \\"MasterFlag\\": false\\n }\\n ],\\n \\"ChangeLogs\\": [\\n {\\n \\"ChangeTime\\": \\"2024-11-13T09:20:47Z\\",\\n \\"ChangeReason\\": \\"merge cut manually\\",\\n \\"MasterUpstream\\": \\"rtmp://118.178.168.35:1936/wwMultitest/pull.livetest2.aliyunlive.com_wwMultitest428_AliRewrite_2?vhost=pull.livetest2.aliyunlive.com&live_rtmp_test=on\\",\\n \\"UpstreamSequence\\": \\"***test_AliRewrite_2\\",\\n \\"UpstreamIp\\": \\"1.1.1.1\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询双流灾备在线记录', + ], + 'DescribeLiveDomainStagingConfig' => [ + 'summary' => '调用DescribeLiveDomainStagingConfig查询灰度环境配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'developer.aliyundoc.com', + ], + ], + [ + 'name' => 'FunctionNames', + 'in' => 'query', + 'schema' => [ + 'description' => '功能列表名称，多个用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'aliauth', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C80705BF-0F76-41FA-BAD1-5B59296A4E59', + ], + 'DomainConfigs' => [ + 'description' => '域名配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '配置状态，取值：'."\n" + .'- **success**：成功。'."\n" + .'- **testing**：配置校验中。'."\n" + .'- **failed**：失败。'."\n" + .'- **configuring**：配置中。', + 'type' => 'string', + 'example' => 'success', + ], + 'ConfigId' => [ + 'description' => '配置ID。', + 'type' => 'string', + 'example' => '6295', + ], + 'FunctionName' => [ + 'description' => '功能名称。', + 'type' => 'string', + 'example' => 'aliauth', + ], + 'FunctionArgs' => [ + 'description' => '功能配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ArgName' => [ + 'description' => '配置名称。', + 'type' => 'string', + 'example' => 'auth_type', + ], + 'ArgValue' => [ + 'description' => '配置的值。', + 'type' => 'string', + 'example' => 'req_auth', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Invalid%s.ValueNotSupported', + 'errorMessage' => 'FunctionName [%s] is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C80705BF-0F76-41FA-BAD1-5B59296A4E59\\",\\n \\"DomainConfigs\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"ConfigId\\": \\"6295\\",\\n \\"FunctionName\\": \\"aliauth\\",\\n \\"FunctionArgs\\": [\\n {\\n \\"ArgName\\": \\"auth_type\\",\\n \\"ArgValue\\": \\"req_auth\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<DescribeLiveDomainStagingConfigResponse>\\n<RequestId>C80705BF-0F76-41FA-BAD1-5B59296A4E59</RequestId>\\n<DomainConfigs>\\n <Status>success</Status>\\n <FunctionName>aliauth</FunctionName>\\n <ConfigId>6295</ConfigId>\\n <FunctionArgs>\\n <ArgValue>req_auth</ArgValue>\\n <ArgName>auth_type</ArgName>\\n </FunctionArgs>\\n</DomainConfigs>\\n</DescribeLiveDomainStagingConfigResponse>","errorExample":""}]', + 'title' => '查询灰度环境配置信息', + 'description' => '## 使用说明'."\n" + .'先获取加速域名，再调用本接口查询灰度环境配置信息。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PublishLiveStagingConfigToProduction' => [ + 'summary' => '调用PublishLiveStagingConfigToProduction将灰度配置转为生产配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'developer.aliyundoc.com', + ], + ], + [ + 'name' => 'FunctionName', + 'in' => 'query', + 'schema' => [ + 'description' => '功能名称。获取功能名称，请参见[DescribeLiveDomainStagingConfig](~~297374~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'aliauth', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StagingConfig.Failed', + 'errorMessage' => 'The rules for the staging environment are being configured. Try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'StagingConfig.NotFound', + 'errorMessage' => 'The staging configuration does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<PublishLiveStagingConfigToProductionResponse>\\r\\n<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n</PublishLiveStagingConfigToProductionResponse>","errorExample":""}]', + 'title' => '将灰度配置转为生产配置', + 'description' => '## 使用说明'."\n" + .'先通过[DescribeLiveDomainStagingConfig接口](~~297374~~)获取功能名称，再调用本接口将灰度配置转为生产配置。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RollbackLiveStagingConfig' => [ + 'summary' => '调用RollbackLiveStagingConfig将灰度环境配置回滚。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'developer.aliyundoc.com', + ], + ], + [ + 'name' => 'FunctionName', + 'in' => 'query', + 'schema' => [ + 'description' => '功能名称。获取功能名称，请参见[DescribeLiveDomainStagingConfig](~~297374~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'aliauth', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'StagingConfig.NotFound', + 'errorMessage' => 'The staging configuration does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<RollbackLiveStagingConfigResponse>\\r\\n<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n</RollbackLiveStagingConfigResponse>","errorExample":""}]', + 'title' => '将灰度环境配置回滚', + 'description' => '## 使用说明'."\n" + .'先通过[DescribeLiveDomainStagingConfig接口](~~297374~~)获取功能名称，再调用本接口将灰度环境配置回滚。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetLiveDomainStagingConfig' => [ + 'summary' => '调用SetLiveDomainStagingConfig设置或修改灰度环境下的域名配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'developer.aliyundoc.com', + ], + ], + [ + 'name' => 'Functions', + 'in' => 'query', + 'schema' => [ + 'description' => '功能列表，仅在修改时需要指定ConfigId，详情请参见**Functions格式说明**。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"functionArgs":[{"argName":"enable","argValue":"on"},{"argName":"pri","argValue":"1"},{"argName":"rule","argValue":"xxx"}],"functionName":"edge_function"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidFunctionName.ValueNotSupported', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidArgName.ValueNotSupported', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidArgValue.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidRule.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ConfigurationConflicts', + 'errorMessage' => 'The staging environment has a configuration in effect. You cannot modify the production environment configuration.', + ], + [ + 'errorCode' => 'InvalidDomain.BelongToConfigGroup', + 'errorMessage' => 'The domain is bound to a configuration group. Modify the domain in the configuration group.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<SetLiveDomainStagingConfigResponse>\\r\\n<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n</SetLiveDomainStagingConfigResponse>","errorExample":""}]', + 'title' => '设置或修改灰度环境下的域名配置', + 'description' => '## 使用说明'."\n" + .'先获取加速域名，再调用本接口设置或修改灰度环境下的域名配置。详情请参见下文**Functions格式说明**。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。'."\n", + 'requestParamsDescription' => '## Functions格式说明'."\n" + ."\n" + .'- 设置配置，示例如下所示：'."\n" + .'`[{"functionArgs":[{"argName":"enable","argValue":"on"},{"argName":"pri","argValue":"1"},{"argName":"rule","argValue":"xxx"}],"functionName":"edge_function"}]`'."\n" + ."\n" + .'- 修改配置，可通过ConfigId（Long类型）指定要修改的配置项，示例如下所示：'."\n" + .'`[{"functionArgs":[{"argName":"enable","argValue":"on"},{"argName":"pri","argValue":"1"},{"argName":"rule","argValue":"yyy"}],"ConfigId":123456,"functionName":"edge_function"}]`'."\n" + ."\n" + .'功能说明：所有参数值均按照字符串类型处理。'."\n" + .'|功能名称|必选参数|可选参数|'."\n" + .'|---|---|---|'."\n" + .'|edge_function：边缘函数。 |- **rule**：DSL规则。<br>- **pri**：优先级。<br>- **enable**：本条规则是否生效，取值：on或off。 |- **name**：规则名称。<br>- **pos**：规则执行位置。<br>- **brk**：命中本条规则后，当前执行位置剩余规则均跳过。<br>- **option**：option管控。<br>- **grammar**：grammar管控，取值：空、es2或js。<br>- **jsmode**：js域名白单管控，取值：redirect或bypass。 |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveSpecificStagingConfig' => [ + 'summary' => '调用 DeleteLiveSpecificStagingConfig 删除灰度环境下的域名配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'developer.aliyundoc.com', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID，多个用英文逗号（,）分隔。获取配置ID，请参见[DescribeLiveDomainStagingConfig](~~2848231~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '6295', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Invalid%s.ValueNotSupported', + 'errorMessage' => 'FunctionName [%s] is not supported.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<DeleteLiveSpecificStagingConfigResponse>\\r\\n<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n</DeleteLiveSpecificStagingConfigResponse>","errorExample":""}]', + 'title' => '删除灰度环境下的域名配置', + 'description' => '## 使用说明'."\n" + .'先通过[DescribeLiveDomainStagingConfig接口](~~297374~~)获得配置ID，再调用本接口删除灰度环境下的域名配置。'."\n" + ."\n\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveIpInfo' => [ + 'summary' => '调用DescribeLiveIpInfo验证指定IP是否为CDN节点的IP地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107056', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'IP', + 'in' => 'query', + 'schema' => [ + 'description' => '指定IP地址，不支持批量验证。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IspEname' => [ + 'description' => '所属运营商英文名称。', + 'type' => 'string', + 'example' => 'telecom', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1B1D0EE7-9559-489D-BC4E-279495EB8FB8', + ], + 'RegionEname' => [ + 'description' => '所属地域英文名称。', + 'type' => 'string', + 'example' => 'China-Guizhou-guiyang', + ], + 'ISP' => [ + 'description' => '所属运营商中文名称。', + 'type' => 'string', + 'example' => '电信', + ], + 'Region' => [ + 'description' => '所属地域中文名称。', + 'type' => 'string', + 'example' => '中国-贵州省-贵阳市', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CdnIP.NotFound', + 'errorMessage' => 'Cannot find this ip in alicdn', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IspEname\\": \\"telecom\\",\\n \\"RequestId\\": \\"1B1D0EE7-9559-489D-BC4E-279495EB8FB8\\",\\n \\"RegionEname\\": \\"China-Guizhou-guiyang\\",\\n \\"ISP\\": \\"电信\\",\\n \\"Region\\": \\"中国-贵州省-贵阳市\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveIpInfoResponse>\\n <RegionEname>China-Guizhou-guiyang</RegionEname>\\n <Region>中国-贵州省-贵阳市</Region>\\n <IspEname>telecom</IspEname>\\n <RequestId>1B1D0EE7-9559-489D-BC4E-279495EB8FB8</RequestId>\\n <ISP>电信</ISP>\\n</DescribeLiveIpInfoResponse>","errorExample":""}]', + 'title' => '获取直播IP信息', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveStreamAuthChecking' => [ + 'summary' => '查询当前在线流的鉴权。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播推流域名或播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'description' => '完整的推流地址或播放地址。您可用[地址生成器](~~197400~~)生成。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://example.com/live/test.flv?auth_key=1664248******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '鉴权不通过的错误信息。', + 'type' => 'string', + 'example' => 'INVALID AUTH_KEY', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16F08B4E-14FD-5D72-AB2F-BAFA4C4D57F1', + ], + 'Status' => [ + 'description' => '鉴权是否有效。'."\n" + .'- pass：有效。'."\n" + .'- false：无效。', + 'type' => 'string', + 'example' => 'pass', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Description\\": \\"INVALID AUTH_KEY\\",\\n \\"RequestId\\": \\"16F08B4E-14FD-5D72-AB2F-BAFA4C4D57F1\\",\\n \\"Status\\": \\"pass\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveStreamAuthCheckingResponse>\\n <Status>pass</Status>\\n <Description/>\\n <RequestId>16F08B4E-14FD-5D72-AB2F-BAFA4C4D57F1</RequestId>\\n</DescribeLiveStreamAuthCheckingResponse>","errorExample":""}]', + 'title' => '查询流鉴权', + 'description' => '本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'responseParamsDescription' => '### 鉴权不通过原因说明'."\n" + .'| 名称 | 描述 |'."\n" + .'|---------------|--------|'."\n" + .'| INVALID AUTH_KEY| 鉴权URL的参数auth_key无效。|'."\n" + .'| INVALID TIMESTAMP| 鉴权URL的时间无效。|'."\n" + .'|INVALID ALIAUTH| 配置的鉴权方式无效。|'."\n" + .'| INVALID MD5HASH| 通过MD5算法计算出的字符串无效。|'."\n", + ], + 'TagLiveResources' => [ + 'summary' => '调用TagLiveResources添加Live资源标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107259', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID。取值：直播域名。'."\n" + .'N的取值范围为**1~50**。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + 'required' => true, + 'example' => 'example.com', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。N的取值范围为**1~20**。', + 'type' => 'string', + 'required' => true, + 'example' => 'env', + ], + 'Value' => [ + 'description' => '标签值。N的取值范围为**1~20**。', + 'type' => 'string', + 'required' => false, + 'example' => 'product', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。固定值：**DOMAIN**。', + 'type' => 'string', + 'required' => true, + 'example' => 'DOMAIN', + 'enum' => [ + 'DOMAIN', + 'domain', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34AB41F1-04A5-496F-8C8D-634BDBE6A9FB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 401 => [ + [ + 'errorCode' => 'InvalidResourceType', + 'errorMessage' => 'The resourceType is invalid.', + ], + [ + 'errorCode' => 'QuotaExceed.TagsPerResource', + 'errorMessage' => 'The maximum number of tags for each resource is exceeded.', + ], + [ + 'errorCode' => 'InvalidTagKey', + 'errorMessage' => 'The tag key is invalid, %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The tags should not contain duplicate keys.', + ], + [ + 'errorCode' => 'InvalidResourcesCount', + 'errorMessage' => 'The count of resources is invalid, %s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34AB41F1-04A5-496F-8C8D-634BDBE6A9FB\\"\\n}","errorExample":""},{"type":"xml","example":"<TagLiveResourcesResponse>\\r\\n <RequestId>34AB41F1-04A5-496F-8C8D-634BDBE6A9FB</RequestId>\\r\\n</TagLiveResourcesResponse>","errorExample":""}]', + 'title' => '添加Live资源标签', + 'description' => ' 单用户调用频率为100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 特殊错误码'."\n" + .'|错误代码 |描述 |Http状态码 |语义 |'."\n" + .'|------------|--------|---------|------|'."\n" + .'|InvalidRegionId.Malformed |The specified RegionId is invalid. |400 |RegionId无效|'."\n" + .'|Resource.NotExist |Resources doesn\'t exist. |400 |Resource不存在|'."\n" + .'|TagKeyIsInvalid |The specified TagKey is invalid. |400 |TagKey格式错误|'."\n" + .'|TooManyTags |Too many tags. |400 |Tag超限|'."\n" + .'|TagValueIsInvalid |The specified TagValue is invalid. |400 |TagValue格式错误|'."\n" + .'|TagKeyRepeated |The specified TagKey is duplicated. |400 |TagKey存在重复值|'."\n" + .'|TagIsInvalid |The number of Tag exceeds 20. |400 |Tag不能超过20|'."\n" + .'|ResourceIdIsInvalid |The number of ResourceId exceeds 50. |400 |ResourceId不能超过50个|'."\n" + .'|SystemTagIsInvalid |The number of System Tag exceeds 50. |400 |系统标签累计不能超过50个|'."\n" + .'|CustomTagIsInvalid |The number of Custom Tag exceeds 20. |400 |用户标签累计不能超过20个|', + ], + 'UnTagLiveResources' => [ + 'summary' => '调用UnTagLiveResources删除Live资源标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107264', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID。直播域名。'."\n" + .'N的取值范围为1~50。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + 'required' => true, + 'example' => 'example.com', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签键。N的取值范围为**1~20**。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'testKey', + ], + 'required' => false, + 'example' => 'env', + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。枚举类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'DOMAIN', + 'enum' => [ + 'DOMAIN', + 'domain', + 'Domain', + ], + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '删除所有标签。取值：'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + ."\n" + .'默认取值为**false**。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '97C68796-EB7F-4D41-9D5B-12B909D76508', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 401 => [ + [ + 'errorCode' => 'InvalidResourceType', + 'errorMessage' => 'The resourceType is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The tags should not contain duplicate keys.', + ], + [ + 'errorCode' => 'InvalidResourcesCount', + 'errorMessage' => 'The count of resources is invalid, %s.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"97C68796-EB7F-4D41-9D5B-12B909D76508\\"\\n}","errorExample":""},{"type":"xml","example":"<UnTagLiveResourcesResponse>\\r\\n <RequestId>97C68796-EB7F-4D41-9D5B-12B909D76508</RequestId>\\r\\n</UnTagLiveResourcesResponse>","errorExample":""}]', + 'title' => '删除Live资源标签', + 'description' => '单用户调用频率为100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 特殊错误码'."\n" + .'|错误代码 |描述 |Http 状态码 |语义 |'."\n" + .'|------------|--------|---------|------|'."\n" + .'|TagIsInvalid |The number of Tag exceeds 20. |400 |Tag不能超过20|'."\n" + .'|ResourceIdIsInvalid |The number of ResourceId exceeds 50. |400 |ResourceId不能超过50个|', + ], + 'ListLiveTagResources' => [ + 'summary' => '查询符合条件的资源和标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'my-resource-id', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '资源的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'Value' => [ + 'description' => '标签键对应的标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'dev', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'TagOwnerUid', + 'in' => 'query', + 'schema' => [ + 'description' => '标签所属阿里云账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx1234xxx', + ], + ], + [ + 'name' => 'TagOwnerBid', + 'in' => 'query', + 'schema' => [ + 'description' => '标签拥有者Bid。', + 'type' => 'string', + 'required' => false, + 'example' => '26842', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'DOMAIN', + 'enum' => [ + 'DOMAIN', + ], + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始的Token。', + 'type' => 'string', + 'required' => false, + 'example' => 'q2j8bLtBdhONLRkgaPBa6A==', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'example' => '6a5e8f4fae643e70d1a2ff1827cd91bd', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => '标签资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签资源。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'my-resource-id', + ], + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'DOMAIN', + ], + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'env', + ], + 'TagValue' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'dev', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 401 => [ + [ + 'errorCode' => 'InvalidResourceType', + 'errorMessage' => 'The resourceType is invalid.', + ], + [ + 'errorCode' => 'InvalidTagKey', + 'errorMessage' => 'The tag key is invalid, %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidResourcesCount', + 'errorMessage' => 'The count of resources is invalid, %s.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The tags should not contain duplicate keys.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"6a5e8f4fae643e70d1a2ff1827cd91bd\\",\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceId\\": \\"my-resource-id\\",\\n \\"ResourceType\\": \\"DOMAIN\\",\\n \\"TagKey\\": \\"env\\",\\n \\"TagValue\\": \\"dev\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询符合条件的资源和标签', + ], + 'DescribeLiveTagResources' => [ + 'summary' => '用于查询Live资源对应的标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID。直播域名。N的取值范围为**1~50**。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + 'required' => true, + 'example' => 'example.com', + 'maxItems' => 50, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。N的取值范围为**1~20**。', + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'Value' => [ + 'description' => '标签值。N的取值范围为**1~20**。', + 'type' => 'string', + 'required' => false, + 'example' => 'product', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'DOMAIN' => 'DOMAIN', + ], + 'example' => 'DOMAIN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****41F1-04A5-496F-8C8D-634BDBE6****', + ], + 'TagResources' => [ + 'description' => '标签资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签资源。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Tag' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'env', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'product', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****41F1-04A5-496F-8C8D-634BDBE6****\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceId\\": \\"example.com\\",\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"product\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveTagResourcesResponse>\\n <RequestId>34AB41F1-04A5-496F-8C8D-634BDBE6A9FB</RequestId>\\n <TagResources>\\n <ResourceId>example.com</ResourceId>\\n <Tag>\\n <Value>product</Value>\\n <Key>env</Key>\\n </Tag>\\n </TagResources>\\n</DescribeLiveTagResourcesResponse>","errorExample":""}]', + 'title' => '查询Live资源对应的标签', + 'description' => '单用户调用频率：10次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddLiveCenterTransfer' => [ + 'summary' => '添加直播中心转推配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流应用名称。输入的AppName必须与需要转推的直播流AppName保持一致，方可生效。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'testapp', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'teststream', + ], + ], + [ + 'name' => 'DstUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '转推的第三方直播地址，最多支持添加1个地址。'."\n" + ."\n" + .'>目标地址协议必须和转推的直播流协议一致，目前仅支持RTMP和SRT协议的转推地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp://push.example2.aliyunlive.com/testapp1/teststream2', + ], + ], + [ + 'name' => 'TransferArgs', + 'in' => 'query', + 'schema' => [ + 'description' => '转推有效时间。取值：'."\n" + ."\n" + .'- **always**：永久生效。'."\n" + ."\n" + .'- **time**：指定时间内有效。'."\n" + ."\n" + .'>取值为**time**时，**StartTime**和**EndTime**必填。', + 'type' => 'string', + 'required' => true, + 'example' => 'always', + 'enum' => [ + 'always', + 'time', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => "\n" + .'转推开始时间。'."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-21T10:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '转推结束时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'>结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7908F2FF-44F8-120F-9FD6-85AE4B6C19EC', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + [ + 'errorCode' => 'CenterTransfersStreamOverLimit', + 'errorMessage' => 'CenterTransfers stream is over limit for this domainName.', + ], + [ + 'errorCode' => 'ConfigAlreadyExists', + 'errorMessage' => 'Config has already exist.', + ], + [ + 'errorCode' => 'CodeIllegalDuration', + 'errorMessage' => 'param end_time is before start_time', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7908F2FF-44F8-120F-9FD6-85AE4B6C19EC\\"\\n}","errorExample":""},{"type":"xml","example":"<AddLiveCenterTransferResponse>\\n <RequestId>7908F2FF-44F8-120F-9FD6-85AE4B6C19EC</RequestId>\\n</AddLiveCenterTransferResponse>","errorExample":""}]', + 'title' => '添加直播中心转推配置', + 'description' => '本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateLiveCenterTransfer' => [ + 'summary' => '调用UpdateLiveCenterTransfer修改直播中心转推配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流应用名称。输入的AppName必须与需要转推的直播流AppName保持一致，方可生效。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'testapp', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'teststream', + ], + ], + [ + 'name' => 'DstUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '转推的第三方直播地址，最多支持添加1个地址。'."\n" + ."\n" + .'>目标地址协议必须和转推的直播流协议一致，目前仅支持RTMP和SRT协议的转推地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp://push.example2.aliyunlive.com/testapp1/teststream2', + ], + ], + [ + 'name' => 'TransferArgs', + 'in' => 'query', + 'schema' => [ + 'description' => '转推有效时间。取值：'."\n" + ."\n" + .'- **always**：永久生效。'."\n" + ."\n" + .'- **time**：指定时间内有效。'."\n" + ."\n" + .'>取值为**time**时，**StartTime**和**EndTime**必填。', + 'type' => 'string', + 'required' => true, + 'example' => 'always', + 'enum' => [ + 'always', + 'time', + ], + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '转推开始时间。'."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-21T10:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '转推结束时间。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'>结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7908F2FF-44F8-120F-9FD6-85AE4B6C19EC', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + [ + 'errorCode' => 'CodeIllegalDuration', + 'errorMessage' => 'param end_time is before start_time', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7908F2FF-44F8-120F-9FD6-85AE4B6C19EC\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateLiveCenterTransferResponse>\\n <RequestId>7908F2FF-44F8-120F-9FD6-85AE4B6C19EC</RequestId>\\n</UpdateLiveCenterTransferResponse>","errorExample":""}]', + 'title' => '修改直播中心转推配置', + 'description' => '本接口仅支持修改**转推有效时间**（TransferArgs、StartTime、EndTime）相关配置'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。、', + ], + 'DescribeLiveCenterTransfer' => [ + 'summary' => '调用DescribeLiveCenterTransfer查询直播中心转推配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流应用名称。输入的AppName必须与需要转推的直播流AppName保持一致，方可生效。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => false, + 'example' => 'testapp', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => false, + 'example' => 'teststream', + ], + ], + [ + 'name' => 'DstUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '转推的第三方直播地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://push.example2.aliyunlive.com/testapp1/teststream2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'LiveCenterTransferInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveCenterTransferInfo' => [ + 'description' => '直播转推服务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '直播转推服务列表。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '直播流应用名称。', + 'type' => 'string', + 'example' => 'teststream', + ], + 'DomainName' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DstUrl' => [ + 'description' => '转推的第三方直播地址。', + 'type' => 'string', + 'example' => 'rtmp://push.example2.aliyunlive.com/testapp1/teststream2', + ], + 'EndTime' => [ + 'description' => '转推结束时间。', + 'type' => 'string', + 'example' => '2022-04-29T15:16:00Z', + ], + 'StartTime' => [ + 'description' => '转推开始时间。', + 'type' => 'string', + 'example' => '2022-04-28T15:16:00Z', + ], + 'StreamName' => [ + 'description' => '直播流名称。', + 'type' => 'string', + 'example' => 'teststream', + ], + 'TransferArgs' => [ + 'description' => '转推有效时间。取值：'."\n" + ."\n" + .'- **always**：永久生效。'."\n" + ."\n" + .'- **time**：指定时间内有效。', + 'type' => 'string', + 'example' => 'time', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C4865B85-664B-19D3-BB16-C62FB83C8226', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LiveCenterTransferInfoList\\": {\\n \\"LiveCenterTransferInfo\\": [\\n {\\n \\"AppName\\": \\"teststream\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DstUrl\\": \\"rtmp://push.example2.aliyunlive.com/testapp1/teststream2\\",\\n \\"EndTime\\": \\"2022-04-29T15:16:00Z\\",\\n \\"StartTime\\": \\"2022-04-28T15:16:00Z\\",\\n \\"StreamName\\": \\"teststream\\",\\n \\"TransferArgs\\": \\"time\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"C4865B85-664B-19D3-BB16-C62FB83C8226\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveCenterTransferResponse>\\n <RequestId>C4865B85-664B-19D3-BB16-C62FB83C8226</RequestId>\\n <LiveCenterTransferInfoList>\\n <EndTime>2022-04-29T15:16:00Z</EndTime>\\n <AppName>teststream</AppName>\\n <StartTime>2022-04-28T15:16:00Z</StartTime>\\n <TransferArgs>time</TransferArgs>\\n <StreamName>teststream</StreamName>\\n <DstUrl>rtmp://push.example2.aliyunlive.com/testapp1/teststream2</DstUrl>\\n <DomainName>example.com</DomainName>\\n </LiveCenterTransferInfoList>\\n</DescribeLiveCenterTransferResponse>","errorExample":""}]', + 'title' => '获取直播中心转推', + 'description' => '本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteLiveCenterTransfer' => [ + 'summary' => '调用DeleteLiveCenterTransfer删除直播中心转推配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流应用名称。输入的AppName必须与需要转推的直播流AppName保持一致，方可生效。您可在[流管理](~~197397~~)页面查看AppName。', + 'type' => 'string', + 'required' => true, + 'example' => 'testapp', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流名称。您可在[流管理](~~197397~~)页面查看StreamName。', + 'type' => 'string', + 'required' => true, + 'example' => 'teststream', + ], + ], + [ + 'name' => 'DstUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '转推的第三方直播地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://push.example2.aliyundoc.com/testapp1/teststream2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7908F2FF-44F8-120F-9FD6-85A******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7908F2FF-44F8-120F-9FD6-85A******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveCenterTransferResponse>\\n <RequestId>7908F2FF-44F8-120F-9FD6-85AE4B6C19EC</RequestId>\\n</DeleteLiveCenterTransferResponse>","errorExample":""}]', + 'title' => '删除直播中心转推', + 'description' => '本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeLiveEdgeTransfer' => [ + 'summary' => '调用DescribeLiveEdgeTransfer查询直播转推配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpDns' => [ + 'description' => '获取转推目标地址的HTTPDNS接口。', + 'type' => 'string', + 'example' => 'http://developer.aliyundoc.com/****', + ], + 'AppName' => [ + 'description' => '直播流所属应用名称。', + 'type' => 'string', + 'example' => 'liveApp****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '53FCB985-C67C-467B-B2B3-398430A21E14', + ], + 'TransferArgs' => [ + 'description' => '推流参数是否透传。取值：'."\n" + .'- **yes**：推流参数透传。'."\n" + .'- **no**：推流参数不透传。', + 'type' => 'string', + 'example' => 'yes', + ], + 'StreamName' => [ + 'description' => '推流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'TargetDomainList' => [ + 'description' => '转推域名列表，多个用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => 'learn.aliyundoc.com,guide.aliyundoc.com', + ], + 'DomainName' => [ + 'description' => '推流域名。', + 'type' => 'string', + 'example' => 'demo.aliyundoc.com', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpDns\\": \\"http://developer.aliyundoc.com/****\\",\\n \\"AppName\\": \\"liveApp****\\",\\n \\"RequestId\\": \\"53FCB985-C67C-467B-B2B3-398430A21E14\\",\\n \\"TransferArgs\\": \\"yes\\",\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"TargetDomainList\\": \\"learn.aliyundoc.com,guide.aliyundoc.com\\",\\n \\"DomainName\\": \\"demo.aliyundoc.com\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeLiveEdgeTransferResponse>\\n <HttpDns>http://developer.aliyundoc.com/****</HttpDns>\\n <AppName>liveApp****</AppName>\\n <RequestId>53FCB985-C67C-467B-B2B3-398430A21E14</RequestId>\\n <TransferArgs>yes</TransferArgs>\\n <StreamName>liveStream****</StreamName>\\n <TargetDomainList>learn.aliyundoc.com,guide.aliyundoc.com</TargetDomainList>\\n <DomainName>demo.aliyundoc.com</DomainName>\\n</DescribeLiveEdgeTransferResponse>","errorExample":""}]', + 'title' => '查询直播转推配置', + 'description' => '先获取推流域名，再调用本接口查询直播边缘转推配置。'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLiveEdgeTransfer' => [ + 'summary' => '删除直播转推配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名。一个域名只有一个直播转推配置。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteLiveEdgeTransferResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>\\n</DeleteLiveEdgeTransferResponse>","errorExample":""}]', + 'title' => '删除直播转推配置', + 'description' => '调用DeleteLiveEdgeTransfer只会删除针对某一域名的直播边缘转推配置，对已经按照该配置进行的直播转推没有影响。以下为典型场景示例：'."\n" + ."\n" + .'| 场景 | 分析 | 结果 |'."\n" + .'| -------------- | -------------- | ------ |'."\n" + .'| 1. 调用SetLiveEdgeTransfer配置直播边缘转推后进行推流，过程中调用DeleteLiveEdgeTransfer删除配置。 | 推流时直播边缘转推配置存在。 | 推流不受影响，直播转推不会中断。 |'."\n" + .'| 2. 推流过程中调用DeleteLiveEdgeTransfer删除直播边缘转推配置，中断推流再重新推流。 | 重新推流时直播边缘转推配置已不存在。 | 不会启动直播边缘转推。 |'."\n" + .'| 3. 调用DeleteLiveEdgeTransfer后才开始直播推流。 | 此时直播边缘转推配置不存在。 | 不会启动直播边缘转推。 |'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetLiveEdgeTransfer' => [ + 'summary' => '调用SetLiveEdgeTransfer设置直播转推配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名。直播转推流以推流的DomainName为粒度设置。一个域名只能有一个直播转推配置。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo.aliyundoc.com', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流所属应用名称。支持正则表达式配置但有例外。详细信息，请参见下文中的**AppName与StreamName参数设置说明**。例如：liveApp****[1,2,3]，表示允许liveApp****1，liveApp****2，liveApp****3三个App转推。'."\n" + ."\n" + .'> - 此参数只对请求参数中的TargetDomainList生效。'."\n" + .'> - 使用正则表达式配置`AppName`参数值时不能使用^或$字符，否则会导致转推失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveApp****', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '推流名称。支持正则表达式配置但有例外。详细信息，请参见下文中的**AppName与StreamName参数设置说明**。例如：liveStream****[1,2,3]，表示允许liveStream****1，liveStream****2，liveStream****3三个流转推。'."\n" + ."\n" + .'>- 此参数只对请求参数中的TargetDomainList生效。'."\n" + .'> - 使用正则表达式配置`StreamName`参数值时不能使用^或$字符，否则会导致转推失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'TargetDomainList', + 'in' => 'query', + 'schema' => [ + 'description' => '用户指定的转推目标域名列表。多个域名用英文逗号（,）分隔。请求中必须带有`TargetDomainList`和`HttpsDns`两个参数中的一个，且二者互斥。'."\n" + ."\n\n" + .'> - 当请求参数中设置了`TargetDomainList`，`AppName`和`StreamName`参数才生效。'."\n" + .'> - 当请求参数中设置了`TargetDomainList`，则不能再设置`HttpsDns`参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'learn.aliyundoc.com,guide.aliyundoc.com', + ], + ], + [ + 'name' => 'HttpDns', + 'in' => 'query', + 'schema' => [ + 'description' => '获取转推目标地址的HTTPDNS接口。请求中必须带有`TargetDomainList`和`HttpsDns`两个参数中的一个，且二者互斥。'."\n" + ."\n" + .'> 若请求参数中设置了`HttpsDns`，则不能再设置`TargetDomainList`参数，且`AppName`和`StreamName`限制不生效。'."\n" + ."\n" + .'直播转推对HTTPDNS接口返回的消息结构有要求，详细信息，请参见下文中的**HTTPDNS说明**。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://developer.aliyundoc.com', + ], + ], + [ + 'name' => 'TransferArgs', + 'in' => 'query', + 'schema' => [ + 'description' => '推流参数是否透传。取值：'."\n" + .'- **yes**：推流参数透传。'."\n" + .'- **no**（默认值）：推流参数不透传。', + 'type' => 'string', + 'required' => false, + 'example' => 'yes', + 'default' => 'no', + 'enum' => [ + 'yes', + 'no', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CF8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CF8\\"\\n}","errorExample":""},{"type":"xml","example":"<SetLiveEdgeTransferResponse>\\n <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CF8</RequestId>\\n</SetLiveEdgeTransferResponse>","errorExample":""}]', + 'title' => '设置直播转推配置', + 'description' => '调用SetLiveEdgeTransfer进行的直播边缘转推配置仅对配置完成后开始的推流生效。以下为部分典型场景示例：'."\n" + ."\n" + .'| 场景 | 分析 | 结果 |'."\n" + .'| -------------- | -------------- | ------ |'."\n" + .'| 1. 用户在调用SetLiveEdgeTransfer之前已经开始推流。 | 此时直播边缘转推流配置不存在。 | 该推流不受SetLiveEdgeTransfer配置的影响，即直播边缘转推流不会启动。 |'."\n" + .'| 2. 用户中断调用SetLiveEdgeTransfer之前已经开始的推流，再重新推流。 | 此时直播边缘转推流配置已经存在。 | 重新开始的推流会按SetLiveEdgeTransfer的配置启动直播转推流。 |'."\n" + .'| 3. 用户在调用SetLiveEdgeTransfer之后开始推流。 | 此时直播边缘转推流配置已经存在。 | 此次推流会按SetLiveEdgeTransfer的配置启动直播转推流。 |'."\n" + ."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '### AppName与StreamName参数设置说明'."\n" + .'AppName与StreamName均不支持`^`、`$`匹配。二者之中任一取值出现`^`或`$`均会导致转推失败。'."\n" + .'### HTTPDNS说明'."\n" + .'如果SetLiveEdgeTransfer的请求参数中设置了`HttpDns`，直播转推时将访问通过`HttpDns`设置的HTTPDNS接口来获取转推目标地址。'."\n" + ."\n" + .'请求示例如下：'."\n" + .'http://developer.aliyundoc.com/?host={<host>}&app={<app>}&name={<name>}{<_ali_user_args>} '."\n" + .'说明：在实际请求HTTPDNS接口时会把以下参数按推流URL中的信息进行替换：'."\n" + ."\n" + .'- {<host>}：推流域名。'."\n" + .'- {<app>}：直播流所属应用名称。'."\n" + .'- {<name>}：流名。'."\n" + .'- {<_ali_user_args>}：用户推流带的参数。'."\n" + ."\n" + .'直播转推对接口返回码和返回数据的要求如下：'."\n" + .'- 返回码为403表示访问失败，不需要转推。'."\n" + .'- 返回码为200表示访问成功，返回结果为JSON格式。结构和参数示例如下：'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "cdn_types": ['."\n" + .' {'."\n" + .' "name": "cdnA****",'."\n" + .' "upstream_url": "rtmp://developer.aliyundoc.com/live/testedge****"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "cdnB****",'."\n" + .' "upstream_url": "rtmp://developer.aliyundoc.com/live/testedge****"'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n" + .'| 参数 | 描述 | 示例 |'."\n" + .'| -------------- | -------------- | ------ |'."\n" + .'| name | CDN名称，可自定义但不能重复。 | cdnA**** |'."\n" + .'| upstream_url |要转推的推流地址。 | rtmp://developer.aliyundoc.com/live/testedge**** |'."\n" + ."\n" + .'> 转推域名从返回的JSON结果里面获取。如果返回多个转推域名，表示需要将原始流推到多路。'."\n" + .'- 返回数据结构不符合要求将导致转推失败。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLiveUserBillPrediction' => [ + 'summary' => '获取直播用户预期账单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive9P39J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。格式为：<i>yyyy-mm-dd</i>t<i>hh:mm:ss</i>z（utc时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-01T05:40:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-01T05:45:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '默认为当前时间, 日期格式按照ISO8601表示法，并使用UTC时间。'."\n" + .'格式为：YYYY-MM-DDThh:mm:ssZ', + 'type' => 'string', + 'example' => '2018-10-25T10:00:00Z', + ], + 'StartTime' => [ + 'description' => '默认为月初第一天的 0 点整, 日期格式按照ISO8601表示法，并使用UTC时间。'."\n" + .'格式为：YYYY-MM-DDThh:mm:ssZ', + 'type' => 'string', + 'example' => '2018-09-30T16:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B95BE680-5A6A-1CAD-8AB1-09DFF5D6****', + ], + 'BillType' => [ + 'description' => '用户计费类型。计费模式取值如下所示：'."\n" + ."\n" + .'- hour_flow：按小时流量计费。'."\n" + .'- day_bandwidth：按日带宽计费。'."\n" + .'- month_95：按月95峰值带宽计费。'."\n" + .'- month_avg_day_bandwidth：按月均日峰值带宽计费。'."\n" + .'- month_4th_day_bandwidth：按月第四日峰值带宽计费。'."\n" + .'- month_avg_day_95：按月均日95峰值带宽计费。'."\n" + .'- month_95_night_half： 按夜间半价95峰值带宽计费。'."\n" + .'- hour_vas：按小时增值服务计费。'."\n" + .'- day_count：按日请求次数计费。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'day_bandwidth', + ], + 'BillPredictionData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BillPredictionDataItem' => [ + 'description' => '账单预测数据。', + 'type' => 'array', + 'items' => [ + 'description' => '账单预测数据。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '预测值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '10000', + ], + 'TimeStp' => [ + 'description' => '预测值对应的时刻，仅95、夜间半价95和月第四日峰值有这个字段。', + 'type' => 'string', + 'example' => '2018-10-15T16:00:00Z', + ], + 'Area' => [ + 'description' => '区域代号。支持：'."\n" + .'- CN：中国内地。'."\n" + .'- OverSeas：海外大区。'."\n" + .'- AP1：亚太1区，包含中国香港地区、中国澳门地区、中国台湾地区、日本以及东南亚除越南和印尼之外的国家。'."\n" + .'- AP2：亚太2区，包含印尼、韩国、越南。'."\n" + .'- AP3：亚太3区，包含澳大利亚、新西兰。'."\n" + .'- NA：北美，包含美国、加拿大。'."\n" + .'- SA：南美，特指巴西。'."\n" + .'- EU：欧洲，包含乌克兰、英国、法国、荷兰、西班牙、意大利、瑞典、德国。'."\n" + .'- MEAA：中东非洲，包含南非、阿曼、阿联酋、科威特。'."\n" + ."\n" + .'不传值时默认为所有区域数据聚合输出。', + 'type' => 'string', + 'example' => 'CN', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'InvalidParameter.', + ], + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified StartTime parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified EndTime is invalid.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The StartTime cannot exceed 31 days before the current time.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified Time is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'BillTypeNotFound', + 'errorMessage' => 'User bill type not found or is not monthly bill type.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2018-10-25T10:00:00Z\\",\\n \\"StartTime\\": \\"2018-09-30T16:00:00Z\\",\\n \\"RequestId\\": \\"B95BE680-5A6A-1CAD-8AB1-09DFF5D6****\\",\\n \\"BillType\\": \\"day_bandwidth\\",\\n \\"BillPredictionData\\": {\\n \\"BillPredictionDataItem\\": [\\n {\\n \\"Value\\": 10000,\\n \\"TimeStp\\": \\"2018-10-15T16:00:00Z\\",\\n \\"Area\\": \\"CN\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取直播用户预期账单', + 'description' => '用于预测用户当月的用量数据，按用户月初第一天的计费模式计算，只支持月度计费模式的预测，只支持用户粒度。 起始时间为月初1号0点，结束时间为当前时间前两个小时。'."\n" + ."\n" + .'- 月95：开始时间至结束时间内，去掉最高5%点后的最高点，为预测值。'."\n" + .' '."\n" + .'- 月均日峰值：每日峰值带宽求和/时间天数，不计算当天的数据。'."\n" + ."\n" + .' - 月第四峰：请求时间内，第四高的峰值为预测值，如果请求时间小于4天，返回预测值为0。'."\n" + ."\n" + .' - 日95月平均：每日日95峰值求和/时间天数，不计算当天的数据。'."\n" + ."\n" + .' - 夜间95：开始时间至结束时间内，去掉最高5%点后的最高点，为预测值。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为1次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'DescribeRTSNativeSDKFirstFrameCost' => [ + 'summary' => '获取某一段时间内,首帧延时组成。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间'."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间'."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-10T21:00:00Z', + ], + ], + [ + 'name' => 'DataInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '时间粒度，支持300, 3600, 14400, 28800和86400秒。不传和传的值不支持时，使用默认值300秒。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'DomainNameList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '默认查询全部(2.1.0版本以上)，也可指定具体的域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。', + 'type' => 'array', + 'items' => [ + 'description' => '域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'a.example.com', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DataInterval' => [ + 'description' => '时间粒度', + 'type' => 'string', + 'example' => '300', + ], + 'EndTime' => [ + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2021-12-10T21:00:00Z', + ], + 'FirstFrameCostData' => [ + 'description' => '每个时间间隔的首帧组成平均延时，单位：毫秒', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Connected' => [ + 'description' => '初始化成功至建联成功耗时', + 'type' => 'string', + 'example' => '100', + ], + 'FinishGetStreamInfo' => [ + 'description' => '建联成功至订阅成功耗时', + 'type' => 'string', + 'example' => '89', + ], + 'FirstFrameComplete' => [ + 'description' => '首包成功至首帧成功耗时', + 'type' => 'string', + 'example' => '32', + ], + 'FirstPacket' => [ + 'description' => '订阅成功至首包成功耗时', + 'type' => 'string', + 'example' => '132', + ], + 'Initialized' => [ + 'description' => '初始化耗时', + 'type' => 'string', + 'example' => '1100', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻', + 'type' => 'string', + 'example' => '2021-12-10T20:00:00Z', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id', + 'description' => 'Id', + 'type' => 'string', + 'example' => 'BC858082-736F-4A25-867B-E5B67C85ACF7', + ], + 'StartTime' => [ + 'description' => '起始时间', + 'type' => 'string', + 'example' => '2021-12-10T20:00:00Z', + ], + ], + ], + ], + ], + '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 \\"DataInterval\\": \\"300\\",\\n \\"EndTime\\": \\"2021-12-10T21:00:00Z\\",\\n \\"FirstFrameCostData\\": [\\n {\\n \\"Connected\\": \\"100\\",\\n \\"FinishGetStreamInfo\\": \\"89\\",\\n \\"FirstFrameComplete\\": \\"32\\",\\n \\"FirstPacket\\": \\"132\\",\\n \\"Initialized\\": \\"1100\\",\\n \\"TimeStamp\\": \\"2021-12-10T20:00:00Z\\"\\n }\\n ],\\n \\"RequestId\\": \\"BC858082-736F-4A25-867B-E5B67C85ACF7\\",\\n \\"StartTime\\": \\"2021-12-10T20:00:00Z\\"\\n}","type":"json"}]', + 'title' => '查询首帧延时组成', + 'description' => '本接口用于查询时间范围内首帧延时组成. QPS限制 本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。', + ], + 'DescribeRTSNativeSDKPlayTime' => [ + 'summary' => '获取某一段时间内,播放时长。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间'."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间'."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-10T21:00:00Z', + ], + ], + [ + 'name' => 'DataInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '时间粒度，支持300, 3600, 14400, 28800和86400秒。不传和传的值不支持时，使用默认值300秒。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'DomainNameList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '默认查询全部(2.1.0及版本以上)，也可指定具体的域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。', + 'type' => 'array', + 'items' => [ + 'description' => '域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'a.example.com', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DataInterval' => [ + 'description' => '时间粒度', + 'type' => 'string', + 'example' => '300', + ], + 'EndTime' => [ + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2021-12-10T21:00:00Z', + ], + 'PlayTimeData' => [ + 'description' => '每个时间间隔的的平均播放时长、平均卡顿时长，单位：毫秒', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PlayTime' => [ + 'description' => '该时间段的平均播放时长', + 'type' => 'string', + 'example' => '1000', + ], + 'StallTime' => [ + 'description' => '该时间段的平均卡顿时长', + 'type' => 'string', + 'example' => '100', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻', + 'type' => 'string', + 'example' => '2021-12-10T20:00:00Z', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id', + 'description' => 'Id', + 'type' => 'string', + 'example' => '7BF95F2A-3B24-4CDE-9346-7F6FA86697A1', + ], + 'StartTime' => [ + 'description' => '起始时间', + 'type' => 'string', + 'example' => '2021-12-10T20:00:00Z', + ], + ], + ], + ], + ], + '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 \\"DataInterval\\": \\"300\\",\\n \\"EndTime\\": \\"2021-12-10T21:00:00Z\\",\\n \\"PlayTimeData\\": [\\n {\\n \\"PlayTime\\": \\"1000\\",\\n \\"StallTime\\": \\"100\\",\\n \\"TimeStamp\\": \\"2021-12-10T20:00:00Z\\"\\n }\\n ],\\n \\"RequestId\\": \\"7BF95F2A-3B24-4CDE-9346-7F6FA86697A1\\",\\n \\"StartTime\\": \\"2021-12-10T20:00:00Z\\"\\n}","type":"json"}]', + 'title' => '查询播放时长', + 'description' => '本接口用于查询时间范围内播放时长. QPS限制 本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。', + ], + 'DescribeRTSNativeSDKPlayFailStatus' => [ + 'summary' => '获取某一段时间内,查询播放失败的原因(状态码形式)。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间'."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间'."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-10T21:00:00Z', + ], + ], + [ + 'name' => 'DataInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '时间粒度，支持300, 3600, 14400, 28800和86400秒。不传和传的值不支持时，使用默认值300秒。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'DomainNameList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '默认查询全部(2.1.0版本以上)，也可指定具体的域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。', + 'type' => 'array', + 'items' => [ + 'description' => '域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'a.example.com', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DataInterval' => [ + 'description' => '时间粒度', + 'type' => 'string', + 'example' => '300', + ], + 'EndTime' => [ + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2021-12-10T21:00:00Z', + ], + 'PlayFailStatus' => [ + 'description' => '每个时间间隔的错误状态码总数，单位：次数', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻', + 'type' => 'string', + 'example' => '2021-12-10T20:00:00Z', + ], + 'V20001' => [ + 'description' => 'DNS解析失败', + 'type' => 'string', + 'example' => '1', + ], + 'V20002' => [ + 'description' => '鉴权失败', + 'type' => 'string', + 'example' => '2', + ], + 'V20011' => [ + 'description' => '建联信令超时', + 'type' => 'string', + 'example' => '3', + ], + 'V20012' => [ + 'description' => '订阅信令返回错误', + 'type' => 'string', + 'example' => '4', + ], + 'V20013' => [ + 'description' => '订阅流不存在', + 'type' => 'string', + 'example' => '5', + ], + 'V20052' => [ + 'description' => '媒体收包超时', + 'type' => 'string', + 'example' => '6', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id', + 'description' => 'Id', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'StartTime' => [ + 'description' => '起始时间', + 'type' => 'string', + 'example' => '2021-12-10T20:00:00Z'."\n", + ], + ], + ], + ], + ], + '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 \\"DataInterval\\": \\"300\\",\\n \\"EndTime\\": \\"2021-12-10T21:00:00Z\\",\\n \\"PlayFailStatus\\": [\\n {\\n \\"TimeStamp\\": \\"2021-12-10T20:00:00Z\\",\\n \\"V20001\\": \\"1\\",\\n \\"V20002\\": \\"2\\",\\n \\"V20011\\": \\"3\\",\\n \\"V20012\\": \\"4\\",\\n \\"V20013\\": \\"5\\",\\n \\"V20052\\": \\"6\\"\\n }\\n ],\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"StartTime\\": \\"2021-12-10T20:00:00Z\\\\n\\"\\n}","type":"json"}]', + 'title' => '查询播放失败的原因', + 'description' => '本接口用于查询时间范围内播放失败的原因(状态码形式). QPS限制 本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。', + ], + 'DescribeRTSNativeSDKFirstFrameDelay' => [ + 'summary' => '获取某一段时间内,首帧延时(平均值)', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间'."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间'."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-10T21:00:00Z', + ], + ], + [ + 'name' => 'DataInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '时间粒度，支持300, 3600, 14400, 28800和86400秒。不传和传的值不支持时，使用默认值300秒。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'DomainNameList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '默认查询全部(2.1.0版本以上)，也可指定具体的域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。', + 'type' => 'array', + 'items' => [ + 'description' => '域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'a.example.com', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DataInterval' => [ + 'description' => '时间粒度', + 'type' => 'string', + 'example' => '300', + ], + 'EndTime' => [ + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2021-12-10T21:00:00Z', + ], + 'FrameDelayData' => [ + 'description' => '每个时间间隔的首帧平均延时，单位：毫秒', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FrameDelay' => [ + 'description' => '该时间段的平均首帧延时', + 'type' => 'string', + 'example' => '400', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻', + 'type' => 'string', + 'example' => '2021-12-10T20:00:00Z', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id', + 'description' => 'Id', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'StartTime' => [ + 'description' => '起始时间', + 'type' => 'string', + 'example' => '2021-12-10T20:00:00Z', + ], + ], + ], + ], + ], + '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 \\"DataInterval\\": \\"300\\",\\n \\"EndTime\\": \\"2021-12-10T21:00:00Z\\",\\n \\"FrameDelayData\\": [\\n {\\n \\"FrameDelay\\": \\"400\\",\\n \\"TimeStamp\\": \\"2021-12-10T20:00:00Z\\"\\n }\\n ],\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"StartTime\\": \\"2021-12-10T20:00:00Z\\"\\n}","type":"json"}]', + 'title' => '查询首帧延时', + 'description' => '本接口用于查询时间范围内获首帧延时.'."\n" + .'QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。', + ], + 'DescribeRTSNativeSDKVvData' => [ + 'summary' => '获取某一段时间内播放次数，含总次数和成功次数', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间'."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间'."\n" + .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-10T21:00:00Z', + ], + ], + [ + 'name' => 'DataInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '时间粒度，支持300, 3600, 14400, 28800和86400秒。不传和传的值不支持时，使用默认值300秒。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'DomainNameList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '数组。', + 'type' => 'array', + 'items' => [ + 'description' => '默认查询全部(2.1.0及版本以上)，也可指定具体的域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'a.example.com', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DataInterval' => [ + 'description' => '时间粒度', + 'type' => 'string', + 'example' => '300', + ], + 'EndTime' => [ + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2021-12-10T21:00:00Z', + ], + 'RequestId' => [ + 'title' => 'Id', + 'description' => 'Id', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F4CD8', + ], + 'StartTime' => [ + 'description' => '起始时间', + 'type' => 'string', + 'example' => '2021-12-10T20:00:00Z', + ], + 'VvData' => [ + 'description' => '每个时间间隔的总播放次数和总成功播放次数，单位：次数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻', + 'type' => 'string', + 'example' => '2021-12-10T20:00:00Z', + ], + 'VvSuccess' => [ + 'description' => '指定时间内的成功播放的总次数', + 'type' => 'string', + 'example' => '99', + ], + 'VvTotal' => [ + 'description' => '指定时间内的总播放次数', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + '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 \\"DataInterval\\": \\"300\\",\\n \\"EndTime\\": \\"2021-12-10T21:00:00Z\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8\\",\\n \\"StartTime\\": \\"2021-12-10T20:00:00Z\\",\\n \\"VvData\\": [\\n {\\n \\"TimeStamp\\": \\"2021-12-10T20:00:00Z\\",\\n \\"VvSuccess\\": \\"99\\",\\n \\"VvTotal\\": \\"100\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询播放次数', + 'description' => 'QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。', + ], + 'DescribeLiveRealtimeLogAuthorized' => [ + 'summary' => '查询用户实时日志投递授权状态。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElive066BXV', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'LiveOpenapiReserve', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数暂无实际意义。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AuthorizedStatus' => [ + 'description' => '授权状态。-**true**：已授权。-**false**：未授权。', + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5c6a2a0df228-4a64- af62-20e91b******'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AuthorizedStatus\\": \\"true\\",\\n \\"RequestId\\": \\"5c6a2a0df228-4a64- af62-20e91b******\\\\n\\"\\n}","type":"json"}]', + 'title' => '查询用户实时日志投递授权状态', + 'description' => '调用本接口查询用户实时日志投递授权状态'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'DescribeUpBpsPeakData' => [ + 'summary' => '查询用户的每日上行带宽峰值。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '拉流开始时间，UTC格式，StartTime和EndTime时间间隔在30天内。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-10-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '拉流结束时间，UTC格式, StartTime和EndTime时间间隔在30天内，且EndTime超过当前时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-10-10T21:00:00Z', + ], + ], + [ + 'name' => 'DomainSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '域名统计开关，取值：'."\n" + ."\n" + .'- on：开启域名统计级别。'."\n" + .'- off：用户级别数据。默认统计用户级别数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '带宽信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + 'DescribeUpPeakTraffics' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DescribeUpPeakTraffic' => [ + 'description' => '每日上行峰值带宽信息', + 'type' => 'array', + 'items' => [ + 'description' => '每日上行峰值带宽信息', + 'type' => 'object', + 'properties' => [ + 'QueryTime' => [ + 'description' => '查询的每日时间。', + 'type' => 'string', + 'example' => '1522080000000', + ], + 'BandWidth' => [ + 'description' => '每日峰值上行峰值带宽。', + 'type' => 'string', + 'example' => '777.2727083333333', + ], + 'StatName' => [ + 'description' => '计数据属性名称。当DomainSwitch取值为on时，显示用户直播域名；为off或者不传值是显示用户Id。', + 'type' => 'string', + 'example' => 'push-live.aliyuncs.com', + ], + 'PeakTime' => [ + 'description' => '每日峰值上行带宽的峰值时刻。', + 'type' => 'string', + 'example' => '1522180000000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified StartTime is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\",\\n \\"DescribeUpPeakTraffics\\": {\\n \\"DescribeUpPeakTraffic\\": [\\n {\\n \\"QueryTime\\": \\"1522080000000\\",\\n \\"BandWidth\\": \\"777.2727083333333\\",\\n \\"StatName\\": \\"push-live.aliyuncs.com\\",\\n \\"PeakTime\\": \\"1522180000000\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询用户的每日上行带宽峰值', + 'description' => '调用接口查询用户的每日上行带宽峰值。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'DescribeUpBpsPeakOfLine' => [ + 'summary' => '查询用户的每日某种专线上行带宽峰值', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '拉流开始时间，UTC格式, StartTime和EndTime时间间隔在30天内。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-10-10T20:00:00Z'."\n", + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '拉流结束时间，UTC格式, StartTime和EndTime时间间隔在30天内，且EndTime超过当前时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-10-10T21:00:00Z'."\n", + ], + ], + [ + 'name' => 'Line', + 'in' => 'query', + 'schema' => [ + 'description' => '专线。取值范围支持【0,9】内的整数。', + 'type' => 'string', + 'required' => true, + 'example' => '3', + 'enum' => [ + '0', + '1', + '2', + '3', + '4', + '5', + '6', + '7', + '8', + '9', + ], + ], + ], + [ + 'name' => 'DomainSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '域名统计开关，取值：'."\n" + ."\n" + .'- on：开启域名统计级别。'."\n" + .'- off：用户级别数据，默认统计用户级别数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '带宽信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6CFDE7AB-571A-14EA-B072-989FF753****', + ], + 'DescribeUpBpsPeakOfLines' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DescribeUpBpsPeakOfLine' => [ + 'description' => '每日上行专线峰值带宽信息。', + 'type' => 'array', + 'items' => [ + 'description' => '每日上行专线峰值带宽信息。', + 'type' => 'object', + 'properties' => [ + 'QueryTime' => [ + 'description' => '查询的每日时间。', + 'type' => 'string', + 'example' => '1522080000000'."\n", + ], + 'StatName' => [ + 'description' => '统计数据属性名称。当DomainSwitch取值为on时，显示用户直播域名；为off或者不传值是显示用户Id。', + 'type' => 'string', + 'example' => 'push-live.aliyuncs.com', + ], + 'BandWidth' => [ + 'description' => '每日峰值上行专线峰值带宽。', + 'type' => 'number', + 'format' => 'float', + 'example' => '777.2727083333333'."\n", + ], + 'PeakTime' => [ + 'description' => '每日峰值上行专线带宽的峰值时刻。', + 'type' => 'string', + 'example' => '1522180000000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 401 => [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CFDE7AB-571A-14EA-B072-989FF753****\\",\\n \\"DescribeUpBpsPeakOfLines\\": {\\n \\"DescribeUpBpsPeakOfLine\\": [\\n {\\n \\"QueryTime\\": \\"1522080000000\\\\n\\",\\n \\"StatName\\": \\"push-live.aliyuncs.com\\",\\n \\"BandWidth\\": 777.2727083333333,\\n \\"PeakTime\\": \\"1522180000000\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询用户的每日某种专线上行带宽峰值', + 'description' => '调用接口查询用户的每日某种专线上行带宽峰值。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'DescribeUpPeakPublishStreamData' => [ + 'summary' => '查询用户的每日上行并发推流数峰值。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveYUZBM3', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '拉流开始时间，UTC格式, StartTime和EndTime时间间隔在30天内。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-10-10T20:00:00Z'."\n", + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '拉流结束时间，UTC格式, StartTime和EndTime时间间隔在30天内，且EndTime超过当前时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-10-10T22:00:00Z'."\n", + ], + ], + [ + 'name' => 'DomainSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '域名统计开关，取值：'."\n" + ."\n" + .'- on：开启域名统计级别。'."\n" + .'- off：用户级别数据，默认统计用户级别数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '推流数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6CFDE7AB-571A-14EA-B072-989FF753****'."\n", + ], + 'DescribeUpPeakPublishStreamDatas' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DescribeUpPeakPublishStreamData' => [ + 'description' => '每日峰值并发推流数据。', + 'type' => 'array', + 'items' => [ + 'description' => '每日峰值并发推流数据。', + 'type' => 'object', + 'properties' => [ + 'QueryTime' => [ + 'description' => '查询的每日时间。', + 'type' => 'string', + 'example' => '1522080000000'."\n", + ], + 'BandWidth' => [ + 'description' => '每日上行峰值带宽。', + 'type' => 'string', + 'example' => '777.2727083333333', + ], + 'StatName' => [ + 'description' => '统计数据属性名称。当DomainSwitch取值为on时，显示用户直播域名；为off或者不传值是显示用户Id。', + 'type' => 'string', + 'example' => 'push-live.aliyuncs.com', + ], + 'PeakTime' => [ + 'description' => '每日峰值并发推流数的峰值时刻。', + 'type' => 'string', + 'example' => '1522180000000'."\n", + ], + 'PublishStreamNum' => [ + 'description' => '每日峰值并发推流数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '36', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified StartTime is invalid.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + ], + [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidCaster.NotFound', + 'errorMessage' => '%s, please check and try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CFDE7AB-571A-14EA-B072-989FF753****\\\\n\\",\\n \\"DescribeUpPeakPublishStreamDatas\\": {\\n \\"DescribeUpPeakPublishStreamData\\": [\\n {\\n \\"QueryTime\\": \\"1522080000000\\\\n\\",\\n \\"BandWidth\\": \\"777.2727083333333\\",\\n \\"StatName\\": \\"push-live.aliyuncs.com\\",\\n \\"PeakTime\\": \\"1522180000000\\\\n\\",\\n \\"PublishStreamNum\\": 36\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询用户的每日上行并发推流数峰值', + 'description' => '调用接口查询用户的每日上行并发推流数峰值。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'DescribeDomainWithIntegrity' => [ + 'summary' => '调用接口获取域名完整性', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '112159', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-10-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间需大于起始时间；获日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-10-10T20:00:00Z', + ], + ], + [ + 'name' => 'Integrity', + 'in' => 'query', + 'schema' => [ + 'description' => '校验完整度。', + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '0.95', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + 'Content' => [ + 'description' => '校验内容。', + 'type' => 'array', + 'items' => [ + 'description' => '校验内容。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '表名。', + 'type' => 'string', + 'example' => '1637825700000', + ], + 'Points' => [ + 'description' => '子Points。', + 'type' => 'array', + 'items' => [ + 'description' => '对应列的数值', + 'type' => 'string', + 'example' => '1637825700000', + ], + ], + 'Columns' => [ + 'description' => '列名', + 'type' => 'array', + 'items' => [ + 'description' => '列名', + 'type' => 'string', + 'example' => 'time', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\",\\n \\"Content\\": [\\n {\\n \\"Name\\": \\"1637825700000\\",\\n \\"Points\\": [\\n \\"1637825700000\\"\\n ],\\n \\"Columns\\": [\\n \\"time\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取域名完整性', + 'description' => '调用接口获取域名完整性'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'DescribeToutiaoLivePlay' => [ + 'summary' => '获取头条指定直播流的拉流信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-10-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间需大于起始时间,时间跨度不得大于10小时，StartTime和EndTime都不填则默认查询当前一小时的数据；获日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-10-10T21:00:00Z', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Stream', + 'in' => 'query', + 'schema' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '响应状态描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + 'Content' => [ + 'description' => '播流信息详情。', + 'type' => 'array', + 'items' => [ + 'description' => '播流信息详情。', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '播流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Bandwidth' => [ + 'description' => '带宽。单位：Mbps', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0801239013671875', + ], + 'StreamName' => [ + 'description' => '播流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'App' => [ + 'description' => '播流所属应用名称。', + 'type' => 'string', + 'example' => 'liveApp****'."\n", + ], + 'PlayNum' => [ + 'description' => '观看人数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '452', + ], + 'Timestamp' => [ + 'description' => '时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1625484600', + ], + 'CdnName' => [ + 'description' => 'Cdn名称。', + 'type' => 'string', + 'example' => 'ali', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"OK\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\",\\n \\"Content\\": [\\n {\\n \\"Domain\\": \\"example.com\\",\\n \\"Bandwidth\\": 0.0801239013671875,\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"App\\": \\"liveApp****\\\\n\\",\\n \\"PlayNum\\": 452,\\n \\"Timestamp\\": 1625484600,\\n \\"CdnName\\": \\"ali\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '头条拉流查询接口', + 'description' => '调用接口查询头条指定直播流的拉流信息。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'DescribeToutiaoLivePublish' => [ + 'summary' => '获取头条指定直播流的推流信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveG4SX14', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + 'default' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-10-10T20:00:00Z'."\n", + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间需大于起始时间,时间跨度不得大于10小时，StartTime和EndTime都不填则默认查询当前一小时的数据；获日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2017-10-10T21:00:00Z'."\n", + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '推流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Stream', + 'in' => 'query', + 'schema' => [ + 'description' => '推流名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveStream****', + ], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => [ + 'description' => '推流所属应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'liveApp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '响应状态描述。', + 'type' => 'string', + 'example' => 'OK'."\n", + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16A96B9A-F203-4EC5-8E43-CB92E68F****', + ], + 'Content' => [ + 'description' => '推流信息详情。', + 'type' => 'array', + 'items' => [ + 'description' => '推流信息详情。', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '推流域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'StreamName' => [ + 'description' => '推流名称。', + 'type' => 'string', + 'example' => 'liveStream****', + ], + 'App' => [ + 'description' => '推流所属应用名称。', + 'type' => 'string', + 'example' => 'liveApp****'."\n", + ], + 'Fps' => [ + 'description' => '帧率。', + 'type' => 'number', + 'format' => 'float', + 'example' => '74.4', + ], + 'Flr' => [ + 'description' => '丢帧数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'Timestamp' => [ + 'description' => '时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1624358970', + ], + 'Bitrate' => [ + 'description' => '码率，单位为比特每秒（bit/s）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '261587', + ], + 'BwDiff' => [ + 'description' => '码率差值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'CdnName' => [ + 'description' => 'Cdn名称。', + 'type' => 'string', + 'example' => 'ali', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"OK\\\\n\\",\\n \\"RequestId\\": \\"16A96B9A-F203-4EC5-8E43-CB92E68F****\\",\\n \\"Content\\": [\\n {\\n \\"Domain\\": \\"example.com\\",\\n \\"StreamName\\": \\"liveStream****\\",\\n \\"App\\": \\"liveApp****\\\\n\\",\\n \\"Fps\\": 74.4,\\n \\"Flr\\": 0,\\n \\"Timestamp\\": 1624358970,\\n \\"Bitrate\\": 261587,\\n \\"BwDiff\\": 0,\\n \\"CdnName\\": \\"ali\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '头条推流查询接口', + 'description' => '调用接口查询头条指定直播流的推流信息。'."\n" + .'## QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~343507~~)。', + ], + 'DescribeRtcCloudTranscode' => [ + 'summary' => '查询云端转码任务。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用 ID。由大小写字母、数字、下划线、短划线（-）组成，最大 64 字符。', + 'type' => 'string', + 'required' => true, + 'example' => '********-7074-****-9ef5-85c19a4*****', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '云端转码任务ID。由大小写字母、数字、下划线、短划线（-）组成，最大 64 字符。', + 'type' => 'string', + 'required' => true, + 'example' => '******73-8501-****-8ac1-72295a******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回内容。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'TaskInfo' => [ + 'description' => '云端转码任务详情信息。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => '********-7074-****-9ef5-85c19a4*****', + ], + 'ChannelId' => [ + 'description' => '频道ID。', + 'type' => 'string', + 'example' => 'myChannel', + ], + 'TaskId' => [ + 'description' => '云端转码任务ID。', + 'type' => 'string', + 'example' => '******73-8501-****-8ac1-72295a******', + ], + 'Status' => [ + 'description' => '云端转码任务状态：'."\n" + ."\n" + .'- STARTING'."\n" + .'- RUNNING'."\n" + .'- RECOVERING'."\n" + .'- STOPPED', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'InputParam' => [ + 'description' => '订阅输入相关参数。', + 'type' => 'object', + 'properties' => [ + 'SingleSubUserParam' => [ + 'description' => '单流订阅输入参数。', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '订阅的用户ID。', + 'type' => 'string', + 'example' => 'userA', + ], + 'StreamType' => [ + 'description' => '订阅用户的媒体类型。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SourceType' => [ + 'description' => '订阅的视频输入流类型。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + 'OutputParams' => [ + 'description' => '转码输出相关参数。', + 'type' => 'array', + 'items' => [ + 'description' => '转码输出参数。', + 'type' => 'object', + 'properties' => [ + 'ChannelId' => [ + 'description' => '转码流转推到的频道ID。', + 'type' => 'string', + 'example' => 'myChannel', + ], + 'UserId' => [ + 'description' => '转码流转推到频道的用户ID。', + 'type' => 'string', + 'example' => 'userA_360p', + ], + 'UserToken' => [ + 'description' => '转码流转推到频道所需的用户Token。', + 'type' => 'string', + 'example' => 'eyJhcHBpZCI********', + ], + 'TranscodeTemplate' => [ + 'description' => '转码模板名。', + 'type' => 'string', + 'example' => 'lhd', + ], + ], + ], + ], + 'MaxIdleTime' => [ + 'description' => '空闲超时时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '600', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter%s', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'MissingParameter%s', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'NotFound%s', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"TaskInfo\\": {\\n \\"AppId\\": \\"********-7074-****-9ef5-85c19a4*****\\",\\n \\"ChannelId\\": \\"myChannel\\",\\n \\"TaskId\\": \\"******73-8501-****-8ac1-72295a******\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"InputParam\\": {\\n \\"SingleSubUserParam\\": {\\n \\"UserId\\": \\"userA\\",\\n \\"StreamType\\": 0,\\n \\"SourceType\\": 0\\n }\\n },\\n \\"OutputParams\\": [\\n {\\n \\"ChannelId\\": \\"myChannel\\",\\n \\"UserId\\": \\"userA_360p\\",\\n \\"UserToken\\": \\"eyJhcHBpZCI********\\",\\n \\"TranscodeTemplate\\": \\"lhd\\"\\n }\\n ],\\n \\"MaxIdleTime\\": 600\\n }\\n}","type":"json"}]', + 'title' => '查询云端转码任务', + ], + 'StartRtcCloudTranscode' => [ + 'summary' => '创建云端转码任务。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '频道所属的应用 ID。由大小写字母、数字、下划线、短划线（-）组成，最大 64 字符。', + 'type' => 'string', + 'required' => true, + 'example' => '********-7074-****-9ef5-85c19a4*****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '待转码用户所属的频道 ID。由大小写字母、数字、下划线、短划线（-）组成，最大 64 字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'myChannel', + ], + ], + [ + 'name' => 'InputParam', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '订阅输入相关参数。', + 'type' => 'object', + 'properties' => [ + 'SingleSubUserParam' => [ + 'description' => '单流订阅输入参数。', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '订阅的用户ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'userA', + ], + 'StreamType' => [ + 'description' => '订阅用户的媒体类型。取值：'."\n" + ."\n" + .'- 0（默认值）：原始流，包含音频与视频流。'."\n" + .'- 1：仅音频流。（暂不支持，设置无效）'."\n" + .'- 2：仅视频流。（暂不支持，设置无效）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'SourceType' => [ + 'description' => '订阅的视频输入流类型，仅订阅媒体类型包含视频流有效。取值：'."\n" + ."\n" + .'- 0（默认值）：摄像头。'."\n" + .'- 1：屏幕共享。（暂不支持，设置无效）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => true, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'OutputParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '转码输出相关参数。', + 'type' => 'array', + 'items' => [ + 'description' => '转码输出参数。', + 'type' => 'object', + 'properties' => [ + 'ChannelId' => [ + 'description' => '转码流转推到的频道ID。由大小写字母、数字、下划线、短划线（-）组成，最大 64 字符。（暂不支持转推到不同的频道，设置无效）', + 'type' => 'string', + 'required' => true, + 'example' => 'myChannel', + ], + 'UserId' => [ + 'description' => '转码流转推到频道的用户ID，需保证与频道内其它用户ID不同。', + 'type' => 'string', + 'required' => true, + 'example' => 'userA_360p', + ], + 'UserToken' => [ + 'description' => '转码流转推到频道所需的用户Token，详见[Token鉴权](https://help.aliyun.com/zh/live/token-based-authentication)。', + 'type' => 'string', + 'required' => true, + 'example' => 'eyJhcHBpZCI********', + ], + 'TranscodeTemplate' => [ + 'description' => '转码模板名。取值：'."\n" + ."\n" + .'- alimcopy'."\n" + .'- lld'."\n" + .'- lsd'."\n" + .'- lhd'."\n" + .'- lud', + 'type' => 'string', + 'required' => true, + 'example' => 'lhd', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'MaxIdleTime', + 'in' => 'query', + 'schema' => [ + 'description' => '空闲超时时间，当任务处于空闲状态（订阅不到指定主播流）的时长超过一定时间会自动停止。'."\n" + .'单位为秒，范围须在[10,14400]内，即最大 4 小时，默认为 300 秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '600', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回内容。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'TaskId' => [ + 'description' => '云端转码任务ID。', + 'type' => 'string', + 'example' => '******73-8501-****-8ac1-72295a******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter%s', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'MissingParameter%s', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'NotFound%s', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"TaskId\\": \\"******73-8501-****-8ac1-72295a******\\"\\n}","type":"json"}]', + 'title' => '创建云端转码任务', + 'description' => '## 服务接入点'."\n" + .'本接口可用的服务接入点包括：'."\n" + ."\n" + .' |地域名称 |地域ID | 公网接入地址 |'."\n" + .' | --- | --- | --- |'."\n" + .' | 新加坡 | ap-southeast-1 | live.ap-southeast-1.aliyuncs.com |', + ], + 'StopRtcCloudTranscode' => [ + 'summary' => '停止云端转码任务。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREliveK6LRQR', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用 ID。由大小写字母、数字、下划线、短划线（-）组成，最大 64 字符。', + 'type' => 'string', + 'required' => true, + 'example' => '********-7074-****-9ef5-85c19a4*****', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '云端转码任务ID。由大小写字母、数字、下划线、短划线（-）组成，最大 64 字符。', + 'type' => 'string', + 'required' => true, + 'example' => '******73-8501-****-8ac1-72295a******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回内容。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter%s', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'MissingParameter%s', + 'errorMessage' => '%s.', + ], + [ + 'errorCode' => 'TooManyRequests', + 'errorMessage' => '%s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s.', + ], + ], + [ + [ + 'errorCode' => 'NotFound%s', + 'errorMessage' => '%s.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', + 'title' => '停止云端转码任务', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2-pop', + 'endpoint' => 'live.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-pop', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-gov-1', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-nu16-b01', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-edge-1', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fujian', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-haidian-cm12-c01', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-bj-b01', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-prod-1', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-1', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-2', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-3', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-test-306', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong-finance-pop', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote-nebula-1', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao-nebula', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et15-b01', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et2-b01', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-inner', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-internal-test-1', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-inner', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-st4-d01', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-su18-b01', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-yushanfang', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangbei', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangbei-na61-b01', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou-na62-a01', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-nebula-1', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1-oxs', + 'endpoint' => 'live.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'rus-west-1-pop', + 'endpoint' => 'live.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'live.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'live.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'live.eu-central-1.aliyuncs.com', + ], + ], +]; |