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/vod/2017-03-21 | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/vod/2017-03-21')
| -rw-r--r-- | data/zh_cn/vod/2017-03-21/api-docs.php | 33255 |
1 files changed, 33255 insertions, 0 deletions
diff --git a/data/zh_cn/vod/2017-03-21/api-docs.php b/data/zh_cn/vod/2017-03-21/api-docs.php new file mode 100644 index 0000000..7faeb94 --- /dev/null +++ b/data/zh_cn/vod/2017-03-21/api-docs.php @@ -0,0 +1,33255 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'vod', + 'version' => '2017-03-21', + ], + 'directories' => [ + [ + 'id' => 347483, + 'title' => '媒体上传', + 'type' => 'directory', + 'children' => [ + 'CreateUploadVideo', + 'RefreshUploadVideo', + 'CreateUploadImage', + 'CreateUploadAttachedMedia', + 'UploadMediaByURL', + 'GetURLUploadInfos', + 'CancelUrlUploadJobs', + 'UploadStreamByURL', + 'DeleteMultipartUpload', + 'GetUploadDetails', + 'RegisterMedia', + ], + ], + [ + 'id' => 347495, + 'title' => '音视频播放', + 'type' => 'directory', + 'children' => [ + 'GetPlayInfo', + 'GetVideoPlayAuth', + ], + ], + [ + 'id' => 347498, + 'title' => '媒资管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 347499, + 'title' => '媒资搜索', + 'type' => 'directory', + 'children' => [ + 'SearchMedia', + ], + ], + [ + 'id' => 347501, + 'title' => '分级存储', + 'type' => 'directory', + 'children' => [ + 'UpdateMediaStorageClass', + 'RestoreMedia', + ], + ], + [ + 'id' => 347504, + 'title' => '分类管理', + 'type' => 'directory', + 'children' => [ + 'AddCategory', + 'UpdateCategory', + 'DeleteCategory', + 'GetCategories', + ], + ], + [ + 'id' => 347509, + 'title' => '音视频管理', + 'type' => 'directory', + 'children' => [ + 'GetVideoInfo', + 'GetVideoInfos', + 'GetVideoList', + 'GetMezzanineInfo', + 'UpdateVideoInfo', + 'UpdateVideoInfos', + 'DeleteMezzanines', + 'DeleteStream', + 'DeleteVideo', + 'BatchGetMediaInfos', + 'DescribeMediaDistribution', + ], + ], + [ + 'id' => 347521, + 'title' => '辅助媒资管理', + 'type' => 'directory', + 'children' => [ + 'GetAttachedMediaInfo', + 'UpdateAttachedMediaInfos', + 'DeleteAttachedMedia', + ], + ], + [ + 'id' => 347525, + 'title' => '图片管理', + 'type' => 'directory', + 'children' => [ + 'GetImageInfo', + 'GetImageInfos', + 'UpdateImageInfos', + 'ListSnapshots', + 'DeleteImage', + ], + ], + [ + 'id' => 347531, + 'title' => '动图管理', + 'type' => 'directory', + 'children' => [ + 'ListDynamicImage', + 'DeleteDynamicImage', + ], + ], + ], + ], + [ + 'id' => 347534, + 'title' => '媒体处理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 347535, + 'title' => '发起处理', + 'type' => 'directory', + 'children' => [ + 'SubmitTranscodeJobs', + 'SubmitSnapshotJob', + 'SubmitPreprocessJobs', + 'SubmitDynamicImageJob', + 'SubmitWorkflowJob', + ], + ], + [ + 'id' => 347541, + 'title' => '转码模板', + 'type' => 'directory', + 'children' => [ + 'AddTranscodeTemplateGroup', + 'UpdateTranscodeTemplateGroup', + 'SetDefaultTranscodeTemplateGroup', + 'ListTranscodeTemplateGroup', + 'GetTranscodeTemplateGroup', + 'DeleteTranscodeTemplateGroup', + ], + ], + [ + 'id' => 347548, + 'title' => '截图模板', + 'type' => 'directory', + 'children' => [ + 'AddVodTemplate', + 'UpdateVodTemplate', + 'GetVodTemplate', + 'ListVodTemplate', + 'DeleteVodTemplate', + ], + ], + [ + 'id' => 347554, + 'title' => '图文水印模板', + 'type' => 'directory', + 'children' => [ + 'AddWatermark', + 'UpdateWatermark', + 'DeleteWatermark', + 'SetDefaultWatermark', + 'GetWatermark', + 'ListWatermark', + ], + ], + [ + 'id' => 347561, + 'title' => '转码任务', + 'type' => 'directory', + 'children' => [ + 'GetTranscodeSummary', + 'ListTranscodeTask', + 'GetTranscodeTask', + ], + ], + [ + 'id' => 347565, + 'title' => '任务管理 ', + 'type' => 'directory', + 'children' => [ + 'ListJobInfo', + 'GetJobDetail', + ], + ], + ], + ], + [ + 'id' => 347568, + 'title' => '视频编辑（云剪辑）', + 'type' => 'directory', + 'children' => [ + 'ProduceEditingProjectVideo', + [ + 'id' => 347570, + 'title' => '云剪辑工程管理', + 'type' => 'directory', + 'children' => [ + 'AddEditingProject', + 'UpdateEditingProject', + 'DeleteEditingProject', + 'SetEditingProjectMaterials', + 'GetEditingProject', + 'GetEditingProjectMaterials', + 'SearchEditingProject', + 'AddEditingProjectMaterials', + 'DeleteEditingProjectMaterials', + ], + ], + ], + ], + [ + 'id' => 347580, + 'title' => '媒体审核', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 347581, + 'title' => '审核设置', + 'type' => 'directory', + 'children' => [ + 'SetAuditSecurityIp', + 'ListAuditSecurityIp', + ], + ], + [ + 'id' => 347584, + 'title' => '智能审核', + 'type' => 'directory', + 'children' => [ + 'SubmitAIMediaAuditJob', + 'SubmitAIImageAuditJob', + 'GetAIMediaAuditJob', + 'GetMediaAuditResult', + 'GetMediaAuditResultDetail', + 'GetMediaAuditResultTimeline', + 'GetMediaAuditAudioResultDetail', + ], + ], + [ + 'id' => 347592, + 'title' => '人工审核', + 'type' => 'directory', + 'children' => [ + 'CreateAudit', + 'GetAuditHistory', + ], + ], + ], + ], + [ + 'id' => 347595, + 'title' => '视频AI', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 347596, + 'title' => 'AI模板', + 'type' => 'directory', + 'children' => [ + 'AddAITemplate', + 'DeleteAITemplate', + 'UpdateAITemplate', + 'SetDefaultAITemplate', + 'GetAITemplate', + 'ListAITemplate', + 'GetDefaultAITemplate', + ], + ], + [ + 'id' => 347604, + 'title' => 'AI作业', + 'type' => 'directory', + 'children' => [ + 'ListAIJob', + 'SubmitAIJob', + ], + ], + [ + 'id' => 347607, + 'title' => '视频DNA', + 'type' => 'directory', + 'children' => [ + 'GetMediaDNAResult', + 'SubmitMediaDNADeleteJob', + ], + ], + [ + 'id' => 347610, + 'title' => '智能标签', + 'type' => 'directory', + 'children' => [ + 'GetAIVideoTagResult', + ], + ], + [ + 'id' => 347612, + 'title' => '智能封面', + 'type' => 'directory', + 'children' => [ + 'SubmitAIImageJob', + 'GetAIImageJobs', + 'ListAIImageInfo', + 'DeleteAIImageInfos', + ], + ], + ], + ], + [ + 'id' => 347617, + 'title' => '直播转点播', + 'type' => 'directory', + 'children' => [ + 'ListLiveRecordVideo', + ], + ], + [ + 'id' => 347619, + 'title' => '点播CDN', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 347620, + 'title' => '监控查询', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 347621, + 'title' => '资源访问数据', + 'type' => 'directory', + 'children' => [ + 'DescribeVodDomainTrafficData', + 'DescribeVodDomainBpsData', + 'DescribeVodDomainBpsDataByLayer', + 'DescribeVodDomainQpsData', + 'DescribeVodDomainHitRateData', + 'DescribeVodDomainReqHitRateData', + 'DescribeVodRangeDataByLocateAndIspService', + ], + ], + [ + 'id' => 347629, + 'title' => '资源回源数据', + 'type' => 'directory', + 'children' => [ + 'DescribeVodDomainSrcTrafficData', + 'DescribeVodDomainSrcBpsData', + ], + ], + [ + 'id' => 347632, + 'title' => '实时访问数据', + 'type' => 'directory', + 'children' => [ + 'DescribeVodDomainRealTimeTrafficData', + 'DescribeVodDomainRealTimeBpsData', + 'DescribeVodDomainRealTimeHttpCodeData', + 'DescribeVodDomainRealTimeQpsData', + 'DescribeVodDomainRealTimeReqHitRateData', + 'DescribeVodDomainRealTimeByteHitRateData', + 'DescribeVodDomainRealTimeDetailData', + ], + ], + ], + ], + [ + 'id' => 347640, + 'title' => '域名管理', + 'type' => 'directory', + 'children' => [ + 'AddVodDomain', + 'DeleteVodDomain', + 'UpdateVodDomain', + 'DescribeVodUserDomains', + 'DescribeVodDomainDetail', + 'BatchStartVodDomain', + 'BatchStopVodDomain', + ], + ], + [ + 'id' => 347648, + 'title' => '域名验证', + 'type' => 'directory', + 'children' => [ + 'VerifyVodDomainOwner', + 'DescribeVodVerifyContent', + ], + ], + [ + 'id' => 347651, + 'title' => '域名配置', + 'type' => 'directory', + 'children' => [ + 'DeleteVodSpecificConfig', + 'SetVodDomainCertificate', + 'DescribeVodDomainConfigs', + 'DescribeVodCertificateList', + 'DescribeVodDomainCertificateInfo', + 'BatchSetVodDomainConfigs', + ], + ], + [ + 'id' => 347658, + 'title' => '刷新预热', + 'type' => 'directory', + 'children' => [ + 'DescribeVodRefreshTasks', + 'DescribeVodRefreshQuota', + 'PreloadVodObjectCaches', + 'RefreshVodObjectCaches', + 'RefreshMediaPlayUrls', + 'GetMediaRefreshJobs', + ], + ], + [ + 'id' => 347665, + 'title' => '日志管理', + 'type' => 'directory', + 'children' => [ + 'DescribeVodDomainLog', + ], + ], + ], + ], + [ + 'id' => 347667, + 'title' => '视频安全', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 347668, + 'title' => 'HLS标准加密', + 'type' => 'directory', + 'children' => [ + 'GenerateKMSDataKey', + 'DecryptKMSDataKey', + ], + ], + [ + 'id' => 347671, + 'title' => '数字水印', + 'type' => 'directory', + 'children' => [ + 'SubmitDigitalWatermarkExtractJob', + 'GetDigitalWatermarkExtractResult', + ], + ], + [ + 'id' => 347674, + 'title' => '安全下载（缓存）', + 'type' => 'directory', + 'children' => [ + 'GenerateDownloadSecretKey', + ], + ], + ], + ], + [ + 'id' => 347676, + 'title' => '数据统计', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 347677, + 'title' => '用量数据', + 'type' => 'directory', + 'children' => [ + 'DescribeVodDomainUsageData', + 'DescribeVodStorageData', + 'DescribeVodTranscodeData', + 'DescribeVodAIData', + 'DescribeVodTieringStorageData', + 'DescribeVodTieringStorageRetrievalData', + ], + ], + [ + 'id' => 347684, + 'title' => '播放质量（QOS/QOE）', + 'type' => 'directory', + 'children' => [ + 'DescribeVodPlayerMetricData', + 'DescribeVodPlayerCollectData', + 'DescribeVodPlayerDimensionData', + ], + ], + [ + 'id' => 347688, + 'title' => '播放数据（新）', + 'type' => 'directory', + 'children' => [ + 'GetDailyPlayRegionStatis', + 'DescribeVodMediaPlayData', + ], + ], + [ + 'id' => 347691, + 'title' => '播放数据（旧）', + 'type' => 'directory', + 'children' => [ + 'DescribePlayTopVideos', + 'DescribePlayUserAvg', + 'DescribePlayUserTotal', + 'DescribePlayVideoStatis', + ], + ], + ], + ], + [ + 'id' => 347696, + 'title' => '多应用体系', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 347697, + 'title' => '应用管理', + 'type' => 'directory', + 'children' => [ + 'CreateAppInfo', + 'DeleteAppInfo', + 'UpdateAppInfo', + 'GetAppInfos', + 'ListAppInfo', + 'AddVodStorageForApp', + ], + ], + [ + 'id' => 347704, + 'title' => '授权管理', + 'type' => 'directory', + 'children' => [ + 'AttachAppPolicyToIdentity', + 'DetachAppPolicyFromIdentity', + 'ListAppPoliciesForIdentity', + ], + ], + [ + 'id' => 347708, + 'title' => '资源迁移', + 'type' => 'directory', + 'children' => [ + 'MoveAppResource', + ], + ], + [ + 'id' => 347710, + 'title' => '播放密钥', + 'type' => 'directory', + 'children' => [ + 'GetAppPlayKey', + 'SetAppPlayKey', + ], + ], + ], + ], + [ + 'id' => 347713, + 'title' => '全局配置', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 347714, + 'title' => '存储管理', + 'type' => 'directory', + 'children' => [ + 'SetCrossdomainContent', + ], + ], + [ + 'id' => 347716, + 'title' => '事件通知', + 'type' => 'directory', + 'children' => [ + 'DeleteMessageCallback', + 'SetMessageCallback', + 'GetMessageCallback', + ], + ], + ], + ], + [ + 'id' => 347720, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'ChangeResourceGroup', + 'DescribeVodDomainMax95BpsData', + 'DescribeVodSSLCertificateList', + 'SetVodDomainSSLCertificate', + 'DescribeVodEditingUsageData', + 'DescribeVodUserVipsByDomain', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'AppInfoDTO' => [ + 'title' => 'A short description of struct', + 'description' => '应用信息', + 'type' => 'object', + 'properties' => [ + 'ItemId' => [ + 'title' => '应用标识', + 'type' => 'string', + ], + 'AppName' => [ + 'title' => '应用名称', + 'type' => 'string', + ], + 'UserId' => [ + 'title' => '用户ID', + 'type' => 'integer', + 'format' => 'int64', + ], + 'AppType' => [ + 'title' => '应用类型', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1-普通应用，2-内嵌SDK.', + ], + 'GmtCreate' => [ + 'title' => '创建时间', + 'type' => 'string', + ], + 'Platforms' => [ + 'title' => '应用包含的平台信息列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '平台类型', + 'type' => 'integer', + 'format' => 'int64', + ], + 'PlatformType' => [ + 'title' => '平台类型', + 'type' => 'integer', + 'format' => 'int64', + ], + 'PkgName' => [ + 'title' => '包名', + 'type' => 'string', + ], + 'PkgSignature' => [ + 'title' => '包签名', + 'type' => 'string', + ], + 'ItemId' => [ + 'title' => '平台标志', + 'type' => 'string', + ], + 'LicenseItemIds' => [ + 'title' => '授权列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => '授权itemId', + ], + ], + ], + ], + ], + 'CreationTime' => [ + 'title' => '创建时间', + 'type' => 'string', + ], + 'ModificationTime' => [ + 'title' => '更新时间', + 'type' => 'string', + ], + 'GmtModified' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'apis' => [ + 'CreateUploadVideo' => [ + 'summary' => '点播服务下发上传地址和凭证以保障授权和安全，防止恶意上传，并在下发时自动创建媒体ID（MediaId），也叫视频ID（VideoId）用于管理。通过调用本接口可获取上传所需地址和凭证，并创建音视频信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39819', + 'abilityTreeNodes' => [ + 'FEATUREvodVQ27S4', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CoverURL', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义视频封面的URL地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://example.aliyundoc.com/image/D22F553TEST****.jpeg', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '上传完成后，在点播中展示的音/视频描述。'."\n" + ."\n" + .'- 长度不超过1024个字符。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'UploadTest', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => '待上传的音/视频源文件地址。'."\n" + ."\n" + .'- 必须带扩展名，且扩展名不区分大小写。'."\n" + .'- 支持的扩展名，请参见[上传概述](~~55396~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'D:\\video_01.mp4', + ], + ], + [ + 'name' => 'FileSize', + 'in' => 'query', + 'schema' => [ + 'description' => '待上传的音/视频源文件的大小。单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '上传完成后，在点播中展示的音/视频标题。'."\n" + ."\n" + .'- 长度不超过128个字符。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'UploadTest', + ], + ], + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => '分类ID。可通过以下方式获取：'."\n" + ."\n" + .'- 登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **分类管理**查看分类ID。'."\n" + .'- 通过[AddCategory](~~AddCategory~~)接口创建分类时，分类ID为返回参数CateId的值。'."\n" + .'- 通过[GetCategories](~~GetCategories~~)接口查询分类时，为请求后返回参数CateId的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100036****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => '音/视频标签。'."\n" + ."\n" + .'- 最多不超过16个标签。'."\n" + .'- 如需设置多个音/视频标签，请使用半角逗号（,）分隔。'."\n" + .'- 单个标签不超过32个字符或汉字。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag1,tag2', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置。为JSON字符串，支持消息回调、上传加速等设置。更多信息，请参见[UserData](~~86952~~)。'."\n" + ."\n" + .'> - 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用，否则回调设置不生效。控制台配置HTTP回调的操作，请参考[回调设置](~~86071~~)。'."\n" + .'> - 如需使用上传加速功能，您需要[填写宜搭信息](https://yida.alibaba-inc.com/o/ticketapply)申请开通，更多信息，请参见[上传相关说明](~~55396~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}', + ], + ], + [ + 'name' => 'TemplateGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板组ID。可通过以下方式获取：'."\n" + .'- 登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒体处理配置** > **转码模板组**查看转码模板组ID。'."\n" + .'- 通过[创建转码模板组](~~102665~~)接口创建转码模板组时，转码模板组ID为返回参数TranscodeTemplateGroupId的值。'."\n" + .'- 通过[查询转码配置列表](~~102669~~)接口查询转码模板组时，为请求后返回参数TranscodeTemplateGroupId的值。'."\n" + ."\n" + .'>- 如果同时传递了WorkflowId和TemplateGroupId，以WorkflowId为准。'."\n" + .'>- 若不传入本参数，则按默认的转码模板组进行转码；若传入了转码模板组ID时，则按指定的模板组进行转码。'."\n" + .'>- 若设置为系统内置的**不转码**模板组，则音视频上传后，仅有[视频上传完成 ](~~55630~~)的事件通知，没有[单个清晰度转码完成](~~55636~~)的事件通知。'."\n" + .'>- 为确保正常播放，当设置为系统内置的**不转码**模板组，则视音频上传完成后，仅以下格式支持不转码直接播放：MP4、FLV、MP3、M3U8、WEBM，其他格式仅支持存储（关注FileName的扩展名）；若使用阿里云播放器播放，则版本须为3.1.0或以上。', + 'type' => 'string', + 'required' => false, + 'example' => '405477f9e214d19ea2c7c854****', + ], + ], + [ + 'name' => 'WorkflowId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流ID。可登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒体处理配置** > **工作流管理**查看工作流ID。'."\n" + ."\n" + .'> 如果同时传递了WorkflowId和TemplateGroupId，以WorkflowId为准。使用说明，请参见[工作流](~~115347~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '613efff3887ec34af685714cc461****', + ], + ], + [ + 'name' => 'StorageLocation', + 'in' => 'query', + 'schema' => [ + 'description' => '存储地址。可通过以下方式获取：'."\n" + .'登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **存储管理**查看存储地址。'."\n" + ."\n" + .'> 若不传此参数，则音视频文件上传至默认的存储地址上（无默认存储地址时上传至存储列表第一个存储地址）；若传入此参数，则音视频文件上传至该指定的存储地址上。', + 'type' => 'string', + 'required' => false, + 'example' => 'out-****.oss-cn-shanghai.aliyuncs.com', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。默认取值：**app-1000000**。更多信息，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-1000000', + ], + ], + [ + 'name' => 'ReferenceId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义 ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'description' => '自定义 ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-04D5-D7393642****', + ], + 'UploadAddress' => [ + 'description' => '上传地址。'."\n" + ."\n" + .'> 接口返回的上传地址是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAddress。', + 'type' => 'string', + 'example' => 'eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****', + ], + 'VideoId' => [ + 'description' => '音/视频ID。可作为媒资管理、媒体处理、媒体审核等接口的请求参数。', + 'type' => 'string', + 'example' => '93ab850b4f6f54b6e91d24d81d44****', + ], + 'UploadAuth' => [ + 'description' => '上传凭证。'."\n" + ."\n" + .'> 接口返回的上传凭证是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAuth。', + 'type' => 'string', + 'example' => 'eyJFbmRwb2ludCI6Imm****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-04D5-D7393642****\\",\\n \\"UploadAddress\\": \\"eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****\\",\\n \\"VideoId\\": \\"93ab850b4f6f54b6e91d24d81d44****\\",\\n \\"UploadAuth\\": \\"eyJFbmRwb2ludCI6Imm****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateUploadVideoResponse>\\n <RequestId>25818875-5F78-4AF6-04D5-D7393642****</RequestId>\\n <UploadAddress>eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****</UploadAddress>\\n <VideoId>93ab850b4f6f54b6e91d24d81d44****</VideoId>\\n <UploadAuth>eyJFbmRwb2ludCI6Imm****</UploadAuth>\\n</CreateUploadVideoResponse>","errorExample":""}]', + 'title' => '获取音视频上传地址和凭证', + 'description' => '- **请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。媒资文件上传到视频点播中会产生存储费用，计费详情，请参见[媒资存储计费](~~188308#section_e97_xrp_mzz~~)。如果您已开通了存储传输加速，则上传媒资文件到视频点播时还将涉及上传加速费用，计费详情请参见[存储传输加速计费](~~188310#section_sta_zm2_tsv~~)。存储费用从文件上传成功开始计算，加速费用在开通后进行上传操作时进行计算，仅调用本接口不计费。**'."\n" + .'- 获取上传地址和凭证为点播服务的核心基础，是每个上传操作的必经过程。点播服务提供多种不同的上传方式，每种方式对获取上传地址和凭证的要求不同，详细内容请参见[上传地址和凭证](~~55397~~)的使用说明。'."\n" + .'- 本接口仅用于获取上传地址和凭证以及创建媒资基础信息，并非上传文件，通过接口上传的完整示例，请参见[通过视频点播API上传媒资文件](~~476208~~)。'."\n" + .'- 本接口既支持获取视频的上传地址和凭证，同时也支持获取音频的上传地址和凭证。具体操作，请参见[上传地址和凭证](~~55397~~)。'."\n" + .'- 如果视频上传凭证失效（默认有效期为3000秒），请调用[RefreshUploadVideo](~~RefreshUploadVideo~~)接口重新获取上传凭证。'."\n" + .'- 上传后，可通过配置回调，接收[上传事件通知](~~55396~~)或调用[GetMezzanineInfo](~~59624~~)接口根据返回的文件状态来判断是否上传成功。'."\n" + .'- 本接口返回的VideoId参数，可以用于媒资生命周期管理或媒体处理。', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidFileName.Extension | The specified FileName’s extension is illegal. | 400 | 参数FileName的文件扩展名无效。点播支持的文件扩展名限制，请参见[上传概述](~~55396~~)。|'."\n" + .'| IllegalCharacters | The specified $Parameter contains illegal emoticon or special characters. | 400 |请求参数Parameter（如：Title、Description、Tags等）参数值中不能包含表情符。|'."\n" + .'| LengthExceededMax | The specified $Parameter length has exceeded $MaxLength bytes. | 400 |请求参数Parameter（如：Title、Description、Tags）参数值长度超过MaxLength限制。参数值长度限制请参考本文档中请求参数说明。|'."\n" + .'| TagsExceededMax | The specified Tags count has exceeded 16. | 400 | 设置的标签个数超过最多16个的限制。|'."\n" + .'| InvalidTemplateGroupId.NotFound | The TemplateGroupId does not exist. | 404 | 指定的模板组ID不存在。|'."\n" + .'| InvalidStorage.NotFound | The StorageLocation does not exist. | 404 | 设置的存储地址不存在，登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **存储管理** 查看确认。|'."\n" + .'| Forbidden.InitFailed | Initialization of your account has failed while opening service. | 403 | 服务开通时账号初始化失败。|'."\n" + .'| AddVideoFailed | Adding video has failed due to some unknown error. | 503 | 创建视频信息失败，请稍后重试。|', + ], + 'RefreshUploadVideo' => [ + 'summary' => '用于视频文件上传超时后重新获取视频上传凭证。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40108', + 'abilityTreeNodes' => [ + 'FEATUREvodVQ27S4', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '音/视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看音频或视频ID。'."\n" + .'- 通过[CreateUploadVideo](~~55407~~)接口上传音频或视频时，音/视频ID为返回参数VideoId的值。'."\n" + .'- 音频或视频上传后，可通过[SearchMedia](~~86044~~)接口查询音/视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'c6a23a870c8c4ffcd40cbd381333****', + ], + ], + [ + 'name' => 'ReferenceId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义 ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'description' => '自定义 ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A43-7DF6-D7393642****', + ], + 'UploadAddress' => [ + 'description' => '上传地址。'."\n" + .'>接口返回的上传地址是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAddress。', + 'type' => 'string', + 'example' => 'eyJTZWN1cml0eVRiQ0FJU3p3TjFxNkZ0NUIyeW****', + ], + 'VideoId' => [ + 'description' => '音/视频ID。', + 'type' => 'string', + 'example' => 'c6a23a870c8c4ffcd40cbd381333****', + ], + 'UploadAuth' => [ + 'description' => '上传凭证。'."\n" + .'>接口返回的上传凭证是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAuth。', + 'type' => 'string', + 'example' => 'FJU3p3TZ0NUIyeW****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A43-7DF6-D7393642****\\",\\n \\"UploadAddress\\": \\"eyJTZWN1cml0eVRiQ0FJU3p3TjFxNkZ0NUIyeW****\\",\\n \\"VideoId\\": \\"c6a23a870c8c4ffcd40cbd381333****\\",\\n \\"UploadAuth\\": \\"FJU3p3TZ0NUIyeW****\\"\\n}","errorExample":""},{"type":"xml","example":"<RefreshUploadVideoResponse>\\n <RequestId>25818875-5F78-4A43-7DF6-D7393642****</RequestId>\\n <UploadAddress>eyJTZWN1cml0eVRiQ0FJU3p3TjFxNkZ0NUIyeW****</UploadAddress>\\n <VideoId>c6a23a870c8c4ffcd40cbd381333****</VideoId>\\n <UploadAuth>FJU3p3TZ0NUIyeW****</UploadAuth>\\n</RefreshUploadVideoResponse>","errorExample":""}]', + 'title' => '刷新视频上传凭证', + 'description' => '该接口也可用于视频、音频源文件的覆盖上传（即获取到源文件上传地址后重新上传且音/视频ID保持不变），但可能会自动触发转码和截图（若设置了上传时转码或截图）。使用说明，请参见[上传地址和凭证](~~55397~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidVideo.Damaged | The video has been Damaged. | 400 | 视频创建有误或已被损坏。|'."\n" + .'| InvalidVideo.NotFound | The video not exist. | 404 | 视频不存在。|', + ], + 'CreateUploadImage' => [ + 'summary' => '点播服务下发上传地址和凭证以保障授权和安全，防止恶意上传，并在下发时自动创建图片ID（ImageId）用于管理。通过调用本接口可获取上传所需地址和凭证，并创建图片信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39817', + 'abilityTreeNodes' => [ + 'FEATUREvodVQ27S4', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '图片标题。规则：'."\n" + ."\n" + .'- 长度不超过128个字符。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'mytitle', + ], + ], + [ + 'name' => 'ImageType', + 'in' => 'query', + 'schema' => [ + 'description' => '图片类型。取值：'."\n" + ."\n" + .'- **default**（默认）：普通图片'."\n" + .'- **cover**：视频封面图'."\n" + ."\n" + .'> 点播控制台目前仅支持对**default**类型的图片进行查看和管理。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'ImageExt', + 'in' => 'query', + 'schema' => [ + 'description' => '待上传的图片源文件的扩展名。取值：'."\n" + ."\n" + .'- **png**（默认）'."\n" + .'- **jpg**'."\n" + .'- **jpeg**'."\n" + .'- **gif**'."\n" + .'- **heic**'."\n" + .'- **webp**', + 'type' => 'string', + 'required' => false, + 'example' => 'png', + ], + ], + [ + 'name' => 'OriginalFileName', + 'in' => 'query', + 'schema' => [ + 'description' => '待上传的图片源文件地址。'."\n" + .'>可不带扩展名；若此处带了扩展名，且此处的扩展名与`ImageExt`中设置的扩展名不一致，以`ImageExt`为准。', + 'type' => 'string', + 'required' => false, + 'example' => 'D:\\picture_01', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => '图片标签。规则：'."\n" + ."\n" + .'- 单个标签不超过32个字符。'."\n" + .'- 最多不超过16个标签。'."\n" + .'- 多个标签之间，请使用半角逗号（,）分隔。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + [ + 'name' => 'StorageLocation', + 'in' => 'query', + 'schema' => [ + 'description' => '存储地址。可通过以下方式获取：'."\n" + .'登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **存储管理**查看存储地址。'."\n" + ."\n" + .'> 若不传此参数，则图片上传到默认的存储地址上；若传入此参数，则图片上传到该指定的存储地址上。', + 'type' => 'string', + 'required' => false, + 'example' => 'outin-****..oss-cn-shanghai.aliyuncs.com', + ], + ], + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => '分类ID。可通过以下方式获取：'."\n" + .'- 登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **分类管理**查看分类ID。'."\n" + .'- 通过[AddCategory](~~AddCategory~~)接口创建分类时，分类ID为返回参数CateId的值。'."\n" + .'- 通过[GetCategories](~~GetCategories~~)接口查询分类时，为请求后返回参数CateId的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100036****', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置，为JSON字符串，支持消息回调、上传加速等设置。详情参见[UserData](~~86952~~)。'."\n" + ."\n" + .'> - 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用，否则回调设置不生效。控制台配置HTTP回调的操作，请参考[回调设置](~~86071~~)。'."\n" + .'> - 如需使用上传加速功能，请提交工单申请开通，更多信息，请参见[上传相关说明](~~55396~~)。关于如何提交工单，请参见[联系我们](~~464625~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '图片描述。'."\n" + ."\n" + .'- 长度不超过1024个字符。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'example' => '图片上传测试', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。默认取值：**app-1000000**。若已开通多应用体系，传入应用ID，可将图片上传到指定应用下。更多信息，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-1000000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'FileURL' => [ + 'description' => '图片文件的OSS地址（不带鉴权）。'."\n" + ."\n" + .'添加图片水印模板时，该地址可作为[AddWatermark](~~AddWatermark~~)接口的请求参数`FileUrl`。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/cover/2017-34DB-4F4C-9373-003AA060****.png', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-AEF6-D7393642****', + ], + 'UploadAddress' => [ + 'description' => '上传地址。'."\n" + ."\n" + .'> 接口返回的上传地址是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAddress。', + 'type' => 'string', + 'example' => 'eyJTZWN1cmuIjoiQ0FJU3p3TjF****', + ], + 'ImageURL' => [ + 'description' => '图片的访问地址。'."\n" + .'> 如果返回的ImageURL在浏览器无法访问（403），是因为您开启了点播域名的鉴权功能。可关闭[URL鉴权](~~86090~~)或自助[生成鉴权签名](~~57007~~)。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/cover/2017-34DB-4F4C-9373-003AA060****.png', + ], + 'ImageId' => [ + 'description' => '图片ID。可作为[GetImageInfo](~~GetImageInfo~~)、[GetImageInfos](~~GetImageInfos~~)、[UpdateImageInfos](~~UpdateImageInfos~~)、[DeleteImage](~~DeleteImage~~)等接口的请求参数。', + 'type' => 'string', + 'example' => '93ab850b4f6f46e91d24d81d4****', + ], + 'UploadAuth' => [ + 'description' => '上传凭证。'."\n" + .'> 接口返回的上传凭证是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAuth。', + 'type' => 'string', + 'example' => 'eyJFbmmRCI6Im****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"FileURL\\": \\"http://example.aliyundoc.com/cover/2017-34DB-4F4C-9373-003AA060****.png\\",\\n \\"RequestId\\": \\"25818875-5F78-AEF6-D7393642****\\",\\n \\"UploadAddress\\": \\"eyJTZWN1cmuIjoiQ0FJU3p3TjF****\\",\\n \\"ImageURL\\": \\"http://example.aliyundoc.com/cover/2017-34DB-4F4C-9373-003AA060****.png\\",\\n \\"ImageId\\": \\"93ab850b4f6f46e91d24d81d4****\\",\\n \\"UploadAuth\\": \\"eyJFbmmRCI6Im****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateUploadImageResponse>\\n <FileURL>http://example.aliyundoc.com/cover/2017-34DB-4F4C-9373-003AA060****.png</FileURL>\\n <RequestId>25818875-5F78-AEF6-D7393642****</RequestId>\\n <UploadAddress>eyJTZWN1cmuIjoiQ0FJU3p3TjF****</UploadAddress>\\n <ImageURL>http://example.aliyundoc.com/cover/2017-34DB-4F4C-9373-003AA060****.png</ImageURL>\\n <ImageId>93ab850b4f6f46e91d24d81d4****</ImageId>\\n <UploadAuth>eyJFbmmRCI6Im****</UploadAuth>\\n</CreateUploadImageResponse>","errorExample":""}]', + 'title' => '获取图片上传地址和凭证', + 'description' => '- **请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。媒资文件上传到视频点播中会产生存储费用，计费详情，请参见[媒资存储计费](~~188308#section_e97_xrp_mzz~~)。如果您已开通了存储传输加速，则上传媒资文件到视频点播时还将涉及上传加速费用，计费详情请参见[存储传输加速计费](~~188310#section_sta_zm2_tsv~~)。**'."\n" + .'- 本接口仅用于获取上传地址和凭证以及创建媒资基础信息，并非上传文件，通过接口上传的完整示例，请参见[通过视频点播API上传媒资文件](~~476208~~)。'."\n" + .'- 上传图片不支持刷新上传地址和凭证。如果图片上传凭证失效（ 默认有效期3000秒），请重新调用此接口获取上传地址和凭证。'."\n" + .'- 可通过配置回调，接收[图片上传完成](~~91968~~)的事件通知来判断是否上传成功。'."\n" + .'- 获取上传地址和凭证为点播服务的核心基础，是每个上传操作的必经过程。点播服务提供多种不同的上传方式，每种方式对获取上传地址和凭证的要求不同，详细内容请参见[上传地址和凭证](~~55397~~)的使用说明。', + ], + 'CreateUploadAttachedMedia' => [ + 'summary' => '上传地址和凭证由点播服务提供，旨在解决授权与安全问题，防止恶意上传，并自动创建用于管理和处理的媒资ID（Mediaid）。辅助媒资如水印、字幕等，通过调用本接口获取上传凭证并创建相应媒资信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39816', + 'abilityTreeNodes' => [ + 'FEATUREvodVQ27S4', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '辅助媒资的标题。规则：'."\n" + ."\n" + .'- 长度不超过128个字节。'."\n" + .'- UTF8编码。', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'schema' => [ + 'description' => '辅助媒资的类型。取值：'."\n" + ."\n" + .'- **watermark**：水印。'."\n" + .'- **subtitle**：字幕。'."\n" + .'- **material**：素材。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'watermark', + ], + ], + [ + 'name' => 'MediaExt', + 'in' => 'query', + 'schema' => [ + 'description' => '待上传的辅助媒资源文件的扩展名。取值：'."\n" + ."\n" + .'- 水印：**png、gif、apng、mov**。'."\n" + .'- 字幕：**srt、ass、stl、ttml、vtt**。'."\n" + .'- 素材：**jpg、gif、png、mp4、mat、zip、apk**。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => [ + 'ass' => 'ass', + 'jpg' => 'jpg', + 'zip' => 'zip', + 'mat' => 'mat', + 'gif' => 'gif', + 'apng' => 'apng', + 'png' => 'png', + 'ttml' => 'ttml', + 'stl' => 'stl', + 'mp4' => 'mp4', + 'srt' => 'srt', + 'mov' => 'mov', + 'vtt' => 'vtt', + 'apk' => 'apk', + ], + 'example' => 'png', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => '待上传的辅助媒资的源文件地址。'."\n" + .'>可不带扩展名；若此处带了扩展名，且此处的扩展名与MediaExt中设置的扩展名不一致，以MediaExt为准。', + 'type' => 'string', + 'required' => false, + 'example' => 'D:\\test.png', + ], + ], + [ + 'name' => 'FileSize', + 'in' => 'query', + 'schema' => [ + 'description' => '文件大小。单位：字节。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => '标签。规则：'."\n" + ."\n" + .'- 最多不超过16个标签。'."\n" + .'- 如需设置多个标签，请使用半角逗号（,）分隔。'."\n" + .'- 单个标签不超过32个字符或汉字。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag1,tag2', + ], + ], + [ + 'name' => 'StorageLocation', + 'in' => 'query', + 'schema' => [ + 'description' => '存储地址。可通过以下方式获取：'."\n" + ."\n" + .'登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **存储管理**查看存储地址。'."\n" + ."\n" + .'> 若不传此参数，则辅助媒资上传到默认的存储地址上；若传入此参数，则辅助媒资上传到该指定的存储地址上。', + 'type' => 'string', + 'required' => false, + 'example' => 'out-****.oss-cn-shanghai.aliyuncs.com', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资描述。规则：'."\n" + ."\n" + .'- 长度不超过1024个字节。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'uploadTest', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置，为JSON字符串，支持消息回调、上传加速等设置。更多详情，请参见[UserData](~~86952#section-6fg-qll-v3w~~)。'."\n" + ."\n" + .'> - 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用，否则回调设置不生效。控制台配置HTTP回调的操作，请参考[回调设置](~~86071~~)。'."\n" + .'> - 如需使用上传加速功能，请提交工单申请开通，更多信息，请参见[上传相关说明](~~55396~~)。关于如何提交工单，请参见[联系我们](~~464625~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}', + ], + ], + [ + 'name' => 'CateIds', + 'in' => 'query', + 'schema' => [ + 'description' => '分类ID。多个ID之间使用半角逗号（,）分隔。最多支持5个。可通过以下方式获取：'."\n" + .'- 登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **分类管理**查看分类ID。'."\n" + .'- 调用[AddCategory](~~AddCategory~~)接口创建分类时会返回。'."\n" + .'- 调用[GetCategories](~~GetCategories~~)接口查询分类时会返回。', + 'type' => 'string', + 'required' => false, + 'example' => '1298****,0813****', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。默认取值：**app-1000000**。若已开通多应用体系，传入应用ID，可将辅助媒资上传到指定应用下。更多信息，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'FileURL' => [ + 'description' => '辅助媒资文件的OSS地址（不带鉴权）。'."\n" + ."\n" + .'添加图片水印模板时，该地址可做为[AddWatermark](~~AddWatermark~~)接口的请求参数`FileUrl`。', + 'type' => 'string', + 'example' => 'https://****.oss-cn-shanghai.aliyuncs.com/watermark/****.mov', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '73254DE5-F260-4720-D06856B63C01****', + ], + 'UploadAddress' => [ + 'description' => '上传地址。'."\n" + .'> 接口返回的上传地址是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAddress。', + 'type' => 'string', + 'example' => 'LWNuLXNoYW5naGFpLmFsaXl1b****', + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '97dc17a5abc3668489b84ce9****', + ], + 'MediaURL' => [ + 'description' => '媒资的访问地址。'."\n" + ."\n" + .'如果配置了CDN域名则返回CDN地址，否则为OSS地址。'."\n" + ."\n" + .'> 如果返回的MediaURL在浏览器无法访问（403），是因为您开启了点播域名的鉴权功能。可关闭[URL鉴权](~~86090~~)或自助[生成鉴权签名](~~57007~~)。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/watermark/****.mov?auth_key=****', + ], + 'UploadAuth' => [ + 'description' => '上传凭证。'."\n" + ."\n" + .'> 接口返回的上传凭证是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAuth。', + 'type' => 'string', + 'example' => 'UzFnUjFxNkZ0NUIZTaklyNWJoQ00zdHF****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"FileURL\\": \\"https://****.oss-cn-shanghai.aliyuncs.com/watermark/****.mov\\",\\n \\"RequestId\\": \\"73254DE5-F260-4720-D06856B63C01****\\",\\n \\"UploadAddress\\": \\"LWNuLXNoYW5naGFpLmFsaXl1b****\\",\\n \\"MediaId\\": \\"97dc17a5abc3668489b84ce9****\\",\\n \\"MediaURL\\": \\"http://example.aliyundoc.com/watermark/****.mov?auth_key=****\\",\\n \\"UploadAuth\\": \\"UzFnUjFxNkZ0NUIZTaklyNWJoQ00zdHF****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateUploadAttachedMediaResponse>\\n <FileURL>https://****.oss-cn-shanghai.aliyuncs.com/watermark/****.mov</FileURL>\\n <RequestId>73254DE5-F260-4720-D06856B63C01****</RequestId>\\n <UploadAddress>LWNuLXNoYW5naGFpLmFsaXl1b****</UploadAddress>\\n <MediaId>97dc17a5abc3668489b84ce9****</MediaId>\\n <MediaURL>http://example.aliyundoc.com/watermark/****.mov?auth_key=****</MediaURL>\\n <UploadAuth>UzFnUjFxNkZ0NUI*****ZTaklyNWJoQ00zdHF</UploadAuth>\\n</CreateUploadAttachedMediaResponse>","errorExample":""}]', + 'title' => '获取辅助媒资上传地址和凭证', + 'description' => '- **请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。媒资文件上传到视频点播中会产生存储费用，计费详情，请参见[媒资存储计费](~~188308#section_e97_xrp_mzz~~)。如果您已开通了存储传输加速，则上传媒资文件到视频点播时还将涉及上传加速费用，计费详情请参见[存储传输加速计费](~~188310#section_sta_zm2_tsv~~)。**'."\n" + .'- 本接口仅用于获取上传地址和凭证以及创建媒资基础信息，并非上传文件，通过接口上传的完整示例，请参见[通过视频点播API上传媒资文件](~~476208~~)。'."\n" + .'- 如果上传凭证失效（有效期3000秒），请重新调用此接口获取上传地址和凭证。'."\n" + .'- 可通过配置回调，接收[辅助媒资上传完成](~~103250~~)的事件通知来判断是否上传成功。'."\n" + .'- 获取上传地址和凭证为点播服务的核心基础，是每个上传操作的必经过程。点播服务提供多种不同的上传方式，每种方式对获取上传地址和凭证的要求不同，详细内容请参见[上传地址和凭证](~~55397~~)的使用说明。', + 'requestParamsDescription' => ' ', + ], + 'UploadMediaByURL' => [ + 'summary' => '基于源文件URL，拉取音视频媒体文件进行上传，支持批量上传。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '40242', + 'abilityTreeNodes' => [ + 'FEATUREvodVQ27S4', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'UploadURLs', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体源文件URL。'."\n" + .'- URL中需要包括扩展名, 比如`https://****.mp4`中mp4为扩展名。'."\n" + .' - 如果URL中不包含扩展名，可以在`UploadMetadatas`中传入`FileExtension`来指定。'."\n" + .' - 如果URL中有扩展名且同时传入`FileExtension`，以传入的`FileExtension`为准。'."\n" + .' - 指定支持的扩展名，请参见[上传概述](~~55396~~)。'."\n" + ."\n" + .'> - URL编码，多个地址之间以半角逗号（,）分隔，最多支持20个， 避免存在特殊字符导致无法上传视频，需要**URL编码后**再做逗号拼接。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'https://****.mp4', + ], + ], + [ + 'name' => 'TemplateGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板组ID。可通过以下方式获取：'."\n" + .'- 登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒体处理配置** > **转码模板组**查看转码模版组ID。'."\n" + .'- 通过[创建转码模板组](~~102665~~)接口创建转码模板组时，转码模板组ID为返回参数TranscodeTemplateGroupId的值。'."\n" + .'- 通过[查询转码配置列表](~~102669~~)接口查询转码模板组时，为请求后返回参数TranscodeTemplateGroupId的值。'."\n" + ."\n" + .'>- 不设置转码模板组ID，则按默认的转码模板组进行转码；设置了转码模板组ID时，会使用该指定的模板组进行转码。'."\n" + .'>- 可以在`UploadMetadatas`中进行设置，如果在UploadMetadatas中设置了TemplateGroupId，此处也设置了TemplateGroupId，则以UploadMetadatas中设置的TemplateGroupId为准。', + 'type' => 'string', + 'required' => false, + 'example' => 'ca3a8f6e4957b65806709586****', + ], + ], + [ + 'name' => 'StorageLocation', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体文件存储地址。'."\n" + ."\n" + .'登录[点播控制台](https://vod.console.aliyun.com/?spm=a2c4g.11186623.2.15.6948257eaZ4m54#/vod/settings/censored)，选择**配置管理** > **媒资管理配置** > **存储管理**查看存储地址。不指定时会使用默认存储地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com', + ], + ], + [ + 'name' => 'UploadMetadatas', + 'in' => 'query', + 'schema' => [ + 'description' => '上传媒体文件的元数据信息，为JSON字符串。'."\n" + ."\n" + .'- 与UploadURLs里的URL匹配才能生效。'."\n" + .'- JSON格式：`[UploadMetadata, UploadMetadata,…]`，需转为JSON字符串 。'."\n" + .'- 更多信息，请参见下表**UploadMetadata**。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"SourceURL":"https://example.aliyundoc.com/video01.mp4","Title":"urlUploadTest"}]', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置。为JSON字符串，支持消息回调、上传加速等设置。更多信息，请参见[UserData](~~86952#UserData~~)。'."\n" + ."\n" + .'> - 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用，否则回调设置不生效。控制台配置HTTP回调的操作，请参考[回调设置](~~86071~~)。'."\n" + .'> - 如需使用上传加速功能，您需要提交工单申请开通，更多信息，请参见[上传相关说明](~~55396~~)。关于如何提交工单，请参见[联系我们](~~464625~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。默认取值：**app-1000000**。 更多信息，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-****', + ], + ], + [ + 'name' => 'WorkflowId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流ID。可登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒体处理配置** > **工作流管理**查看工作流ID。'."\n" + ."\n" + .'> 如果同时传递了WorkflowId和TemplateGroupId，以WorkflowId为准。使用说明，请参见[工作流](~~115347~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'e1e243b42548248197d6f74f9****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义去重识别码，如果传递了该参数请求，当检测到在过去10分钟内曾有过相同识别码的请求，则会在本次请求时返回错误。'."\n" + .'> '."\n" + .'> - 该去重识别码由您自定义设置，长度最长为50个字符，支持大小写英文字母、数字、短划线（-）和下划线（_），不传或者带空字符串表示不去重。', + 'type' => 'string', + 'required' => false, + 'example' => '5c62d40299034bbaa4c195da330****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'UploadJobs' => [ + 'description' => '上传任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '上传任务详情。', + 'type' => 'object', + 'properties' => [ + 'SourceURL' => [ + 'description' => '上传任务对应的源文件URL。', + 'type' => 'string', + 'example' => 'http://example****.mp4', + ], + 'JobId' => [ + 'description' => '上传任务ID。', + 'type' => 'string', + 'example' => 'ad90a501b1b94fb72374ad005046****', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"UploadJobs\\": [\\n {\\n \\"SourceURL\\": \\"http://example****.mp4\\",\\n \\"JobId\\": \\"ad90a501b1b94fb72374ad005046****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<UploadMediaByURLResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <UploadJobs>\\n <SourceURL>http://example****.mp4</SourceURL>\\n <JobId>ad90a501b1b94fb72374ad005046****</JobId>\\n </UploadJobs>\\n</UploadMediaByURLResponse>","errorExample":""}]', + 'title' => 'URL批量拉取上传', + 'description' => '- **请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。媒资文件上传到视频点播中会产生存储费用，计费详情，请参见[媒资存储计费](~~188308#section_e97_xrp_mzz~~)。如果您已开通了存储传输加速，则上传媒资文件到视频点播时还将涉及上传加速费用，计费详情请参见[存储传输加速计费](~~188310#section_sta_zm2_tsv~~)。**'."\n" + .'- 本接口支持上传的媒体文件格式，请参见[媒体格式](~~55396#section-e27-2rj-mde~~)。'."\n" + .'- 本接口主要适用于文件没有存储在本地服务器或终端，需要通过公网访问的URL地址上传的场景。'."\n" + .'- 本接口为异步上传接口，非实时，不保证时效性，一般提交后会在数小时、甚至数天内完成迁移上传。如果对时效性要求较高，建议使用上传SDK上传。'."\n" + .'- 如果配置了回调，则上传完成后会收到[URL上传视频完成](~~86326~~)的事件通知，可以通过[获取URL上传信息](~~106830~~)接口查询上传状态。'."\n" + .'- 上传任务提交成功后，会在云端生成异步执行的任务，相应服务地域下所有用户提交的URL上传任务进行排队执行，完成时间受已有任务数量影响；上传完成后可根据事件通知（消息回调）返回的URL和视频ID等信息进行关联。'."\n" + .'- 本接口目前仅支持**华东2（上海）**、**华北2（北京）**、**华南1（深圳）**、**新加坡**、**美国**（**硅谷**）地域。'."\n" + .'- 同一个媒体文件URL，每次提交上传任务都会在点播中产生一个新的媒体资源（即产生新的媒体ID）。'."\n" + .'- 单个文件超过20GB时，将导致上传失败。如您有单个文件超过20GB的上传需求，请使用上传SDK进行上传。详细信息请参见[上传SDK概述](~~52200~~)。', + 'requestParamsDescription' => '## UploadMetadata'."\n" + ."\n" + .'| 名称 | 类型 | 是否必需 | 描述 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| SourceURL | String | 是 | 需要上传的媒体源文件URL。|'."\n" + .'| Title |String |否 |媒体标题。长度不超过128个字节。UTF-8编码。|'."\n" + .'| FileSize| String |否 |文件大小。|'."\n" + .'| Description| String |否 |描述。长度不超过1024个字节。UTF-8编码。|'."\n" + .'| CoverURL |String |否 |自定义视频封面URL地址。|'."\n" + .'| CateId |String |否 |分类ID。可通过登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **分类管理**查看分类ID。|'."\n" + .'| Tags |String |否 |标签。单个标签不超过32字节，最多不超过16个标签。多个标签，请使用半角逗号（,）分隔。UTF8编码。|'."\n" + .'| TemplateGroupId |String |否 |转码模板组ID。会覆盖外层传入的TemplateGroupId。|'."\n" + .'|WorkflowId |String |否 |工作流ID。如果同时传入了WorkflowId和TemplateGroupId，以WorkflowId为准。更多信息，请参见[工作流](~~115347~~)。|'."\n" + .'|FileExtension |String |否| 媒体文件扩展名，支持的扩展名，请参见[上传概述](~~55396~~)。|'."\n" + .'|ReferenceId |String |否| 自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。|'."\n" + ."\n" + .'> - UploadMetadata 中的参数（如Title、Description、Tags等）不能包含表情符。'."\n" + .'> - 为确保正常播放，当TemplateGroupId设置为“VOD\\_NO\\_TRANSCODE”不转码的方式上传视频文件后，目前仅以下格式的文件支持不转码直接播放：MP4、FLV、MP3、M3U8、WEBM，其他格式仅支持存储（关注FileName的扩展名）。若使用阿里云播放器，版本须为3.1.0或以上。'."\n" + .'> - 指定不转码的模板组（TemplateGroupId设置为“VOD\\_NO\\_TRANSCODE”），视频上传后仅有[视频上传完成](~~55630~~)的事件通知，没有[单个清晰度转码完成](~~55636~~)的事件通知。'."\n" + .'> - 如果配置了回调，视频上传完成后，除了上传和转码通知，还有[URL上传视频完成](~~86326~~)事件通知。'."\n" + .'> - 批量提交时，每一个SourceURL有独立的通知。', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidParameter.UploadURLs| The specified parameter UploadURLs is not valid. |400| 参数UploadURLs无效。|', + ], + 'GetURLUploadInfos' => [ + 'summary' => '获取URL上传信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39992', + 'abilityTreeNodes' => [ + 'FEATUREvodVQ27S4', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'JobIds', + 'in' => 'query', + 'schema' => [ + 'description' => '上传任务ID（JobId）列表。由一个或多个JobId组成，JobId为通过[UploadMediaByURL](~~86311~~)接口上传时，返回参数JobId的值。'."\n" + .'- 最多支持10个ID。'."\n" + .'- 多个ID之间使用半角逗号（,）分隔。'."\n" + ."\n" + .'> JobIds和UploadURLs必须指定一个，二者同时传入时只处理JobIds。', + 'type' => 'string', + 'required' => false, + 'example' => '86c1925fba0****,7afb201e7fa****,2cc4997378****', + ], + ], + [ + 'name' => 'UploadURLs', + 'in' => 'query', + 'schema' => [ + 'description' => '上传视频源文件URL列表。多个URL之间使用半角逗号（,）分隔，最多支持10个。'."\n" + .'> - 使用前，先进行URL编码。'."\n" + .'> - 如果同一URL视频多次上传，建议传入单个URL进行查询。'."\n" + .'> - JobIds和UploadURLs必须指定一个，二者同时传入时只处理JobIds。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://****.mp4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'NonExists' => [ + 'description' => '不存在的URL上传任务ID或URL列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的URL上传任务ID或URL列表。', + 'type' => 'string', + 'example' => '["****1", "****2"]', + ], + ], + 'URLUploadInfoList' => [ + 'description' => 'URL上传信息列表。具体上传名称及描述，请参见[URLUploadInfo：URL上传信息](~~52839~~)。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'URL上传信息详情。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-01-01T01:01:01Z', + ], + 'Status' => [ + 'description' => 'URL拉取任务状态。具体的拉取状态取值及说明，请参见[Status：URL上传任务状态](~~52839~~)。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'error_message', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'CompleteTime' => [ + 'description' => '完成时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-01-01T01:11:01Z', + ], + 'JobId' => [ + 'description' => '上传任务ID。', + 'type' => 'string', + 'example' => '86c1925fba0****', + ], + 'UserData' => [ + 'description' => '自定义设置。为JSON字符串。更多信息，请参见[UserData](~~86952~~)。', + 'type' => 'string', + 'example' => '{"MessageCallback":"{"CallbackURL":"http://example.aliyundoc.com"}", "Extend":"{"localId":"***", "test":"www"}"}', + ], + 'UploadURL' => [ + 'description' => '上传视频源文件URL。'."\n" + ."\n" + .'> 最多可以返回100条记录。', + 'type' => 'string', + 'example' => 'http://****.mp4', + ], + 'MediaId' => [ + 'description' => '媒体ID。', + 'type' => 'string', + 'example' => '93ab850b4f6f54b6e91d24d81d4****', + ], + 'FileSize' => [ + 'description' => '文件大小。单位：字节。', + 'type' => 'string', + 'example' => '24', + ], + 'RegisteredMediaId' => [ + 'title' => '已注册的媒资ID。', + 'description' => '已注册的媒资ID。', + 'type' => 'string', + 'example' => '93ab850b4f654b6e91d24d81d44****', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"NonExists\\": [\\n \\"[\\\\\\"****1\\\\\\", \\\\\\"****2\\\\\\"]\\"\\n ],\\n \\"URLUploadInfoList\\": [\\n {\\n \\"CreationTime\\": \\"2019-01-01T01:01:01Z\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"ErrorMessage\\": \\"error_message\\",\\n \\"ErrorCode\\": \\"200\\",\\n \\"CompleteTime\\": \\"2019-01-01T01:11:01Z\\",\\n \\"JobId\\": \\"86c1925fba0****\\",\\n \\"UserData\\": \\"{\\\\\\"MessageCallback\\\\\\":\\\\\\"{\\\\\\"CallbackURL\\\\\\":\\\\\\"http://example.aliyundoc.com\\\\\\"}\\\\\\", \\\\\\"Extend\\\\\\":\\\\\\"{\\\\\\"localId\\\\\\":\\\\\\"***\\\\\\", \\\\\\"test\\\\\\":\\\\\\"www\\\\\\"}\\\\\\"}\\",\\n \\"UploadURL\\": \\"http://****.mp4\\",\\n \\"MediaId\\": \\"93ab850b4f6f54b6e91d24d81d4****\\",\\n \\"FileSize\\": \\"24\\",\\n \\"RegisteredMediaId\\": \\"93ab850b4f654b6e91d24d81d44****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetURLUploadInfosResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <NonExists>[\\"****1\\", \\"****2\\"]</NonExists>\\n <URLUploadInfoList>\\n <UrlUploadJobInfoDTO>\\n <CreationTime>2019-01-01T01:01:01Z</CreationTime>\\n <Status>SUCCESS</Status>\\n <ErrorMessage>error_message</ErrorMessage>\\n <ErrorCode>200</ErrorCode>\\n <CompleteTime>2019-01-01T01:11:01Z</CompleteTime>\\n <JobId>86c1925fba0****</JobId>\\n <UserData>{\\"MessageCallback\\":\\"{\\"CallbackURL\\":\\"http://example.aliyundoc.com\\"}\\", \\"Extend\\":\\"{\\"localId\\":\\"***\\", \\"test\\":\\"www\\"}\\"}</UserData>\\n <UploadURL>http://****.mp4</UploadURL>\\n <MediaId>93ab850b4f6f54b6e91d24d81d4****</MediaId>\\n <FileSize>24</FileSize>\\n </UrlUploadJobInfoDTO>\\n </URLUploadInfoList>\\n</GetURLUploadInfosResponse>","errorExample":""}]', + 'title' => '获取URL上传信息', + 'description' => '- 通过URL上传时返回的JobId或者上传时使用的URL来获取URL上传信息，包括URL上传状态、UserData、创建时间、完成时间等。'."\n" + .'- **本接口仅支持查询一年内的上传任务数据。**'."\n" + .'- 本接口目前服务地址仅支持：**华东 2（上海**）、**新加坡**。'."\n" + .'- 调用[UploadMediaByURL](~~UploadMediaByURL~~)接口将媒资文件上传到视频点播中后，可调用本接口通过URL拉取上传任务ID（`JobIds`）或者媒体源文件URL（`UploadURLs`）来查询指定媒体文件的上传信息。'."\n" + .'- 调用本接口时，`JobIds`和`UploadURLs`必须传入一个，二者同时传入时只处理`JobIds`。'."\n" + .'- 如果媒资上传失败，调用本接口可以查看错误码和错误信息；如果媒资上传成功，调用本接口可以查看对应的媒资ID。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CancelUrlUploadJobs' => [ + 'summary' => '取消排队中的URL上传任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '46269', + 'abilityTreeNodes' => [ + 'FEATUREvodVQ27S4', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'JobIds', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID列表，任务ID（JobId）可以通过[GetPlayInfo](~~56124~~)接口中返回的PlayInfo结构体中获取。'."\n" + .'- 最多支持10个ID。'."\n" + .'- 多个ID之间使用半角逗号（,）分隔。'."\n" + ."\n" + .'> JobIds和UploadUrls必须指定一个，二者同时传入时只处理JobIds。', + 'type' => 'string', + 'required' => false, + 'example' => '341c92e6c18dc435ee31253685****,0193d395194a83ad6ee2ef27a5b5****', + ], + ], + [ + 'name' => 'UploadUrls', + 'in' => 'query', + 'schema' => [ + 'description' => '上传源视频URL列表。多个URL之间使用半角逗号（,）分隔，最多支持10个。'."\n" + ."\n" + .'> - 使用前，先进行URL编码。'."\n" + .'> - JobIds和UploadUrls必须指定一个，二者同时传入时只处理JobIds。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.example.aliyundoc.com/***/video01.mp4,http://www.example.aliyundoc.com/***/video02.mp4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4D5C-3C3D-D7393642****', + ], + 'CanceledJobs' => [ + 'description' => '取消成功的任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '取消成功的任务列表。返回值为JobId。', + 'type' => 'string', + 'example' => '341c92e6c18dc435ee31253685****,0193d395194a83ad6ee2ef27a5b5****', + ], + ], + 'NonExists' => [ + 'description' => '不存在的任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的JobId或URL列表。'."\n" + ."\n" + .'如果请求参数为JobIds，返回值为JobId；如果请求参数为UploadURLs，返回值为URL。', + 'type' => 'string', + 'example' => 'http://www.example.aliyundoc.com/***/video01.mp4,http://www.example.aliyundoc.com/***/video02.mp4', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4D5C-3C3D-D7393642****\\",\\n \\"CanceledJobs\\": [\\n \\"341c92e6c18dc435ee31253685****,0193d395194a83ad6ee2ef27a5b5****\\"\\n ],\\n \\"NonExists\\": [\\n \\"http://www.example.aliyundoc.com/***/video01.mp4,http://www.example.aliyundoc.com/***/video02.mp4\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CancelUrlUploadJobsResponse>\\n <RequestId>25818875-5F78-4D5C-3C3D-D7393642****</RequestId>\\n <CanceledJobs>341c92e6c18dc435ee31253685****,0193d395194a83ad6ee2ef27a5b5****</CanceledJobs>\\n <NonExists>http://www.example.aliyundoc.com/***/video01.mp4,http://www.example.aliyundoc.com/***/video02.mp4</NonExists>\\n</CancelUrlUploadJobsResponse>","errorExample":""}]', + 'title' => '取消URL上传任务', + 'description' => '- 只能取消任务状态为**Pending**的URL上传任务，可通过[GetURLUploadInfos](~~106830~~)接口查询任务状态。'."\n" + .'- 已经开始执行的上传任务无法取消。'."\n" + .'- 请求参数 JobIds和UploadUrls必须指定一个，二者同时传入时只处理JobIds。', + ], + 'UploadStreamByURL' => [ + 'summary' => '上传外部存储的转码流文件并挂载到对应的点播媒资下。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '100689', + 'abilityTreeNodes' => [ + 'FEATUREvodVQ27S4', + ], + ], + 'parameters' => [ + [ + 'name' => 'StreamURL', + 'in' => 'query', + 'schema' => [ + 'description' => '转码流文件URL。'."\n" + ."\n" + .'如果转码流的URL需要鉴权，需要在StreamURL中传入鉴权参数，并确保该URL可以通过公网访问。'."\n" + .'>URL可以通过控制台获取音视频的地址；也可以通过getplayinfo接口调用来获取音视频地址。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'https://example.com/lesson-01.mp4', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '转码流对应的点播媒资ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ca3a8f6e49*****57b65806709586', + ], + ], + [ + 'name' => 'Definition', + 'in' => 'query', + 'schema' => [ + 'description' => '视频流清晰度。'."\n" + ."\n" + .'取值，详情请参考: [媒资参数说明-清晰度](~~124671~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'HD', + ], + ], + [ + 'name' => 'FileExtension', + 'in' => 'query', + 'schema' => [ + 'description' => '转码流文件扩展名。'."\n" + ."\n\n" + .'扩展名请参见[概述](~~55396~~)中的音频和视频的支持文件格式。'."\n" + ."\n\n" + .'当该参数不为空时，会覆盖StreamURL地址中的文件扩展名。'."\n" + ."\n" + .'><notice>若StreamURL地址中不含文件扩展名，该参数必填。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'mp4', + ], + ], + [ + 'name' => 'HDRType', + 'in' => 'query', + 'schema' => [ + 'title' => '视频流HDR类型', + 'description' => '转码流HDR类型。取值：'."\n" + .'- HDR'."\n" + .'- HDR10'."\n" + .'- HLG'."\n" + .'- DolbyVision'."\n" + .'- HDRVivid'."\n" + .'- SDR+'."\n" + .'> - 大小写不敏感。'."\n" + .'> - 非HDR视频该参数为空即可。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HDR10', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义参数。详情参见[UserData](~~86952~~)。'."\n" + .'> 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用，否则回调设置不生效。控制台配置HTTP回调的操作，请参考[回调设置](~~86071~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"MessageCallback":{"CallbackURL":"http://aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}}', + ], + ], + [ + 'name' => 'UploadMetadata', + 'in' => 'query', + 'schema' => [ + 'description' => '上传媒体文件的元数据信息，为JSON字符串。'."\n" + .'- 更多信息，请参见下表**UploadMetadata**。', + 'type' => 'string', + 'required' => false, + 'example' => '{"AddressMapping":"1","CustomPath":"test/xxx","CustomFileName":"xxx.mp4","isOverwritePath":"0"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '基本信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7AE96389-DF1E-598D-816B-7B40F13B4620', + ], + 'StreamJobId' => [ + 'description' => '转码流JobId。可以作为[GetURLUploadInfos](~~106830~~)接口的请求参数。'."\n" + ."\n" + .'点播使用JobId唯一标识一个转码流文件。详情请参考：[基本数据-PlayInfo视频播放信息](~~52839~~)。', + 'type' => 'string', + 'example' => 'e304b34fb3d959f92baef97b6496****', + ], + 'FileURL' => [ + 'description' => '转码流OSS文件地址。', + 'type' => 'string', + 'example' => 'http://outin-31059bcee7810a200163e1c8dba****.oss-cn-shanghai.aliyuncs.com/lesson-01.mp4', + ], + 'SourceURL' => [ + 'description' => '转码流输入URL地址。可以作为[GetURLUploadInfos](~~106830~~)接口的请求参数。', + 'type' => 'string', + 'example' => 'https://example.com/lesson-01.mp4', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7AE96389-DF1E-598D-816B-7B40F13B4620\\",\\n \\"StreamJobId\\": \\"e304b34fb3d959f92baef97b6496****\\",\\n \\"FileURL\\": \\"http://outin-31059bcee7810a200163e1c8dba****.oss-cn-shanghai.aliyuncs.com/lesson-01.mp4\\",\\n \\"SourceURL\\": \\"https://example.com/lesson-01.mp4\\"\\n}","errorExample":""},{"type":"xml","example":"<UploadStreamByURLResponse>\\n <RequestId>7AE96389-DF1E-598D-816B-7B40F13B4620</RequestId>\\n <StreamJobId>e304b34fb3d959f92baef97b6496****</StreamJobId>\\n <FileURL>http://outin-31059bcee7810a200163e1c8dba****.oss-cn-shanghai.aliyuncs.com/lesson-01.mp4</FileURL>\\n <SourceURL>https://example.com/lesson-01.mp4</SourceURL>\\n</UploadStreamByURLResponse>","errorExample":""}]', + 'title' => '通过URL上传转码流', + 'description' => '- **请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。媒资文件上传到视频点播中会产生存储费用，计费详情，请参见[媒资存储计费](~~188308#section_e97_xrp_mzz~~)。如果您已开通了存储传输加速，则上传媒资文件到视频点播时还将涉及上传加速费用，计费详情请参见[存储传输加速计费](~~188310#section_sta_zm2_tsv~~)。**'."\n" + .'- 该接口目前仅支持**上海**和**新加坡**地域使用。'."\n" + .'- 调用本接口上传外部存储的转码流文件并挂载到对应的点播媒资下。本接口支持的转码流HDR类型为HDR、HDR10、HLG、DolbyVision、HDRVivid和SDR+类型。'."\n" + .'- 您可以通过[获取URL上传信息](~~106830~~)接口来查询上传状态，上传完成后会收到[URL上传转码流完成](~~376427~~)的事件通知。', + 'requestParamsDescription' => '## UploadMetadata'."\n" + ."\n" + .'| 名称 | 类型 | 是否必需 | 描述 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| AddressMapping | String | 否 | 地址映射规则。取值：1 代表映射转码流的URL，2 代表自定义路径|'."\n" + .'| CustomPath |String |否 |自定义文件路径。长度不超过1000个字节。UTF-8编码。|'."\n" + .'| CustomFileName| String |否 |自定义文件名称。长度不超过1000个字节。UTF-8编码。|'."\n" + .'| IsOverwritePath| String |否 |自定义文件路径存在时是否覆盖。取值：0 代表不覆盖，1 代表覆盖|'."\n" + ."\n" + .'> - 当AddressMapping取值为2时，CustomPath和CustomFileName均不能为空'."\n" + .'> - 当IsOverwritePath取值为0时，如果自定义的文件路径已经存在，接口会返回失败', + ], + 'DeleteMultipartUpload' => [ + 'summary' => '删除上传中产生的碎片文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39840', + 'abilityTreeNodes' => [ + 'FEATUREvod8R2V42', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体ID，即音/视频ID（VideoId）。可通过以下方式获取：'."\n" + .'- 通过控制台上传的音/视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看音/视频ID。'."\n" + .'- 通过[获取视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，音/视频ID为返回参数VideoId的值。'."\n" + .'- 音/视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询音/视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '61ccbdb06fa3012be4d8083f6****', + ], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体类型。取固定值：**video**（音/视频）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'video', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteMultipartUploadResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n</DeleteMultipartUploadResponse>","errorExample":""}]', + 'title' => '删除上传中的碎片文件', + 'description' => '- 使用分片上传时，若上传失败则可能会产生碎片文件，一般7天后会自动清除。在上传完成或失败后，可调用本接口手动清除碎片文件。'."\n" + .'- 调用本接口不会删除原始文件和转码后的文件，只会删除上传过程中产生的碎片文件。'."\n" + .'- 调用[删除完整视频](~~52837~~)接口，会删除包含碎片文件等在内的完整视频文件。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidParameter |The specified parameter “MediaType” is invalid. |400 | MediaType参数无效。|'."\n" + .'| InvalidMultipartUpload.NotFound |The multipart upload not exist. |400 | 碎片文件不存在。|'."\n" + .'| InvalidVideo.NotFound |The video does not exist. |400 | 视频不存在。|'."\n" + .'| InvalidFile.NotFound |The file does not exist. |400 | 视频文件不存在。|'."\n" + .'| InvalidStorage.NotFound| can’t find storage.| 400 |存储不存在。|'."\n" + .'| AccessDenied |Access denied by authorizer’s policy.| 400 |自有bucket未授权点播服务访问，无权限执行该操作。|', + ], + 'GetUploadDetails' => [ + 'summary' => '通过媒体ID获取媒体上传详情（如上传时间、已上传比例、上传来源等信息），支持批量获取。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39988', + 'abilityTreeNodes' => [ + 'FEATUREvodVQ27S4', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaIds', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体ID，即音/视频ID（VideoId）。多个ID之间使用半角逗号（,）分隔，最多支持20个。可通过以下方式获取：'."\n" + .'- 通过控制台上传的音/视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看音/视频ID。'."\n" + .'- 通过[获取音视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，为返回参数VideoId的值。'."\n" + .'- 音/视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '61ccbdb06fa83012be4d8083f6****,7d2fbc380b0e08e55f****', + ], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体类型。取固定值：**video**（音/视频）。', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9E290613-04F4-47F4-795D30732077****', + ], + 'ForbiddenMediaIds' => [ + 'description' => '禁止访问的媒体ID。', + 'type' => 'array', + 'items' => [ + 'description' => '禁止访问的媒体ID。', + 'type' => 'string', + 'example' => '7d2fbc380b0e08e55f****', + ], + ], + 'NonExistMediaIds' => [ + 'description' => '不存在的媒体ID。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的媒体ID。', + 'type' => 'string', + 'example' => 'dfsg****', + ], + ], + 'UploadDetails' => [ + 'description' => '上传详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '视频状态。具体的视频状态取值及描述，请参见[Status：视频状态](~~52839~~)的取值列表。', + 'type' => 'string', + 'example' => 'Uploading', + ], + 'CreationTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2019-04-28T09:42:07Z', + ], + 'UploadSource' => [ + 'description' => '上传资源。', + 'type' => 'string', + 'example' => 'WebSDK', + ], + 'UploadIP' => [ + 'description' => '上传IP地址。', + 'type' => 'string', + 'example' => '192.168.0.1', + ], + 'DeviceModel' => [ + 'description' => '设备模型。', + 'type' => 'string', + 'example' => 'Chrome', + ], + 'ModificationTime' => [ + 'description' => '更新时间。格式为：_yyyy-MM-ddTHH:mm:ssZ_（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2019-04-28T09:43:12Z', + ], + 'CompletionTime' => [ + 'description' => '完成时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2019-04-28T09:45:07Z', + ], + 'MediaId' => [ + 'description' => '上传的音/视频ID。', + 'type' => 'string', + 'example' => '61ccbdb06fa83012be4d8083f6****', + ], + 'UploadSize' => [ + 'description' => '上传大小。单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '346', + ], + 'UploadRatio' => [ + 'description' => '上传比率。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.038', + ], + 'UploadStatus' => [ + 'description' => '上传任务状态。具体的上传状态取值及描述，请参见[Status：URL上传任务状态](~~52839~~)的取值列表。', + 'type' => 'string', + 'example' => 'Uploading', + ], + 'Title' => [ + 'description' => '标题。', + 'type' => 'string', + 'example' => '测试文件上传详情', + ], + 'FileSize' => [ + 'description' => '文件大小。单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '46', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9E290613-04F4-47F4-795D30732077****\\",\\n \\"ForbiddenMediaIds\\": [\\n \\"7d2fbc380b0e08e55f****\\"\\n ],\\n \\"NonExistMediaIds\\": [\\n \\"dfsg****\\"\\n ],\\n \\"UploadDetails\\": [\\n {\\n \\"Status\\": \\"Uploading\\",\\n \\"CreationTime\\": \\"2019-04-28T09:42:07Z\\",\\n \\"UploadSource\\": \\"WebSDK\\",\\n \\"UploadIP\\": \\"192.168.0.1\\",\\n \\"DeviceModel\\": \\"Chrome\\",\\n \\"ModificationTime\\": \\"2019-04-28T09:43:12Z\\",\\n \\"CompletionTime\\": \\"2019-04-28T09:45:07Z\\",\\n \\"MediaId\\": \\"61ccbdb06fa83012be4d8083f6****\\",\\n \\"UploadSize\\": 346,\\n \\"UploadRatio\\": 0.038,\\n \\"UploadStatus\\": \\"Uploading\\",\\n \\"Title\\": \\"测试文件上传详情\\",\\n \\"FileSize\\": 46\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetUploadDetailsResponse>\\n <RequestId>9E290613-04F4-47F4-795D30732077****</RequestId>\\n <ForbiddenMediaIds>7d2fbc380b0e08e55f****</ForbiddenMediaIds>\\n <NonExistMediaIds>dfsg****</NonExistMediaIds>\\n <UploadDetails>\\n <UploadDetail>\\n <Status>Uploading</Status>\\n <CreationTime>2019-04-28T09:42:07Z</CreationTime>\\n <UploadSource>WebSDK</UploadSource>\\n <UploadIP>192.168.0.1</UploadIP>\\n <DeviceModel>Chrome</DeviceModel>\\n <ModificationTime>2019-04-28T09:43:12Z</ModificationTime>\\n <CompletionTime>2019-04-28T09:45:07Z</CompletionTime>\\n <MediaId>61ccbdb06fa83012be4d8083f6****</MediaId>\\n <UploadSize>346</UploadSize>\\n <UploadRatio>0.038</UploadRatio>\\n <UploadStatus>Uploading</UploadStatus>\\n <Title>测试文件上传详情</Title>\\n <FileSize>46</FileSize>\\n </UploadDetail>\\n </UploadDetails>\\n</GetUploadDetailsResponse>","errorExample":""}]', + 'title' => '获取媒体上传详情', + 'description' => '- 本接口只支持获取音/视频的上传详情。'."\n" + .'- 如果通过点播控制台上传的音/视频，通过本接口可获取到上传比例等信息。如果是使用SDK上传的音/视频，满足以下条件的[上传SDK](~~52200~~)才能通过本接口获取到媒体上传详情。'."\n" + ."\n" + .'> 仅服务端上传SDK支持本接口，客户端上传SDK暂不支持本接口。本接口支持的服务端上传SDK版本限制如下：'."\n" + .'> - Java上传SDK的版本 ≥ 1.4.4'."\n" + .'> - C++上传SDK的版本 ≥ 1.0.0'."\n" + .'> - PHP上传SDK的版本 ≥ 1.0.2'."\n" + .'> - Python上传SDK的版本 ≥ 1.3.0'."\n" + ."\n\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'|LimitExceeded.MediaIds| The input parameter “MediaIds” Exceed the limit. |400 |媒资ID数量超过上限20个。|', + ], + 'RegisterMedia' => [ + 'summary' => '进行媒资注册，接入点播服务的OSS自有Bucket上的存量媒资文件，需要进行媒资注册生成点播需要的关联数据后，才能正常使用点播提供的转码、截图等功能。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '43406', + 'abilityTreeNodes' => [ + 'FEATUREvodVQ27S4', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegisterMetadatas', + 'in' => 'query', + 'schema' => [ + 'description' => '注册媒资元数据。为JSON字符串，一次最多支持设置10个媒资元数据。参数结构的更多信息，请参见下表**RegisterMetadata**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"FileURL":"https://****.oss-cn-shanghai.aliyuncs.com/video/test/video123.m3u8","Title":"VideoName"}]', + ], + ], + [ + 'name' => 'TemplateGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板组ID。可通过以下方式获取：'."\n" + .'- 登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒体处理配置** > **转码模板组**查看转码模版组ID。'."\n" + .'- 通过[创建转码模板组](~~102665~~)接口创建转码模板组时，转码模板组ID为返回参数TranscodeTemplateGroupId的值。'."\n" + .'- 通过[查询转码配置列表](~~102669~~)接口查询转码模板组时，为请求后返回参数TranscodeTemplateGroupId的值。'."\n" + ."\n" + .'> - 如果不需要转码，请指定为VOD\\_NO\\_TRANSCODE（不转码模板组），否则视频状态会为**上传完成**，从而无法使用播放服务播放音视频。如果需要转码，则指定对应转码模板组ID。'."\n" + .'> - 如果同时传递了WorkflowId和TemplateGroupId，以WorkflowId为准。使用说明，请参见[工作流](~~115347~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ca3a8f6e49c87b65806709586****', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置。为JSON字符串，支持消息回调等设置。参数详情，请参见[UserData](~~86952#section_6fg_qll_v3w~~)。'."\n" + .'>本接口不支持回调，即便此参数中设置了消息回调，在媒资注册完成后也不会产生回调消息。当后续对注册完成的媒资发起转码、截图等媒体处理时，若在发起转码、截图时单独设置了UserData中的消息回调，则优先使用那个回调地址；未设置，则使用此处注册媒资时UserData中设置的回调地址。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Extend":{"localId":"****","test":"www"}}', + ], + ], + [ + 'name' => 'WorkflowId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流ID。可登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒体处理配置** > **工作流管理**查看工作流ID。'."\n" + ."\n" + .'> 如果同时传递了WorkflowId和TemplateGroupId，以WorkflowId为准。使用说明，请参见[工作流](~~115347~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '637adc2b7ba51a83d841606f8****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '14F43C5C-8033-448B-AD04F64E5098****', + ], + 'FailedFileURLs' => [ + 'description' => '注册失败的文件地址列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '注册失败的文件地址列表。', + 'type' => 'string', + 'example' => '["http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4"]', + ], + ], + 'RegisteredMediaList' => [ + 'description' => '本次注册成功的Media列表，包括新增注册和已注册成功过的文件。', + 'type' => 'array', + 'items' => [ + 'description' => '注册详情。', + 'type' => 'object', + 'properties' => [ + 'NewRegister' => [ + 'description' => '新注册或重复注册。'."\n" + ."\n" + .'- **true**：表示新注册。'."\n" + .'- **false**：表示重复注册。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'FileURL' => [ + 'description' => 'OSS文件地址。', + 'type' => 'string', + 'example' => 'http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4', + ], + 'MediaId' => [ + 'description' => '点播媒体ID。当注册的媒体文件为音视频时，对应点播的VideoId。', + 'type' => 'string', + 'example' => 'd97af32828084d1896683b1aa38****', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"14F43C5C-8033-448B-AD04F64E5098****\\",\\n \\"FailedFileURLs\\": [\\n \\"[\\\\\\"http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4\\\\\\"]\\"\\n ],\\n \\"RegisteredMediaList\\": [\\n {\\n \\"NewRegister\\": false,\\n \\"FileURL\\": \\"http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4\\",\\n \\"MediaId\\": \\"d97af32828084d1896683b1aa38****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RegisterMediaResponse>\\n <RequestId>14F43C5C-8033-43E7-B48B-AD04F64E5098</RequestId>\\n <RegisteredMediaList>\\n <MediaId>d97af328280842229aed1896683b1aa38</MediaId>\\n <FileURL>http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4</FileURL>\\n <NewRegister>true</NewRegister>\\n </RegisteredMediaList>\\n <RegisteredMediaList>\\n <MediaId>d97af328280842229aed1896683b1aa38</MediaId>\\n <FileURL>http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_02.mp4</FileURL>\\n <NewRegister>false</NewRegister>\\n </RegisteredMediaList>\\n <FailedFileURLs>http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4</FailedFileURLs>\\n</RegisterMediaResponse>","errorExample":""}]', + 'title' => '注册媒资信息', + 'description' => '- 针对已接入点播服务的OSS bucket，已存储在OSS bucket上的音视频媒体文件，需要通过注册媒资接口生成点播需要的关联数据后，才能在点播服务中对这些媒体文件通过媒体ID发起转码、截图和AI处理等。'."\n" + .'- 一次最多可注册**10个OSS媒体文件**，且一次提交的媒体文件对应的存储地址需要一致。'."\n" + .'- 在点播中上传的媒体文件，如未指定转码模板组ID，则会按照默认模板组进行转码处理；与之不同的是，注册媒资后，如未指定转码模板组ID，则不会自动触发转码；如指定了转码模板组ID，则会按照指定的模板组进行转码处理。'."\n" + .'- 重复注册的媒体文件，只返回与其**关联的唯一媒体ID**，不做其他处理。'."\n" + .'- 请确保您要注册的媒资文件含有合法的后缀，否则会注册失败。', + 'requestParamsDescription' => '## RegisterMetadata'."\n" + .'指定要注册的媒资元数据。'."\n" + .'| 名称 | 类型 | 是否必选 | 描述 |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| FileURL | String | 是 | 源文件地址。可通过[获取源文件信息](~~59624~~)接口获取。<br>长度不超过1024个字节，文件名需要保证全局唯一。添加相同文件名称时，则关联唯一媒体ID。 结构为OSS bucket的公网访问地址+ObjectName（文件名）。|'."\n" + .'| Title | String | 是 | 标题。长度不超过128个字节。UTF8编码。 |'."\n" + .'| Description | String | 否 | 描述。长度不超过1024个字节。UTF8编码。 |'."\n" + .'| Tags | String | 否 | 标签。单个标签不超过32个字节，最多不超过16个标签，多个标签之间用半角逗号(,)分隔。UTF8编码。 |'."\n" + .'| CoverURL | String | 否 | 封面URL。长度不超过1024个字节。 |'."\n" + .'| CateId | Long | 否 | 分类ID。可通过以下方式获取：<br>登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **分类管理**查看分类ID。<br>通过[创建分类](~~56401~~)接口创建分类时，分类ID为返回参数CateId的值。<br>通过[获取分类及子分类](~~56406~~)接口查询分类时，为请求后返回参数CateId的值。|'."\n" + .'| ReferenceId | String | 否 | 自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。 |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetPlayInfo' => [ + 'summary' => '调用此接口并提供音视频ID即可获取播放地址，随后可使用阿里云播放器或第三方播放器（如系统原生、开源或自研播放器）播放音视频内容。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39972', + 'abilityTreeNodes' => [ + 'FEATUREvodCOWQO0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '音/视频ID，仅支持传入单个音/视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的音/视频，可登录[视频点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看音/视频ID。'."\n" + .'- 通过[CreateUploadVideo](~~55407~~)接口上传音/视频时，音/视频ID为返回参数VideoId的值。'."\n" + .'- 音/视频上传后，可通过[SearchMedia](~~86044~~)接口查询音/视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '93ab850b4f654b6e91d24d81d44****', + ], + ], + [ + 'name' => 'Formats', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体流格式。多个格式之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **mp4**'."\n" + .'- **m3u8**'."\n" + .'- **mp3**'."\n" + .'- **flv**'."\n" + .'- **mpd**'."\n" + ."\n\n" + .'> - 默认获取所有格式的流。'."\n" + .'> - mpd格式仅当转码模板中配置了`dash`封装格式时才会输出。更多详情，请参见[Container：封装格式](~~52839#title-7rr-3hj-gy5~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'mp4,m3u8', + ], + ], + [ + 'name' => 'AuthTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '设置播放地址的有效时间。单位：秒。'."\n" + ."\n" + .'- 当OutputType取值为**cdn**时：'."\n" + ."\n" + .' - 只有开启了URL鉴权，播放地址才会定期失效，否则会永久有效。URL鉴权的开启及配置方法，请参见[URL鉴权](~~86090~~)。'."\n" + .' - 最小值：**1**。'."\n" + .' - 最大值：无限制。'."\n" + .' - 默认值：未设置时，取值为URL鉴权中设置的默认有效时长。'."\n" + ."\n" + .'- 当OutputType取值为**oss**时：'."\n" + ."\n" + .' - 只有存储权限为私有，播放地址才会定期失效，否则会永久有效。'."\n" + .' - 最小值：**1**。'."\n" + .' - 最大值：为降低源站安全风险，当音视频存储在点播系统Bucket上时，最大值为**604800**（即7天），当音视频存储在OSS自有Bucket上时，最大值为**129600**（即36小时）。如果此处设置的最大值不能满足您的需求，您可以设置OutputType为**cdn**，通过设置URL鉴权来设置更长的有效期。'."\n" + .' - 默认值：未设置时，取值为**3600**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1800', + ], + ], + [ + 'name' => 'OutputType', + 'in' => 'query', + 'schema' => [ + 'description' => '输出地址类型。取值：'."\n" + ."\n" + .'- **oss**：回源地址。'."\n" + .'- **cdn**（默认）：加速地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'cdn', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体流类型。多个类型之间用半角逗号（,）分隔。支持类型：'."\n" + ."\n" + .'- **video**：视频。'."\n" + .'- **audio**：音频。'."\n" + ."\n" + .'默认获取所有类型的流。', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + ], + ], + [ + 'name' => 'ReAuthInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'CDN二次鉴权参数，为JSON字符串。当开启了URL鉴权的A方式鉴权功能时，可通过该参数设置鉴权URL的`uid`和`rand`，请参见[鉴权方式A说明](~~2249352~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"uid":"12345","rand":"abckljd"}', + ], + ], + [ + 'name' => 'Definition', + 'in' => 'query', + 'schema' => [ + 'description' => '视频流清晰度。多个清晰度之间用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **FD**：流畅。'."\n" + .'- **LD**：标清。'."\n" + .'- **SD**：高清。'."\n" + .'- **HD**：超清'."\n" + .'- **OD**：原画。'."\n" + .'- **2K**：2K。'."\n" + .'- **4K**：4K。'."\n" + .'- **SQ**：普通音质。'."\n" + .'- **HQ**：高音质。'."\n" + .'- **AUTO**：自适应码率。'."\n" + ."\n" + .'> - 默认获取所有清晰度的流。'."\n" + .'> - 生成溯源水印时，本参数必填，需与溯源水印转码时所设置的清晰度保持一致。'."\n" + .'> - AUTO格式仅当转码模板中配置了转码打包时才会有该清晰度输出，请参见[PackageSetting：转码打包设置](~~52839#title-4fk-cg8-gzx~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'LD', + ], + ], + [ + 'name' => 'ResultType', + 'in' => 'query', + 'schema' => [ + 'description' => '返回数据类型。取值：'."\n" + ."\n" + .'- **Single**（默认）：每种清晰度和格式只返回一路最新转码完成的流。'."\n" + .'- **Multiple**：每种清晰度和格式返回所有转码完成的流。', + 'type' => 'string', + 'required' => false, + 'example' => 'Single', + ], + ], + [ + 'name' => 'PlayConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '播放自定义设置。为JSON字符串，支持指定域名播放设置。参数构造详情，请参见[PlayConfig](~~86952#section-9g7-s9b-v7z~~)。'."\n" + ."\n" + .'> - PlayConfig不设置或者其中`PlayDomain`不设置时，接口默认使用点播配置的默认域名；如果没有设置默认域名，则会根据域名的修改时间倒序查询，使用最新修改过的域名作为播放域名。为防止返回的不是想要的域名，建议设置默认播放域名（可登录[视频点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **存储管理** > **管理** > **回源到此存储地址的域名**设置默认播放域名）。'."\n" + .'> - 当PlayConfig中的`EncryptType`参数设置为`AliyunVoDEncryption`时，为了保障您的视频安全，默认不返回私有加密流播放地址，若需要返回私有加密流播放地址，需要同时设置`ResultType`参数为`Multiple`。', + 'type' => 'string', + 'required' => false, + 'example' => '{"PlayDomain":"vod.test_domain","XForwardedFor":"yqCD7Fp1uqChoVj/sl/p5Q==","PreviewTime":"20","MtsHlsUriToken":"yqCD7Fp1uqChoVjslp5Q"}', + ], + ], + [ + 'name' => 'AdditionType', + 'in' => 'query', + 'schema' => [ + 'description' => '获取弹幕蒙版数据URL地址，取值：**danmu**。'."\n" + ."\n" + .'> 仅当`outputType`取值为`cdn`时才会生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'danmu', + ], + ], + [ + 'name' => 'Trace', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义的数字水印信息。'."\n" + .'- 当`DigitalWatermarkType`取值为`TraceMark`时，通过传入本参数，可以为视频设置溯源水印的水印信息，并返回包含水印信息的视频流。仅支持传入英文字母、数字及中文字符，最多支持1024个字符。'."\n" + .'- 当`DigitalWatermarkType`取值为`CopyrightMark`时，`Trace`对应创建水印模板时所设置的**水印文字**。通过传入本参数，可以查询并返回指定水印文字的视频流。', + 'type' => 'string', + 'required' => false, + 'example' => 'test mark', + ], + ], + [ + 'name' => 'DigitalWatermarkType', + 'in' => 'query', + 'schema' => [ + 'description' => '数字水印类型。取值：'."\n" + ."\n" + .'- TraceMark：溯源水印。'."\n" + .'- CopyrightMark：版权水印。', + 'type' => 'string', + 'required' => false, + 'example' => 'TraceMark', + ], + ], + [ + 'name' => 'CodecName', + 'in' => 'query', + 'schema' => [ + 'title' => '编码类型。', + 'description' => '编码类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'H264', + ], + ], + [ + 'name' => 'ReferenceId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'description' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F552E596-967D-5500-842F-17E6364****', + ], + 'VideoBase' => [ + 'description' => '音/视频基本信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '音/视频创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-06-26T06:38:48Z', + ], + 'Status' => [ + 'description' => '音/视频状态。各取值及描述，请参见[Status：音视频状态](~~52839#title-vqg-8cz-7p8~~)。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'VideoId' => [ + 'description' => '音/视频ID。', + 'type' => 'string', + 'example' => '93ab850b4f654b6e91d24d81d44****', + ], + 'CoverURL' => [ + 'description' => '音/视频封面地址。'."\n" + .'> 如果上传完视频后需要实时获取音/视频封面地址，您可以配置点播回调，详情请参见[HTTP回调](~~67214~~)及[视频截图完成事件](~~57337~~)。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/sample.jpg?auth_key=2333232-atb****', + ], + 'Duration' => [ + 'description' => '音/视频时长。单位：秒。', + 'type' => 'string', + 'example' => '3.1667', + ], + 'Title' => [ + 'description' => '音/视频标题。', + 'type' => 'string', + 'example' => '阿里云VOD', + ], + 'MediaType' => [ + 'description' => '媒体文件类型，取值：'."\n" + ."\n" + .'- **video**：视频。'."\n" + .'- **audio**：纯音频。', + 'type' => 'string', + 'example' => 'video', + ], + 'DanMuURL' => [ + 'description' => '弹幕蒙版数据的地址。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/****?auth_key=abdf2123-6783232****', + ], + 'StorageClass' => [ + 'description' => '媒资存储类型。取值：'."\n" + ."\n" + .'- **Standard**：标准。'."\n" + .'- **IA**：媒资低频。'."\n" + .'- **Archive**：媒资归档。'."\n" + .'- **ColdArchive**：媒资冷归档。'."\n" + .'- **SourceIA**：源文件低频。'."\n" + .'- **SourceArchive**：源文件归档。'."\n" + .'- **SourceColdArchive**：源文件冷归档。'."\n" + .'- **Changing**：媒资存储类型变更中。'."\n" + .'- **SourceChanging**：源文件存储类型变更中。', + 'type' => 'string', + 'example' => 'Standard', + ], + ], + ], + 'PlayInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PlayInfo' => [ + 'description' => '音/视频播放信息（流信息）。', + 'type' => 'array', + 'items' => [ + 'description' => '音/视频详细信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2022-04-18T07:37:15Z', + ], + 'Status' => [ + 'description' => '媒体流状态，取值：'."\n" + ."\n" + .'- **Normal**：正常状态，标记的是每种清晰度和格式的一路最新转码完成的流的状态。'."\n" + .'- **Invisible**：不可见状态，当每种清晰度和格式有多路重复的转码流时，除了最新的一路流会被标记为正常状态，其他流会被标记为不可见状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Specification' => [ + 'description' => '音视频转码输出规格。各取值及描述，请参见[输出规格：Specification](~~124671#section-6bv-l0g-opq~~)。', + 'type' => 'string', + 'example' => 'H264.LD', + ], + 'NarrowBandType' => [ + 'description' => '转码类型。取值：'."\n" + ."\n" + .'- **0**：普通转码。'."\n" + .'- **1.0**：窄带高清1.0转码。'."\n" + .'- **2.0**：窄带高清2.0转码。', + 'type' => 'string', + 'example' => '0', + ], + 'Height' => [ + 'description' => '媒体流高度。单位：px。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '640', + ], + 'Bitrate' => [ + 'description' => '媒体流码率。单位：Kbps。'."\n" + .'> 受M3U8动态分片特性影响，其码率计算可能存在偏差。', + 'type' => 'string', + 'example' => '450.878', + ], + 'ModificationTime' => [ + 'description' => '更新时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2022-04-20T06:32:19Z', + ], + 'WatermarkId' => [ + 'description' => '当前媒体流关联的水印模板ID。', + 'type' => 'string', + 'example' => 'dgfn26457856****', + ], + 'Encrypt' => [ + 'description' => '媒体流是否加密流，取值：'."\n" + ."\n" + .'- **0**：否。'."\n" + .'- **1**：是。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Definition' => [ + 'description' => '视频流清晰度定义。取值：'."\n" + ."\n" + .'- **FD**：流畅。'."\n" + .'- **LD**：标清。'."\n" + .'- **SD**：高清。'."\n" + .'- **HD**：超清'."\n" + .'- **OD**：原画。'."\n" + .'- **2K**：2K。'."\n" + .'- **4K**：4K。'."\n" + .'- **SQ**：普通音质。'."\n" + .'- **HQ**：高音质。'."\n" + .'- **AUTO**：自适应码率。', + 'type' => 'string', + 'example' => 'LD', + ], + 'EncryptType' => [ + 'description' => '媒体流加密类型。取值：'."\n" + ."\n" + .'- **AliyunVoDEncryption**：阿里云视频加密。'."\n" + .'- **HLSEncryption**：HLS标准加密。'."\n" + ."\n" + .'> 如果加密类型为**AliyunVoDEncryption**，则只能使用阿里云播放器SDK才能正常播放。', + 'type' => 'string', + 'example' => 'AliyunVoDEncryption', + ], + 'EncryptMode' => [ + 'description' => '媒体流加密模式。取值：'."\n" + ."\n" + .'- **License**：本地解密模式。'."\n" + ."\n" + .'> 如果加密模式为**License**，则只能使用阿里云播放器SDK才能正常播放。', + 'type' => 'string', + 'example' => 'License', + ], + 'StreamType' => [ + 'description' => '媒体流类型。'."\n" + .'若媒体流为视频则取值：**video**，若是纯音频则取值：**audio**。', + 'type' => 'string', + 'example' => 'video', + ], + 'JobId' => [ + 'description' => '媒体流转码的作业ID。作为媒体流的唯一标识。', + 'type' => 'string', + 'example' => '80e9c6580e754a798c3c19c59b16****', + ], + 'Size' => [ + 'description' => '媒体流大小。单位：Byte。'."\n" + .'> 受M3U8动态分片特性影响，其媒体流大小计算可能存在偏差。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '418112', + ], + 'Width' => [ + 'description' => '媒体流宽度。单位：px。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '360', + ], + 'Fps' => [ + 'description' => '媒体流帧率。单位：帧/每秒。', + 'type' => 'string', + 'example' => '25', + ], + 'Duration' => [ + 'description' => '媒体流长度。单位：秒。', + 'type' => 'string', + 'example' => '9.0464', + ], + 'PlayURL' => [ + 'description' => '视频流的播放地址。', + 'type' => 'string', + 'example' => 'https://example.aliyundoc.com/d52ee123f331466aabf6ab32a93d****/a777f9e24e6e47a2a942467d5c38ea37-8ee8e04293c6657fdda282bc422704****.m3u8', + ], + 'Format' => [ + 'description' => '媒体流格式。'."\n" + .'- 若媒体文件为视频则取值： **mp4**、 **m3u8**。'."\n" + .'- 若是纯音频则取值：**mp3**。', + 'type' => 'string', + 'example' => 'm3u8', + ], + 'HDRType' => [ + 'title' => '视频流HDR类型', + 'description' => '媒体流HDR类型。取值：'."\n" + .'- HDR'."\n" + .'- HDR10'."\n" + .'- HLG'."\n" + .'- DolbyVision'."\n" + .'- HDRVivid'."\n" + .'- SDR+', + 'type' => 'string', + 'example' => 'HLG', + ], + 'BitDepth' => [ + 'title' => '颜色位深', + 'description' => '颜色位深。取值为整数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'JobType' => [ + 'description' => '数字水印类型。取值：'."\n" + .'- **1**：溯源水印。'."\n" + .'- **2**：版权水印。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'JobExt' => [ + 'description' => '版权水印的自定义水印信息。仅当`JobType`为`2`时返回该字段。', + 'type' => 'string', + 'example' => 'CopyrightMarkTest', + ], + 'CodecName' => [ + 'description' => '编码类型。取值：'."\n" + ."\n" + .'- H264'."\n" + ."\n" + .'- H265', + 'type' => 'string', + 'example' => 'H264', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F552E596-967D-5500-842F-17E6364****\\",\\n \\"VideoBase\\": {\\n \\"CreationTime\\": \\"2017-06-26T06:38:48Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"VideoId\\": \\"93ab850b4f654b6e91d24d81d44****\\",\\n \\"CoverURL\\": \\"http://example.aliyundoc.com/sample.jpg?auth_key=2333232-atb****\\",\\n \\"Duration\\": \\"3.1667\\",\\n \\"Title\\": \\"阿里云VOD\\",\\n \\"MediaType\\": \\"video\\",\\n \\"DanMuURL\\": \\"http://example.aliyundoc.com/****?auth_key=abdf2123-6783232****\\",\\n \\"StorageClass\\": \\"Standard\\"\\n },\\n \\"PlayInfoList\\": {\\n \\"PlayInfo\\": [\\n {\\n \\"CreationTime\\": \\"2022-04-18T07:37:15Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Specification\\": \\"H264.LD\\",\\n \\"NarrowBandType\\": \\"0\\",\\n \\"Height\\": 640,\\n \\"Bitrate\\": \\"450.878\\",\\n \\"ModificationTime\\": \\"2022-04-20T06:32:19Z\\",\\n \\"WatermarkId\\": \\"dgfn26457856****\\",\\n \\"Encrypt\\": 1,\\n \\"Definition\\": \\"LD\\",\\n \\"EncryptType\\": \\"AliyunVoDEncryption\\",\\n \\"EncryptMode\\": \\"License\\",\\n \\"StreamType\\": \\"video\\",\\n \\"JobId\\": \\"80e9c6580e754a798c3c19c59b16****\\",\\n \\"Size\\": 418112,\\n \\"Width\\": 360,\\n \\"Fps\\": \\"25\\",\\n \\"Duration\\": \\"9.0464\\",\\n \\"PlayURL\\": \\"https://example.aliyundoc.com/d52ee123f331466aabf6ab32a93d****/a777f9e24e6e47a2a942467d5c38ea37-8ee8e04293c6657fdda282bc422704****.m3u8\\",\\n \\"Format\\": \\"m3u8\\",\\n \\"HDRType\\": \\"HLG\\",\\n \\"BitDepth\\": 8,\\n \\"JobType\\": 2,\\n \\"JobExt\\": \\"CopyrightMarkTest\\",\\n \\"CodecName\\": \\"H264\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetPlayInfoResponse>\\n <VideoBase>\\n <Status>Normal</Status>\\n <VideoId>93ab850b4f654b6e91d24d81d44****</VideoId>\\n <TranscodeMode>NoTranscode</TranscodeMode>\\n <CreationTime>2022-04-18T07:37:15Z</CreationTime>\\n <Title>阿里云VOD</Title>\\n <MediaType>video</MediaType>\\n <CoverURL>http://example.aliyundoc.com/sample.jpg?auth_key=2333232-atb****</CoverURL>\\n <Duration>3.1667</Duration>\\n <OutputType>cdn</OutputType>\\n </VideoBase>\\n <RequestId>F552E596-967D-5500-842F-17E6364****</RequestId>\\n <PlayInfoList>\\n <PlayInfo>\\n <Status>Normal</Status>\\n <StreamType>video</StreamType>\\n <HDRType>HLG</HDRType>\\n <Size>418112</Size>\\n <Definition>LD</Definition>\\n <Fps>25</Fps>\\n <Specification>H264.LD</Specification>\\n <ModificationTime>2022-04-20T06:32:19Z</ModificationTime>\\n <Duration>9.0464</Duration>\\n <Bitrate>450.878</Bitrate>\\n <BitDepth>8</BitDepth>\\n <Encrypt>0</Encrypt>\\n <PreprocessStatus>UnPreprocess</PreprocessStatus>\\n <Format>m3u8</Format>\\n <NarrowBandType>0</NarrowBandType>\\n <PlayURL>https://example.aliyundoc.com/d52ee123f331466aabf6ab32a93d****/a777f9e24e6e47a2a942467d5c38ea37-8ee8e04293c6657fdda282bc422704****.m3u8</PlayURL>\\n <CreationTime>2022-04-20T06:32:14Z</CreationTime>\\n <Height>640</Height>\\n <Width>360</Width>\\n <JobId>80e9c6580e754a798c3c19c59b16****</JobId>\\n </PlayInfo>\\n </PlayInfoList>\\n</GetPlayInfoResponse>","errorExample":""}]', + 'title' => '获取音视频播放地址', + 'description' => '- **请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。从点播的播放地址直接下载或播放视频将产生下行流量费用，未配置加速域名时请参见[存储流出流量计费](~~188308#section-rwh-e88-f7j~~)；已配置加速域名时请参见[加速服务计费](~~188308#section-c5t-oq9-15e~~)。如果您已开通了存储传输加速，则从点播的播放地址直接下载或播放视频还将涉及下载加速费用，计费详情请参见[存储传输加速计费](~~188310#section_sta_zm2_tsv~~)。**'."\n" + .'- 只有状态为正常（Status字段值为Normal）的视频才能正常播放。关于播放地址的播放说明及使用限制等更多信息，请参见[音视频播放](~~57290~~)。'."\n" + .'- 当[媒资存储](~~2392368~~)类型为非标准存储时，需要对PlayConfig参数的StorageClass字段进行相应设置，详情请参见[PlayConfig](~~86952#section-9g7-s9b-v7z~~)。'."\n" + .'- 当视频播放异常时，您可以调用[GetMezzanineInfo](~~GetMezzanineInfo~~)接口查询视频源文件信息是否正确。'."\n" + .'<props="china">'."\n" + .'- 如需调用本接口生成m3u8溯源水印视频流，请先提交工单，申请开通，如何提交工单，请参见[联系我们](~~464625~~)。更多溯源水印详细信息，请参见[数字水印](~~2527021~~)。</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ | '."\n" + .'| Forbidden.IllegalStatus |Status of the video is illegal. Current Status is %s. |403 |视频状态无效，当前状态为%s。只有**Normal**状态的视频才能播放。|'."\n" + .'| InvalidVideo.NotFound |The video does not exist. |404| 视频不存在。|'."\n" + .'| InvalidVideo.NoneStream |The video has no stream to play for the request parameter ‘Formats : mp4, Definition : LD, StreamType : video’. |404| 根据您的筛选条件找不到可以播放的转码输出流，请检查您的[转码配置](~~86068~~)与筛选条件是否匹配。|'."\n" + .'| Forbidden.AliyunVoDEncryption |Currently only the AliyunVoDEncryption stream exists, you must use the Aliyun player to play or set the value of ResultType to Multiple. |403 |当前仅存在阿里云视频加密的转码输出流，必须使用阿里云播放器进行播放或者设置请求参数**ResultType**值为**Multiple**。|'."\n", + ], + 'GetVideoPlayAuth' => [ + 'summary' => '调用本接口获取音视频的播放凭证（PlayAuth）。阿里云播放器SDK使用该凭证自动获取播放地址。由于播放凭证具有时效性，且与特定音视频绑定，不可混用或重复使用，因此凭证过期或无效将导致无法播放。此播放方式适用于需要高安全性的音视频播放场景。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40001', + 'abilityTreeNodes' => [ + 'FEATUREvodCOWQO0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '音/视频ID，仅支持传入单个音/视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看音/视频ID。'."\n" + .'- 通过[CreateUploadVideo](~~55407~~)接口上传音/视频时，音/视频ID为返回参数VideoId的值。'."\n" + .'- 音/视频上传后，可通过[SearchMedia](~~86044~~)接口查询音/视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'dfde02284a5c46622a097adaf44a****', + ], + ], + [ + 'name' => 'AuthInfoTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '播放凭证过期时间，单位：**秒**。如果凭证过期则无法获取播放地址，需要重新获取凭证。'."\n" + ."\n" + .'- 默认为**100**秒。'."\n" + .'- 取值范围：`[100,3000]`。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'ApiVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'API版本号，固定取值为**1.0.0**。', + 'type' => 'string', + 'required' => false, + 'example' => '1.0.0', + ], + ], + [ + 'name' => 'ReferenceId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'description' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'PlayAuth' => [ + 'description' => '音/视频播放凭证。', + 'type' => 'string', + 'example' => 'sstyYuew6789000000xtt7TYUh****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E4EBD2BF-5EB0-4476-8829-9D94E1B1****', + ], + 'VideoMeta' => [ + 'description' => '音/视频Meta信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '音/视频状态。各取值及描述，请参见[Status：音视频状态](~~52839#title-vqg-8cz-7p8~~)。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Duration' => [ + 'description' => '音/视频时长。单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '120.0', + ], + 'Title' => [ + 'description' => '音/视频标题。', + 'type' => 'string', + 'example' => 'Alibaba Cloud VOD Video Title', + ], + 'VideoId' => [ + 'description' => '音/视频ID。', + 'type' => 'string', + 'example' => 'dfde02284a5c46622a097adaf44a****', + ], + 'CoverURL' => [ + 'description' => '音/视频封面地址。', + 'type' => 'string', + 'example' => 'https://example.aliyundoc.com/****.jpg', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PlayAuth\\": \\"sstyYuew6789000000xtt7TYUh****\\",\\n \\"RequestId\\": \\"E4EBD2BF-5EB0-4476-8829-9D94E1B1****\\",\\n \\"VideoMeta\\": {\\n \\"Status\\": \\"Normal\\",\\n \\"Duration\\": 120,\\n \\"Title\\": \\"Alibaba Cloud VOD Video Title\\",\\n \\"VideoId\\": \\"dfde02284a5c46622a097adaf44a****\\",\\n \\"CoverURL\\": \\"https://example.aliyundoc.com/****.jpg\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetVideoPlayAuthResponse>\\n <PlayAuth>sstyYuew6789000000xtt7TYUh****</PlayAuth>\\n <RequestId>E4EBD2BF-5EB0-4476-8829-9D94E1B1****</RequestId>\\n <VideoMeta>\\n <Status>Normal</Status>\\n <Duration>120</Duration>\\n <Title>阿里云VOD</Title>\\n <VideoId>dfde02284a5c46622a097adaf44a****</VideoId>\\n <CoverURL>https://example.aliyundoc.com/****.jpg</CoverURL>\\n </VideoMeta>\\n</GetVideoPlayAuthResponse>","errorExample":""}]', + 'title' => '获取音视频播放凭证', + 'description' => '- 使用阿里云播放器SDK（适用于PlayAuth播放方式），调用本接口来获取播放凭证，阿里云播放器SDK通过播放凭证自动获取播放地址进行播放，更多信息，请参见[阿里云播放器SDK](~~125579~~)。'."\n" + .'- 如果播放凭证过期则无法获取播放地址，需要重新获取播放凭证。', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| Forbidden.IllegalStatus |Status of the video is illegal. |403| 视频状态无效。|'."\n" + .'| InvalidVideo.NotFound |The video does not exist. |404|视频不存在。|'."\n" + .'| MissingVideoId | VideoId is mandatory for this action. |400|VideoId参数是必选项。|', + ], + 'SearchMedia' => [ + 'summary' => '本接口用于搜索视频点播生产的视频、音频和图片等媒资信息，调用本接口配合媒资搜索协议可实现在视频点播中进行指定返回字段、精确匹配、模糊匹配、多值查询、范围查询、排序字段等多方式多维度的搜索查询。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40118', + 'abilityTreeNodes' => [ + 'FEATUREvodCOT3DK', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SearchType', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索媒资数据类型。取值范围：'."\n" + ."\n" + .'- **video**（默认值）：视频。'."\n" + .'- **audio**：音频。'."\n" + .'- **image**：图片。'."\n" + .'- **attached**：辅助媒资。'."\n" + ."\n" + .'> 当本参数取值为**video**或**audio**，且需要遍历搜索条件命中的所有数据时，必须设置ScrollToken参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索结果中返回的媒资字段。'."\n" + ."\n" + .'默认只返回基本媒资字段，可指定返回更多媒资字段，请参见[使用示例](~~99179~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Title,CoverURL', + ], + ], + [ + 'name' => 'Match', + 'in' => 'query', + 'schema' => [ + 'description' => '过滤条件。语法规则，请参见[搜索协议语法](~~86991~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'field = value', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段和排序顺序。多个使用半角逗号（,）分隔。取值：'."\n" + .'- **CreationTime:Desc**（默认值）：按创建时间倒序。'."\n" + .'- **CreationTime:Asc**：按创建时间升序。'."\n" + ."\n" + .'> - 排序字段示例：[排序字段](~~99179~~)。'."\n" + .'> - 获取搜索条件是前5000条的数据时，最多支持三个排序字段。'."\n" + .'> - 获取搜索条件是所有数据时，仅支持一个排序字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreationTime:Desc', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为**1**。'."\n" + ."\n" + .'> 当本参数取值超过**200**时，建议同时设置ScrollToken参数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的数据条数。默认值为**10**，最大值为**100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ScrollToken', + 'in' => 'query', + 'schema' => [ + 'description' => '翻页标识。长度为32个字符。'."\n" + .'第一次执行搜索请求时不用设置本参数。搜索请求命中数据时，服务端会返回该参数值，用于记录当前搜索数据的位置地址。请记录返回的参数值，下一次搜索时按下述要求或建议设置本参数：'."\n" + .'- 当SearchType参数取值为**video**或**audio**，且需要遍历搜索条件命中的所有数据时，本参数必须设置。'."\n" + .'- 当PageNo参数取值超过**200**时，建议设置本参数优化搜索性能。', + 'type' => 'string', + 'required' => false, + 'example' => '24e0fba7188fae707e146esa54****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3E0CEF83-FB09-4E34-BA1451814B03****', + ], + 'Total' => [ + 'description' => '满足搜索条件的媒资信息总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ScrollToken' => [ + 'description' => '翻页标识。', + 'type' => 'string', + 'example' => '24e0fba7188fae707e146esa54****', + ], + 'MediaList' => [ + 'description' => '媒资信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '媒资信息详情。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '媒体创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-07-19T03:45:25Z', + ], + 'MediaType' => [ + 'description' => '媒体类型。取值范围：'."\n" + ."\n" + .'- **video**：视频。'."\n" + .'- **audio**：音频。'."\n" + .'- **image**：图片。'."\n" + .'- **attached**：辅助媒资。', + 'type' => 'string', + 'example' => 'video', + ], + 'MediaId' => [ + 'description' => '媒体ID。', + 'type' => 'string', + 'example' => 'a82a2cd7d4e147bbed6c1ee372****', + ], + 'Video' => [ + 'description' => '[视频信息](~~86991~~)。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态。取值：'."\n" + ."\n" + .'- **Uploading**：上传中。'."\n" + .'- **UploadFail**：上传失败。'."\n" + .'- **UploadSucc**：上传完成。'."\n" + .'- **Transcoding**：转码中。'."\n" + .'- **TranscodeFail**：转码失败。'."\n" + .'- **Blocked**：屏蔽。'."\n" + .'- **Normal**：正常。', + 'type' => 'string', + 'example' => 'UploadSucc', + ], + 'CreationTime' => [ + 'description' => '视频信息创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-07-19T03:45:25Z', + ], + 'StorageLocation' => [ + 'description' => '存储区域。', + 'type' => 'string', + 'example' => 'outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000123', + ], + 'Tags' => [ + 'description' => '视频标签。', + 'type' => 'string', + 'example' => 'tag1', + ], + 'ModificationTime' => [ + 'description' => '视频信息更新时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-07-19T03:48:25Z', + ], + 'MediaSource' => [ + 'description' => '来源。取值：'."\n" + ."\n" + .'- **general**：点播上传。'."\n" + .'- **short_video**：短视频SDK。'."\n" + .'- **editing**：剪辑合成。'."\n" + .'- **live**：直播录制。', + 'type' => 'string', + 'example' => 'general', + ], + 'Description' => [ + 'description' => '视频描述。', + 'type' => 'string', + 'example' => 'Alibaba Cloud VOD video description', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'CoverURL' => [ + 'description' => '封面图片。', + 'type' => 'string', + 'example' => 'https://example.aliyundoc.com/image01.png', + ], + 'VideoId' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'example' => 'a82a2asdasqadaf3faa0ed6c1ee372****', + ], + 'DownloadSwitch' => [ + 'description' => '下载开关。只有状态开启时才允许离线下载。取值范围：'."\n" + ."\n" + .'- **on**（开启）：初始状态，允许离线下载。'."\n" + .'- **off**（禁用）：禁用离线下载。', + 'type' => 'string', + 'example' => 'on', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => 'video1', + ], + 'TranscodeMode' => [ + 'description' => '转码模式。取值：'."\n" + ."\n" + .'- **FastTranscode**（普通转码）：默认模式，上传完成即开始转码，且转码完成才能播放。'."\n" + .'- **NoTranscode**（不转码即分发）：上传完成不转码，且立即能播放。'."\n" + .'- **AsyncTranscode**（上传即分发并转码） ：上传完成即能播放，同时异步进行转码。', + 'type' => 'string', + 'example' => 'FastTranscode', + ], + 'PreprocessStatus' => [ + 'description' => '预处理状态 。取值：'."\n" + ."\n" + .'- **UnPreprocess**：未进行预处理。'."\n" + .'- **Preprocessing**：预处理中。'."\n" + .'- **PreprocessSucceed**：预处理完成。'."\n" + .'- **PreprocessFailed**：预处理失败。', + 'type' => 'string', + 'example' => 'Preprocessing', + ], + 'RestoreExpiration' => [ + 'description' => '媒资解冻有效期。', + 'type' => 'string', + 'example' => '2023-03-30T10:14:14Z', + ], + 'RestoreStatus' => [ + 'description' => '媒资解冻状态。取值：'."\n" + .'- **Processing**：解冻中。'."\n" + .'- **Success**：解冻成功。'."\n" + .'- **Failed**：解冻失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'StorageClass' => [ + 'description' => '媒资存储类型。取值：'."\n" + .'- **Standard**：标准。'."\n" + .'- **IA**：媒资低频。'."\n" + .'- **Archive**：媒资归档。'."\n" + .'- **ColdArchive**：媒资冷归档。'."\n" + .'- **SourceIA**：源文件低频。'."\n" + .'- **SourceArchive**：源文件归档。'."\n" + .'- **SourceColdArchive**：源文件冷归档。'."\n" + .'- **Changing**：媒资存储类型变更中。'."\n" + .'- **SourceChanging**：源文件存储类型变更中。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'Size' => [ + 'description' => '视频大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Duration' => [ + 'description' => '视频时长。单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '123', + ], + 'Title' => [ + 'description' => '视频标题。', + 'type' => 'string', + 'example' => 'Alibaba Cloud VOD Video Title', + ], + 'SpriteSnapshots' => [ + 'description' => '雪碧图列表。', + 'type' => 'array', + 'items' => [ + 'description' => '雪碧图列表。', + 'type' => 'string', + 'example' => '{“http://example.aliyundoc.com/image02.jpg”}', + ], + ], + 'Snapshots' => [ + 'description' => '自动截图列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自动截图列表。', + 'type' => 'string', + 'example' => '{“http://example.aliyundoc.com/image03.jpg”}', + ], + ], + 'ReferenceId' => [ + 'title' => '自定义 ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'description' => '自定义 ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'example' => '123-123', + ], + ], + ], + 'Audio' => [ + 'description' => '[音频信息](~~86991~~)。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态。取值：'."\n" + ."\n" + .'- **Uploading**：上传中。'."\n" + .'- **Normal**：正常。 '."\n" + .'- **UploadFail**：失败。'."\n" + .'- **Deleted**：删除。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CreationTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-07-19T03:45:25Z', + ], + 'StorageLocation' => [ + 'description' => '存储区域。', + 'type' => 'string', + 'example' => 'outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000123', + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'tag1,tag2', + ], + 'ModificationTime' => [ + 'description' => '更新时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-07-19T03:48:25Z', + ], + 'MediaSource' => [ + 'description' => '来源。取值：'."\n" + ."\n" + .'- **general**（点播上传）：普通上传。'."\n" + .'- **short_video**（短视频SDK）： 通过短视频SDK上传文件至点播，详细内容请参见[短视频SDK](~~53407~~)。'."\n" + .'- **editing**（剪辑合成）：通过云剪辑合成上传文件至点播，详细内容请参见[视频合成](~~68536~~)。'."\n" + .'- **live**（直播录制）：通过直播录制上传文件至点播。', + 'type' => 'string', + 'example' => 'general', + ], + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'Alibaba Cloud VOD Audio Description', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'CoverURL' => [ + 'description' => '封面图片。', + 'type' => 'string', + 'example' => 'http://example.com/image04.jpg', + ], + 'AudioId' => [ + 'description' => '音频ID。', + 'type' => 'string', + 'example' => 'a82a2cd7d4e147bbed6c1ee372****', + ], + 'DownloadSwitch' => [ + 'description' => '下载开关。只有状态开启时才允许离线下载。取值：'."\n" + ."\n" + .'- **on**（开启）：初始状态，允许离线下载。'."\n" + .'- **off**（禁用）：禁用离线下载。', + 'type' => 'string', + 'example' => 'on', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => 'cate1', + ], + 'TranscodeMode' => [ + 'description' => '转码模式。取值范围：'."\n" + ."\n" + .'- **FastTranscode**（普通转码，默认值）：上传完成即开始转码，且转码完成才能播放。'."\n" + .'- **NoTranscode**（不转码即分发）：上传完成不转码，且立即能播放。'."\n" + .'- **AsyncTranscode**（上传即分发并转码）：上传完成即能播放，同时异步进行转码。', + 'type' => 'string', + 'example' => 'FastTranscode', + ], + 'PreprocessStatus' => [ + 'description' => '预处理状态，预处理完成后的视频才可用于直播导播。取值：'."\n" + ."\n" + .'- **UnPreprocess**：未进行预处理。'."\n" + .'- **Preprocessing**：预处理中。'."\n" + .'- **PreprocessSucceed**：预处理完成。'."\n" + .'- **PreprocessFailed**：预处理失败。', + 'type' => 'string', + 'example' => 'UnPreprocess', + ], + 'RestoreExpiration' => [ + 'description' => '媒资解冻有效期。', + 'type' => 'string', + 'example' => '2023-03-30T10:14:14Z', + ], + 'RestoreStatus' => [ + 'description' => '媒资解冻状态。取值：'."\n" + .'- **Processing**：解冻中。'."\n" + .'- **Success**：解冻成功。'."\n" + .'- **Failed**：解冻失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'StorageClass' => [ + 'description' => '媒资存储类型。取值：'."\n" + .'- **Standard**：标准。'."\n" + .'- **IA**：媒资低频。'."\n" + .'- **Archive**：媒资归档。'."\n" + .'- **ColdArchive**：媒资冷归档。'."\n" + .'- **SourceIA**：源文件低频。'."\n" + .'- **SourceArchive**：源文件归档。'."\n" + .'- **SourceColdArchive**：源文件冷归档。'."\n" + .'- **Changing**：变更中。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'Size' => [ + 'description' => '大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Duration' => [ + 'description' => '时长。', + 'type' => 'number', + 'format' => 'float', + 'example' => '123', + ], + 'Title' => [ + 'description' => '标题。', + 'type' => 'string', + 'example' => 'Alibaba Cloud VOD Audio Title', + ], + 'SpriteSnapshots' => [ + 'description' => '雪碧图列表。', + 'type' => 'array', + 'items' => [ + 'description' => '雪碧图列表。', + 'type' => 'string', + 'example' => '{“http://example.aliyundoc.com/image02.jpg”}', + ], + ], + 'Snapshots' => [ + 'description' => '自动截图列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自动截图列表。', + 'type' => 'string', + 'example' => '{“http://example.aliyundoc.com/image03.jpg”}', + ], + ], + 'ReferenceId' => [ + 'title' => '自定义 ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'description' => '自定义 ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'example' => '123-123', + ], + ], + ], + 'Image' => [ + 'description' => '[图片信息](~~86991~~)。', + 'type' => 'object', + 'properties' => [ + 'StorageLocation' => [ + 'description' => '存储地域。', + 'type' => 'string', + 'example' => 'outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com', + ], + 'CreationTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-07-19T03:45:25Z', + ], + 'Status' => [ + 'description' => '图片状态。'."\n" + ."\n" + .'- **Uploading**（上传中）：初始状态，表示图片正在上传。'."\n" + .'- **Normal**（正常）：图片上传成功。'."\n" + .'- **UploadFail**（失败）：图片上传失败。', + 'type' => 'string', + 'example' => 'Uploading', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000123', + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'tag1', + ], + 'ModificationTime' => [ + 'description' => '更新时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-07-19T03:48:25Z', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => 'cate1', + ], + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'Alibaba Cloud VOD Image Description', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'URL' => [ + 'description' => '图片URL。', + 'type' => 'string', + 'example' => 'https://example.com/****.png', + ], + 'Title' => [ + 'description' => '标题。', + 'type' => 'string', + 'example' => 'Alibaba Cloud VOD Image Title', + ], + 'ImageId' => [ + 'description' => '图片ID。', + 'type' => 'string', + 'example' => '11130843741se99wqmoes****', + ], + ], + ], + 'AttachedMedia' => [ + 'description' => '[辅助媒资信息](~~86991~~)。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2018-07-19T03:45:25Z', + ], + 'Status' => [ + 'description' => '状态。取值：'."\n" + ."\n" + .'- **Uploading**（上传中）： 初始状态，表示辅助媒资正在上传。'."\n" + .'- **Normal**（正常）：辅助媒资上传成功。'."\n" + .'- **UploadFail**（失败）：辅助媒资上传失败。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'StorageLocation' => [ + 'description' => '存储区域。', + 'type' => 'string', + 'example' => 'outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com', + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'tag1', + ], + 'ModificationTime' => [ + 'description' => '更新时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2018-07-19T03:48:25Z', + ], + 'MediaId' => [ + 'description' => '辅助媒资ID。', + 'type' => 'string', + 'example' => 'a82a2cd7d4e147ba0ed6c1ee372****', + ], + 'BusinessType' => [ + 'description' => '业务类型。取值：'."\n" + ."\n" + .'- **watermark**：水印。'."\n" + .'- **subtitle**：字幕。'."\n" + .'- **material**：素材。', + 'type' => 'string', + 'example' => 'watermark', + ], + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'Alibaba Cloud VOD-assisted media asset description', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'URL' => [ + 'description' => '辅助媒资URL。', + 'type' => 'string', + 'example' => 'https://example.com/****.png', + ], + 'Title' => [ + 'description' => '标题。', + 'type' => 'string', + 'example' => 'Alibaba Cloud VOD-assisted media asset Title', + ], + 'Categories' => [ + 'description' => '分类ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '分类详情。', + 'type' => 'object', + 'properties' => [ + 'ParentId' => [ + 'description' => '父节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => 'cate1', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10027394', + ], + 'Level' => [ + 'description' => '分类层级。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'AiData' => [ + 'title' => 'AI详细信息', + 'description' => 'AI详细信息。', + 'type' => 'object', + 'properties' => [ + 'AiLabelInfo' => [ + 'title' => 'AI标签信息列表', + 'description' => 'AI标签信息列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'AI标签信息', + 'description' => 'AI标签信息。', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => '分类', + 'description' => '分类。', + 'type' => 'string', + 'example' => 'Transportation', + ], + 'LabelName' => [ + 'title' => '实体名称', + 'description' => '实体名称。', + 'type' => 'string', + 'example' => 'Car', + ], + 'LabelId' => [ + 'title' => '实体ID', + 'description' => '实体ID。', + 'type' => 'string', + 'example' => '10310250338', + ], + 'Occurrences' => [ + 'title' => '片段列表', + 'description' => '片段列表。', + 'type' => 'array', + 'items' => [ + 'title' => '片段', + 'description' => '片段。', + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'title' => '打分', + 'description' => '打分。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.75287705'."\n", + ], + 'From' => [ + 'title' => '片段起始时间', + 'description' => '片段起始时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.4'."\n", + ], + 'To' => [ + 'title' => '片段结束时间', + 'description' => '片段结束时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2.5', + ], + ], + ], + ], + ], + ], + ], + 'OcrInfo' => [ + 'title' => '字幕信息列表', + 'description' => '字幕信息列表。', + 'type' => 'array', + 'items' => [ + 'title' => '字幕信息', + 'description' => '字幕信息。', + 'type' => 'object', + 'properties' => [ + 'From' => [ + 'title' => '片段起始时间', + 'description' => '片段起始时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.4', + ], + 'To' => [ + 'title' => '片段结束时间', + 'description' => '片段结束时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2.5', + ], + 'Content' => [ + 'title' => '文本内容', + 'description' => '文本内容。', + 'type' => 'string', + 'example' => 'Text content'."\n", + ], + ], + ], + ], + ], + ], + 'AiRoughData' => [ + 'title' => 'AI简介数据', + 'description' => 'AI简介数据。', + 'type' => 'object', + 'properties' => [ + 'SaveType' => [ + 'title' => '保存类型', + 'description' => '保存类型。', + 'type' => 'string', + 'example' => 'type1'."\n", + ], + 'Status' => [ + 'title' => '数据状态', + 'description' => '数据状态。', + 'type' => 'string', + 'example' => 'SaveSuccess', + ], + 'AiJobId' => [ + 'title' => 'AI任务ID', + 'description' => 'AI任务ID。', + 'type' => 'string', + 'example' => 'cd35b0b0025f71edbfcb472190a9xxxx', + ], + 'AiCategory' => [ + 'title' => '视频AI分类', + 'description' => '视频AI分类。', + 'type' => 'string', + 'example' => 'TV drama'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3E0CEF83-FB09-4E34-BA1451814B03****\\",\\n \\"Total\\": 10,\\n \\"ScrollToken\\": \\"24e0fba7188fae707e146esa54****\\",\\n \\"MediaList\\": [\\n {\\n \\"CreationTime\\": \\"2018-07-19T03:45:25Z\\",\\n \\"MediaType\\": \\"video\\",\\n \\"MediaId\\": \\"a82a2cd7d4e147bbed6c1ee372****\\",\\n \\"Video\\": {\\n \\"Status\\": \\"UploadSucc\\",\\n \\"CreationTime\\": \\"2018-07-19T03:45:25Z\\",\\n \\"StorageLocation\\": \\"outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com\\",\\n \\"CateId\\": 10000123,\\n \\"Tags\\": \\"tag1\\",\\n \\"ModificationTime\\": \\"2018-07-19T03:48:25Z\\",\\n \\"MediaSource\\": \\"general\\",\\n \\"Description\\": \\"Alibaba Cloud VOD video description\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"CoverURL\\": \\"https://example.aliyundoc.com/image01.png\\",\\n \\"VideoId\\": \\"a82a2asdasqadaf3faa0ed6c1ee372****\\",\\n \\"DownloadSwitch\\": \\"on\\",\\n \\"CateName\\": \\"video1\\",\\n \\"TranscodeMode\\": \\"FastTranscode\\",\\n \\"PreprocessStatus\\": \\"Preprocessing\\",\\n \\"RestoreExpiration\\": \\"2023-03-30T10:14:14Z\\",\\n \\"RestoreStatus\\": \\"Success\\",\\n \\"StorageClass\\": \\"Standard\\",\\n \\"Size\\": 123,\\n \\"Duration\\": 123,\\n \\"Title\\": \\"Alibaba Cloud VOD Video Title\\",\\n \\"SpriteSnapshots\\": [\\n \\"{“http://example.aliyundoc.com/image02.jpg”}\\"\\n ],\\n \\"Snapshots\\": [\\n \\"{“http://example.aliyundoc.com/image03.jpg”}\\"\\n ],\\n \\"ReferenceId\\": \\"123-123\\"\\n },\\n \\"Audio\\": {\\n \\"Status\\": \\"Normal\\",\\n \\"CreationTime\\": \\"2018-07-19T03:45:25Z\\",\\n \\"StorageLocation\\": \\"outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com\\",\\n \\"CateId\\": 10000123,\\n \\"Tags\\": \\"tag1,tag2\\",\\n \\"ModificationTime\\": \\"2018-07-19T03:48:25Z\\",\\n \\"MediaSource\\": \\"general\\",\\n \\"Description\\": \\"Alibaba Cloud VOD Audio Description\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"CoverURL\\": \\"http://example.com/image04.jpg\\",\\n \\"AudioId\\": \\"a82a2cd7d4e147bbed6c1ee372****\\",\\n \\"DownloadSwitch\\": \\"on\\",\\n \\"CateName\\": \\"cate1\\",\\n \\"TranscodeMode\\": \\"FastTranscode\\",\\n \\"PreprocessStatus\\": \\"UnPreprocess\\",\\n \\"RestoreExpiration\\": \\"2023-03-30T10:14:14Z\\",\\n \\"RestoreStatus\\": \\"Success\\",\\n \\"StorageClass\\": \\"Standard\\",\\n \\"Size\\": 123,\\n \\"Duration\\": 123,\\n \\"Title\\": \\"Alibaba Cloud VOD Audio Title\\",\\n \\"SpriteSnapshots\\": [\\n \\"{“http://example.aliyundoc.com/image02.jpg”}\\"\\n ],\\n \\"Snapshots\\": [\\n \\"{“http://example.aliyundoc.com/image03.jpg”}\\"\\n ],\\n \\"ReferenceId\\": \\"123-123\\"\\n },\\n \\"Image\\": {\\n \\"StorageLocation\\": \\"outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com\\",\\n \\"CreationTime\\": \\"2018-07-19T03:45:25Z\\",\\n \\"Status\\": \\"Uploading\\",\\n \\"CateId\\": 1000123,\\n \\"Tags\\": \\"tag1\\",\\n \\"ModificationTime\\": \\"2018-07-19T03:48:25Z\\",\\n \\"CateName\\": \\"cate1\\",\\n \\"Description\\": \\"Alibaba Cloud VOD Image Description\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"URL\\": \\"https://example.com/****.png\\",\\n \\"Title\\": \\"Alibaba Cloud VOD Image Title\\",\\n \\"ImageId\\": \\"11130843741se99wqmoes****\\"\\n },\\n \\"AttachedMedia\\": {\\n \\"CreationTime\\": \\"2018-07-19T03:45:25Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"StorageLocation\\": \\"outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Tags\\": \\"tag1\\",\\n \\"ModificationTime\\": \\"2018-07-19T03:48:25Z\\",\\n \\"MediaId\\": \\"a82a2cd7d4e147ba0ed6c1ee372****\\",\\n \\"BusinessType\\": \\"watermark\\",\\n \\"Description\\": \\"Alibaba Cloud VOD-assisted media asset description\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"URL\\": \\"https://example.com/****.png\\",\\n \\"Title\\": \\"Alibaba Cloud VOD-assisted media asset Title\\",\\n \\"Categories\\": [\\n {\\n \\"ParentId\\": -1,\\n \\"CateName\\": \\"cate1\\",\\n \\"CateId\\": 10027394,\\n \\"Level\\": 1\\n }\\n ]\\n },\\n \\"AiData\\": {\\n \\"AiLabelInfo\\": [\\n {\\n \\"Category\\": \\"Transportation\\",\\n \\"LabelName\\": \\"Car\\",\\n \\"LabelId\\": \\"10310250338\\",\\n \\"Occurrences\\": [\\n {\\n \\"Score\\": 0.75287705,\\n \\"From\\": 1.4,\\n \\"To\\": 2.5\\n }\\n ]\\n }\\n ],\\n \\"OcrInfo\\": [\\n {\\n \\"From\\": 1.4,\\n \\"To\\": 2.5,\\n \\"Content\\": \\"Text content\\\\n\\"\\n }\\n ]\\n },\\n \\"AiRoughData\\": {\\n \\"SaveType\\": \\"type1\\\\n\\",\\n \\"Status\\": \\"SaveSuccess\\",\\n \\"AiJobId\\": \\"cd35b0b0025f71edbfcb472190a9xxxx\\",\\n \\"AiCategory\\": \\"TV drama\\\\n\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<SearchMediaResponse>\\n <RequestId>3E0CEF83-FB09-4E34-BA1451814B03****</RequestId>\\n <Total>10</Total>\\n <ScrollToken>24e0fba7188fae707e146esa54****</ScrollToken>\\n <MediaList>\\n <CreationTime>2018-07-19T03:45:25Z</CreationTime>\\n <MediaType>video</MediaType>\\n <MediaId>a82a2cd7d4e147bbed6c1ee372****</MediaId>\\n <Video>\\n <Status>UploadSucc</Status>\\n <CreationTime>2018-07-19T03:45:25Z</CreationTime>\\n <StorageLocation>outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com</StorageLocation>\\n <CateId>10000123</CateId>\\n <Tags>tag1</Tags>\\n <ModificationTime>2018-07-19T03:48:25Z</ModificationTime>\\n <MediaSource>general</MediaSource>\\n <Description>视频测试</Description>\\n <AppId>app-****</AppId>\\n <CoverURL>https://example.aliyundoc.com/image01.png</CoverURL>\\n <VideoId>a82a2asdasqadaf3faa0ed6c1ee372****</VideoId>\\n <DownloadSwitch>on</DownloadSwitch>\\n <CateName>video1</CateName>\\n <TranscodeMode>FastTranscode</TranscodeMode>\\n <PreprocessStatus>Preprocessing</PreprocessStatus>\\n <Size>123</Size>\\n <Duration>123</Duration>\\n <Title>ceshi</Title>\\n <SpriteSnapshots>{“http://example.aliyundoc.com/image02.jpg”}</SpriteSnapshots>\\n <Snapshots>{“http://example.aliyundoc.com/image03.jpg”}</Snapshots>\\n </Video>\\n <Audio>\\n <Status>Normal</Status>\\n <CreationTime>2018-07-19T03:45:25Z</CreationTime>\\n <StorageLocation>outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com</StorageLocation>\\n <CateId>10000123</CateId>\\n <Tags>tag1,tag2</Tags>\\n <ModificationTime>2018-07-19T03:48:25Z</ModificationTime>\\n <MediaSource>general</MediaSource>\\n <Description>音频描述</Description>\\n <AppId>app-****</AppId>\\n <CoverURL>http://example.com/image04.jpg</CoverURL>\\n <AudioId>a82a2cd7d4e147bbed6c1ee372****</AudioId>\\n <DownloadSwitch>on</DownloadSwitch>\\n <CateName>ceshi</CateName>\\n <TranscodeMode>FastTranscode</TranscodeMode>\\n <PreprocessStatus>UnPreprocess</PreprocessStatus>\\n <Size>123</Size>\\n <Duration>123</Duration>\\n <Title>音频</Title>\\n <SpriteSnapshots>{“http://example.aliyundoc.com/image02.jpg”}</SpriteSnapshots>\\n <Snapshots>{“http://example.aliyundoc.com/image03.jpg”}</Snapshots>\\n </Audio>\\n <Image>\\n <StorageLocation>outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com</StorageLocation>\\n <CreationTime>2018-07-19T03:45:25Z</CreationTime>\\n <Status>Uploading</Status>\\n <CateId>1000123</CateId>\\n <Tags>tag1</Tags>\\n <ModificationTime>2018-07-19T03:48:25Z</ModificationTime>\\n <CateName>美图1</CateName>\\n <Description>图片测试</Description>\\n <AppId>app-****</AppId>\\n <URL>https://example.com/****.png</URL>\\n <Title>image1</Title>\\n <ImageId>11130843741se99wqmoes****</ImageId>\\n </Image>\\n <AttachedMedia>\\n <CreationTime>2018-07-19T03:45:25Z</CreationTime>\\n <Status>Normal</Status>\\n <StorageLocation>outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com</StorageLocation>\\n <Tags>测试</Tags>\\n <ModificationTime>2018-07-19T03:48:25Z</ModificationTime>\\n <MediaId>a82a2cd7d4e147ba0ed6c1ee372****</MediaId>\\n <BusinessType>watermark</BusinessType>\\n <Description>测试</Description>\\n <AppId>app-****</AppId>\\n <URL>https://example.com/****.png</URL>\\n <Title>测试</Title>\\n <Categories>\\n <ParentId>-1</ParentId>\\n <CateName>测试</CateName>\\n <CateId>10027394</CateId>\\n <Level>1</Level>\\n </Categories>\\n </AttachedMedia>\\n </MediaList>\\n</SearchMediaResponse>","errorExample":""}]', + 'title' => '搜索媒体信息', + 'description' => '对于支持精确匹配和模糊查询的字段，采用其他查询手段时，其返回的结果都将遵循该字段所支持的查询方式，例如，如果一个字段仅支持模糊查询，则通过多值查询方法获取的结果也是基于模糊匹配返回的。'."\n" + ."\n" + .'获取命中数据条数限制说明如下：'."\n" + .'- 方法一：分页遍历'."\n" + ."\n" + .' 对于命中的搜索结果，您可以通过设置分页参数“PageNo”（页码）和“PageSize”（每页显示的记录数）来逐步遍历最多5000条数据。如果搜索结果超出了5000条，为了保证有效地遍历数据，请调整搜索条件以缩小结果范围。需要注意的是，此方法无法遍历完整数据集。若要遍历更多数据，请参考方法二。'."\n" + .'- 方法二：全量遍历（限音视频搜索）'."\n" + ."\n" + .' 此方法适用于视频和音频内容的搜索，支持遍历最多200万条的全部搜索结果。如果搜索结果数量超过200万条，您应该通过增加更多筛选条件来减少结果数量。使用此方法时，除了“PageNo”和“PageSize”，您还需使用“ScrollToken”参数实现分页。请注意，每次仅支持向后遍历最多100条记录。'."\n" + .'使用“PageSize”为20为例，以下是分页逻辑：'."\n" + .' - 若“PageNo”为1，您可以查询接下来的最多5页数据。'."\n" + .' - 若“PageNo”为2，您可以查询接下来的最多6页数据。'."\n" + ."\n" + .'请确保在搜索时合理设置分页参数，并根据结果集大小选择适当的遍历方法。若您翻页的数据将大于1000条时，为了您的查询更方便快捷我们推荐您使用方法2来进行数据处理。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| SortByExceededMax |The SortBy parameter only supports one sort field when traversing all data. |400 |遍历所有数据时，仅支持一个排序字段。|'."\n" + .'| ErrorMatchSyntax |The parameter Match.%s has an error syntax, please check it. |400| Match参数语法错误，请检查后重试。|'."\n" + .'| InvalidScrollToken.Expired |The ScrollToken is expired，please refresh it. |400| 翻页标识过期，请从第一页重新获取数据。|', + ], + 'UpdateMediaStorageClass' => [ + 'summary' => '修改媒资存储类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '171759', + 'abilityTreeNodes' => [ + 'FEATUREvodM1QLPK', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaIds', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体ID，即音/视频ID（VideoId）。多个ID之间使用半角逗号（,）分隔，最多支持20个。可通过以下方式获取：'."\n" + .'- 通过控制台上传的音/视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看音/视频ID。'."\n" + .'- 通过[获取音视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，为返回参数VideoId的值。'."\n" + .'- 音/视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd56c2ac0cee271ed80004710b5ba****', + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'schema' => [ + 'description' => '变更范围，不传则取默认值**All**。取值：'."\n" + .'- **All**（默认）： 将整个媒资的资源（源文件和转码流）做分级存储。'."\n" + .'- **SourceFile**：仅对媒资ID下的视频源文件做分级存储，源文件之外的资源为标准存储。', + 'type' => 'string', + 'required' => false, + 'example' => 'All', + ], + ], + [ + 'name' => 'StorageClass', + 'in' => 'query', + 'schema' => [ + 'description' => '存储类型。取值：'."\n" + .'- **Standard**：标准'."\n" + .'- **IA**：低频（Infrequent Access）'."\n" + .'- **Archive**：归档'."\n" + .'- **ColdArchive**：冷归档', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Archive', + ], + ], + [ + 'name' => 'RestoreTier', + 'in' => 'query', + 'schema' => [ + 'description' => '解冻优先级（仅冷归档媒资需要）。不传则取默认值**Standard**，取值：'."\n" + .'- **Expedited**：高级'."\n" + .'- **Standard**（默认）：标准'."\n" + .'- **Bulk**：批量', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + [ + 'name' => 'AllowUpdateWithoutTimeLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '是否允许存储时长不足的媒资进行存储类型变更。取值：'."\n" + ."\n" + .'- **true**：允许'."\n" + .'- **false（默认）**：不允许'."\n" + ."\n" + .'>如果媒资存储时长不足，强制进行存储类型变更，会涉及额外的取回费用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '30FA0B7C-3A81-5449-93CD-ACA149E6****', + ], + 'Status' => [ + 'description' => '任务状态。取值：'."\n" + ."\n" + .'- **Processing**：处理中。'."\n" + .'- **Failed**：失败。', + 'type' => 'string', + 'example' => 'Processing', + ], + 'IgnoredList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MediaId' => [ + 'description' => '获取失败的媒资ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '获取失败的媒资ID。', + 'type' => 'string', + 'example' => '[\'19e231ee6e3e417fbf2e92ec2680****\']', + ], + ], + ], + ], + 'ForbiddenList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MediaForbiddenReasonDTO' => [ + 'description' => '处理失败的媒资ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '处理失败媒资信息。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '19e231ee6e3e417fbf2e92ec2680****', + ], + 'Reason' => [ + 'description' => '失败原因。', + 'type' => 'string', + 'example' => 'TargetStorageClassInconsistent', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30FA0B7C-3A81-5449-93CD-ACA149E6****\\",\\n \\"Status\\": \\"Processing\\",\\n \\"IgnoredList\\": {\\n \\"MediaId\\": [\\n \\"[\'19e231ee6e3e417fbf2e92ec2680****\']\\"\\n ]\\n },\\n \\"ForbiddenList\\": {\\n \\"MediaForbiddenReasonDTO\\": [\\n {\\n \\"MediaId\\": \\"19e231ee6e3e417fbf2e92ec2680****\\",\\n \\"Reason\\": \\"TargetStorageClassInconsistent\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '修改媒资存储类型', + 'description' => '- 请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。视频点播中修改媒资存储类型会产生存储费用，计费详情，请参见[媒资存储计费](~~188308#section-e97-xrp-mzz~~)。'."\n" + .'- 修改媒资存储类型是一个**异步操作**，整体完成后给用户发送回调。'."\n" + .'- 若媒资当前的存储类型为归档或冷归档，调用本接口会自动触发解冻，解冻完成后修改存储类型，不需要用户手动调用RestoreMedia接口解冻媒资。其中冷归档需要传入解冻优先级，默认为RestoreTier=Standard。'."\n" + ."\n" + .'- 变更中的媒资不能再次发起变更任务，不能进行生产、处理。'."\n" + ."\n" + .'- 非标准存储的媒资有最低存储时长要求，低频/源文件低频至少存储 30 天；归档/源文件归档至少存储 60 天；冷归档、源文件冷归档至少存储 180 天。如果存储时长不够，修改媒资存储类型，会产生不足规定时间的存储费用，例如：低频访问存储10天后通过接口修改存储类型为标准存储，会一次性产生20天的低频访问存储费用，总共30天的低频访问存储费用。'."\n" + ."\n" + .'- **暂不支持修改自有bucket存储类型**。', + 'requestParamsDescription' => '对于冷归档类型的媒资，您可以指定解冻天数和解冻优先级，解冻天数最短为1天，最长为365天。不同解冻优先级的取回时间如下：'."\n" + .'- 高优先级（Expedited）：表示1小时内完成解冻。'."\n" + .'- 标准（Standard）：表示2~5小时内完成解冻。'."\n" + .'- 批量（Bulk）：表示5~12小时内完成解冻。', + ], + 'RestoreMedia' => [ + 'summary' => '解冻媒资。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '171760', + 'abilityTreeNodes' => [ + 'FEATUREvodM1QLPK', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaIds', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体ID，即音/视频ID（VideoId）。多个ID之间使用半角逗号（,）分隔，最多支持20个。可通过以下方式获取：'."\n" + ."\n" + .'- 通过控制台上传的音/视频，可登录点播控制台，选择媒资库 > 音/视频查看音/视频ID。'."\n" + .'- 通过获取音视频上传地址和凭证接口获取上传地址和凭证时，为返回参数VideoId的值。'."\n" + .'- 音/视频上传后，可通过搜索媒体信息接口查询，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => true, + 'example' => '8bc8e94fe4e55abde85718****,eb186180e989dd56****', + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'schema' => [ + 'description' => '变更范围，不传则取默认值**All**。取值：'."\n" + .'- **All**（默认）： 将整个媒资的资源（源文件和转码流）做分级存储。'."\n" + .'- **SourceFile**：仅对媒资ID下的视频源文件做分级存储，源文件之外的资源为标准存储。', + 'type' => 'string', + 'required' => false, + 'example' => 'All', + ], + ], + [ + 'name' => 'RestoreDays', + 'in' => 'query', + 'schema' => [ + 'description' => '解冻时长。默认1天，归档媒资最多7天，冷归档媒资最多365天', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'RestoreTier', + 'in' => 'query', + 'schema' => [ + 'description' => '解冻优先级（仅冷归档媒资需要），不传则取默认值**Standard**。取值：'."\n" + .'- **Expedited**：高级，表示1小时内完成解冻、'."\n" + .'- **Standard**（默认）：标准，默认值，表示2~5小时内完成解冻。'."\n" + .'- **Bulk**：批量，表示5~12小时内完成解冻。', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8E70E3F8-E2EE-47BC-4677-379D6F28****', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IgnoredList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MediaId' => [ + 'description' => '获取失败的媒资ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '获取失败的媒资ID。', + 'type' => 'string', + 'example' => '[\'7f29b8d0c5fa71ed9685e6f7d559****\']', + ], + ], + ], + ], + 'ForbiddenList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MediaForbiddenReasonDTO' => [ + 'description' => '处理失败的媒资ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '处理失败的媒资信息。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => 'fa10ee70898671edb99f6eb3690d****', + ], + 'Reason' => [ + 'description' => '失败原因。', + 'type' => 'string', + 'example' => 'Forbidden.RestoreMedia', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8E70E3F8-E2EE-47BC-4677-379D6F28****\\",\\n \\"Success\\": true,\\n \\"IgnoredList\\": {\\n \\"MediaId\\": [\\n \\"[\'7f29b8d0c5fa71ed9685e6f7d559****\']\\"\\n ]\\n },\\n \\"ForbiddenList\\": {\\n \\"MediaForbiddenReasonDTO\\": [\\n {\\n \\"MediaId\\": \\"fa10ee70898671edb99f6eb3690d****\\",\\n \\"Reason\\": \\"Forbidden.RestoreMedia\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '解冻媒资', + 'description' => '- 请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。视频点播中解冻媒资产生存储费用，计费详情，请参见[媒资存储计费](~~188308#section-e97-xrp-mzz~~)。'."\n" + .'- 仅归档及冷归档的音视频可用，解冻成功后，文件可以进行访问。解冻中的音视频不能修改存储类型。'."\n" + .'解冻会产生取回流量，冷归档音视频解冻成功后，会生成一份标准存储类型的文件副本用于访问，文件副本在解冻时间结束前会收取标准存储费用。', + ], + 'AddCategory' => [ + 'summary' => '通过调用本接口来创建分类，可以有效地对存储在视频点播平台上的音视频、图片及短视频素材进行归类，从而使得资源的查找与管理变得更加高效便捷。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39783', + 'abilityTreeNodes' => [ + 'FEATUREvodUYOK6S', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CateName', + 'in' => 'query', + 'schema' => [ + 'description' => '分类名称。'."\n" + .'- 最多支持64个字节。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '搞笑', + ], + ], + [ + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => [ + 'description' => '父分类ID。'."\n" + ."\n" + .'可登录[视频点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **分类管理** > **音视频/图片分类**或**短视频素材分类**查看分类ID。'."\n" + ."\n" + .'> - 若传入此参数，则在该父分类下创建子分类。若不传入此参数，则创建一级分类。'."\n" + .'> - 因短视频素材分类的一级分类全部为系统内置，不支持修改、新增、删除，仅支持在一级分类下创建子分类，所以当`Type`为`material`时，此参数必填。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100012****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '分类类型。取值：'."\n" + ."\n" + .'- **default**（默认值）：音视频/图片分类。'."\n" + .'- **material**：短视频素材分类。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'Category' => [ + 'description' => '媒资分类信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '分类类型。取值：'."\n" + ."\n" + .'- **default**：音视频/图片分类。'."\n" + .'- **material**：短视频素材分类。', + 'type' => 'string', + 'example' => 'default', + ], + 'ParentId' => [ + 'description' => '父分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100012', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => '搞笑', + ], + 'CateId' => [ + 'description' => '分类ID。后续可作为[UpdateCategory](~~UpdateCategory~~)、[DeleteCategory](~~DeleteCategory~~)、[GetCategories](~~GetCategories~~)接口的请求参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10020', + ], + 'Level' => [ + 'description' => '分类层级。取值：'."\n" + .'- **0**：一级分类。'."\n" + .'- **1**：二级分类。'."\n" + .'- **2**：三级分类。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"Category\\": {\\n \\"Type\\": \\"default\\",\\n \\"ParentId\\": 100012,\\n \\"CateName\\": \\"搞笑\\",\\n \\"CateId\\": 10020,\\n \\"Level\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddCategoryResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <Category>\\n <Type>default</Type>\\n <ParentId>100012****</ParentId>\\n <CateName>搞笑</CateName>\\n <CateId>10020****</CateId>\\n <Level>1</Level>\\n </Category>\\n</AddCategoryResponse>","errorExample":""}]', + 'title' => '创建分类', + 'description' => '- 音视频/图片分类（`Type`为`default`）最多支持三级分类，每级分类最多支持创建100个子分类；短视频素材分类（`Type`为`material`）最多支持两级分类，每级分类最多支持创建100个子分类。'."\n" + .'- 创建分类后，您可以在上传媒体资源时或对已经上传的媒体资源进行分类划分，具体操作，请参见[媒资分类](~~86070~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ----- |'."\n" + .'| LevelExceededMax | The level of categories exceeded maximum. | 400 | 分类层级超过最大限制。|'."\n" + .'| SubTotalExceededMax | The total of sub categories exceeded maximum. | 400 | 子分类个数超过最大限制。|'."\n" + .'| InvalidCateId.NotFound | The CateId not exist. | 404 | 父分类ID不存在。|', + ], + 'UpdateCategory' => [ + 'summary' => '调用本接口对分类名称进行修改更新。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40213', + 'abilityTreeNodes' => [ + 'FEATUREvodUYOK6S', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CateName', + 'in' => 'query', + 'schema' => [ + 'description' => '分类名称。'."\n" + ."\n" + .'- 最多支持64个字节。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '风景', + ], + ], + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => '分类ID，仅支持传入单个分类ID。可通过以下方式获取：'."\n" + .'- 登录[视频点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **分类管理** > **音视频/图片分类**或**短视频素材分类**查看分类ID。'."\n" + .'- 调用[AddCategory](~~AddCategory~~)接口创建分类时会返回。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10020****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateCategoryResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n</UpdateCategoryResponse>","errorExample":""}]', + 'title' => '更新分类', + 'description' => '创建分类后，可调用本接口修改分类的名称，若已为部分媒体资源标注了该分类，则修改分类名称后，该部分媒体资源已标注的分类名称会同步更新。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidCateId.NotFound| The CateId not exist.| 404 |分类ID不存在。|', + ], + 'DeleteCategory' => [ + 'summary' => '调用本接口删除分类及其子分类。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39827', + 'abilityTreeNodes' => [ + 'FEATUREvodUYOK6S', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => '分类ID，仅支持传入单个分类ID。可通过以下方式获取：'."\n" + .'- 登录[视频点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **分类管理**查看分类ID。'."\n" + .'- 通过[AddCategory](~~AddCategory~~)接口创建分类时会返回。'."\n" + ."\n" + .'> 若传入的分类ID为父分类的ID，则会同时删除该分类及其所有子分类，请谨慎操作。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '3300****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCategoryResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n</DeleteCategoryResponse>","errorExample":""}]', + 'title' => '删除分类', + 'description' => '- **本接口会同时删除分类及其子分类（包括二级分类和三级分类），请谨慎操作。**'."\n" + .'- 若已为部分媒体资源标注了分类，则删除该分类后，该部分媒体资源已标注的分类会被同步删除。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidCateId.NotFound| The CateId not exist. |404| 分类ID不存在。|'."\n", + ], + 'GetCategories' => [ + 'summary' => '调用本接口按ID或类型来筛选查询指定的分类信息，及其子分类（即下一级分类）的列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39943', + 'abilityTreeNodes' => [ + 'FEATUREvodUYOK6S', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => '分类ID，传入此参数，则可查询指定ID的分类。仅支持传入单个分类ID。可通过以下方式获取：'."\n" + .'- 登录[视频点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **分类管理**查看分类ID。'."\n" + .'- 通过[AddCategory](~~AddCategory~~)接口创建分类时会返回。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '49339****', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '子分类列表页号。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '子分类列表页大小。默认值为**10**，最大值为**100**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果排序。取值：'."\n" + ."\n" + .'- **CreationTime:Desc**（默认值）：按创建时间倒序。'."\n" + .'- **CreationTime:Asc**：按创建时间升序。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreationTime:Desc', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '分类类型，传入此参数，则可筛选查询指定类型的分类。取值：'."\n" + .'- **default**：音视频/图片分类。'."\n" + .'- **material**：短视频素材分类。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'SubTotal' => [ + 'description' => '子分类总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'Category' => [ + 'description' => '分类的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '分类类型。取值：'."\n" + .'- **default**：音视频/图片分类。'."\n" + .'- **material**：短视频素材分类。', + 'type' => 'string', + 'example' => 'default', + ], + 'ParentId' => [ + 'description' => '父分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100012****', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => '电影', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Level' => [ + 'description' => '分类层级。取值：'."\n" + ."\n" + .'- **0**：一级分类。'."\n" + .'- **1**：二级分类。'."\n" + .'- **2**：三级分类。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'SubCategories' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Category' => [ + 'description' => '子分类的详细信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '子分类的类型。取值：'."\n" + .'- **default**：音视频/图片分类。'."\n" + .'- **material**：短视频素材分类。', + 'type' => 'string', + 'example' => 'default', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => '电影', + ], + 'ParentId' => [ + 'description' => '父分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10020****', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'SubTotal' => [ + 'description' => '子分类总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Level' => [ + 'description' => '分类层级。取值：'."\n" + ."\n" + .'- **0**：一级分类。'."\n" + .'- **1**：二级分类。'."\n" + .'- **2**：三级分类。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SubTotal\\": 2,\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"Category\\": {\\n \\"Type\\": \\"default\\",\\n \\"ParentId\\": 0,\\n \\"CateName\\": \\"电影\\",\\n \\"CateId\\": 100,\\n \\"Level\\": 0\\n },\\n \\"SubCategories\\": {\\n \\"Category\\": [\\n {\\n \\"Type\\": \\"default\\",\\n \\"CateName\\": \\"电影\\",\\n \\"ParentId\\": 0,\\n \\"CateId\\": 100,\\n \\"SubTotal\\": 1,\\n \\"Level\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetCategoriesResponse>\\n <SubTotal>3795</SubTotal>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <Category>\\n <Type>default</Type>\\n <ParentId>100012****</ParentId>\\n <CateName>电影</CateName>\\n <CateId>100</CateId>\\n <Level>0</Level>\\n </Category>\\n <SubCategories>\\n <Type>default</Type>\\n <CateName>电影</CateName>\\n <ParentId>10020****</ParentId>\\n <CateId>100</CateId>\\n <SubTotal>1</SubTotal>\\n <Level>1</Level>\\n </SubCategories>\\n</GetCategoriesResponse>","errorExample":""}]', + 'title' => '获取分类及其子分类信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidCateId.NotFound| The CateId not exist. |404 |分类ID不存在。|'."\n", + ], + 'GetVideoInfo' => [ + 'summary' => '调用本接口通过音/视频ID来获取单个音视频的标题、描述、时长、封面URL、状态、创建时间、大小、截图、分类和标签等信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39998', + 'abilityTreeNodes' => [ + 'FEATUREvodYRQNEN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '音/视频ID，仅支持传入一个音/视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看音/视频ID。'."\n" + .'- 通过[获取视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，音/视频ID为返回参数VideoId的值。'."\n" + .'- 音视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询音/视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '9b73864d75f1d231e9001cd5f8****', + ], + ], + [ + 'name' => 'ReferenceId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'description' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'Video' => [ + 'description' => '音/视频信息。', + 'type' => 'object', + 'properties' => [ + 'StorageLocation' => [ + 'description' => '音/视频存储地址。', + 'type' => 'string', + 'example' => 'out-201703232251****.oss-cn-shanghai.aliyuncs.com', + ], + 'CreationTime' => [ + 'description' => '音/视频创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-11-14T09:15:50Z', + ], + 'Status' => [ + 'description' => '音/视频状态。各状态可执行的操作及使用限制等详细信息，请参见[Status：音视频状态](~~52839#title-vqg-8cz-7p8~~)。取值：'."\n" + ."\n" + .'- **Uploading**：上传中。'."\n" + .'- **UploadFail**：上传失败。'."\n" + .'- **UploadSucc**：上传完成。'."\n" + .'- **Transcoding**：转码中。'."\n" + .'- **TranscodeFail**：转码失败。'."\n" + .'- **Blocked**：屏蔽。'."\n" + .'- **Normal**：正常。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '781111****', + ], + 'VideoId' => [ + 'description' => '音/视频ID。', + 'type' => 'string', + 'example' => '9b73864d75f1d231e9001cd5f8****', + ], + 'DownloadSwitch' => [ + 'description' => '离线下载开关状态，打开离线下载功能后，则允许移动端用户通过阿里云播放器将视频缓存至本地观看。具体操作，请参见[离线下载](~~86107~~)。取值：'."\n" + ."\n" + .'- **on**：开启，允许离线下载。'."\n" + .'- **off**：关闭，禁止离线下载。', + 'type' => 'string', + 'example' => 'on', + ], + 'Tags' => [ + 'description' => '音/视频标签。多个标签之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'tag1, tag2', + ], + 'ModificationTime' => [ + 'description' => '音/视频的最后更新时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-11-14T10:15:50Z', + ], + 'RegionId' => [ + 'description' => '音/视频存储所在地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'CustomMediaInfo' => [ + 'description' => '自定义媒资信息。'."\n" + ."\n" + .'> 该参数已废弃，调用API已不会返回该参数。'."\n", + 'type' => 'string', + 'example' => '{"aaa":"test"}', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => 'cate1', + ], + 'Description' => [ + 'description' => '音/视频描述。', + 'type' => 'string', + 'example' => 'Alibaba Cloud VOD video description', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'Size' => [ + 'description' => '音/视频源文件大小。单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10897890', + ], + 'CoverURL' => [ + 'description' => '音/视频封面URL。', + 'type' => 'string', + 'example' => 'https://example.aliyundoc.com/****.jpg', + ], + 'TemplateGroupId' => [ + 'description' => '转码模板组ID。', + 'type' => 'string', + 'example' => '9ae2af636ca64835b0c10412f448****', + ], + 'Duration' => [ + 'description' => '音/视频时长。单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '135.6', + ], + 'Title' => [ + 'description' => '音/视频标题。', + 'type' => 'string', + 'example' => 'Alibaba Cloud VOD Video Title', + ], + 'AuditStatus' => [ + 'description' => '音/视频的终审结果。取值：'."\n" + ."\n" + .'- **Normal**：通过。'."\n" + .'- **Blocked**：屏蔽。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Snapshots' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Snapshot' => [ + 'description' => '视频截图URL数组。', + 'type' => 'array', + 'items' => [ + 'description' => '视频截图URL数组。'."\n" + .'> 本接口仅会返回视频的封面截图数据，通过[视频截图](~~99368~~)功能截取的普通截图、雪碧截图、雪碧图原始图、WebVTT截图的截图数据，请调用[ListSnapshots](~~ListSnapshots~~)接口查询。', + 'type' => 'string', + 'example' => '["http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****","http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27243****",...]', + ], + ], + ], + ], + 'StorageClass' => [ + 'description' => '媒资存储类型。取值：'."\n" + ."\n" + .'- **Standard**：标准。'."\n" + .'- **IA**：媒资低频。'."\n" + .'- **Archive**：媒资归档。'."\n" + .'- **ColdArchive**：媒资冷归档。'."\n" + .'- **SourceIA**：源文件低频。'."\n" + .'- **SourceArchive**：源文件归档。'."\n" + .'- **SourceColdArchive**：源文件冷归档。'."\n" + .'- **Changing**：媒资存储类型变更中。'."\n" + .'- **SourceChanging**：源文件存储类型变更中。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'RestoreStatus' => [ + 'description' => '媒资解冻状态。取值：'."\n" + .'- **Processing**：解冻中。'."\n" + .'- **Success**：解冻成功。'."\n" + .'- **Failed**：解冻失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RestoreExpiration' => [ + 'description' => '媒资解冻有效期。', + 'type' => 'string', + 'example' => '2023-03-30T10:14:14Z', + ], + 'UserData' => [ + 'description' => '自定义设置。为 JSON 字符串，支持消息回调、上传加速等设置。更多信息，请参见[UserData](~~86952~~) 。', + 'type' => 'string', + 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}', + ], + 'ReferenceId' => [ + 'title' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'description' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'example' => '123-123', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"Video\\": {\\n \\"StorageLocation\\": \\"out-201703232251****.oss-cn-shanghai.aliyuncs.com\\",\\n \\"CreationTime\\": \\"2017-11-14T09:15:50Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CateId\\": 0,\\n \\"VideoId\\": \\"9b73864d75f1d231e9001cd5f8****\\",\\n \\"DownloadSwitch\\": \\"on\\",\\n \\"Tags\\": \\"tag1, tag2\\",\\n \\"ModificationTime\\": \\"2017-11-14T10:15:50Z\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"CustomMediaInfo\\": \\"{\\\\\\"aaa\\\\\\":\\\\\\"test\\\\\\"}\\",\\n \\"CateName\\": \\"cate1\\",\\n \\"Description\\": \\"Alibaba Cloud VOD video description\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"Size\\": 10897890,\\n \\"CoverURL\\": \\"https://example.aliyundoc.com/****.jpg\\",\\n \\"TemplateGroupId\\": \\"9ae2af636ca64835b0c10412f448****\\",\\n \\"Duration\\": 135.6,\\n \\"Title\\": \\"Alibaba Cloud VOD Video Title\\",\\n \\"AuditStatus\\": \\"Normal\\",\\n \\"Snapshots\\": {\\n \\"Snapshot\\": [\\n \\"[\\\\\\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\\\\\",\\\\\\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27243****\\\\\\",...]\\"\\n ]\\n },\\n \\"StorageClass\\": \\"Standard\\",\\n \\"RestoreStatus\\": \\"Success\\",\\n \\"RestoreExpiration\\": \\"2023-03-30T10:14:14Z\\",\\n \\"UserData\\": \\"{\\\\\\"MessageCallback\\\\\\":{\\\\\\"CallbackURL\\\\\\":\\\\\\"http://example.aliyundoc.com\\\\\\"},\\\\\\"Extend\\\\\\":{\\\\\\"localId\\\\\\":\\\\\\"*****\\\\\\",\\\\\\"test\\\\\\":\\\\\\"www\\\\\\"}}\\",\\n \\"ReferenceId\\": \\"123-123\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetVideoInfoResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <Video>\\n <StorageLocation>out-201703232251****.oss-cn-shanghai.aliyuncs.com</StorageLocation>\\n <CreationTime>2017-11-14T09:15:50Z</CreationTime>\\n <Status>Normal</Status>\\n <CateId>781111****</CateId>\\n <VideoId>9b73864d75f1d231e9001cd5f8****</VideoId>\\n <Tags>标签1, 标签2</Tags>\\n <ModificationTime>2017-11-14T10:15:50Z</ModificationTime>\\n <RegionId>cn-shanghai</RegionId>\\n <CateName>分类名</CateName>\\n <Description>阿里云VOD视频描述</Description>\\n <AppId>app-****</AppId>\\n <Size>10897890</Size>\\n <CoverURL>https://example.aliyundoc.com/****.jpg</CoverURL>\\n <TemplateGroupId>9ae2af636ca64835b0c10412f448****</TemplateGroupId>\\n <Duration>135.6</Duration>\\n <Title>阿里云VOD视频标题</Title>\\n <AuditStatus>Normal</AuditStatus>\\n <Snapshots>[\\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\",\\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27243****\\",...]</Snapshots>\\n </Video>\\n</GetVideoInfoResponse>","errorExample":""}]', + 'title' => '获取单个音视频信息', + 'description' => '音视频上传完成后，点播会对上传完成的音视频源文件进行分析，因此媒资信息是异步生成的。可通过设置[音视频分析完成](~~99935~~)的[事件通知](~~55627~~)，当接收到[音视频分析完成](~~99935~~)的事件通知后，再调用本接口获取音视频信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidVideo.NotFound |The video does not exist. |404 |视频不存在。|'."\n", + ], + 'GetVideoInfos' => [ + 'summary' => '调用本接口通过音/视频ID批量获取多个音视频的标题、描述、时长、封面URL、状态、创建时间、大小、截图、分类和标签等信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '43387', + 'abilityTreeNodes' => [ + 'FEATUREvodYRQNEN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoIds', + 'in' => 'query', + 'schema' => [ + 'description' => '音/视频ID列表。多个ID之间使用半角逗号（,）分隔，最多支持20个。可通过以下方式获取音/视频ID：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看音/视频ID。'."\n" + .'- 通过[获取视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，音/视频ID为返回参数VideoId的值。'."\n" + .'- 音/视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询音/视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '7753d144efd8e649c6c45fe0579****,7753d144efd74d6c45fe0570****', + ], + ], + [ + 'name' => 'ReferenceIds', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义 ID 列表。由一个或多个自定义 ID 组成，多个 ID 之间使用半角逗号（,）分隔。最多支持 20 个。', + 'description' => '自定义 ID 列表。由一个或多个自定义 ID 组成，多个 ID 之间使用半角逗号（,）分隔。最多支持 20 个。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123,1234-1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'NonExistVideoIds' => [ + 'description' => '不存在的音/视频ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的音/视频ID列表。', + 'type' => 'string', + 'example' => '["7753d144efd8e649c6c45fe0579****"]', + ], + ], + 'NonExistReferenceIds' => [ + 'title' => '不存在的自定义 ID 列表。', + 'description' => '不存在的自定义 ID 列表。', + 'type' => 'array', + 'items' => [ + 'title' => '不存在的自定义 ID 列表。', + 'description' => '不存在的自定义 ID 列表。', + 'type' => 'string', + 'example' => '123-123', + ], + ], + 'VideoList' => [ + 'description' => '音/视频信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '音/视频信息详情。', + 'type' => 'object', + 'properties' => [ + 'StorageLocation' => [ + 'description' => '音/视频存储地址。', + 'type' => 'string', + 'example' => 'out-****.oss-cn-shanghai.aliyuncs.com', + ], + 'CreationTime' => [ + 'description' => '音/视频创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-06-26T05:38:48Z', + ], + 'Status' => [ + 'description' => '视频状态。取值：'."\n" + ."\n" + .'- **Uploading**：上传中。'."\n" + .'- **UploadFail**：上传失败。'."\n" + .'- **UploadSucc**：上传完成。'."\n" + .'- **Transcoding**：转码中。'."\n" + .'- **TranscodeFail**：转码失败。'."\n" + .'- **Blocked**：屏蔽。'."\n" + .'- **Normal**：正常。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '781111****', + ], + 'VideoId' => [ + 'description' => '音/视频ID。', + 'type' => 'string', + 'example' => '7753d144efd74d6c45fe0570****', + ], + 'DownloadSwitch' => [ + 'description' => '离线下载开关状态，打开离线下载功能后，则允许移动端用户通过阿里云播放器将视频缓存至本地观看。具体操作，请参见[离线下载](~~86107~~)。取值：'."\n" + ."\n" + .'- **on**：开启，允许离线下载。'."\n" + .'- **off**：关闭，禁止离线下载。', + 'type' => 'string', + 'example' => 'on', + ], + 'Tags' => [ + 'description' => '音/视频标签。多个标签之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'tag1, tag2', + ], + 'ModificationTime' => [ + 'description' => '音/视频的最后一次更新时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-06-26T06:38:48Z', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => 'cate1', + ], + 'Description' => [ + 'description' => '音/视频描述。', + 'type' => 'string', + 'example' => 'Alibaba Cloud VOD video description', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'Size' => [ + 'description' => '音/视频源文件大小。单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '453', + ], + 'CoverURL' => [ + 'description' => '音/视频封面URL。', + 'type' => 'string', + 'example' => 'https://example.aliyundoc.com/****.jpg', + ], + 'TemplateGroupId' => [ + 'description' => '转码模板组ID。', + 'type' => 'string', + 'example' => 'b4039216985f4312a5382a4ed****', + ], + 'Duration' => [ + 'description' => '音/视频时长。单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '120', + ], + 'Title' => [ + 'description' => '音/视频标题。', + 'type' => 'string', + 'example' => 'Alibaba Cloud VOD Video Title', + ], + 'Snapshots' => [ + 'description' => '视频截图URL数组。', + 'type' => 'array', + 'items' => [ + 'description' => '视频截图URL数组。'."\n" + .'> 本接口仅会返回视频的封面截图数据，通过[视频截图](~~99368~~)功能截取的普通截图、雪碧截图、雪碧图原始图、WebVTT截图的截图数据，请调用[ListSnapshots](~~ListSnapshots~~)接口查询。', + 'type' => 'string', + 'example' => '["http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****","http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27243****",...]', + ], + ], + 'StorageClass' => [ + 'description' => '媒资存储类型。取值：'."\n" + .'- **Standard**：标准。'."\n" + .'- **IA**：媒资低频。'."\n" + .'- **Archive**：媒资归档。'."\n" + .'- **ColdArchive**：媒资冷归档。'."\n" + .'- **SourceIA**：源文件低频。'."\n" + .'- **SourceArchive**：源文件归档。'."\n" + .'- **SourceColdArchive**：源文件冷归档。'."\n" + .'- **Changing**：媒资存储类型变更中。'."\n" + .'- **SourceChanging**：源文件存储类型变更中。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'RestoreStatus' => [ + 'description' => '媒资解冻状态。取值：'."\n" + .'- **Processing**：解冻中。'."\n" + .'- **Success**：解冻成功。'."\n" + .'- **Failed**：解冻失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RestoreExpiration' => [ + 'description' => '媒资解冻有效期。', + 'type' => 'string', + 'example' => '2023-03-30T10:14:14Z', + ], + 'UserData' => [ + 'description' => '自定义设置。为 JSON 字符串，支持消息回调、上传加速等设置。更多信息，请参见[UserData](~~86952~~) 。', + 'type' => 'string', + 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}', + ], + 'ReferenceId' => [ + 'title' => '不存在的自定义 ID 列表。', + 'description' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'example' => '123-123', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"NonExistVideoIds\\": [\\n \\"[\\\\\\"7753d144efd8e649c6c45fe0579****\\\\\\"]\\"\\n ],\\n \\"NonExistReferenceIds\\": [\\n \\"123-123\\"\\n ],\\n \\"VideoList\\": [\\n {\\n \\"StorageLocation\\": \\"out-****.oss-cn-shanghai.aliyuncs.com\\",\\n \\"CreationTime\\": \\"2017-06-26T05:38:48Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CateId\\": 0,\\n \\"VideoId\\": \\"7753d144efd74d6c45fe0570****\\",\\n \\"DownloadSwitch\\": \\"on\\",\\n \\"Tags\\": \\"tag1, tag2\\",\\n \\"ModificationTime\\": \\"2017-06-26T06:38:48Z\\",\\n \\"CateName\\": \\"cate1\\",\\n \\"Description\\": \\"Alibaba Cloud VOD video description\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"Size\\": 453,\\n \\"CoverURL\\": \\"https://example.aliyundoc.com/****.jpg\\",\\n \\"TemplateGroupId\\": \\"b4039216985f4312a5382a4ed****\\",\\n \\"Duration\\": 120,\\n \\"Title\\": \\"Alibaba Cloud VOD Video Title\\",\\n \\"Snapshots\\": [\\n \\"[\\\\\\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\\\\\",\\\\\\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27243****\\\\\\",...]\\"\\n ],\\n \\"StorageClass\\": \\"Standard\\",\\n \\"RestoreStatus\\": \\"Success\\",\\n \\"RestoreExpiration\\": \\"2023-03-30T10:14:14Z\\",\\n \\"UserData\\": \\"{\\\\\\"MessageCallback\\\\\\":{\\\\\\"CallbackURL\\\\\\":\\\\\\"http://example.aliyundoc.com\\\\\\"},\\\\\\"Extend\\\\\\":{\\\\\\"localId\\\\\\":\\\\\\"*****\\\\\\",\\\\\\"test\\\\\\":\\\\\\"www\\\\\\"}}\\",\\n \\"ReferenceId\\": \\"123-123\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetVideoInfosResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <NonExistVideoIds>[\\"7753d144efd8e649c6c45fe0579****\\"]</NonExistVideoIds>\\n <VideoList>\\n <StorageLocation>out-****.oss-cn-shanghai.aliyuncs.com</StorageLocation>\\n <CreationTime>2017-06-26T05:38:48Z</CreationTime>\\n <Status>Normal</Status>\\n <CateId>781111****</CateId>\\n <VideoId>7753d144efd74d6c45fe0570****</VideoId>\\n <Tags>标签1, 标签2</Tags>\\n <ModificationTime>2017-06-26T06:38:48Z</ModificationTime>\\n <CateName>分类名称</CateName>\\n <Description>阿里云VOD视频描述</Description>\\n <AppId>app-****</AppId>\\n <Size>453</Size>\\n <CoverURL>https://example.aliyundoc.com/****.jpg</CoverURL>\\n <TemplateGroupId>b4039216985f4312a5382a4ed****</TemplateGroupId>\\n <Duration>120</Duration>\\n <Title>阿里云VOD视频标题</Title>\\n <Snapshots>[\\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\",\\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27243****\\",...]</Snapshots>\\n </VideoList>\\n</GetVideoInfosResponse>","errorExample":""}]', + 'title' => '批量获取音视频信息', + 'description' => '- 一次最多获取20个音视频的信息。'."\n" + .'- 音视频上传完成后，点播会对上传完成的音视频源文件进行分析，因此媒资信息是异步生成的。可通过设置[音视频分析完成](~~99935~~)的[事件通知](~~55627~~)，当接收到[音视频分析完成](~~99935~~)的事件通知后，再调用本接口获取音视频信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidVideo.NotFound |The video does not exist. |404 |视频不存在。|', + ], + 'GetVideoList' => [ + 'summary' => '获取视频信息列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40000', + 'abilityTreeNodes' => [ + 'FEATUREvodYRQNEN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => '分类ID。可通过以下方式获取：'."\n" + .'- 登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **分类管理**查看分类ID。'."\n" + .'- 通过[创建分类](~~56401~~)接口创建分类时，分类ID为返回参数CateId的值。'."\n" + .'- 通过[获取分类及子分类](~~56406~~)接口查询分类时，为请求后返回参数CateId的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '781111', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '视频状态。支持获取多个状态的视频，多个状态之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **Uploading**：上传中。'."\n" + .'- **UploadFail**：上传失败。'."\n" + .'- **UploadSucc**：上传完成。'."\n" + .'- **Transcoding**：转码中。'."\n" + .'- **TranscodeFail**：转码失败。'."\n" + .'- **Checking**：审核中。'."\n" + .'- **Blocked**：屏蔽。'."\n" + .'- **Normal**：正常。'."\n" + .'- **ProduceFail**：合成失败。'."\n" + ."\n" + .'各视频状态的具体含义解释及相关限制，请参见[Status：视频状态](~~52839#section-p7c-jgy-070~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Uploading,Normal', + ], + ], + [ + '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' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果排序。取值：'."\n" + ."\n" + .'- **CreationTime:Desc**（默认值）：按创建时间倒序。'."\n" + .'- **CreationTime:Asc**：按创建时间升序。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreationTime:Asc', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'CreationTime（创建时间）的开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-01-11T12:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'CreationTime的结束时间，需晚于开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-01-11T12:59:00Z', + ], + ], + [ + 'name' => 'StorageLocation', + 'in' => 'query', + 'schema' => [ + 'description' => '音/视频存储地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'out-****.oss-cn-shanghai.aliyuncs.com', + ], + ], + [ + 'name' => 'ReferenceIds', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义 ID 列表。由一个或多个自定义 ID 组成，多个 ID 之间使用半角逗号（,）分隔。最多支持 20 个。', + 'description' => '自定义 ID 列表。由一个或多个自定义 ID 组成，多个 ID 之间使用半角逗号（,）分隔。最多支持 20 个。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123,1234-1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '音/视频总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'VideoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Video' => [ + 'description' => '获取音/视频信息列表。最大支持获取前5000条。', + 'type' => 'array', + 'items' => [ + 'description' => '音/视频信息详情。', + 'type' => 'object', + 'properties' => [ + 'StorageLocation' => [ + 'description' => '音/视频存储地址。', + 'type' => 'string', + 'example' => 'out-****.oss-cn-shanghai.aliyuncs.com', + ], + 'Status' => [ + 'description' => '视频状态。取值：'."\n" + ."\n" + .'- **Uploading**：上传中。'."\n" + .'- **UploadFail**：上传失败。'."\n" + .'- **UploadSucc**：上传完成。'."\n" + .'- **Transcoding**：转码中。'."\n" + .'- **TranscodeFail**：转码失败。'."\n" + .'- **Checking**：审核中。'."\n" + .'- **Blocked**：屏蔽。'."\n" + .'- **Normal**：正常。'."\n" + .'- **ProduceFail**：合成失败。'."\n" + ."\n" + .'各视频状态的具体含义解释及相关限制，请参见[Status：视频状态](~~52839#section-p7c-jgy-070~~)。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CreationTime' => [ + 'description' => '音/视频创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2017-11-14T09:15:50Z', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '781111', + ], + 'VideoId' => [ + 'description' => '音/视频ID。', + 'type' => 'string', + 'example' => '9ae2af636ca6c10412f44891fc****', + ], + 'Tags' => [ + 'description' => '音/视频标签。多个用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => '标签1, 标签2', + ], + 'ModificationTime' => [ + 'description' => '视频更新时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2017-11-14T09:16:50Z', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => '分类名称', + ], + 'Description' => [ + 'description' => '音/视频描述。', + 'type' => 'string', + 'example' => '阿里云VOD视频描述', + ], + 'AppId' => [ + 'description' => '应用ID。默认取值：**app-1000000**。', + 'type' => 'string', + 'example' => 'app-1000000', + ], + 'Size' => [ + 'description' => '音/视频源文件大小。单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10897890', + ], + 'CoverURL' => [ + 'description' => '音/视频封面URL。', + 'type' => 'string', + 'example' => 'https://example.aliyundoc.com/****.jpg', + ], + 'Duration' => [ + 'description' => '音/视频时长。单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '135.6', + ], + 'Title' => [ + 'description' => '音/视频标题。', + 'type' => 'string', + 'example' => '阿里云VOD视频标题', + ], + 'Snapshots' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Snapshot' => [ + 'description' => '视频截图URL数组。', + 'type' => 'array', + 'items' => [ + 'description' => '视频截图URL。'."\n" + ."\n" + .'> 只有经过[视频截图](~~99368~~)处理的视频，才会返回截图数据，否则返回为空。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****', + ], + ], + ], + ], + 'StorageClass' => [ + 'description' => '媒资存储类型。取值：'."\n" + ."\n" + .'- **Standard**：标准。'."\n" + .'- **IA**：媒资低频。'."\n" + .'- **Archive**：媒资归档。'."\n" + .'- **ColdArchive**：媒资冷归档。'."\n" + .'- **SourceIA**：源文件低频。'."\n" + .'- **SourceArchive**：源文件归档。'."\n" + .'- **SourceColdArchive**：源文件冷归档。'."\n" + .'- **Changing**：媒资存储类型变更中。'."\n" + .'- **SourceChanging**：源文件存储类型变更中。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'RestoreStatus' => [ + 'description' => '媒资解冻状态。取值：'."\n" + .'- **Processing**：解冻中。'."\n" + .'- **Success**：解冻成功。'."\n" + .'- **Failed**：解冻失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RestoreExpiration' => [ + 'description' => '媒资解冻有效期。', + 'type' => 'string', + 'example' => '2023-03-30T10:14:14Z', + ], + 'UserData' => [ + 'description' => '自定义设置。为 JSON 字符串，支持消息回调、上传加速等设置。更多信息，请参见 [UserData](~~86952~~)。', + 'type' => 'string', + 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}', + ], + 'ReferenceId' => [ + 'title' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'description' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'example' => '123-123', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Total\\": 100,\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"VideoList\\": {\\n \\"Video\\": [\\n {\\n \\"StorageLocation\\": \\"out-****.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreationTime\\": \\"2017-11-14T09:15:50Z\\",\\n \\"CateId\\": 781111,\\n \\"VideoId\\": \\"9ae2af636ca6c10412f44891fc****\\",\\n \\"Tags\\": \\"标签1, 标签2\\",\\n \\"ModificationTime\\": \\"2017-11-14T09:16:50Z\\",\\n \\"CateName\\": \\"分类名称\\",\\n \\"Description\\": \\"阿里云VOD视频描述\\",\\n \\"AppId\\": \\"app-1000000\\",\\n \\"Size\\": 10897890,\\n \\"CoverURL\\": \\"https://example.aliyundoc.com/****.jpg\\",\\n \\"Duration\\": 135.6,\\n \\"Title\\": \\"阿里云VOD视频标题\\",\\n \\"Snapshots\\": {\\n \\"Snapshot\\": [\\n \\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\"\\n ]\\n },\\n \\"StorageClass\\": \\"Standard\\",\\n \\"RestoreStatus\\": \\"Success\\",\\n \\"RestoreExpiration\\": \\"2023-03-30T10:14:14Z\\",\\n \\"UserData\\": \\"{\\\\\\"MessageCallback\\\\\\":{\\\\\\"CallbackURL\\\\\\":\\\\\\"http://example.aliyundoc.com\\\\\\"},\\\\\\"Extend\\\\\\":{\\\\\\"localId\\\\\\":\\\\\\"*****\\\\\\",\\\\\\"test\\\\\\":\\\\\\"www\\\\\\"}}\\",\\n \\"ReferenceId\\": \\"123-123\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetVideoListResponse>\\n <Total>100</Total>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <VideoList>\\n <StorageLocation>out-****.oss-cn-shanghai.aliyuncs.com</StorageLocation>\\n <Status>Normal</Status>\\n <CreationTime>2017-11-14T09:15:50Z</CreationTime>\\n <CateId>781111****</CateId>\\n <VideoId>9ae2af636ca6c10412f44891fc****</VideoId>\\n <Tags>标签1, 标签2</Tags>\\n <ModificationTime>2017-11-14T09:16:50Z</ModificationTime>\\n <CateName>分类名称</CateName>\\n <Description>阿里云VOD视频描述</Description>\\n <AppId>app-1000000</AppId>\\n <Size>10897890</Size>\\n <CoverURL>https://example.aliyundoc.com/****.jpg</CoverURL>\\n <Duration>135.6</Duration>\\n <Title>阿里云VOD视频标题</Title>\\n <Snapshots>[\\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\",\\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27243****\\",...]</Snapshots>\\n </VideoList>\\n</GetVideoListResponse>","errorExample":""}]', + 'title' => '获取音视频信息列表', + 'description' => '本接口最多可获取指定筛选条件（如视频状态、分类ID等）的前**5000**条音视频。建议限定StartTime和EndTime来分批获取数据。若需要查询更多音视频，甚至遍历所有音视频信息，请参见[搜索媒体信息](~~86044~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| VideoListExceededMax |The video list exceeded maximum. |400 |翻页总条数超过最大限制。|'."\n" + .'| InvalidVideo.NotFound| The video does not exist. |404| 视频不存在。|'."\n", + ], + 'GetMezzanineInfo' => [ + 'summary' => '获取音视频的源文件信息，包括文件地址、分辨率、码率等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39967', + 'abilityTreeNodes' => [ + 'FEATUREvodYRQNEN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '音/视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的音/视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[获取视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，音/视频ID为返回参数VideoId的值。'."\n" + .'- 视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询音/视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1f1a6fc03ca04814031b8a6559e****', + ], + ], + [ + 'name' => 'AuthTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => 'FileURL（源文件地址）签名过期时间。单位：秒。默认值为**3600**，支持设置最小值为**1**。'."\n" + .' - 如果OutputType取值为**cdn**：'."\n" + .' - 只有开启了URL鉴权，FileURL才会定期失效，否则会永久有效。'."\n" + .' - 最小值：**1**。'."\n" + .' - 最大值：无限制。'."\n" + .' - 默认值：未设置时，取值为**3600**。'."\n" + .'- 如果OutputType取值为**oss**：'."\n" + .' - 只有存储权限为私有，FileURL才会定期失效，否则会永久有效。'."\n" + .' - 最小值：**1**。'."\n" + .' - 最大值：为降低源站安全风险，当音视频存储在点播系统Bucket上时，最大值为**2592000**（即30天），当音视频存储在OSS自有Bucket上时，最大值为**129600**（即36小时）。'."\n" + .' - 默认值：未设置时，取值为**3600**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'OutputType', + 'in' => 'query', + 'schema' => [ + 'description' => '输出地址类型。取值：'."\n" + ."\n" + .'- **oss**：回源地址。'."\n" + .'- **cdn**（默认）：加速地址。'."\n" + ."\n" + .'> 当源文件所在的bucket类型为in时，只返回OSS地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss', + ], + ], + [ + 'name' => 'AdditionType', + 'in' => 'query', + 'schema' => [ + 'description' => '附加信息类型。多个使用半角逗号（,）分隔，默认只返回基本信息。取值：'."\n" + ."\n" + .'- **video**：视频流信息。'."\n" + .'- **audio**：音频流信息。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'video', + ], + ], + [ + 'name' => 'ReferenceId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'description' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'Mezzanine' => [ + 'description' => '文件信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '文件创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2017-11-14T09:15:50Z', + ], + 'Status' => [ + 'description' => '文件状态。取值：'."\n" + ."\n" + .'- **Uploading**（上传中）：文件的初始状态，表示正在上传。'."\n" + .'- **Normal**（正常）：文件上传成功。'."\n" + .'- **UploadFail**（失败）：文件上传失败。'."\n" + .'- **Deleted**（删除）：文件被删除。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileURL' => [ + 'description' => '源文件地址。', + 'type' => 'string', + 'example' => 'http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/27ffc438-164h67f57ef-0005-6884-51a-1****.mp4', + ], + 'VideoId' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'example' => '1f1a6fc03ca04814031b8a6559e****', + ], + 'Height' => [ + 'description' => '文件高度。单位：px。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '540', + ], + 'Bitrate' => [ + 'description' => '文件码率。单位：Kbps。', + 'type' => 'string', + 'example' => '771.2280', + ], + 'FileName' => [ + 'description' => '文件名称。', + 'type' => 'string', + 'example' => '27ffc438-164h67f57ef-0005-6884-51a-1****.mp4', + ], + 'OutputType' => [ + 'description' => '输出地址类型。取值范围 ：'."\n" + ."\n" + .'- **oss**：回源地址。'."\n" + .'- **cdn**（默认）：加速地址。'."\n" + ."\n" + .'> 仅支持播放格式为MP4的OSS地址。', + 'type' => 'string', + 'example' => 'oss', + ], + 'PreprocessStatus' => [ + 'description' => '预处理状态 。取值：'."\n" + ."\n" + .'- **UnPreprocess**：未进行预处理。'."\n" + .'- **Preprocessing**：预处理中。'."\n" + .'- **PreprocessSucceed**：预处理完成。'."\n" + .'- **PreprocessFailed**：预处理失败。', + 'type' => 'string', + 'example' => 'UnPreprocess', + ], + 'Width' => [ + 'description' => '文件宽度。单位：px。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '960', + ], + 'Size' => [ + 'description' => '文件大小。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4096477', + ], + 'Duration' => [ + 'description' => '文件时长。单位：秒。', + 'type' => 'string', + 'example' => '42.4930', + ], + 'Fps' => [ + 'description' => '文件帧率，每秒多少帧。', + 'type' => 'string', + 'example' => '25.0000', + ], + 'AudioStreamList' => [ + 'description' => '音频流信息。', + 'type' => 'array', + 'items' => [ + 'description' => '音频流详情。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => '音频流序号，标识音频流在整个媒体流中的位置。', + 'type' => 'string', + 'example' => '0', + ], + 'Timebase' => [ + 'description' => '时基。', + 'type' => 'string', + 'example' => '0.000000', + ], + 'SampleFmt' => [ + 'description' => '采样格式。', + 'type' => 'string', + 'example' => 'fltp', + ], + 'SampleRate' => [ + 'description' => '采样率。', + 'type' => 'string', + 'example' => '44100', + ], + 'ChannelLayout' => [ + 'description' => '声道输出样式。取值：'."\n" + ."\n" + .'- **mono**：单声道。'."\n" + .'- **stereo**：双声道。', + 'type' => 'string', + 'example' => 'mono', + ], + 'Lang' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'und', + ], + 'CodecLongName' => [ + 'description' => '编码格式长述名。', + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'Channels' => [ + 'description' => '声道数。', + 'type' => 'string', + 'example' => '1', + ], + 'NumFrames' => [ + 'description' => '总帧数。', + 'type' => 'string', + 'example' => '1', + ], + 'Bitrate' => [ + 'description' => '码率。', + 'type' => 'string', + 'example' => '62.885', + ], + 'CodecTagString' => [ + 'description' => '编码格式标记文本。', + 'type' => 'string', + 'example' => 'mp4a', + ], + 'StartTime' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'CodecName' => [ + 'description' => '编码格式简述名。', + 'type' => 'string', + 'example' => 'aac', + ], + 'Duration' => [ + 'description' => '时长。', + 'type' => 'string', + 'example' => '3.227574', + ], + 'CodecTag' => [ + 'description' => '编码格式标记。', + 'type' => 'string', + 'example' => '0x6134706d', + ], + 'CodecTimeBase' => [ + 'description' => '编码时基。', + 'type' => 'string', + 'example' => '1/44100', + ], + ], + ], + ], + 'VideoStreamList' => [ + 'description' => '视频流信息。', + 'type' => 'array', + 'items' => [ + 'description' => '视频流详情。', + 'type' => 'object', + 'properties' => [ + 'Timebase' => [ + 'description' => '时基。', + 'type' => 'string', + 'example' => '0.000000', + ], + 'Index' => [ + 'description' => '视频流序号，标识视频流在整个媒体流中的位置。', + 'type' => 'string', + 'example' => '1', + ], + 'AvgFPS' => [ + 'description' => '平均帧率。', + 'type' => 'string', + 'example' => '30.0', + ], + 'PixFmt' => [ + 'description' => '像素格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Lang' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'und', + ], + 'Sar' => [ + 'description' => '编码信号分辨率比。', + 'type' => 'string', + 'example' => '0:1', + ], + 'Height' => [ + 'description' => '视频分辨率长。', + 'type' => 'string', + 'example' => '320', + ], + 'CodecLongName' => [ + 'description' => '编码格式长述名。', + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'NumFrames' => [ + 'description' => '总帧数。', + 'type' => 'string', + 'example' => '0', + ], + 'Bitrate' => [ + 'description' => '文件码率。单位：Kbps。', + 'type' => 'string', + 'example' => '500', + ], + 'Rotate' => [ + 'description' => '视频旋转角度，取值范围：**[0，360)**。', + 'type' => 'string', + 'example' => '90', + ], + 'CodecTagString' => [ + 'description' => '编码格式标记文本。', + 'type' => 'string', + 'example' => 'avc1', + ], + 'HasBFrames' => [ + 'description' => '是否有B帧。', + 'type' => 'string', + 'example' => '0', + ], + 'Profile' => [ + 'description' => '编码预置。', + 'type' => 'string', + 'example' => 'Main', + ], + 'StartTime' => [ + 'description' => '起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'Dar' => [ + 'description' => '编码显示分辨率比。', + 'type' => 'string', + 'example' => '0:1', + ], + 'CodecName' => [ + 'description' => '编码格式简述名。', + 'type' => 'string', + 'example' => 'h264', + ], + 'Width' => [ + 'description' => '视频分辨率宽。', + 'type' => 'string', + 'example' => '568', + ], + 'Duration' => [ + 'description' => '时长。', + 'type' => 'string', + 'example' => '3.166667', + ], + 'Fps' => [ + 'description' => '目标帧率。', + 'type' => 'string', + 'example' => '30.0', + ], + 'CodecTag' => [ + 'description' => '编码格式标记。', + 'type' => 'string', + 'example' => '0x31637661', + ], + 'CodecTimeBase' => [ + 'description' => '编码时基。', + 'type' => 'string', + 'example' => '1/60', + ], + 'Level' => [ + 'description' => '编码等级。', + 'type' => 'string', + 'example' => '30', + ], + 'HDRType' => [ + 'title' => '视频流HDR类型', + 'description' => '视频流HDR类型。', + 'type' => 'string', + 'example' => 'HDR', + ], + ], + ], + ], + 'StorageClass' => [ + 'description' => '媒资存储类型。取值：'."\n" + ."\n" + .'- **Standard**：标准。'."\n" + .'- **IA**：媒资低频。'."\n" + .'- **Archive**：媒资归档。'."\n" + .'- **ColdArchive**：媒资冷归档。'."\n" + .'- **SourceIA**：源文件低频。'."\n" + .'- **SourceArchive**：源文件归档。'."\n" + .'- **SourceColdArchive**：源文件冷归档。'."\n" + .'- **Changing**：媒资存储类型变更中。'."\n" + .'- **SourceChanging**：源文件存储类型变更中。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'RestoreStatus' => [ + 'description' => '媒资解冻状态。取值：'."\n" + .'- **Processing**：解冻中。'."\n" + .'- **Success**：解冻成功。'."\n" + .'- **Failed**：解冻失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RestoreExpiration' => [ + 'description' => '媒资解冻有效期。', + 'type' => 'string', + 'example' => '2023-03-30T10:14:14Z', + ], + 'FileMD5' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"Mezzanine\\": {\\n \\"CreationTime\\": \\"2017-11-14T09:15:50Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"FileURL\\": \\"http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/27ffc438-164h67f57ef-0005-6884-51a-1****.mp4\\",\\n \\"VideoId\\": \\"1f1a6fc03ca04814031b8a6559e****\\",\\n \\"Height\\": 540,\\n \\"Bitrate\\": \\"771.2280\\",\\n \\"FileName\\": \\"27ffc438-164h67f57ef-0005-6884-51a-1****.mp4\\",\\n \\"OutputType\\": \\"oss\\",\\n \\"PreprocessStatus\\": \\"UnPreprocess\\",\\n \\"Width\\": 960,\\n \\"Size\\": 4096477,\\n \\"Duration\\": \\"42.4930\\",\\n \\"Fps\\": \\"25.0000\\",\\n \\"AudioStreamList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Timebase\\": \\"0.000000\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"ChannelLayout\\": \\"mono\\",\\n \\"Lang\\": \\"und\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"Channels\\": \\"1\\",\\n \\"NumFrames\\": \\"1\\",\\n \\"Bitrate\\": \\"62.885\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"StartTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Duration\\": \\"3.227574\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTimeBase\\": \\"1/44100\\"\\n }\\n ],\\n \\"VideoStreamList\\": [\\n {\\n \\"Timebase\\": \\"0.000000\\",\\n \\"Index\\": \\"1\\",\\n \\"AvgFPS\\": \\"30.0\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Lang\\": \\"und\\",\\n \\"Sar\\": \\"0:1\\",\\n \\"Height\\": \\"320\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"NumFrames\\": \\"0\\",\\n \\"Bitrate\\": \\"500\\",\\n \\"Rotate\\": \\"90\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"HasBFrames\\": \\"0\\",\\n \\"Profile\\": \\"Main\\",\\n \\"StartTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"Dar\\": \\"0:1\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"Width\\": \\"568\\",\\n \\"Duration\\": \\"3.166667\\",\\n \\"Fps\\": \\"30.0\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTimeBase\\": \\"1/60\\",\\n \\"Level\\": \\"30\\",\\n \\"HDRType\\": \\"HDR\\"\\n }\\n ],\\n \\"StorageClass\\": \\"Standard\\",\\n \\"RestoreStatus\\": \\"Success\\",\\n \\"RestoreExpiration\\": \\"2023-03-30T10:14:14Z\\",\\n \\"FileMD5\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMezzanineInfoResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <Mezzanine>\\n <CreationTime>2017-11-14T09:15:50Z</CreationTime>\\n <Status>Normal</Status>\\n <FileURL>http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/27ffc438-164h67f57ef-0005-6884-51a-1****.mp4</FileURL>\\n <VideoId>1f1a6fc03ca04814031b8a6559e****</VideoId>\\n <Height>540</Height>\\n <Bitrate>771.2280</Bitrate>\\n <FileName>27ffc438-164h67f57ef-0005-6884-51a-1****.mp4</FileName>\\n <OutputType>oss</OutputType>\\n <Width>960</Width>\\n <Size>4096477</Size>\\n <Duration>42.4930</Duration>\\n <Fps>25.0000</Fps>\\n <AudioStreamList>\\n <Index>0</Index>\\n <Timebase>0.000000</Timebase>\\n <SampleFmt>fltp</SampleFmt>\\n <SampleRate>44100</SampleRate>\\n <ChannelLayout>mono</ChannelLayout>\\n <Lang>und</Lang>\\n <CodecLongName>AAC (Advanced Audio Coding)</CodecLongName>\\n <Channels>1</Channels>\\n <NumFrames>1</NumFrames>\\n <Bitrate>62.885</Bitrate>\\n <CodecTagString>mp4a</CodecTagString>\\n <StartTime>2017-01-11T12:00:00Z</StartTime>\\n <CodecName>aac</CodecName>\\n <Duration>3.227574</Duration>\\n <CodecTag>0x6134706d</CodecTag>\\n <CodecTimeBase>1/44100</CodecTimeBase>\\n </AudioStreamList>\\n <VideoStreamList>\\n <Timebase>0.000000</Timebase>\\n <Index>1</Index>\\n <AvgFPS>30.0</AvgFPS>\\n <PixFmt>yuv420p</PixFmt>\\n <Lang>und</Lang>\\n <Sar>0:1</Sar>\\n <Height>320</Height>\\n <CodecLongName>H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10</CodecLongName>\\n <NumFrames>0</NumFrames>\\n <Bitrate>500</Bitrate>\\n <Rotate>90</Rotate>\\n <CodecTagString>avc1</CodecTagString>\\n <HasBFrames>0</HasBFrames>\\n <Profile>Main</Profile>\\n <StartTime>2017-01-11T12:00:00Z</StartTime>\\n <Dar>0:1</Dar>\\n <CodecName>h264</CodecName>\\n <Width>568</Width>\\n <Duration>3.166667</Duration>\\n <Fps>30.0</Fps>\\n <CodecTag>0x31637661</CodecTag>\\n <CodecTimeBase>1/60</CodecTimeBase>\\n <Level>30</Level>\\n <HDRType>HDR</HDRType>\\n </VideoStreamList>\\n </Mezzanine>\\n</GetMezzanineInfoResponse>","errorExample":""}]', + 'title' => '获取源文件信息', + 'description' => '当一路视频或音频流转码完成后才可以获取到完整的源文件信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidVideo.NotFound| The video does not exist. |404| 视频ID不存在。|'."\n" + .'| InvalidFile.NotFound |The file does not exist. |404 |视频文件不存在。|'."\n", + ], + 'UpdateVideoInfo' => [ + 'summary' => '修改单个音视频信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40229', + 'abilityTreeNodes' => [ + 'FEATUREvod7B2GUR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '音/视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看音/视频ID。'."\n" + .'- 通过[获取视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，音/视频ID为返回参数VideoId的值。'."\n" + .'- 视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询音/视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2deda93265312baf9b0ed810d****', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '音/视频标题。'."\n" + ."\n" + .'- 长度不超过128个字节。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'Alibaba Cloud VOD Video Title', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => '标签。'."\n" + ."\n" + .'- 单个标签不超过32字节。最多不超过16个标签。'."\n" + .'- 多个标签之间用半角逗号（,）分隔。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag1,tag2', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '音/视频描述。'."\n" + ."\n" + .'- 长度不超过1024个字节。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'Alibaba Cloud VOD video description', + ], + ], + [ + 'name' => 'CoverURL', + 'in' => 'query', + 'schema' => [ + 'description' => '音/视频封面URL地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://example.aliyundoc.com/****.jpg', + ], + ], + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => '分类ID。可通过以下方式获取：'."\n" + .'- 登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **分类管理**查看分类ID。'."\n" + .'- 通过[创建分类](~~56401~~)接口创建分类时，分类ID为返回参数CateId的值。'."\n" + .'- 通过[获取分类及子分类](~~56406~~)接口查询分类时，为请求后返回参数CateId的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '384761111', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置。为 JSON 字符串，支持消息回调、上传加速等设置。更多信息，请参见 [UserData](~~86952~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}', + ], + ], + [ + 'name' => 'ReferenceId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义 ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'description' => '自定义 ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateVideoInfoResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n</UpdateVideoInfoResponse>","errorExample":""}]', + 'title' => '修改单个音视频信息', + 'description' => '### 使用说明'."\n" + .'通过视频ID来定位音/视频，支持修改音/视频的标题、标签、描述等信息，传入参数则更新相应字段，否则该字段不会被覆盖或更新。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidVideo.NotFound |The video does not exist. |404 |视频不存在。|'."\n", + ], + 'UpdateVideoInfos' => [ + 'summary' => '批量修改音视频信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40231', + 'abilityTreeNodes' => [ + 'FEATUREvod7B2GUR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'UpdateContent', + 'in' => 'query', + 'schema' => [ + 'description' => '更新内容。一次最多支持修改20个音/视频的信息，多个音/视频对象信息之间以英文逗号（,）分隔，一次更新超过20个将更新失败并报错`CountExceededMax`。'."\n" + .'格式为JSON字符串，构建参数详情，参见下表**更新内容UpdateContent**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"VideoId":"f45cf4eba5cb90233389558c39****","Title":"Alibaba Cloud VOD Video Title1"},{"VideoId":"f45cf4eba5c84233389558c36****","Title":"Alibaba Cloud VOD Video Title2"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'ForbiddenVideoIds' => [ + 'description' => '被禁止操作的音/视频ID列表（一般由于无[权限](~~113600~~)导致）。', + 'type' => 'array', + 'items' => [ + 'description' => '被禁止操作的音/视频ID列表（一般由于无[权限](~~113600~~)导致）。', + 'type' => 'string', + 'example' => 'f45cf4eba5c84233389558c36****', + ], + ], + 'NonExistVideoIds' => [ + 'description' => '不存在的音/视频ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的音/视频ID列表。', + 'type' => 'string', + 'example' => 'f45cf4eba5cb90233389558c39****', + ], + ], + 'NonExistReferenceIds' => [ + 'title' => '不存在的自定义 ID 列表。', + 'description' => '不存在的自定义 ID 列表。', + 'type' => 'array', + 'items' => [ + 'title' => '不存在的自定义 ID 列表。', + 'description' => '不存在的自定义 ID 列表。', + 'type' => 'string', + 'example' => '123-123', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"ForbiddenVideoIds\\": [\\n \\"f45cf4eba5c84233389558c36****\\"\\n ],\\n \\"NonExistVideoIds\\": [\\n \\"f45cf4eba5cb90233389558c39****\\"\\n ],\\n \\"NonExistReferenceIds\\": [\\n \\"123-123\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<UpdateVideoInfosResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <ForbiddenVideoIds>f45cf4eba5c84233389558c36****</ForbiddenVideoIds>\\n <NonExistVideoIds>f45cf4eba5cb90233389558c39****</NonExistVideoIds>\\n</UpdateVideoInfosResponse>","errorExample":""}]', + 'title' => '批量修改音视频信息', + 'description' => '### 使用说明'."\n" + .'- 通过音/视频ID来定位视频，支持修改音/视频的标题、标签、描述等信息，传入参数则更新相应字段，否则该字段不会被覆盖或更新。'."\n" + .'- 一次最多支持修改20个音/视频的信息。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'requestParamsDescription' => '## 更新内容UpdateContent'."\n" + ."\n" + .'> UpdateContent的取值需要转为String后作为传入参数。'."\n" + ."\n" + .'| 名称 |类型 |是否必需 |描述 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| VideoId |String |是 |音/视频ID。可通过以下方式获取：<br>通过控制台上传的音/视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看音/视频ID。<br>通过[获取视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，音/视频ID为返回参数VideoId的值。<br>音/视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询音/视频ID，为请求后返回参数VideoId的值。|'."\n" + .'|Title |String |否 |音/视频标题。|'."\n" + .'| Description |String |否 |音/视频描述。|'."\n" + .'| Tags |String |否 |图片标签。单个标签不超过32字节。最多不超过16个标签。多个标签之间用半角逗号（,）分隔。UTF8编码。|'."\n" + .'| CoverURL |String |否 |音/视频封面URL。|'."\n" + .'| CateId| Long |否 |分类ID。可通过以下方式获取：<br>登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **分类管理**查看分类ID。<br>通过[创建分类](~~56401~~)接口创建分类时，分类ID为返回参数CateId的值。<br>通过[获取分类及子分类](~~56406~~)接口查询分类时，为请求后返回参数CateId的值。|'."\n" + .'| ReferenceId |String |否 |自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。|', + 'responseParamsDescription' => ' ', + ], + 'DeleteMezzanines' => [ + 'summary' => '批量删除音视频源文件信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39839', + 'abilityTreeNodes' => [ + 'FEATUREvod8R2V42', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoIds', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除源文件的音/视频ID列表。一次最多支持20个音/视频ID，多个ID之间用半角逗号（,）分隔。可通过以下方式获取：'."\n" + .'- 通过控制台上传的音/视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看音/视频ID。'."\n" + .'- 通过[获取视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，音/视频ID为返回参数VideoId的值。'."\n" + .'- 音/视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询音/视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '23ab850b4f654b6e91d24d8157****,93ab850b4f6f4b6e91d24d81d4****', + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制删除源文件，取值：'."\n" + .'- **false**：否，默认值。'."\n" + .'- **true**：是。'."\n" + ."\n" + .'> 当视频转码模式为不转码或异步转码时，由于源文件会作为原画用于播放，默认不可删除该视频的源文件，此时，若需要强制删除该视频的源文件，可将本参数设置为**true**。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ReferenceIds', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义 ID 列表。由一个或多个自定义 ID 组成，多个 ID 之间使用半角逗号（,）分隔。最多支持 20 个。', + 'description' => '自定义 ID 列表。由一个或多个自定义 ID 组成，多个 ID 之间使用半角逗号（,）分隔。最多支持 20 个。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123,1234-1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'UnRemoveableVideoIds' => [ + 'description' => '不可删除的音/视频ID列表。'."\n" + ."\n" + .'> 一般由于源文件作为原画（当视频转码模式为不转码或异步转码时，源文件会作为原画用于播放，默认不可删除该视频的源文件）或无[权限](~~113600~~)导致。', + 'type' => 'array', + 'items' => [ + 'description' => '不可删除的音/视频ID列表。'."\n" + ."\n" + .'> 一般由于源文件作为原画（当视频转码模式为不转码或异步转码时，源文件会作为原画用于播放，默认不可删除该视频的源文件）或无[权限](~~113600~~)导致。', + 'type' => 'string', + 'example' => '23ab850b4f6f44b6e91d24d8157****', + ], + ], + 'NonExistVideoIds' => [ + 'description' => '不存在的音/视频ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的音/视频ID列表。', + 'type' => 'string', + 'example' => '93ab850b4f6f4b6e91d24d81d4****', + ], + ], + 'NonExistReferenceIds' => [ + 'title' => '不存在的自定义 ID 列表。', + 'description' => '不存在的自定义 ID 列表。', + 'type' => 'array', + 'items' => [ + 'title' => '不存在的自定义 ID 列表。', + 'description' => '不存在的自定义 ID 列表。', + 'type' => 'string', + 'example' => '123-123', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"UnRemoveableVideoIds\\": [\\n \\"23ab850b4f6f44b6e91d24d8157****\\"\\n ],\\n \\"NonExistVideoIds\\": [\\n \\"93ab850b4f6f4b6e91d24d81d4****\\"\\n ],\\n \\"NonExistReferenceIds\\": [\\n \\"123-123\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DeleteMezzaninesResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <UnRemoveableVideoIds>23ab850b4f6f44b6e91d24d8157****</UnRemoveableVideoIds>\\n <NonExistVideoIds>93ab850b4f6f4b6e91d24d81d4****</NonExistVideoIds>\\n</DeleteMezzaninesResponse>","errorExample":""}]', + 'title' => '批量删除音视频源文件', + 'description' => '点播的媒体处理操作（转码、截图、审核等）均是对源文件的操作，因此源文件一旦删除，后续的媒体处理操作将无法进行，请慎重操作。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DeleteStream' => [ + 'summary' => '删除媒体流（视频流，音频流）信息及存储文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39842', + 'abilityTreeNodes' => [ + 'FEATUREvod8R2V42', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'JobIds', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体流转码的作业ID列表，由一个或多个JobId组成。'."\n" + .'- 多个ID之间使用半角逗号（,）分隔，最多支持同一个视频下的20个作业ID。'."\n" + .'- JobId可以通过[GetPlayInfo](~~56124~~)接口中返回的PlayInfo结构体中获取，每个媒体流对应的JobId不同。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '35eb4dbda18c49cc0025df374b46****', + ], + ], + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[CreateUploadVideo](~~55407~~)接口上传视频时，视频ID为返回参数VideoId的值。'."\n" + .'- 视频上传后，可通过[SearchMedia](~~86044~~)接口查询视频ID，为请求后返回参数VideoId的值。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '95948ddba24446b6aed5db985e78****', + ], + ], + [ + 'name' => 'ReferenceId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义 ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'description' => '自定义 ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A7U43F6-D7393642****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A7U43F6-D7393642****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteStreamResponse>\\n <RequestId>25818875-5F78-4A7U43F6-D7393642****</RequestId>\\n</DeleteStreamResponse>","errorExample":""}]', + 'title' => '删除媒体流', + 'description' => '### 使用说明'."\n" + .'支持批量删除。'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| JobIdsExceededMax |The JobIds exceeded maximum. |400 |作业ID列表超过最大长度。|'."\n" + .'| InvalidVideo.NotFound| The video does not exist. |404 |视频不存在。|'."\n" + .'| InvalidStream.NotFound| The stream does not exist. |404 |媒体流不存在。|'."\n" + .'| DeleteStreamFailed |Deleting stream has failed due to some unknown error. |503 |删除媒体流失败，请稍后重试。|', + ], + 'DeleteVideo' => [ + 'summary' => '删除完整视频（包括视频源文件、转码后的流文件、封面截图等）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39846', + 'abilityTreeNodes' => [ + 'FEATUREvod8R2V42', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoIds', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID列表。由一个或多个视频ID组成，多个ID之间使用半角逗号（,）分隔。最多支持20个。视频ID可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[CreateUploadVideo](~~55407~~)接口上传视频时，视频ID为返回参数VideoId的值。'."\n" + .'- 视频上传后，可通过[SearchMedia](~~86044~~)接口查询视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'e44ebf1147hdsa2d2adbea8b****,e44ebf11oj984adbea8****,73ab850b4f6f4b6e91d24d81d54****', + ], + ], + [ + 'name' => 'ReferenceIds', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义 ID 列表。由一个或多个自定义 ID 组成，多个 ID 之间使用半角逗号（,）分隔。最多支持 20 个。', + 'description' => '自定义 ID 列表。由一个或多个自定义 ID 组成，多个 ID 之间使用半角逗号（,）分隔。最多支持 20 个。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123,1234-1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E4EBD2BF-5EB0-4476-8829-9D94E1B1****', + ], + 'ForbiddenVideoIds' => [ + 'description' => '被禁止操作的视频ID列表。'."\n" + ."\n" + .'> 一般由于无[权限](~~113600~~)导致。', + 'type' => 'array', + 'items' => [ + 'description' => '被禁止操作的视频ID列表。'."\n" + ."\n" + .'> 一般由于无[权限](~~113600~~)导致。', + 'type' => 'string', + 'example' => '73ab850b4f6f4b6e91d24d81d54****', + ], + ], + 'NonExistVideoIds' => [ + 'description' => '不存在的视频ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的视频ID列表。'."\n" + .'> 当请求删除的视频ID中，有一部分不存在时，则会返回该部分不存在的视频ID；若请求删除的视频全部都不存在时，则会报错404。'."\n", + 'type' => 'string', + 'example' => 'e44ebf1147hdsa2d2adbea8b****', + ], + ], + 'NonExistReferenceIds' => [ + 'title' => '不存在的自定义 ID 列表。', + 'description' => '不存在的自定义 ID 列表。', + 'type' => 'array', + 'items' => [ + 'title' => '不存在的自定义 ID 列表。', + 'description' => '不存在的自定义 ID 列表。', + 'type' => 'string', + 'example' => '123-123', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4EBD2BF-5EB0-4476-8829-9D94E1B1****\\",\\n \\"ForbiddenVideoIds\\": [\\n \\"73ab850b4f6f4b6e91d24d81d54****\\"\\n ],\\n \\"NonExistVideoIds\\": [\\n \\"e44ebf1147hdsa2d2adbea8b****\\"\\n ],\\n \\"NonExistReferenceIds\\": [\\n \\"123-123\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DeleteVideoResponse>\\n <RequestId>E4EBD2BF-5EB0-4476-8829-9D94E1B1****</RequestId>\\n <ForbiddenVideoIds>73ab850b4f6f4b6e91d24d81d54****</ForbiddenVideoIds>\\n <NonExistVideoIds>e44ebf1147hdsa2d2adbea8b****</NonExistVideoIds>\\n</DeleteVideoResponse>","errorExample":""}]', + 'title' => '删除完整视频', + 'description' => '### 使用说明'."\n" + .'- **此接口为物理删除视频，且无法恢复，请谨慎操作。**'."\n" + .'- 支持批量删除。'."\n" + .'- 删除视频时会删除源文件，包括视频源文件、转码后的流文件、封面截图等。但CDN缓存不会同步刷新，如果业务需要，可通过点播控制台的刷新功能，来清除CDN节点上的垃圾数据。相关操作请参见[刷新预热](~~86098~~)。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| VideoIdsExceededMax |The VideoIds exceeded maximum. |400 |视频ID列表超过最大长度。|'."\n" + .'| InvalidVideo.NotFound |The video does not exist. |404 |视频不存在。|'."\n" + .'| DeleteVideoFailed| Deleting video has failed due to some unknown error. |503 |删除视频失败，请稍后重试。|', + ], + 'BatchGetMediaInfos' => [ + 'summary' => '批量获取媒资基础信息和源文件信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257507', + 'abilityTreeNodes' => [ + 'FEATUREvodYRQNEN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaIds', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID，即音/视频ID（VideoId）。多个ID之间使用半角逗号（,）分隔，最多支持20个。可通过以下方式获取：'."\n" + ."\n" + .'- 通过控制台上传的音/视频，可登录点播控制台，选择媒资库 > 音/视频查看音/视频ID。'."\n" + .'- 通过获取音视频上传地址和凭证接口获取上传地址和凭证时，为返回参数VideoId的值。'."\n" + .'- 音/视频上传后，可通过搜索媒体信息接口查询，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => '61ccbdb06fa83012be4d8083f6****,7d2fbc380b0e08e55f****', + ], + ], + [ + 'name' => 'ReferenceIds', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义 ID 列表。由一个或多个自定义 ID 组成，多个 ID 之间使用半角逗号（,）分隔。最多支持 20 个。', + 'description' => '自定义 ID 列表。由一个或多个自定义 ID 组成，多个 ID 之间使用半角逗号（,）分隔。最多支持 20 个。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123,1234-1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9E290613-04F4-47F4-795D30732077****', + ], + 'NonExistMediaIds' => [ + 'description' => '不存在的媒资ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的媒资ID列表。', + 'type' => 'string', + 'example' => '["bbc65bba53f6ed90de118a7849****"]', + ], + ], + 'NonExistReferenceIds' => [ + 'title' => '不存在的自定义 ID 列表。', + 'description' => '不存在的自定义 ID 列表。', + 'type' => 'array', + 'items' => [ + 'title' => '不存在的自定义 ID 列表。', + 'description' => '不存在的自定义 ID 列表。', + 'type' => 'string', + 'example' => '123-123', + ], + ], + 'ForbiddenMediaIds' => [ + 'description' => '被禁止操作的媒资ID列表，通常是由于没有多应用的权限而导致被禁止操作，更多信息，请参见[多应用](~~113600~~)。', + 'type' => 'array', + 'items' => [ + 'description' => '被禁止操作的媒资ID列表，通常是由于没有多应用的权限而导致被禁止操作，更多信息，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'example' => '["bbc65bba53f6ed90de118a7849****"]', + ], + ], + 'MediaInfos' => [ + 'description' => '媒资列表。', + 'type' => 'array', + 'items' => [ + 'description' => '媒资列表。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '10a5fa364a5b71ef89246733a78e****', + ], + 'MediaInfo' => [ + 'description' => '媒资基础信息。', + 'type' => 'object', + 'properties' => [ + 'StorageLocation' => [ + 'description' => '音/视频存储地址。', + 'type' => 'string', + 'example' => 'outin-***.oss-cn-shanghai.aliyuncs.com', + ], + 'CreationTime' => [ + 'description' => '音/视频创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2017-11-14T09:15:50Z', + ], + 'Status' => [ + 'description' => '视频状态。取值：'."\n" + ."\n" + .'- **Uploading**：上传中。'."\n" + .'- **UploadFail**：上传失败。'."\n" + .'- **UploadSucc**：上传完成。'."\n" + .'- **Transcoding**：转码中。'."\n" + .'- **TranscodeFail**：转码失败。'."\n" + .'- **Blocked**：屏蔽。'."\n" + .'- **Normal**：正常。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '781111****', + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '7753d144efd74d6c45fe0570****', + ], + 'DownloadSwitch' => [ + 'description' => '离线下载开关状态，打开离线下载功能后，则允许移动端用户通过阿里云播放器将视频缓存至本地观看。具体操作，请参见[离线下载](~~86107~~)。取值：'."\n" + ."\n" + .'- **on**：开启，允许离线下载。'."\n" + .'- **off**：关闭，禁止离线下载。', + 'type' => 'string', + 'example' => 'on', + ], + 'Tags' => [ + 'description' => '音/视频标签。多个标签之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'tag1, tag2', + ], + 'ModificationTime' => [ + 'description' => '音/视频的最后一次更新时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2017-06-26T06:38:48Z', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => 'cate1', + ], + 'Description' => [ + 'description' => '音/视频描述。', + 'type' => 'string', + 'example' => 'Alibaba Cloud VOD video description', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'CoverURL' => [ + 'description' => '音/视频封面URL。', + 'type' => 'string', + 'example' => 'https://example.aliyundoc.com/****.jpg', + ], + 'TemplateGroupId' => [ + 'description' => '转码模板组ID。', + 'type' => 'string', + 'example' => 'b4039216985f4312a5382a4ed****', + ], + 'Title' => [ + 'description' => '音/视频标题。', + 'type' => 'string', + 'example' => 'Alibaba Cloud VOD Video Title', + ], + 'Snapshots' => [ + 'description' => '视频截图URL数组。', + 'type' => 'array', + 'items' => [ + 'description' => '视频截图URL数组。'."\n" + .'> 本接口仅会返回视频的封面截图数据，通过[视频截图](~~99368~~)功能截取的普通截图、雪碧截图、雪碧图原始图、WebVTT截图的截图数据，请调用[ListSnapshots](~~ListSnapshots~~)接口查询。', + 'type' => 'string', + 'example' => '["http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****","http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27243****",...]', + ], + ], + 'StorageClass' => [ + 'description' => '媒资存储类型。取值：'."\n" + .'- **Standard**：标准。'."\n" + .'- **IA**：媒资低频。'."\n" + .'- **Archive**：媒资归档。'."\n" + .'- **ColdArchive**：媒资冷归档。'."\n" + .'- **SourceIA**：源文件低频。'."\n" + .'- **SourceArchive**：源文件归档。'."\n" + .'- **SourceColdArchive**：源文件冷归档。'."\n" + .'- **Changing**：媒资存储类型变更中。'."\n" + .'- **SourceChanging**：源文件存储类型变更中。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'RestoreStatus' => [ + 'description' => '媒资解冻状态。取值：'."\n" + .'- **Processing**：解冻中。'."\n" + .'- **Success**：解冻成功。'."\n" + .'- **Failed**：解冻失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RestoreExpiration' => [ + 'description' => '媒资解冻有效期。', + 'type' => 'string', + 'example' => '2023-03-30T10:14:14Z', + ], + 'UserData' => [ + 'description' => '自定义参数。', + 'type' => 'string', + 'example' => '{"Extend":"xxx","MessageCallback":"xxx"}', + ], + 'ReferenceId' => [ + 'title' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'description' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'example' => '123-123', + ], + ], + ], + 'MezzanineInfo' => [ + 'description' => '源文件信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '文件创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2017-11-14T09:15:50Z', + ], + 'Status' => [ + 'description' => '文件状态。取值：'."\n" + ."\n" + .'- **Uploading**（上传中）：文件的初始状态，表示正在上传。'."\n" + .'- **Normal**（正常）：文件上传成功。'."\n" + .'- **UploadFail**（失败）：文件上传失败。'."\n" + .'- **Deleted**（删除）：文件被删除。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileURL' => [ + 'description' => '源文件地址。', + 'type' => 'string', + 'example' => 'http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/27ffc438-164h67f57ef-0005-6884-51a-1****.mp4', + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '1f1a6fc03ca04814031b8a6559e****', + ], + 'Height' => [ + 'description' => '文件高度。单位：px。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '540', + ], + 'Bitrate' => [ + 'description' => '文件码率。单位：Kbps。', + 'type' => 'string', + 'example' => '771.2280', + ], + 'FileName' => [ + 'description' => '文件名称。', + 'type' => 'string', + 'example' => '27ffc438-164h67f57ef-0005-6884-51a-1****.mp4'."\n", + ], + 'Width' => [ + 'description' => '文件宽度。单位：px。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '960', + ], + 'Size' => [ + 'description' => '文件大小。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4096477', + ], + 'Duration' => [ + 'description' => '文件时长。单位：秒。', + 'type' => 'string', + 'example' => '42.4930', + ], + 'Fps' => [ + 'description' => '文件帧率，每秒多少帧。', + 'type' => 'string', + 'example' => '25.0000', + ], + 'AudioStreamList' => [ + 'description' => '音频流信息。', + 'type' => 'array', + 'items' => [ + 'description' => '音频流详情', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => '音频流序号，标识音频流在整个媒体流中的位置。', + 'type' => 'string', + 'example' => '0', + ], + 'Timebase' => [ + 'description' => '时基。', + 'type' => 'string', + 'example' => '0.000000', + ], + 'SampleFmt' => [ + 'description' => '采样格式。', + 'type' => 'string', + 'example' => 'fltp', + ], + 'SampleRate' => [ + 'description' => '采样率。', + 'type' => 'string', + 'example' => '44100', + ], + 'ChannelLayout' => [ + 'description' => '声道输出样式。取值：'."\n" + ."\n" + .'- **mono**：单声道。'."\n" + .'- **stereo**：双声道。', + 'type' => 'string', + 'example' => 'mono', + ], + 'Lang' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'und', + ], + 'CodecLongName' => [ + 'description' => '编码格式长述名。', + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)'."\n", + ], + 'Channels' => [ + 'description' => '声道数。', + 'type' => 'string', + 'example' => '1', + ], + 'NumFrames' => [ + 'description' => '总帧数。', + 'type' => 'string', + 'example' => '1', + ], + 'Bitrate' => [ + 'description' => '码率。', + 'type' => 'string', + 'example' => '62.885', + ], + 'CodecTagString' => [ + 'description' => '编码格式标记文本。', + 'type' => 'string', + 'example' => 'mp4a', + ], + 'StartTime' => [ + 'description' => '起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'CodecName' => [ + 'description' => '编码格式简述名。', + 'type' => 'string', + 'example' => 'aac', + ], + 'Duration' => [ + 'description' => '时长。', + 'type' => 'string', + 'example' => '3.227574', + ], + 'CodecTag' => [ + 'description' => '编码格式标记。', + 'type' => 'string', + 'example' => '0x6134706d', + ], + 'CodecTimeBase' => [ + 'description' => '编码时基。', + 'type' => 'string', + 'example' => '1/44100', + ], + ], + ], + ], + 'VideoStreamList' => [ + 'description' => '视频流信息。', + 'type' => 'array', + 'items' => [ + 'description' => '视频流详情。', + 'type' => 'object', + 'properties' => [ + 'Timebase' => [ + 'description' => '时基。', + 'type' => 'string', + 'example' => '0.000000', + ], + 'Index' => [ + 'description' => '视频流序号，标识视频流在整个媒体流中的位置', + 'type' => 'string', + 'example' => '1', + ], + 'AvgFPS' => [ + 'description' => '平均帧率。', + 'type' => 'string', + 'example' => '30.0', + ], + 'PixFmt' => [ + 'description' => '像素格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Lang' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'und', + ], + 'Sar' => [ + 'description' => '编码信号分辨率比。', + 'type' => 'string', + 'example' => '0:1', + ], + 'Height' => [ + 'description' => '视频分辨率长。', + 'type' => 'string', + 'example' => '320', + ], + 'CodecLongName' => [ + 'description' => '编码格式长述名。', + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'NumFrames' => [ + 'description' => '总帧数。', + 'type' => 'string', + 'example' => '0', + ], + 'Bitrate' => [ + 'description' => '文件码率。单位：Kbps。', + 'type' => 'string', + 'example' => '500', + ], + 'Rotate' => [ + 'description' => '视频旋转角度，取值范围：[0，360)。', + 'type' => 'string', + 'example' => '90', + ], + 'CodecTagString' => [ + 'description' => '编码格式标记文本。', + 'type' => 'string', + 'example' => 'avc1', + ], + 'HasBFrames' => [ + 'description' => '是否有B帧。', + 'type' => 'string', + 'example' => '0', + ], + 'Profile' => [ + 'description' => '编码预置。', + 'type' => 'string', + 'example' => 'Main', + ], + 'StartTime' => [ + 'description' => '起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'Dar' => [ + 'description' => '编码显示分辨率比。', + 'type' => 'string', + 'example' => '0:1', + ], + 'CodecName' => [ + 'description' => '编码格式简述名。', + 'type' => 'string', + 'example' => 'h264', + ], + 'Width' => [ + 'description' => '视频分辨率宽。', + 'type' => 'string', + 'example' => '568', + ], + 'Duration' => [ + 'description' => '时长。', + 'type' => 'string', + 'example' => '3.166667', + ], + 'Fps' => [ + 'description' => '目标帧率。', + 'type' => 'string', + 'example' => '30.0', + ], + 'CodecTag' => [ + 'description' => '编码格式标记。', + 'type' => 'string', + 'example' => '0x31637661', + ], + 'CodecTimeBase' => [ + 'description' => '编码时基。', + 'type' => 'string', + 'example' => '1/60', + ], + 'Level' => [ + 'description' => '编码等级。', + 'type' => 'string', + 'example' => '30', + ], + 'HDRType' => [ + 'title' => '视频流HDR类型', + 'description' => '视频流HDR类型', + 'type' => 'string', + 'example' => 'HDR', + ], + ], + ], + ], + 'FileMD5' => [ + 'type' => 'string', + ], + ], + ], + 'PlayInfoList' => [ + 'description' => '音/视频播放信息（流信息）。', + 'type' => 'array', + 'items' => [ + 'description' => '音/视频详细信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2022-04-18T07:37:15Z'."\n", + ], + 'Status' => [ + 'description' => '媒体流状态，取值：'."\n" + ."\n" + .'- **Normal**：正常状态，标记的是每种清晰度和格式的一路最新转码完成的流的状态。'."\n" + .'- **Invisible**：不可见状态，当每种清晰度和格式有多路重复的转码流时，除了最新的一路流会被标记为正常状态，其他流会被标记为不可见状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Specification' => [ + 'description' => '音视频转码输出规格。各取值及描述，请参见[输出规格：Specification](~~124671#section-6bv-l0g-opq~~)。', + 'type' => 'string', + 'example' => 'H264.LD', + ], + 'NarrowBandType' => [ + 'description' => '转码类型。取值：'."\n" + ."\n" + .'- **0**：普通转码。'."\n" + .'- **1.0**：窄带高清1.0转码。'."\n" + .'- **2.0**：窄带高清2.0转码。', + 'type' => 'string', + 'example' => '0', + ], + 'Height' => [ + 'description' => '媒体流高度。单位：px。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '640', + ], + 'Bitrate' => [ + 'description' => '媒体流码率。单位：Kbps。', + 'type' => 'string', + 'example' => '450.878', + ], + 'ModificationTime' => [ + 'description' => '更新时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2022-04-20T06:32:19Z', + ], + 'WatermarkId' => [ + 'description' => '当前媒体流关联的水印模板ID。', + 'type' => 'string', + 'example' => 'dgfn26457856****', + ], + 'Encrypt' => [ + 'description' => '媒体流是否加密流，取值：'."\n" + ."\n" + .'- **0**：否。'."\n" + .'- **1**：是。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Definition' => [ + 'description' => '视频流清晰度定义。取值：'."\n" + ."\n" + .'- **FD**：流畅。'."\n" + .'- **LD**：标清。'."\n" + .'- **SD**：高清。'."\n" + .'- **HD**：超清'."\n" + .'- **OD**：原画。'."\n" + .'- **2K**：2K。'."\n" + .'- **4K**：4K。'."\n" + .'- **SQ**：普通音质。'."\n" + .'- **HQ**：高音质。'."\n" + .'- **AUTO**：自适应码率。', + 'type' => 'string', + 'example' => 'LD', + ], + 'EncryptType' => [ + 'description' => '媒体流加密类型。取值：'."\n" + ."\n" + .'- **AliyunVoDEncryption**：阿里云视频加密。'."\n" + .'- **HLSEncryption**：HLS标准加密。'."\n" + ."\n" + .'> 如果加密类型为**AliyunVoDEncryption**，则只能使用阿里云播放器SDK才能正常播放。', + 'type' => 'string', + 'example' => 'AliyunVoDEncryption', + ], + 'EncryptMode' => [ + 'description' => '媒体流加密模式。取值：'."\n" + ."\n" + .'- **License**：本地解密模式。'."\n" + ."\n" + .'> 如果加密模式为**License**，则只能使用阿里云播放器SDK才能正常播放。', + 'type' => 'string', + 'example' => 'License', + ], + 'StreamType' => [ + 'description' => '媒体流类型。'."\n" + .'若媒体流为视频则取值：**video**，若是纯音频则取值：**audio**。', + 'type' => 'string', + 'example' => 'video', + ], + 'JobId' => [ + 'description' => '媒体流转码的作业ID。作为媒体流的唯一标识。', + 'type' => 'string', + 'example' => '80e9c6580e754a798c3c19c59b16****', + ], + 'Size' => [ + 'description' => '媒体流大小。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '418112', + ], + 'Width' => [ + 'description' => '媒体流宽度。单位：px。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '360', + ], + 'Fps' => [ + 'description' => '媒体流帧率。单位：帧/每秒。', + 'type' => 'string', + 'example' => '25', + ], + 'Duration' => [ + 'description' => '媒体流长度。单位：秒。', + 'type' => 'string', + 'example' => '9.0464', + ], + 'PlayURL' => [ + 'description' => '视频流的播放地址。', + 'type' => 'string', + 'example' => 'https://example.aliyundoc.com/d52ee123f331466aabf6ab32a93d****/a777f9e24e6e47a2a942467d5c38ea37-8ee8e04293c6657fdda282bc422704****.m3u8', + ], + 'Format' => [ + 'description' => '媒体流格式。'."\n" + .'- 若媒体文件为视频则取值： **mp4**、 **m3u8**。'."\n" + .'- 若是纯音频则取值：**mp3**。', + 'type' => 'string', + 'example' => 'm3u8', + ], + 'HDRType' => [ + 'title' => '视频流HDR类型', + 'description' => '媒体流HDR类型。取值：'."\n" + .'- HDR'."\n" + .'- HDR10'."\n" + .'- HLG'."\n" + .'- DolbyVision'."\n" + .'- HDRVivid'."\n" + .'- SDR+', + 'type' => 'string', + 'example' => 'HLG', + ], + 'BitDepth' => [ + 'title' => '颜色位深', + 'description' => '颜色位深。取值为整数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'JobType' => [ + 'description' => '数字水印类型。取值：'."\n" + .'- **1**：溯源水印。'."\n" + .'- **2**：版权水印。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'JobExt' => [ + 'description' => '版权水印的自定义水印信息。仅当`JobType`为`2`时返回该字段。', + 'type' => 'string', + 'example' => 'CopyrightMarkTest', + ], + 'CodecName' => [ + 'description' => '编码格式简述名。', + 'type' => 'string', + 'example' => 'h264', + ], + 'TemplateId' => [ + 'description' => '转码模板ID。', + 'type' => 'string', + 'example' => 'a86a4338dd2e83da45154004a541****', + ], + 'TemplateGroupId' => [ + 'description' => '转码模板组ID。', + 'type' => 'string', + 'example' => 'fb0716154b21a4ecb5b70a26ccc8****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9E290613-04F4-47F4-795D30732077****\\",\\n \\"NonExistMediaIds\\": [\\n \\"[\\\\\\"bbc65bba53f6ed90de118a7849****\\\\\\"]\\"\\n ],\\n \\"NonExistReferenceIds\\": [\\n \\"123-123\\"\\n ],\\n \\"ForbiddenMediaIds\\": [\\n \\"[\\\\\\"bbc65bba53f6ed90de118a7849****\\\\\\"]\\"\\n ],\\n \\"MediaInfos\\": [\\n {\\n \\"MediaId\\": \\"10a5fa364a5b71ef89246733a78e****\\",\\n \\"MediaInfo\\": {\\n \\"StorageLocation\\": \\"outin-***.oss-cn-shanghai.aliyuncs.com\\",\\n \\"CreationTime\\": \\"2017-11-14T09:15:50Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CateId\\": 0,\\n \\"MediaId\\": \\"7753d144efd74d6c45fe0570****\\",\\n \\"DownloadSwitch\\": \\"on\\",\\n \\"Tags\\": \\"tag1, tag2\\",\\n \\"ModificationTime\\": \\"2017-06-26T06:38:48Z\\",\\n \\"CateName\\": \\"cate1\\",\\n \\"Description\\": \\"Alibaba Cloud VOD video description\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"CoverURL\\": \\"https://example.aliyundoc.com/****.jpg\\",\\n \\"TemplateGroupId\\": \\"b4039216985f4312a5382a4ed****\\",\\n \\"Title\\": \\"Alibaba Cloud VOD Video Title\\",\\n \\"Snapshots\\": [\\n \\"[\\\\\\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\\\\\",\\\\\\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27243****\\\\\\",...]\\"\\n ],\\n \\"StorageClass\\": \\"Standard\\",\\n \\"RestoreStatus\\": \\"Success\\",\\n \\"RestoreExpiration\\": \\"2023-03-30T10:14:14Z\\",\\n \\"UserData\\": \\"{\\\\\\"Extend\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"MessageCallback\\\\\\":\\\\\\"xxx\\\\\\"}\\",\\n \\"ReferenceId\\": \\"123-123\\"\\n },\\n \\"MezzanineInfo\\": {\\n \\"CreationTime\\": \\"2017-11-14T09:15:50Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"FileURL\\": \\"http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/27ffc438-164h67f57ef-0005-6884-51a-1****.mp4\\",\\n \\"MediaId\\": \\"1f1a6fc03ca04814031b8a6559e****\\",\\n \\"Height\\": 540,\\n \\"Bitrate\\": \\"771.2280\\",\\n \\"FileName\\": \\"27ffc438-164h67f57ef-0005-6884-51a-1****.mp4\\\\n\\",\\n \\"Width\\": 960,\\n \\"Size\\": 4096477,\\n \\"Duration\\": \\"42.4930\\",\\n \\"Fps\\": \\"25.0000\\",\\n \\"AudioStreamList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Timebase\\": \\"0.000000\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"ChannelLayout\\": \\"mono\\",\\n \\"Lang\\": \\"und\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\\\n\\",\\n \\"Channels\\": \\"1\\",\\n \\"NumFrames\\": \\"1\\",\\n \\"Bitrate\\": \\"62.885\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"StartTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Duration\\": \\"3.227574\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"CodecTimeBase\\": \\"1/44100\\"\\n }\\n ],\\n \\"VideoStreamList\\": [\\n {\\n \\"Timebase\\": \\"0.000000\\",\\n \\"Index\\": \\"1\\",\\n \\"AvgFPS\\": \\"30.0\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Lang\\": \\"und\\",\\n \\"Sar\\": \\"0:1\\",\\n \\"Height\\": \\"320\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"NumFrames\\": \\"0\\",\\n \\"Bitrate\\": \\"500\\",\\n \\"Rotate\\": \\"90\\",\\n \\"CodecTagString\\": \\"avc1\\",\\n \\"HasBFrames\\": \\"0\\",\\n \\"Profile\\": \\"Main\\",\\n \\"StartTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"Dar\\": \\"0:1\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"Width\\": \\"568\\",\\n \\"Duration\\": \\"3.166667\\",\\n \\"Fps\\": \\"30.0\\",\\n \\"CodecTag\\": \\"0x31637661\\",\\n \\"CodecTimeBase\\": \\"1/60\\",\\n \\"Level\\": \\"30\\",\\n \\"HDRType\\": \\"HDR\\"\\n }\\n ],\\n \\"FileMD5\\": \\"\\"\\n },\\n \\"PlayInfoList\\": [\\n {\\n \\"CreationTime\\": \\"2022-04-18T07:37:15Z\\\\n\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Specification\\": \\"H264.LD\\",\\n \\"NarrowBandType\\": \\"0\\",\\n \\"Height\\": 640,\\n \\"Bitrate\\": \\"450.878\\",\\n \\"ModificationTime\\": \\"2022-04-20T06:32:19Z\\",\\n \\"WatermarkId\\": \\"dgfn26457856****\\",\\n \\"Encrypt\\": 1,\\n \\"Definition\\": \\"LD\\",\\n \\"EncryptType\\": \\"AliyunVoDEncryption\\",\\n \\"EncryptMode\\": \\"License\\",\\n \\"StreamType\\": \\"video\\",\\n \\"JobId\\": \\"80e9c6580e754a798c3c19c59b16****\\",\\n \\"Size\\": 418112,\\n \\"Width\\": 360,\\n \\"Fps\\": \\"25\\",\\n \\"Duration\\": \\"9.0464\\",\\n \\"PlayURL\\": \\"https://example.aliyundoc.com/d52ee123f331466aabf6ab32a93d****/a777f9e24e6e47a2a942467d5c38ea37-8ee8e04293c6657fdda282bc422704****.m3u8\\",\\n \\"Format\\": \\"m3u8\\",\\n \\"HDRType\\": \\"HLG\\",\\n \\"BitDepth\\": 8,\\n \\"JobType\\": 2,\\n \\"JobExt\\": \\"CopyrightMarkTest\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"TemplateId\\": \\"a86a4338dd2e83da45154004a541****\\",\\n \\"TemplateGroupId\\": \\"fb0716154b21a4ecb5b70a26ccc8****\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量获取媒资信息', + 'description' => '- 一次最多获取20个音视频的信息。'."\n" + .'- 音视频上传完成后，点播会对上传完成的音视频源文件进行分析，因此媒资信息是异步生成的。可通过设置[音视频分析完成](~~99935~~)的[事件通知](~~55627~~)，当接收到[音视频分析完成](~~99935~~)的事件通知后，再调用本接口获取音视频信息。', + ], + 'DescribeMediaDistribution' => [ + 'summary' => '查询音视频媒资数据按时间分布。起止时间跨度最大6个月。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '254961', + 'abilityTreeNodes' => [ + 'FEATUREvodYRQNEN', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'CreationTime（创建时间）的开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。起止时间跨度最大6个月。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-01-11T12:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'CreationTime 的结束时间，需晚于开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。起止时间跨度最大6个月。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-01-11T12:59:00Z', + ], + ], + [ + 'name' => 'StorageClass', + 'in' => 'query', + 'schema' => [ + 'description' => '分级存储类型：'."\n" + .'- Standard：标准存储'."\n" + .'- IA：低频访问'."\n" + .'- Archive：归档存储'."\n" + .'- ColdArchive：冷归档存储'."\n" + .'- SourceIA：源文件低频访问'."\n" + .'- SourceArchive：源文件归档存储'."\n" + .'- SourceColdArchive：源文件冷归档存储'."\n" + .'- Changing：媒资存储类型变更中'."\n" + .'- SourceChanging：源文件存储类型变更中', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '统计间隔，默认值为天day。'."\n" + .'- hour：小时，按起止时间所在自然小时统计'."\n" + .'- day：天，按起止时间所在自然天统计'."\n" + .'- week：星期，按起止时间所在自然周统计'."\n" + .'- month：月，按起止时间所在自然月统计', + 'type' => 'string', + 'required' => false, + 'example' => 'day', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'Total' => [ + 'description' => '音/视频总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'MediaDistributionList' => [ + 'description' => '音/视频媒资分布列表。按照起止时间所在的自然小时、天、周、月等统计周期进行展示。', + 'type' => 'array', + 'items' => [ + 'description' => '音/视频媒资分布。没有数据则不显示。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '统计起始时间（包括）。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。', + 'type' => 'string', + 'example' => '2017-11-13T00:00:00Z', + ], + 'EndTime' => [ + 'description' => '统计结束时间（不包括）。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。', + 'type' => 'string', + 'example' => '2017-11-14T00:00:00Z', + ], + 'Count' => [ + 'description' => '在统计自然周期内，输入时间范围命中的媒资数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"Total\\": 100,\\n \\"MediaDistributionList\\": [\\n {\\n \\"StartTime\\": \\"2017-11-13T00:00:00Z\\",\\n \\"EndTime\\": \\"2017-11-14T00:00:00Z\\",\\n \\"Count\\": 12\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询媒资分布', + 'description' => '- 目前该接口服务地址仅支持：华东 2（上海）。'."\n" + .'- 如果您不指定StartTime和EndTime，该接口默认返回过去 7天的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。', + ], + 'GetAttachedMediaInfo' => [ + 'summary' => '当水印图片、字幕文件、素材等辅助媒资上传到视频点播后，可以调用本接口传入多个辅助媒资ID批量获取辅助媒资的基本信息及访问地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39939', + 'abilityTreeNodes' => [ + 'FEATUREvodYRQNEN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaIds', + 'in' => 'query', + 'schema' => [ + 'description' => '辅助媒资ID。'."\n" + .'- 多个ID之间使用半角逗号（,）分隔，最多支持20个ID。'."\n" + .'- 调用[CreateUploadAttachedMedia](~~CreateUploadAttachedMedia~~)接口获取辅助媒资上传地址和凭证后，会返回。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eb1861d2c9a842340e989dd56****,0222e203cf80f9c22870a4d2c****', + ], + ], + [ + 'name' => 'AuthTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '辅助媒资地址过期时间，单位：秒。'."\n" + ."\n" + .' - 如果OutputType取值为**cdn**：'."\n" + .' - 只有开启了URL鉴权的辅助媒资地址才会过期失效，否则会永久有效。'."\n" + .' - 最小值：**1**。'."\n" + .' - 最大值：无限制。'."\n" + .' - 默认值：未设置时，取值为URL鉴权中设置的默认有效时长。'."\n" + .'- 如果OutputType取值为**oss**：'."\n" + .' - 只有存储权限为私有，辅助媒资地址才会过期失效，否则会永久有效。'."\n" + .' - 最小值：**1**。'."\n" + .' - 最大值：为降低源站安全风险，当辅助媒资存储在点播系统Bucket上时，最大值为**2592000**（即30天），当辅助媒资存储在OSS自有Bucket上时，最大值为**129600**（即36小时）。'."\n" + .' - 默认值：未设置时，取值为**3600**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'OutputType', + 'in' => 'query', + 'schema' => [ + 'description' => '输出地址类型。取值：'."\n" + ."\n" + .'- **oss**：回源地址。'."\n" + .'- **cdn**（默认）：加速地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '221BCB57-B217-42BF-619BD13378F9****', + ], + 'NonExistMediaIds' => [ + 'description' => '不存在的辅助媒资ID。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的辅助媒资ID。', + 'type' => 'string', + 'example' => 'eb1861d2c9a842340e989dd56****', + ], + ], + 'AttachedMediaList' => [ + 'description' => '辅助媒资信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '辅助媒资详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '辅助媒资类型。'."\n" + ."\n" + .'- **watermark**：水印。'."\n" + .'- **subtitle**：字幕。'."\n" + .'- **material**：素材。', + 'type' => 'string', + 'example' => 'subtitle', + ], + 'StorageLocation' => [ + 'description' => '辅助媒资的存储地址。', + 'type' => 'string', + 'example' => 'outin-bfefbb9*****c7426.oss-cn-shanghai.aliyuncs.com', + ], + 'CreationTime' => [ + 'description' => '辅助媒资创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2019-01-01T10:00:00Z', + ], + 'Status' => [ + 'description' => '辅助媒资状态。取值：'."\n" + .'- **Uploading**：上传中。'."\n" + .'- **Normal**：正常。'."\n" + .'- **UploadFail**：上传失败。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Tags' => [ + 'description' => '标签。'."\n" + .'>仅当辅助媒资有标签信息时，才会返回此参数。', + 'type' => 'string', + 'example' => 'tag1,tag2', + ], + 'ModificationTime' => [ + 'description' => '辅助媒资的最后更新时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2020-05-31T11:42:20Z', + ], + 'MediaId' => [ + 'description' => '辅助媒资ID。', + 'type' => 'string', + 'example' => '0222e203cf80f9c22870a4d2c****', + ], + 'Description' => [ + 'description' => '描述。'."\n" + .'>仅当辅助媒资有描述信息时，才会返回此参数。', + 'type' => 'string', + 'example' => '描述测试', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-*****', + ], + 'URL' => [ + 'description' => '辅助媒资的访问地址。'."\n" + ."\n" + .'> 如果点播配置了CDN域名则为CDN地址，否则为OSS地址。', + 'type' => 'string', + 'example' => 'https://al*****.cn/subtitle/9843C2*****4E186F19B6.vtt?auth_key=159099f60e0b7fd59****', + ], + 'Title' => [ + 'description' => '标题。', + 'type' => 'string', + 'example' => '字幕测试', + ], + 'Categories' => [ + 'description' => '分类列表。', + 'type' => 'array', + 'items' => [ + 'description' => '分类详情。', + 'type' => 'object', + 'properties' => [ + 'ParentId' => [ + 'description' => '父分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000224336', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000224338', + ], + 'Level' => [ + 'description' => '分类层级。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"221BCB57-B217-42BF-619BD13378F9****\\",\\n \\"NonExistMediaIds\\": [\\n \\"eb1861d2c9a842340e989dd56****\\"\\n ],\\n \\"AttachedMediaList\\": [\\n {\\n \\"Type\\": \\"subtitle\\",\\n \\"StorageLocation\\": \\"outin-bfefbb9*****c7426.oss-cn-shanghai.aliyuncs.com\\",\\n \\"CreationTime\\": \\"2019-01-01T10:00:00Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Tags\\": \\"tag1,tag2\\",\\n \\"ModificationTime\\": \\"2020-05-31T11:42:20Z\\",\\n \\"MediaId\\": \\"0222e203cf80f9c22870a4d2c****\\",\\n \\"Description\\": \\"描述测试\\",\\n \\"AppId\\": \\"app-*****\\",\\n \\"URL\\": \\"https://al*****.cn/subtitle/9843C2*****4E186F19B6.vtt?auth_key=159099f60e0b7fd59****\\",\\n \\"Title\\": \\"字幕测试\\",\\n \\"Categories\\": [\\n {\\n \\"ParentId\\": 1000224336,\\n \\"CateName\\": \\"测试\\",\\n \\"CateId\\": 1000224338,\\n \\"Level\\": 0\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetAttachedMediaInfoResponse>\\n <RequestId>221BCB57-B217-42BF-619BD13378F9****</RequestId>\\n <NonExistMediaIds>eb1861d2c9a842340e989dd56****</NonExistMediaIds>\\n <AttachedMediaList>\\n <Type>subtitle</Type>\\n <StorageLocation>outin-bfefbb9*****c7426.oss-cn-shanghai.aliyuncs.com</StorageLocation>\\n <CreationTime>2019-01-01T10:00:00Z</CreationTime>\\n <Status>Normal</Status>\\n <Tags>tag1,tag2</Tags>\\n <ModificationTime>2020-05-31T11:42:20Z</ModificationTime>\\n <MediaId>0222e203cf80f9c22870a4d2c****</MediaId>\\n <Description>描述测试</Description>\\n <AppId>app-*****</AppId>\\n <URL>https://al*****.cn/subtitle/9843C2*****4E186F19B6.vtt?auth_key=159099f60e0b7fd59****</URL>\\n <Title>字幕测试</Title>\\n <Categories>\\n <ParentId>1000224336</ParentId>\\n <CateName>测试</CateName>\\n <CateId>1000224338</CateId>\\n <Level>0</Level>\\n </Categories>\\n </AttachedMediaList>\\n</GetAttachedMediaInfoResponse>","errorExample":""}]', + 'title' => '批量获取辅助媒资信息', + 'description' => '一次最多支持获取20个辅助媒资的信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| ExceededMax |The input parameter “MediaIds” Exceed the limit. |400 |辅助媒资ID超过上限20个。|', + ], + 'UpdateAttachedMediaInfos' => [ + 'summary' => '当将带有水印的图片、字幕文件或其它素材等辅助媒体资源上传至视频点播后，可以通过本接口依据这些辅助媒体的唯一标识符（ID），批量更新它们的标题、描述、标签及分类等信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40211', + 'abilityTreeNodes' => [ + 'FEATUREvod7B2GUR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'UpdateContent', + 'in' => 'query', + 'schema' => [ + 'description' => '更新内容。一次最多支持修改20个辅助媒资信息。参数结构请参考下表**更新内容UpdateContent**。'."\n" + .'>- `Title`、`Description`、`Tags`更新内容中不能包含表情符。'."\n" + .'>- 传入参数则更新相应字段，否则相应字段不会被覆盖或更新。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"MediaId":"bbc65bba53f6ed90de118a7849****","Title":"标题1","Description":"描述1","Tags":"标签1,标签2"},{"MediaId":"f45cf4eba5cb90233389558c39****","Title2":"标题","Description2":"描述","Tags":"标签3,标签4"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4DF6-D7393642CA58****', + ], + 'NonExistMediaIds' => [ + 'description' => '不存在的辅助媒资ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的辅助媒资ID列表。', + 'type' => 'string', + 'example' => '["bbc65bba53f6ed90de118a7849****"]', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4DF6-D7393642CA58****\\",\\n \\"NonExistMediaIds\\": [\\n \\"[\\\\\\"bbc65bba53f6ed90de118a7849****\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<UpdateAttachedMediaInfosResponse>\\n <RequestId>25818875-5F78-4DF6-D7393642CA58****</RequestId>\\n <NonExistMediaIds>[\\"bbc65bba53f6ed90de118a7849****\\"]</NonExistMediaIds>\\n</UpdateAttachedMediaInfosResponse>","errorExample":""}]', + 'title' => '批量更新辅助媒资信息', + 'description' => '一次最多支持修改20个辅助媒资的信息。', + 'requestParamsDescription' => '## 更新内容UpdateContent'."\n" + ."\n" + .'> UpdateContent的取值需要转为String后作为传入参数。'."\n" + ."\n" + .'| 名称| 类型 |是否必需| 描述|'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'|MediaId |String |是 |辅助媒资ID。调用[CreateUploadAttachedMedia](~~CreateUploadAttachedMedia~~)接口后会返回。|'."\n" + .'|Title |String| 否 |标题。长度不超过128个字节。UTF-8编码。|'."\n" + .'| Description |String |否 |描述。长度不超过1024个字节。UTF-8编码。|'."\n" + .'| Tags |String| 否 |标签。单个标签不超过32字节。最多不超过16个标签。多个标签之间使用半角逗号（,）分隔。UTF8编码。|'."\n" + .'| CateIds |String |否 |分类ID。多个ID之间使用半角逗号（,）分隔。可通过以下方式获取：<br>登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **分类管理**，查看分类ID。<br>调用[AddCategory](~~AddCategory~~)接口创建分类时会返回。<br>调用[GetCategories](~~GetCategories~~)接口查询分类时会返回。|', + ], + 'DeleteAttachedMedia' => [ + 'summary' => '当水印图片、字幕文件、素材等辅助媒体资源上传至视频点播后，可以利用本接口能进行单个或批量的删除操作。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39826', + 'abilityTreeNodes' => [ + 'FEATUREvod8R2V42', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaIds', + 'in' => 'query', + 'schema' => [ + 'description' => '辅助媒资ID。'."\n" + .'- 多个ID之间使用半角逗号（,）分隔，最多支持20个ID。'."\n" + .'- 调用[CreateUploadAttachedMedia](~~CreateUploadAttachedMedia~~)接口获取辅助媒资上传地址和凭证后，会返回。', + 'type' => 'string', + 'required' => true, + 'example' => '8bc8e94fe4e55abde85718****,eb186180e989dd56****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'NonExistMediaIds' => [ + 'description' => '删除失败的辅助媒资ID。', + 'type' => 'array', + 'items' => [ + 'description' => '删除失败的辅助媒资ID。', + 'type' => 'string', + 'example' => '["8bc8e94fe4e55abde85718****"]', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"NonExistMediaIds\\": [\\n \\"[\\\\\\"8bc8e94fe4e55abde85718****\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DeleteAttachedMediaResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <NonExistMediaIds>[\\"8bc8e94fe4e55abde85718****\\"]</NonExistMediaIds>\\n</DeleteAttachedMediaResponse>","errorExample":""}]', + 'title' => '批量删除辅助媒资', + 'description' => '- **本接口为物理删除辅助媒资，一旦删除，无法恢复，请谨慎操作。**'."\n" + .'- 一次最多支持删除20个辅助媒资。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetImageInfo' => [ + 'summary' => '图片上传至视频点播后，可调用本接口通过图片ID获取其基本信息及访问地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39955', + 'abilityTreeNodes' => [ + 'FEATUREvodYRQNEN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => '图片ID。可通过以下方式获取：'."\n" + .'- 可登录[点播控制台](https://vod.console.aliyun.com/)，选择**媒资库>图片**，查看ID。'."\n" + .'- 调用[CreateUploadImage](~~CreateUploadImage~~)接口获取上传地址和凭证时会返回。'."\n" + .'- 调用[SearchMedia](~~SearchMedia~~)接口查询图片时会返回。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '3e34733b40b9a96ccf5c1ff6f69****', + ], + ], + [ + 'name' => 'AuthTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '图片访问地址的过期时间。单位：秒。'."\n" + ."\n" + .'- 当OutputType取值为cdn时：'."\n" + .' - 只有开启了URL鉴权的图片地址才会过期失效，否则会永久有效。'."\n" + .' - 最小值：1。'."\n" + .' - 最大值：无限制。'."\n" + .' - 默认值：未设置时，取值为URL鉴权中设置的默认有效时长。'."\n" + .'- 当OutputType取值为oss时：'."\n" + .' - 只有存储权限为私有，播放地址才会过期失效，否则会永久有效。'."\n" + .' - 最小值：1。'."\n" + .' - 最大值：为降低源站安全风险，当图片存储在点播系统Bucket上时，最大值为**2592000**（即30天），当图片存储在OSS自有Bucket上时，最大值为**129600**（即36小时）。'."\n" + .' - 默认值：未设置时，取值为3600。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'OutputType', + 'in' => 'query', + 'schema' => [ + 'description' => '输出的图片访问地址的类型。取值范围 ：'."\n" + ."\n" + .'- oss：回源地址。'."\n" + .'- cdn（默认）：加速地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'cdn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AB99D4DF-FAFA-49DC-9C548C1E261E****', + ], + 'ImageInfo' => [ + 'description' => '图片信息列表。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '图片创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-11-21T02:37:23Z', + ], + 'StorageLocation' => [ + 'description' => '图片文件的存储地址。', + 'type' => 'string', + 'example' => 'outin-****..oss-cn-shanghai.aliyuncs.com', + ], + 'Status' => [ + 'description' => '图片状态。取值：'."\n" + ."\n" + .'- **Uploading**：初始状态，表示图片正在上传。'."\n" + .'- **Normal**：图片上传成功。'."\n" + .'- **UploadFail**：图片上传失败。', + 'type' => 'string', + 'example' => 'Uploading', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '254766071', + ], + 'Tags' => [ + 'description' => '图片标签。多个标签之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'tag1,tag2,tag3', + ], + 'ImageType' => [ + 'description' => '图片类型。取值：'."\n" + ."\n" + .'- **default**：普通图片'."\n" + .'- **cover**：视频封面图', + 'type' => 'string', + 'example' => 'default', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'Description' => [ + 'description' => '图片描述。', + 'type' => 'string', + 'example' => '测试描述', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'URL' => [ + 'description' => '图片访问地址（如果配置了CDN域名则为CDN地址，否则为OSS地址）。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/image/default/****.gif?auth_key=****', + ], + 'Title' => [ + 'description' => '图片标题。', + 'type' => 'string', + 'example' => 'this is a sample', + ], + 'ImageId' => [ + 'description' => '图片ID。', + 'type' => 'string', + 'example' => 'bbc65bba53f9*****ed90de118a7849', + ], + 'Mezzanine' => [ + 'description' => '图片源信息。', + 'type' => 'object', + 'properties' => [ + 'FileURL' => [ + 'description' => '图片文件的OSS地址。', + 'type' => 'string', + 'example' => 'https://outin-bfefbb*****163e1c7426.oss-cn-XXXXXXXX.aliyuncs.com/image/default/5E84CD536*****D4DAD.png?Expires=1590982353&OSSAccessKeyId=*****&Signature=ALPET74o*****c%3D', + ], + 'OriginalFileName' => [ + 'description' => '上传的图片源文件地址。', + 'type' => 'string', + 'example' => '****.gif', + ], + 'Width' => [ + 'description' => '图片宽度。单位：像素。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Height' => [ + 'description' => '图片高度。单位：像素。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'FileSize' => [ + 'description' => '文件大小。单位：字节。', + 'type' => 'string', + 'example' => '8932', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AB99D4DF-FAFA-49DC-9C548C1E261E****\\",\\n \\"ImageInfo\\": {\\n \\"CreationTime\\": \\"2018-11-21T02:37:23Z\\",\\n \\"StorageLocation\\": \\"outin-****..oss-cn-shanghai.aliyuncs.com\\",\\n \\"Status\\": \\"Uploading\\",\\n \\"CateId\\": 254766071,\\n \\"Tags\\": \\"tag1,tag2,tag3\\",\\n \\"ImageType\\": \\"default\\",\\n \\"CateName\\": \\"测试\\",\\n \\"Description\\": \\"测试描述\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"URL\\": \\"http://example.aliyundoc.com/image/default/****.gif?auth_key=****\\",\\n \\"Title\\": \\"this is a sample\\",\\n \\"ImageId\\": \\"bbc65bba53f9*****ed90de118a7849\\",\\n \\"Mezzanine\\": {\\n \\"FileURL\\": \\"https://outin-bfefbb*****163e1c7426.oss-cn-XXXXXXXX.aliyuncs.com/image/default/5E84CD536*****D4DAD.png?Expires=1590982353&OSSAccessKeyId=*****&Signature=ALPET74o*****c%3D\\",\\n \\"OriginalFileName\\": \\"****.gif\\",\\n \\"Width\\": 200,\\n \\"Height\\": 200,\\n \\"FileSize\\": \\"8932\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetImageInfoResponse>\\n <RequestId>AB99D4DF-FAFA-49DC-9C548C1E261E****</RequestId>\\n <ImageInfo>\\n <CreationTime>2018-11-21T02:37:23Z</CreationTime>\\n <StorageLocation>outin-****..oss-cn-shanghai.aliyuncs.com</StorageLocation>\\n <Status>Uploading</Status>\\n <CateId>254766071</CateId>\\n <Tags>tag1,tag2,tag3</Tags>\\n <ImageType>NormalSnapshot</ImageType>\\n <CateName>测试</CateName>\\n <Description>测试描述</Description>\\n <AppId>app-****</AppId>\\n <URL>http://example.aliyundoc.com/image/default/****.gif?auth_key=****</URL>\\n <Title>this is a sample</Title>\\n <ImageId>bbc65bba53f9*****ed90de118a7849</ImageId>\\n <Mezzanine>\\n <FileURL>https://outin-bfefbb*****163e1c7426.oss-cn-shanghai.aliyuncs.com/image/default/5E84CD536*****D4DAD.png?Expires=1590982353&OSSAccessKeyId=*****&Signature=ALPET74o*****c%3D</FileURL>\\n <OriginalFileName>****.gif</OriginalFileName>\\n <Width>200</Width>\\n <Height>200</Height>\\n <FileSize>8932</FileSize>\\n </Mezzanine>\\n </ImageInfo>\\n</GetImageInfoResponse>","errorExample":""}]', + 'title' => '获取单个图片信息', + 'description' => '本接口仅支持查询上传到视频点播中的图片信息；如需查询通过视频截图生成的截图信息，请调用[ListSnapshots](~~ListSnapshots~~)接口查询。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| NoSuchResource |The specified resource does not exist. |404 |图片不存在。|', + ], + 'GetImageInfos' => [ + 'summary' => '图片上传到视频点播后，可以调用本接口通过传入多个图片ID，批量获取图片的基本信息及访问地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ImageIds', + 'in' => 'query', + 'schema' => [ + 'description' => '图片ID列表，多个ID之间使用半角逗号（,）分隔，最多支持20个ID。可通过以下方式获取：'."\n" + .'- 可登录[点播控制台](https://vod.console.aliyun.com/)，选择**媒资库>图片**，查看ID。'."\n" + .'- 调用[CreateUploadImage](~~CreateUploadImage~~)获取上传地址和凭证时会返回。'."\n" + .'- 调用[SearchMedia](~~SearchMedia~~)查询图片时会返回。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bbc65bba53fed90de118a7849****,594228cdd14b4d069fc17a8c4a****', + ], + ], + [ + 'name' => 'AuthTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '图片访问地址的过期时间。单位：秒。'."\n" + ."\n" + .'- 当OutputType取值为cdn时：'."\n" + .' - 只有开启了URL鉴权的图片地址才会过期失效，否则会永久有效。'."\n" + .' - 最小值：1。'."\n" + .' - 最大值：无限制。'."\n" + .' - 默认值：未设置时，取值为URL鉴权中设置的默认有效时长。'."\n" + .'- 当OutputType取值为oss时：'."\n" + .' - 只有存储权限为私有，播放地址才会过期失效，否则会永久有效。'."\n" + .' - 最小值：1。'."\n" + .' - 最大值：为降低源站安全风险，当图片存储在点播系统Bucket上时，最大值为**2592000**（即30天），当图片存储在OSS自有Bucket上时，最大值为**129600**（即36小时）。'."\n" + .' - 默认值：未设置时，取值为3600。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'OutputType', + 'in' => 'query', + 'schema' => [ + 'description' => '输出的图片访问地址的类型。取值范围 ：'."\n" + ."\n" + .'- oss：回源地址。'."\n" + .'- cdn（默认）：加速地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'cdn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58*****', + ], + 'ImageInfo' => [ + 'description' => '图片信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '图片信息列表。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '图片创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-11-21T02:37:23Z', + ], + 'StorageLocation' => [ + 'description' => '图片文件的存储地址。', + 'type' => 'string', + 'example' => 'outin-****..oss-cn-shanghai.aliyuncs.com', + ], + 'Status' => [ + 'description' => '图片状态。取值：'."\n" + ."\n" + .'- **Uploading**：初始状态，表示图片正在上传。'."\n" + .'- **Normal**：图片上传成功。'."\n" + .'- **UploadFail**：图片上传失败。', + 'type' => 'string', + 'example' => 'Uploading', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '254766071', + ], + 'Tags' => [ + 'description' => '图片标签。多个标签之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'tag1,tag2,tag3', + ], + 'ImageType' => [ + 'description' => '图片类型。取值：'."\n" + .'- **default**：普通图片'."\n" + .'- **cover**：视频封面图', + 'type' => 'string', + 'example' => 'default', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'Description' => [ + 'description' => '图片描述。', + 'type' => 'string', + 'example' => '测试描述', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'URL' => [ + 'description' => '图片访问地址（如果配置了CDN域名则为CDN地址，否则为OSS地址）。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/image/default/****.gif?auth_key=****', + ], + 'Title' => [ + 'description' => '图片标题。', + 'type' => 'string', + 'example' => 'this is a sample', + ], + 'ImageId' => [ + 'description' => '图片ID。', + 'type' => 'string', + 'example' => 'bbc65bba53f9*****ed90de118a7849', + ], + 'Mezzanine' => [ + 'description' => '图片源信息。', + 'type' => 'object', + 'properties' => [ + 'FileURL' => [ + 'description' => '图片文件的OSS地址。', + 'type' => 'string', + 'example' => 'https://outin-bfefbb*****163e1c7426.oss-cn-XXXXXXXX.aliyuncs.com/image/default/5E84CD536*****D4DAD.png?Expires=1590982353&OSSAccessKeyId=*****&Signature=ALPET74o*****c%3D', + ], + 'OriginalFileName' => [ + 'description' => '上传的图片源文件地址。', + 'type' => 'string', + 'example' => '****.gif', + ], + 'Width' => [ + 'description' => '图片宽度。单位：像素。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Height' => [ + 'description' => '图片高度。单位：像素。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'FileSize' => [ + 'description' => '文件大小。单位：字节。', + 'type' => 'string', + 'example' => '8932', + ], + ], + ], + ], + ], + ], + 'NonExistImageIds' => [ + 'description' => '不存在的图片ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的图片ID列表。', + 'type' => 'string', + 'example' => 'f45cf4eba5c80233389558c39****', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58*****\\",\\n \\"ImageInfo\\": [\\n {\\n \\"CreationTime\\": \\"2018-11-21T02:37:23Z\\",\\n \\"StorageLocation\\": \\"outin-****..oss-cn-shanghai.aliyuncs.com\\",\\n \\"Status\\": \\"Uploading\\",\\n \\"CateId\\": 254766071,\\n \\"Tags\\": \\"tag1,tag2,tag3\\",\\n \\"ImageType\\": \\"default\\",\\n \\"CateName\\": \\"测试\\",\\n \\"Description\\": \\"测试描述\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"URL\\": \\"http://example.aliyundoc.com/image/default/****.gif?auth_key=****\\",\\n \\"Title\\": \\"this is a sample\\",\\n \\"ImageId\\": \\"bbc65bba53f9*****ed90de118a7849\\",\\n \\"Mezzanine\\": {\\n \\"FileURL\\": \\"https://outin-bfefbb*****163e1c7426.oss-cn-XXXXXXXX.aliyuncs.com/image/default/5E84CD536*****D4DAD.png?Expires=1590982353&OSSAccessKeyId=*****&Signature=ALPET74o*****c%3D\\",\\n \\"OriginalFileName\\": \\"****.gif\\",\\n \\"Width\\": 200,\\n \\"Height\\": 200,\\n \\"FileSize\\": \\"8932\\"\\n }\\n }\\n ],\\n \\"NonExistImageIds\\": [\\n \\"f45cf4eba5c80233389558c39****\\"\\n ]\\n}","type":"json"}]', + 'title' => '批量获取图片信息 ', + 'description' => '- 本接口仅支持查询上传到视频点播中的图片信息；如需查询通过视频截图生成的截图信息，请调用[ListSnapshots](~~ListSnapshots~~)接口查询。'."\n" + .'- 一次最多可查询20个图片的信息。', + ], + 'UpdateImageInfos' => [ + 'summary' => '图片上传到视频点播后，可以调用本接口通过图片ID批量修改图片的标题、描述、标签和分类信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40221', + 'abilityTreeNodes' => [ + 'FEATUREvod7B2GUR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'UpdateContent', + 'in' => 'query', + 'schema' => [ + 'description' => '更新内容。一次最多支持修改20个图片的信息。参数结构参考下表**更新内容UpdateContent**。'."\n" + ."\n" + .'> - Title、Description、Tags更新内容中不能包含表情符。'."\n" + .'>- 传入参数则更新相应字段，否则相应字段不会被覆盖或更新。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"ImageId":"ff8fe57e3461416c6a267a4e09****","Title":"标题","Description":"描述","Tags":"标签1,标签2"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'NonExistImageIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ImageId' => [ + 'description' => '不存在的图片ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的图片ID列表。', + 'type' => 'string', + 'example' => 'f45cf4eba5c80233389558c39****', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"NonExistImageIds\\": {\\n \\"ImageId\\": [\\n \\"f45cf4eba5c80233389558c39****\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateImageInfosResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <NonExistImageIds>f45cf4eba5c80233389558c39****</NonExistImageIds>\\n</UpdateImageInfosResponse>","errorExample":""}]', + 'title' => '批量更新图片信息', + 'description' => '- 本接口仅支持修改上传的图片，暂不支持修改视频截图产生的图片。'."\n" + .'- 一次最多支持修改20个图片的信息。', + 'requestParamsDescription' => '## 更新内容UpdateContent'."\n" + ."\n" + .'> UpdateContent的取值需要转为String后作为传入参数。'."\n" + ."\n" + .'| 名称 |类型 |是否必需 |描述 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| ImageId |String |是 |图片ID。可通过以下方式获取：<br>可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **图片**查看ID。<br>调用[CreateUploadImage](~~CreateUploadImage~~)接口获取上传地址和凭证时会返回。<br>调用[SearchMedia](~~SearchMedia~~)接口查询图片时会返回。|'."\n" + .'|Title |String |否 |图片标题。 长度不超过128个字节。UTF8编码。|'."\n" + .'| Description |String |否 |图片描述。长度不超过1024个字节。UTF8编码。|'."\n" + .'| Tags |String |否 |图片标签。单个标签不超过32字节。最多不超过16个标签。多个标签之间用半角逗号（,）分隔。UTF8编码。|'."\n" + .'| CateId| Long |否 |分类ID。可通过以下方式获取：<br>登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒资管理配置** > **分类管理**查看分类ID。<br>调用[AddCategory](~~AddCategory~~)接口创建分类时会返回。<br>调用[GetCategories](~~GetCategories~~)接口查询分类时会返回。|', + ], + 'ListSnapshots' => [ + 'summary' => '调用本接口可以查询通过视频截图作业生成的截图，以及视频上传时系统生成的封面截图。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40067', + 'abilityTreeNodes' => [ + 'FEATUREvodYRQNEN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID。可通过以下方式获取：'."\n" + .'- 可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 调用[CreateUploadVideo](~~CreateUploadVideo~~)接口获取上传地址和凭证时会返回。'."\n" + .'- 调用[SearchMedia](~~SearchMedia~~)接口查询视频时会返回。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd3e680e618708fbf2cae7cc931****', + ], + ], + [ + 'name' => 'SnapshotType', + 'in' => 'query', + 'schema' => [ + 'description' => '返回的截图类型。取值：'."\n" + ."\n" + .'- **CoverSnapshot**（默认值）：封面截图。'."\n" + .'- **NormalSnapshot**：普通截图。'."\n" + .'- **SpriteSnapshot**：雪碧截图。'."\n" + .'- **SpriteOriginSnapshot**：雪碧图原始图。'."\n" + .'- **WebVttSnapshot**：WebVtt截图。', + 'type' => 'string', + 'required' => false, + 'example' => 'CoverSnapshot', + ], + ], + [ + 'name' => 'AuthTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '截图访问地址的过期时间。默认值：**3600**，最小值：**3600**，单位：秒。'."\n" + ."\n" + .'- 该参数只有开启了[URL鉴权](~~57007~~)才会生效。'."\n" + .'- 当设置的时间小于**3600秒**时，默认为**3600秒**。'."\n" + .'- 如果返回的是OSS地址，为降低源站安全风险，最大值为**2592000**（即30天）。', + 'type' => 'string', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '翻页大小，每页显示条数。默认值：**20**，最大值：**100**。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '翻页页号。默认值：**1**。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'MediaSnapshot' => [ + 'description' => '视频截图数据。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '截图作业创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-12-20T12:23:45Z', + ], + 'Regular' => [ + 'description' => '截图地址生成规则。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/snapshot/sample{SnapshotCount}.jpg', + ], + 'Total' => [ + 'description' => '截图总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'JobId' => [ + 'description' => '截图作业ID。', + 'type' => 'string', + 'example' => 'ad90a501b1b9472374ad005046****', + ], + 'Snapshots' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Snapshot' => [ + 'description' => '截图详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => '截图索引值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Url' => [ + 'description' => '截图访问地址。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/snapshot/sample00001****.jpg', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"MediaSnapshot\\": {\\n \\"CreationTime\\": \\"2017-12-20T12:23:45Z\\",\\n \\"Regular\\": \\"http://example.aliyundoc.com/snapshot/sample{SnapshotCount}.jpg\\",\\n \\"Total\\": 100,\\n \\"JobId\\": \\"ad90a501b1b9472374ad005046****\\",\\n \\"Snapshots\\": {\\n \\"Snapshot\\": [\\n {\\n \\"Index\\": 1,\\n \\"Url\\": \\"http://example.aliyundoc.com/snapshot/sample00001****.jpg\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListSnapshotsResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <MediaSnapshot>\\n <CreationTime>2017-12-20T12:23:45Z</CreationTime>\\n <Regular>http://example.aliyundoc.com/snapshot/sample{SnapshotCount}.jpg</Regular>\\n <Total>100</Total>\\n <JobId>ad90a501b1b9472374ad005046****</JobId>\\n <Snapshots>\\n <Index>1</Index>\\n <Url>http://example.aliyundoc.com/snapshot/sample00001****.jpg</Url>\\n </Snapshots>\\n </MediaSnapshot>\\n</ListSnapshotsResponse>","errorExample":""}]', + 'title' => '查询视频截图数据', + 'description' => '若一个视频发起过多次视频截图，则本接口仅返回最近一次成功的截图数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidVideo.NotFound| The video does not exist.| 404 |视频不存在。|'."\n" + .'| NoSuchResource |The specified resource %s does not exist. |404 |指定资源不存在。|'."\n" + .'| Forbidden.IllegalStatus| Status of the video is illegal. |400 |视频状态无效。只有状态为**上传完成**、**正常**、**审核中**以及**屏蔽**的视频才能查询截图数据。|'."\n" + ."\n", + ], + 'DeleteImage' => [ + 'summary' => '调用本接口删除用户上传的图片或视频截图生成的图片。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39834', + 'abilityTreeNodes' => [ + 'FEATUREvod8R2V42', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DeleteImageType', + 'in' => 'query', + 'schema' => [ + 'description' => '图片删除操作类型。取值：'."\n" + ."\n" + .'- **ImageURL**：根据图片URL删除指定图片。'."\n" + .'- **ImageId**：根据图片ID删除指定图片。'."\n" + .'- **VideoId**：根据视频ID删除其关联的图片。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'VideoId', + ], + ], + [ + 'name' => 'ImageURLs', + 'in' => 'query', + 'schema' => [ + 'description' => '图片地址，为[CreateUploadImage](~~CreateUploadImage~~)接口返回参数`ImageURL`的值。支持传入多个URL，多个URL之间使用半角逗号（,）分隔，最多支持传入20个URL。'."\n" + ."\n" + .'> 当**DeleteImageType**取值为**ImageURL**时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://example.aliyundoc.com/image/default/41AE7ADABBE*****.png', + ], + ], + [ + 'name' => 'ImageIds', + 'in' => 'query', + 'schema' => [ + 'description' => '图片ID。支持传入多个ID，多个图片ID之间请使用半角逗号（,）分隔，最多支持传入20个ID。可通过以下方式获取图片ID：'."\n" + .'- 可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **图片**查看ID。'."\n" + .'- 调用[CreateUploadImage](~~CreateUploadImage~~)接口获取上传地址和凭证时会返回。'."\n" + .'- 调用[SearchMedia](~~SearchMedia~~)接口查询图片时会返回。'."\n" + ."\n" + .'> 当**DeleteImageType**取值为**ImageId**时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'bbc65bba53fed90de118a7849****,594228cdd14b4d069fc17a8c4a****', + ], + ], + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID，仅支持传入单个视频ID。可通过以下方式获取：'."\n" + .'- 可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 调用[CreateUploadVideo](~~CreateUploadVideo~~)接口获取上传地址和凭证时会返回。'."\n" + .'- 调用[SearchMedia](~~SearchMedia~~)接口查询视频时会返回。'."\n" + ."\n" + .'>当**DeleteImageType**取值为**VideoId**时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'eb1861d2c9a8842340e989dd56****', + ], + ], + [ + 'name' => 'ImageType', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的视频关联的图片类型。取值：'."\n" + ."\n" + .'- **CoverSnapshot**：封面截图。'."\n" + .'- **NormalSnapshot**：普通截图。'."\n" + .'- **SpriteSnapshot**：雪碧截图。'."\n" + .'- **SpriteOriginSnapshot**：雪碧图原始图。'."\n" + .'- **All**：以上所有类型的图片。取值为非`All`时，支持选择以上多个图片类型，多个取值之间使用半角逗号（,）分隔。'."\n" + ."\n" + .'>当**DeleteImageType**取值为**VideoId**时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'All', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteImageResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n</DeleteImageResponse>","errorExample":""}]', + 'title' => '删除图片或视频截图', + 'description' => '- **调用本接口删除图片时，会真正删除源文件，且不可逆，一旦删除，图片无法找回，请谨慎操作。**'."\n" + .'- 当**DeleteImageType**取值为**VideoId**时，**VideoId**、**ImageType**才可用且必须传入。 '."\n" + .'- 当**DeleteImageType**取值为**ImageURL**时，**ImageIds**、**ImageURLs**才可用且必须传入。 '."\n" + .'- 调用本接口删除图片后，某些情况存在CDN缓存，可能出现图片URL不会立即失效的现象。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| NoSuchResource |The specified resource does not exist. |404 |图片信息不存在。|'."\n", + ], + 'ListDynamicImage' => [ + 'summary' => '调用本接口，通过视频ID查询视频截动图列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40053', + 'abilityTreeNodes' => [ + 'FEATUREvodYRQNEN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[获取视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，视频ID为返回参数VideoId的值。'."\n" + .'- 视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2e114f1100590c3193918fd449a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '570189B6-572E-4953-13B4278EE0D8****', + ], + 'DynamicImageList' => [ + 'description' => '动图结果。', + 'type' => 'array', + 'items' => [ + 'description' => '动图详情。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '动图创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2020-07-28T02:01:06Z', + ], + 'FileURL' => [ + 'description' => '动图文件地址。', + 'type' => 'string', + 'example' => 'https://example.aliyundoc.com/2e114f110059*****0c3193918fd449a/image/dynamic/2b4e51df60*****323ef43d6e336ecf.webp?auth_key=1597296785-0-0-4a48e85*****bd2bb358e0b3cade', + ], + 'VideoId' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'example' => '2e114f1100590c3193918fd449a****', + ], + 'Width' => [ + 'description' => '动图宽。单位：px。', + 'type' => 'string', + 'example' => '640', + ], + 'JobId' => [ + 'description' => '动图作业ID。', + 'type' => 'string', + 'example' => '2bf4390af9e5491c09cc720ad****', + ], + 'Height' => [ + 'description' => '动图高。单位：px。', + 'type' => 'string', + 'example' => '360', + ], + 'Fps' => [ + 'description' => '动图帧率。单位：帧/每秒。', + 'type' => 'string', + 'example' => '10', + ], + 'Duration' => [ + 'description' => '动图时长。单位：秒。', + 'type' => 'string', + 'example' => '2', + ], + 'Format' => [ + 'description' => '动图格式，取值：'."\n" + .'- **gif**。'."\n" + .'- **webp**。', + 'type' => 'string', + 'example' => 'webp', + ], + 'DynamicImageId' => [ + 'description' => '动图ID。', + 'type' => 'string', + 'example' => '2b4e51df60323ef43d6e336ecf****', + ], + 'FileSize' => [ + 'description' => '动图文件大小。单位：Byte。', + 'type' => 'string', + 'example' => '119866', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"570189B6-572E-4953-13B4278EE0D8****\\",\\n \\"DynamicImageList\\": [\\n {\\n \\"CreationTime\\": \\"2020-07-28T02:01:06Z\\",\\n \\"FileURL\\": \\"https://example.aliyundoc.com/2e114f110059*****0c3193918fd449a/image/dynamic/2b4e51df60*****323ef43d6e336ecf.webp?auth_key=1597296785-0-0-4a48e85*****bd2bb358e0b3cade\\",\\n \\"VideoId\\": \\"2e114f1100590c3193918fd449a****\\",\\n \\"Width\\": \\"640\\",\\n \\"JobId\\": \\"2bf4390af9e5491c09cc720ad****\\",\\n \\"Height\\": \\"360\\",\\n \\"Fps\\": \\"10\\",\\n \\"Duration\\": \\"2\\",\\n \\"Format\\": \\"webp\\",\\n \\"DynamicImageId\\": \\"2b4e51df60323ef43d6e336ecf****\\",\\n \\"FileSize\\": \\"119866\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListDynamicImageResponse>\\n <RequestId>570189B6-572E-4953-13B4278EE0D8****</RequestId>\\n <DynamicImageList>\\n <CreationTime>2020-07-28T02:01:06Z</CreationTime>\\n <FileURL>https://example.aliyundoc.com/2e114f110059*****0c3193918fd449a/image/dynamic/2b4e51df60*****323ef43d6e336ecf.webp?auth_key=1597296785-0-0-4a48e85*****bd2bb358e0b3cade</FileURL>\\n <VideoId>2e114f1100590c3193918fd449a****</VideoId>\\n <Width>640</Width>\\n <JobId>2bf4390af9e5491c09cc720ad****</JobId>\\n <Height>360</Height>\\n <Fps>10</Fps>\\n <Duration>2</Duration>\\n <Format>webp</Format>\\n <DynamicImageId>2b4e51df60323ef43d6e336ecf****</DynamicImageId>\\n <FileSize>119866</FileSize>\\n </DynamicImageList>\\n</ListDynamicImageResponse>","errorExample":""}]', + 'title' => '查询动图列表', + 'description' => '### 使用说明'."\n" + .'- 视频动图截取完成后，可以调用本接口来获取视频的动图信息。'."\n" + .'- 视频动图任务可通过API（[提交媒体动图作业](~~186842~~)接口）或控制台发起，更多内容，请参见[视频动图](~~177484~~)。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDynamicImage' => [ + 'summary' => '调用本接口删除动图信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39831', + 'abilityTreeNodes' => [ + 'FEATUREvod3O95DN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的动图所关联的视频ID。视频ID可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[获取视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，视频ID为返回参数VideoId的值。'."\n" + .'- 视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2321077d460b028700ef6c2f4d****', + ], + ], + [ + 'name' => 'DynamicImageIds', + 'in' => 'query', + 'schema' => [ + 'description' => '动图文件ID列表。动图文件ID为[查询动图列表](~~180958~~)接口返回参数DynamicImageId的值。'."\n" + ."\n" + .'- 多个ID之间使用半角逗号（,）分隔，最多支持10个ID。'."\n" + .'- **如果不传该参数，将按VideoId删除视频下的所有动图，但是如果视频下的动图数量超过10个，将拒绝删除请求。**', + 'type' => 'string', + 'required' => false, + 'example' => 'beafec3834a4e52ea52042a4****,8281c8519847fd8970e79e80b6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0C8F0FDD-A99F-4188-B41934C97A54****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C8F0FDD-A99F-4188-B41934C97A54****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDynamicImageResponse>\\n <RequestId>0C8F0FDD-A99F-4188-B41934C97A54****</RequestId>\\n</DeleteDynamicImageResponse>","errorExample":""}]', + 'title' => '删除动图信息', + 'description' => '- 本接口只会删除动图与视频的关联关系，并不会实际删除动图文件。'."\n" + .'- 关联关系删除之后，将无法通过[查询动图列表](~~180958~~)接口查询到视频下已被删除的动图信息。'."\n" + .'- 如果不传**DynamicImageIds**，将按VideoId删除视频下的所有动图，但是如果视频下的动图数量超过10个，将拒绝删除请求。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SubmitTranscodeJobs' => [ + 'summary' => '调用本接口提交媒体转码作业，开始异步转码处理。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40196', + 'abilityTreeNodes' => [ + 'FEATUREvodAFH3DF', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[CreateUploadVideo](~~55407~~)接口上传视频时，视频ID为返回参数VideoId的值。'."\n" + .'- 视频上传后，可通过[SearchMedia](~~86044~~)接口查询视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '142710f878bd42508932f660d7b1****', + ], + ], + [ + 'name' => 'TemplateGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频转码时使用的转码组ID。使用指定的模板组进行转码，您可以登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** >**媒体处理配置** > **转码模板组**查看模版组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0e408c803baf658ee637790c5d9f****', + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => '管道ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'd3e680e618708erf45fbf2cae7c****', + ], + ], + [ + 'name' => 'EncryptConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '加密配置，为JSON字符串，只有使用HLS标准加密时才需要此参数。'."\n" + ."\n" + .'> - [EncryptConfig](~~86952~~)结构体中**CipherText**参数必须为通过[GenerateKMSDataKey](~~455051~~)生成的AES_128密文密钥，否则标准加密转码失败。标准加密接入流程，请参见[HLS标准加密](~~68612~~)。'."\n" + .'> - 无论标准加密、私有加密，**TemplateGroupId**对应的模板数据，必须都勾选HLS加密选项，否则不加密。', + 'type' => 'string', + 'required' => false, + 'example' => '{"CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk3****", "DecryptKeyUri":"http://demo.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3****","KeyServiceType":"KMS"}', + ], + ], + [ + 'name' => 'OverrideParams', + 'in' => 'query', + 'schema' => [ + 'description' => '覆盖参数（JSON字符串），支持对转码模板关联的指定图片水印文件、文字水印内容、字幕文件地址以及字幕文件编码格式的覆盖。参数结构详情，请参见[OverrideParams](~~98618~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Watermarks":[{"WatermarkId":"af2afe4761992c47dae973374****","FileUrl":"http://developer.aliyundoc.com/image/image.png"},{"WatermarkId":"e8e5b8038d7ada85b376c2707****","Content":"watermark test"}]}', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => '当前发起的转码作业在所有排队作业中的优先级。'."\n" + ."\n" + .'- 取值范围：**1**~**10**。'."\n" + .'- 最高优先级：**10**。'."\n" + .'- 默认值：**6**。'."\n" + ."\n" + .'> Priority参数只影响当前发起的转码作业在所有排队状态作业中的优先级，但不影响已经转码处理中的任务优先级。', + 'type' => 'string', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置。为JSON字符串，支持消息回调等设置。具体详情，请参见[UserData](~~86952~~)。'."\n" + ."\n" + .'> 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用，否则回调设置不生效。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Extend":{"localId":"****","test":"***"}}', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义去重识别码，如果7天内曾有过相同的识别码的请求，则本次的请求会返回错误。'."\n" + .'长度最长为50个字符，支持大小写英文字母、数字、短划线（-）和下划线（_），不传或者带空字符串表示不去重。', + 'type' => 'string', + 'required' => false, + 'example' => '5c62d40299034bbaa4c195da330****', + ], + ], + [ + 'name' => 'ReferenceId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'description' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TranscodeTaskId' => [ + 'description' => '当前提交的转码任务ID。', + 'type' => 'string', + 'example' => '9f4a0df7da2c8a81c8c0408c84****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E4EBD2BF-5EB0-4476-8829-9D94E1B1****', + ], + 'TranscodeJobs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TranscodeJob' => [ + 'description' => '媒体作业信息。'."\n" + ."\n" + .'> HLS多码率自适应打包任务不会返回该参数，需要异步接收回调处理结果。', + 'type' => 'array', + 'items' => [ + 'description' => '媒体作业详情。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '作业ID。'."\n" + ."\n" + .'> HLS多码率自适应打包任务不会返回该参数，需要异步接收回调处理结果。', + 'type' => 'string', + 'example' => 'd8921ce8505716cfe86fb112c4****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TranscodeTaskId\\": \\"9f4a0df7da2c8a81c8c0408c84****\\",\\n \\"RequestId\\": \\"E4EBD2BF-5EB0-4476-8829-9D94E1B1****\\",\\n \\"TranscodeJobs\\": {\\n \\"TranscodeJob\\": [\\n {\\n \\"JobId\\": \\"d8921ce8505716cfe86fb112c4****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SubmitTranscodeJobsResponse>\\n <TranscodeTaskId>9f4a0df7da2c8a81c8c0408c84****</TranscodeTaskId>\\n <RequestId>E4EBD2BF-5EB0-4476-8829-9D94E1B1****</RequestId>\\n <TranscodeJobs>\\n <JobId>d8921ce8505716cfe86fb112c4****</JobId>\\n </TranscodeJobs>\\n</SubmitTranscodeJobsResponse>","errorExample":""}]', + 'title' => '提交媒体转码作业', + 'description' => '### 使用说明'."\n" + .'- **请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。转码为付费功能，计费详情，请参见[媒资转码计费](~~188308#section-ejb-nii-nqa~~)。**'."\n" + .'- 只有状态为上传完成、正常和审核中的视频才能发起转码。'."\n" + .'- 如需要获取转码结果，可接收回调消息：[单个清晰度转码完成](~~55636~~)、 [全部转码完成](~~55638~~)。'."\n" + .'- 该接口可支持HLS自适应码流打包任务中对字幕地址进行动态替换，如打包任务无字幕打包处理，不建议采用该接口发起任务处理，而建议视频上传时设置对应的打包模板组ID即可自动发起打包流程。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidVideo.NotFound |The video does not exist. |404 |视频不存在。|'."\n" + .'| NoSuchResource |The specified resource %s does not exist. |404 |用户相关的资源数据不存在， %s表示具体资源信息。|'."\n" + .'| Forbidden.IllegalStatus |Status of the video is illegal. |400 |视频状态无效。只有状态为**上传完成**、**正常**和**审核中**的视频才能发起转码。|'."\n" + ."\n\n", + ], + 'SubmitSnapshotJob' => [ + 'summary' => '调用本接口提交视频截图作业，开始异步截图处理。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40195', + 'abilityTreeNodes' => [ + 'FEATUREvodFAR72I', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[获取视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，视频ID为返回参数VideoId的值。'."\n" + .'- 视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'd3e680e618708efbf2cae7cc9312****', + ], + ], + [ + 'name' => 'SpecifiedOffsetTime', + 'in' => 'query', + 'schema' => [ + 'description' => '截图指定时间的起始点。'."\n" + ."\n" + .'- 单位：毫秒。'."\n" + .'- 默认值：**0**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Width', + 'in' => 'query', + 'schema' => [ + 'description' => '截图宽，取值范围：`[8,4096]`，默认原片宽，单位：px。', + 'type' => 'string', + 'required' => false, + 'example' => '1280', + ], + ], + [ + 'name' => 'Height', + 'in' => 'query', + 'schema' => [ + 'description' => '截图高，取值范围：`[8,4096]`，默认原片高，单位：px。', + 'type' => 'string', + 'required' => false, + 'example' => '720', + ], + ], + [ + 'name' => 'Count', + 'in' => 'query', + 'schema' => [ + 'description' => '截图的最大数量。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '截图的间隔时间，必须**大于或等于0**。'."\n" + .'- 单位：秒。'."\n" + .'- 默认值：**1**。'."\n" + .'- Interval为**0**时，表示按照Count数根据视频时长平均截图。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SpriteSnapshotConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '生成雪碧图的配置信息。如果不为空则生成雪碧图。参数结构详情，请参见[SpriteSnapshotConfig ](~~86952~~) 。', + 'type' => 'string', + 'required' => false, + 'example' => '{\'CellWidth\': 120, \'CellHeight\': 68, \'Columns\': 3,\'Lines\': 10, \'Padding\': 20, \'Margin\': 50}', + ], + ], + [ + 'name' => 'SnapshotTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '截图模板ID。'."\n" + .'- 推荐先创建截图模板，再传递截图模板ID。截图模板创建详情，请参见[添加截图模板](~~99406~~)。'."\n" + .'- 如果传递截图模板ID，会忽略除Action、VideoId之外的请求参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'f5b228fe693bf55bd87b789****', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置。仅支持JSON字符串，支持用户自定义数据透传及指定回调地址设置等。参数结构详情，请参见[UserData](~~86952~~)。'."\n" + ."\n" + .'> 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用，否则回调设置不生效。', + 'type' => 'string', + 'required' => false, + 'example' => '{"MessageCallback":{"CallbackURL":"http://.example.aliyundoc.com"},"Extend":{"localId":"xxx","example":"www"}}', + ], + ], + [ + 'name' => 'SpecifiedOffsetTimes', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '指定视频时间点进行截图，单位：毫秒。一次可指定最多30个时间点。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义时间点，毫秒', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + 'required' => false, + 'example' => '123-123', + ], + ], + [ + 'name' => 'ReferenceId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义 ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'description' => '自定义 ID，仅支持小写字母、大写字母、数字、横线、下划线，长度 6-64 位。用户维度唯一。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-5EB0-4AF6-D7393642****', + ], + 'SnapshotJob' => [ + 'description' => '截图作业信息。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '截图作业ID。', + 'type' => 'string', + 'example' => 'ad90a501b1b94b72374ad0050464****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-5EB0-4AF6-D7393642****\\",\\n \\"SnapshotJob\\": {\\n \\"JobId\\": \\"ad90a501b1b94b72374ad0050464****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<SubmitSnapshotJobResponse>\\n <RequestId>25818875-5F78-5EB0-4AF6-D7393642****</RequestId>\\n <SnapshotJob>\\n <JobId>ad90a501b1b94b72374ad0050464****</JobId>\\n </SnapshotJob>\\n</SubmitSnapshotJobResponse>","errorExample":""}]', + 'title' => '提交媒体截图作业', + 'description' => '- 暂时只支持生成JPG格式的图片。'."\n" + .'- 截图完成会产生EventType=SnapshotComplete,SubType=SpecifiedTime的[视频截图完成](~~57337~~)的事件通知。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'requestParamsDescription' => '> Count和Interval至少指定一个，若同时指定，截图数目以少者为准。'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidVideo.NotFound |The video does not exist. |404 |视频不存在。|'."\n" + .'| NoSuchResource |The specified resource %s does not exist. |404 |指定资源不存在。|'."\n" + .'| Forbidden.IllegalStatus |Status of the video is illegal. |400 |视频状态无效。只有状态为**上传完成**、**正常**、**审核中**以及**屏蔽**的视频才能发起截图。|', + ], + 'SubmitPreprocessJobs' => [ + 'summary' => '调用本接口通过导播台对视频进行转码处理。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40191', + 'abilityTreeNodes' => [ + 'FEATUREvodAFH3DF', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[CreateUploadVideo](~~55407~~)接口上传视频时，视频ID为返回参数VideoId的值。'."\n" + .'- 视频上传后，可通过[SearchMedia](~~86044~~)接口查询视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd3e680e618708efbf2cae7cc9312****', + ], + ], + [ + 'name' => 'PreprocessType', + 'in' => 'query', + 'schema' => [ + 'description' => '预处理类型。取固定值：**LivePreprocess**（导播台视频预处理）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'LivePreprocess', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E4EBD2BF-5EB0-4476-8829-9D94E1B1****', + ], + 'PreprocessJobs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PreprocessJob' => [ + 'description' => '作业信息。', + 'type' => 'array', + 'items' => [ + 'description' => '作业详情。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => 'bb396607fd11fee9effbb99c4****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4EBD2BF-5EB0-4476-8829-9D94E1B1****\\",\\n \\"PreprocessJobs\\": {\\n \\"PreprocessJob\\": [\\n {\\n \\"JobId\\": \\"bb396607fd11fee9effbb99c4****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SubmitPreprocessJobsResponse>\\n <RequestId>E4EBD2BF-5EB0-4476-8829-9D94E1B1****</RequestId>\\n <PreprocessJobs>\\n <JobId>bb396607fd11fee9effbb99c4****</JobId>\\n </PreprocessJobs>\\n</SubmitPreprocessJobsResponse>","errorExample":""}]', + 'title' => '导播台视频预处理', + 'description' => '- 视频预处理实际是转码过程，生成符合导播台播放要求的视频，所以会有**计量计费**信息产生，计费详情请参见[云导播费用](~~64531~~)。'."\n" + .'- 为满足导播台对于素材的质量要求，MP4格式且短边是360的视频必须满足以下至少一项才能发起预处理：分辨率超过1920/比特率超过6000 kbps/帧数超过25。'."\n" + .'- 接收[转码完成](~~55638~~)的回调消息，来获取处理结果。当回调消息**Preprocess=true**时，表示预处理完成回调。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidVideo.NotFound |The video does not exist. |404 |视频不存在。|'."\n" + .'| NoSuchResource| The specified resource %s does not exist. |404 |指定资源不存在。|'."\n" + .'| Forbidden.IllegalStatus| Status of the video is illegal. |400 |视频状态无效。只有状态为**上传完成**、**正常**、**审核中**以及**转码中**的视频才能发起视频预处理。|'."\n", + ], + 'SubmitDynamicImageJob' => [ + 'summary' => '调用本接口提交媒体动图作业，开始异步处理。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40185', + 'abilityTreeNodes' => [ + 'FEATUREvodFAR72I', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID。可通过以下方式获取：'."\n" + ."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[获取视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，视频ID为返回参数VideoId的值。'."\n" + .'- 视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '7d2fbc3e273441bdb0e08e55f8****', + ], + ], + [ + 'name' => 'DynamicImageTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '动图模板ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1a443dc52ef10abc4794d700*****', + ], + ], + [ + 'name' => 'OverrideParams', + 'in' => 'query', + 'schema' => [ + 'description' => '覆盖参数（JSON字符串）。具体详情，请参见[OverrideParams](~~98618~~)。支持对动图模板配置中的参数进行覆盖。具体内容，请参见[DynamicImageTemplateConfig](~~52839~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Watermarks":[{"Content":"UserID: 666**","WatermarkId":"8ca03c884944bd05efccc312367****"}]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-74A6-BEF6-D7393642****', + ], + 'DynamicImageJob' => [ + 'description' => '动图作业信息。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '动图作业ID。', + 'type' => 'string', + 'example' => 'ad90a501b1bfb72374ad0050746****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-74A6-BEF6-D7393642****\\",\\n \\"DynamicImageJob\\": {\\n \\"JobId\\": \\"ad90a501b1bfb72374ad0050746****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<SubmitDynamicImageJobResponse>\\n <RequestId>25818875-5F78-74A6-BEF6-D7393642****</RequestId>\\n <DynamicImageJob>\\n <JobId>ad90a501b1bfb72374ad0050746****</JobId>\\n </DynamicImageJob>\\n</SubmitDynamicImageJobResponse>","errorExample":""}]', + 'title' => '提交媒体动图作业', + 'description' => '### 使用说明'."\n" + .'- 只有状态为**上传完成**、**转码中**、**正常**、**审核中**和**屏蔽**的视频才能发起动图作业。'."\n" + .'- 动图生产计入视频转码费用，且计费标准一致，按照分辨率和时长计费。具体收费详情，请参见[媒资转码计费](~~188308~~)。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidVideo.NotFound |The video does not exist. |404 |视频不存在。|'."\n" + .'| NoSuchResource |The specified resource %s does not exist. |404 |用户相关的资源数据不存在， %s表示具体资源信息。|'."\n" + .'| Forbidden.IllegalStatus| Status of the video is illegal. |400 |视频状态无效。只有状态为**上传完成**、**转码中**、**正常**、**审核中**和**屏蔽**的视频才能发起动图作业。|', + ], + 'SubmitWorkflowJob' => [ + 'summary' => '对视频发起点播工作流处理。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40198', + 'abilityTreeNodes' => [ + 'FEATUREvodR23QUR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'WorkflowId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流ID。可登录[点播控制台](https://vod.console.aliyun.com)，选择**配置管理** > **媒体处理配置** > **工作流管理**查看ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '34d577eade633860bdf1237****', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID，即视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[获取视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，视频ID为返回参数VideoId的值。'."\n" + .'- 视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '058b39e75269da42b08f00459****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A01C8FF4-C106-4431-418F973DADB7****', + ], + 'TaskId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A01C8FF4-C106-4431-418F973DADB7****\\",\\n \\"TaskId\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitWorkflowJobResponse>\\n <RequestId>A01C8FF4-C106-4431-418F973DADB7****</RequestId>\\n</SubmitWorkflowJobResponse>","errorExample":""}]', + 'title' => '提交点播工作流作业', + 'description' => '- **请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。使用工作流过程中，可能涉及产生转码、加密、智能审核等费用，计费详情，请参见[视频点播计费概述](~~188307~~)。**'."\n" + .'- 调用本接口，可对视频发起工作流处理任务。有关工作流的更多内容，请参见[工作流](~~115347~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddTranscodeTemplateGroup' => [ + 'summary' => '调用本接口添加转码配置信息，可创建新的转码模板组，或者向指定模板组中添加新的转码模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39789', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板组名称。'."\n" + ."\n" + .'- 长度不超过128个字节。'."\n" + .'- UTF-8编码。'."\n" + .'> TranscodeTemplateGroupId和Name必须传递一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'transcodetemplate', + ], + ], + [ + 'name' => 'TranscodeTemplateList', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板配置信息（JSON字符串）。参数结构详情，请参见[TranscodeTemplate](~~52839~~)。'."\n" + .'>- 该参数不传递，则不会构建转码处理流程，视频上传不会触发转码。'."\n" + .'>- 如果不需要设置Width或者Height属性，则不传相应属性即可，请不要设置为空串，例如："Height":""。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Video":{"Bitrate":"400","Codec":"H.264","Fps":"30","Height":360,"Width":640},"Definition":"SD","Container":{"Format":"mp4"},"TemplateName":"testName","MuxConfig":{},"Audio":{"Codec":"AAC","Bitrate":"64","Samplerate":"44100"}}]', + ], + ], + [ + 'name' => 'TranscodeTemplateGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板组ID。若指定了转码模板组ID，则可向指定的模板组中添加新的转码模板。'."\n" + .'> TranscodeTemplateGroupId和Name必须传递一个。', + 'type' => 'string', + 'required' => false, + 'example' => '4c71a339fe52b4fa6f4527****', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。默认取值： **app-1000000**。使用说明，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'TranscodeTemplateGroupId' => [ + 'description' => '转码模板组ID。', + 'type' => 'string', + 'example' => '34e908aa4024af7821c31f93a2a****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TranscodeTemplateGroupId\\": \\"34e908aa4024af7821c31f93a2a****\\",\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddTranscodeTemplateGroupResponse>\\r\\n\\t<RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\r\\n\\t<TranscodeTemplateGroupId>34e908aa4024a*****f7821c31f93a2a</TranscodeTemplateGroupId>\\r\\n</AddTranscodeTemplateGroupResponse>","errorExample":""}]', + 'title' => '创建转码模板组', + 'description' => '- 被视频点播后台**锁定**的转码模板组不支持自定义操作，您可以调用[GetTranscodeTemplateGroup](~~GetTranscodeTemplateGroup~~)接口查询模板配置，通过返回的响应参数Locked，查看模板组是否被锁定；您可以调用[UpdateTranscodeTemplateGroup](~~UpdateTranscodeTemplateGroup~~)接口将模板解锁后，再进行更改等操作。'."\n" + .'- 由于转码涉及到文件的存储地址，因此如果没有可以正常使用的存储地址，暂不支持添加转码模板组（您可以在**视频点播控制台 > 配置管理 > 媒资管理配置 > 存储管理**中，激活**点播系统bucket**获取可用的存储地址）。'."\n" + .'- **不转码**模板组，不允许追加转码模板配置信息。'."\n" + .'- **TranscodeTemplateGroupId**和**Name**必须传递一个。'."\n" + .'- 支持最多创建20个转码模板组。'."\n" + .'- 一个转码模板组支持最多添加20个转码模板配置。'."\n" + .'- 若需要通过转码生成多码率自适应流地址时，一个转码模板组中支持最多添加10个视频打包模板 ，若超过10个，则只会生成各码流地址，不会生成自适应流地址。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidStorage.NotFound| The storage info dose not exist. |404| 不存在存储地址数据。|'."\n" + .'| InvalidTranscodeTemplateGroup.NotFound| The transcode template group does not exist. |404 |指定的转码模板组不存在。|'."\n" + .'| Forbidden.LockedTemplateGroup |The transcode template group has been locked. |403| 指定的模板组被锁定，不可操作，请联系点播后台。|'."\n" + .'| Forbidden.SpecialTemplateGroup| The transcode template group is using for special purpose. |403| 特殊用途转码模板组，不允许追加转码模板配置，例如：不转码即分发模板组、仅存储模板组。|'."\n" + .'| TrasncodeTemplateGroupExceededMax| The transcode template group size exceeded maximum. |400| 转码模板组数据达到上限，转码模板组最大支持创建20个。|'."\n" + .'| TranscodeTemplateExceededMax| The template transcode template config size exceeded maximum. |400| 转码模板组关联的转码模板配置数据达到上限，最大支持关联20个转码模板配置。|'."\n" + .'| WatermarkExceededMax |The watermark size exceeded maximum. |400| 转码模板组下单个转码模板能关联的水印ID数达到上限，最大支持关联4个水印ID。|'."\n", + ], + 'UpdateTranscodeTemplateGroup' => [ + 'summary' => '调用本接口修改转码配置信息，可修改转码模板组下指定的转码模板配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40227', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板组名称。'."\n" + ."\n" + .'- 长度不超过128个字节。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'transcodetemplate', + ], + ], + [ + 'name' => 'TranscodeTemplateList', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板配置信息（JSON字符串）。参数结构详情，请参见[TranscodeTemplate](~~52839#title-9mb-8o2-uu6~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Video":{"Bitrate":"400","Codec":"H.264","Fps":"30"},"Audio":{"Codec":"AAC","Bitrate":"64","Definition":"SD","EncryptType":"Private","Container":{"Format":"m3u8"},"PackageType":"HLSPackage"}}]', + ], + ], + [ + 'name' => 'Locked', + 'in' => 'query', + 'schema' => [ + 'description' => '模板组锁定状态。取值范围：'."\n" + ."\n" + .'- **Enabled**：锁定，处于锁定状态的模板组将无法被修改。'."\n" + .'- **Disabled**（默认）：不锁定。'."\n" + ."\n" + .'默认值为**Disabled**，传参时将修改模板组锁定状态，转码模板组名称和配置保持不变。', + 'type' => 'string', + 'required' => false, + 'example' => 'Disabled', + ], + ], + [ + 'name' => 'TranscodeTemplateGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '4c71a339fe*****52b4fa6f4527', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TranscodeTemplateGroupId' => [ + 'description' => '转码模板组ID。', + 'type' => 'string', + 'example' => '34e908aa4024a*****f7821c31f93a2a', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TranscodeTemplateGroupId\\": \\"34e908aa4024a*****f7821c31f93a2a\\",\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateTranscodeTemplateGroupResponse>\\n <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\n <TranscodeTemplateGroupId>34e908aa4024a*****f7821c31f93a2a</TranscodeTemplateGroupId>\\n</UpdateTranscodeTemplateGroupResponse>","errorExample":""}]', + 'title' => '修改转码配置', + 'description' => '出于安全保护目的，处于锁定状态的转码模板组不能进行添加、修改、删除等操作。您可以调用[GetTranscodeTemplateGroup](~~GetTranscodeTemplateGroup~~)接口查询模板配置，通过返回的响应参数Locked，查看模板组是否被锁定；或调用本接口将模板组解锁后，再进行添加、修改、删除等操作。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidStorage.NotFound| The storage info dose not exist.| 404 |不存在存储地址数据。|'."\n" + .'| InvalidTranscodeTemplateGroup.NotFound |The transcode template group does not exist. |404|指定的转码模板组不存在。|'."\n" + .'| Forbidden.LockedTemplateGroup |The transcode template group has been locked. |403| 指定的模板组被锁定，不可操作，请联系点播后台。|'."\n" + ."\n", + ], + 'SetDefaultTranscodeTemplateGroup' => [ + 'summary' => '调用本接口设置默认转码模板配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40136', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TranscodeTemplateGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd58079958be8d*****b699ab7ab6e1bf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\"\\n}","errorExample":""},{"type":"xml","example":"<SetDefaultTranscodeTemplateGroupResponse>\\r\\n <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\r\\n</SetDefaultTranscodeTemplateGroupResponse>","errorExample":""}]', + 'title' => '设置默认转码配置', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'|InvalidTranscodeTemplateGroup.NotFound| The transcode template group does not exist. |404| 指定的转码模板组不存在。|'."\n" + ."\n", + ], + 'ListTranscodeTemplateGroup' => [ + 'summary' => '调用本接口查询转码模板配置列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40075', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。默认取值**app-1000000**。使用说明，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'TranscodeTemplateGroupList' => [ + 'description' => '转码模板组数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '模板组的创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2018-12-05T10:20:09Z', + ], + 'IsDefault' => [ + 'description' => '是否是默认模板组。取值：'."\n" + ."\n" + .'- **Default**：默认模板组。'."\n" + .'- **NotDefault**：非默认模板组。', + 'type' => 'string', + 'example' => 'Default', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'TranscodeTemplateGroupId' => [ + 'description' => '转码模板组ID。', + 'type' => 'string', + 'example' => '17a9889fc66852*****d791c886700932', + ], + 'Name' => [ + 'description' => '模板组的名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ModifyTime' => [ + 'description' => '模板组的修改时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2018-12-05T10:22:09Z', + ], + 'Locked' => [ + 'description' => '转码模板组锁定状态。取值：'."\n" + .'- **Disabled**：未锁定'."\n" + .'- **Enabled**：锁定', + 'type' => 'string', + 'example' => 'Disabled', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"TranscodeTemplateGroupList\\": [\\n {\\n \\"CreationTime\\": \\"2018-12-05T10:20:09Z\\",\\n \\"IsDefault\\": \\"Default\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"TranscodeTemplateGroupId\\": \\"17a9889fc66852*****d791c886700932\\",\\n \\"Name\\": \\"test\\",\\n \\"ModifyTime\\": \\"2018-12-05T10:22:09Z\\",\\n \\"Locked\\": \\"Disabled\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListTranscodeTemplateGroupResponse>\\n<RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\n<TranscodeTemplateGroupList>\\n <IsDefault>Default</IsDefault>\\n <Locked>Disabled</Locked>\\n <ModifyTime>2018-12-05T10:22:09Z</ModifyTime>\\n <AppId>app-****</AppId>\\n <TranscodeMode>FastTranscode</TranscodeMode>\\n <TranscodeTemplateGroupId>17a9889fc66852*****d791c886700932</TranscodeTemplateGroupId>\\n <CreationTime>2018-12-05T10:20:09Z</CreationTime>\\n <Name>test</Name>\\n</TranscodeTemplateGroupList>\\n</ListTranscodeTemplateGroupResponse>","errorExample":""}]', + 'title' => '查询转码配置列表', + 'description' => '> 该接口不会返回每个转码模板组下的转码模板配置信息，您可以通过[查询单个转码模板组](~~102670~~)接口获取。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetTranscodeTemplateGroup' => [ + 'summary' => '根据转码模板组ID查询转码配置的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39986', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TranscodeTemplateGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a591f697c7167*****6ae1502142d0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6730AC93-7B12-4B*****7F-49EE1FE8BC49', + ], + 'TranscodeTemplateGroup' => [ + 'description' => '转码模板组数据。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '模板组的创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-12-12T10:20:51Z', + ], + 'IsDefault' => [ + 'description' => '是否是默认模板组。取值：'."\n" + ."\n" + .'- **Default**：默认模板组。'."\n" + .'- **NotDefault**：非默认模板组。', + 'type' => 'string', + 'example' => 'NotDefault', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'TranscodeTemplateGroupId' => [ + 'description' => '转码模板组ID。', + 'type' => 'string', + 'example' => 'a59b11f697c716*****6ae1502142d0', + ], + 'Name' => [ + 'description' => '模板组的名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ModifyTime' => [ + 'description' => '模板组的修改时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-12-12T11:20:51Z', + ], + 'Locked' => [ + 'description' => '模板组是否处于锁定状态。取值：'."\n" + .'- **Disabled**：未锁定'."\n" + .'- **Enabled**：锁定', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'TranscodeTemplateList' => [ + 'description' => '转码模板配置信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '模板类型，取值：'."\n" + ."\n" + .'- **Normal**（默认）：正常转码模板。该类型模板不能设置PackageSetting参数。'."\n" + .'- **VideoPackage**：视频流打包模板。该类型模板会先转码，后构建自适应码流，且必须要配置PackageSetting参数。'."\n" + .'- **SubtitlePackage**：字幕打包模板。该类型模板不会转码，仅将对应字幕信息构建到自适应码率输出文件中，且必须要设置PackageSetting参数。但该类型模板不能在模板组中单独存在，需要与VideoPackage类型模板一同配置（一个模板组仅能配置一个该类型模板）。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Video' => [ + 'description' => '视频流转码配置参数（JSON字符串）。', + 'type' => 'string', + 'example' => '{"Codec":"H.264","Bitrate":"900","Width":"960","Remove":"false","Fps":"30"}', + ], + 'TransConfig' => [ + 'description' => '条件转码参数。如需要根据源片码率、分辨率进行基本逻辑判断再输出转码视频，则可设置该参数 （JSON字符串）。', + 'type' => 'string', + 'example' => '{"IsCheckReso":"true","IsCheckResoFail":"false","IsCheckVideoBitrate":"false","IsCheckVideoBitrateFail":"false","IsCheckAudioBitrate":"false","IsCheckAudioBitrateFail":"false"}', + ], + 'Rotate' => [ + 'description' => '视频旋转标参数。控制画面的旋转角度，例如：设置180，则视频画面将上下颠倒。取值范围：`[0,360]`。', + 'type' => 'string', + 'example' => '90', + ], + 'TranscodeTemplateId' => [ + 'description' => '转码模板ID。', + 'type' => 'string', + 'example' => '696d29a11erc057*****a3acc398d02f4', + ], + 'TemplateName' => [ + 'description' => '转码模板名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'EncryptSetting' => [ + 'description' => '转码加密配置信息。', + 'type' => 'string', + 'example' => '"EncryptType":"Private"', + ], + 'Audio' => [ + 'description' => '音频流转码配置参数（JSON字符串）。', + 'type' => 'string', + 'example' => '{"Codec":"AAC","Remove":"false","Bitrate":"44","Samplerate":"32000","Channels":"2","Profile":"aac_low"}', + ], + 'TranscodeFileRegular' => [ + 'description' => '自定义转码输出路径。', + 'type' => 'string', + 'example' => '{MediaId}/transcoce_1', + ], + 'Container' => [ + 'description' => '封装音视频码流的容器格式（JSON字符串）。', + 'type' => 'string', + 'example' => '"Format":"m3u8"', + ], + 'Clip' => [ + 'description' => '视频裁剪配置（JSON字符串）。例如：需要截取视频中的5s内容，用于生成一个新的视频，则可设置该参数。', + 'type' => 'string', + 'example' => '{"TimeSpan":{"Seek":"1","Duration":"5"}', + ], + 'Definition' => [ + 'description' => '普通转码模板清晰度标记：'."\n" + ."\n" + .'- **LD**（流畅）'."\n" + .'- **SD**（标清）'."\n" + .'- **HD**（高清）'."\n" + .'- **FHD**（超清）'."\n" + .'- **OD**（原画，即转封装）'."\n" + .'- **2K**'."\n" + .'- **4K**'."\n" + .'- **SQ**（普通音质）'."\n" + .'- **HQ**（高音质）'."\n" + ."\n" + .'窄带高清1.0内置转码模板清晰度标记：'."\n" + ."\n" + .'- **LD-NBV1**（流畅）'."\n" + .'- **SD-NBV1**（标清）'."\n" + .'- **HD-NBV1**（高清）'."\n" + .'- **FHD-NBV1**（超清）'."\n" + .'- **2K-NBV1**'."\n" + .'- **4K-NBV1**'."\n" + ."\n" + .'> - 所有转码模板不支持清晰度标记修改。'."\n" + .'> - 窄带高清1.0转码模板音视频分辨率、码率等参数为系统内置，不支持修改。'."\n" + .'> - 窄带高清1.0转码模板创建只支持FLV、M3U8(HLS)、MP4格式。'."\n", + 'type' => 'string', + 'example' => 'SD', + ], + 'PackageSetting' => [ + 'description' => '打包配置。仅支持HLS自适应码流打包、DASH打包（JSON字符串）。', + 'type' => 'string', + 'example' => '"PackageType":"HLSPackage","PackageConfig":{ "BandWidth":"900000" }', + ], + 'SubtitleList' => [ + 'description' => '字幕配置 （JSON字符串）。', + 'type' => 'string', + 'example' => '[{"SubtitleUrl":"http://outin-test.oss-cn-shanghai.aliyuncs.com/subtitles/c737fece-14f1-4364-b107-d5f7f8edde0e.ass","CharEncode":"utf-8"}]', + ], + 'MuxConfig' => [ + 'description' => '转码的分片设置参数。HLS必传（JSON字符串）。', + 'type' => 'string', + 'example' => '"Segment": { "Duration":"6" }', + ], + 'WatermarkIds' => [ + 'description' => '关联的图文水印模板ID。', + 'type' => 'array', + 'items' => [ + 'description' => '关联的图文水印模板ID。', + 'type' => 'string', + 'example' => '"USER_DEFAULT_WATERMARK","ddddddddd"', + ], + ], + 'TraceMark' => [ + 'description' => '溯源水印信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "Enable": true'."\n" + .'}', + ], + 'CopyrightMark' => [ + 'description' => '版权水印信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "Content": "测试版权水印文案"'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6730AC93-7B12-4B*****7F-49EE1FE8BC49\\",\\n \\"TranscodeTemplateGroup\\": {\\n \\"CreationTime\\": \\"2018-12-12T10:20:51Z\\",\\n \\"IsDefault\\": \\"NotDefault\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"TranscodeTemplateGroupId\\": \\"a59b11f697c716*****6ae1502142d0\\",\\n \\"Name\\": \\"test\\",\\n \\"ModifyTime\\": \\"2018-12-12T11:20:51Z\\",\\n \\"Locked\\": \\"Enabled\\",\\n \\"TranscodeTemplateList\\": [\\n {\\n \\"Type\\": \\"Normal\\",\\n \\"Video\\": \\"{\\\\\\"Codec\\\\\\":\\\\\\"H.264\\\\\\",\\\\\\"Bitrate\\\\\\":\\\\\\"900\\\\\\",\\\\\\"Width\\\\\\":\\\\\\"960\\\\\\",\\\\\\"Remove\\\\\\":\\\\\\"false\\\\\\",\\\\\\"Fps\\\\\\":\\\\\\"30\\\\\\"}\\",\\n \\"TransConfig\\": \\"{\\\\\\"IsCheckReso\\\\\\":\\\\\\"true\\\\\\",\\\\\\"IsCheckResoFail\\\\\\":\\\\\\"false\\\\\\",\\\\\\"IsCheckVideoBitrate\\\\\\":\\\\\\"false\\\\\\",\\\\\\"IsCheckVideoBitrateFail\\\\\\":\\\\\\"false\\\\\\",\\\\\\"IsCheckAudioBitrate\\\\\\":\\\\\\"false\\\\\\",\\\\\\"IsCheckAudioBitrateFail\\\\\\":\\\\\\"false\\\\\\"}\\",\\n \\"Rotate\\": \\"90\\",\\n \\"TranscodeTemplateId\\": \\"696d29a11erc057*****a3acc398d02f4\\",\\n \\"TemplateName\\": \\"test\\",\\n \\"EncryptSetting\\": \\"\\\\\\"EncryptType\\\\\\":\\\\\\"Private\\\\\\"\\",\\n \\"Audio\\": \\"{\\\\\\"Codec\\\\\\":\\\\\\"AAC\\\\\\",\\\\\\"Remove\\\\\\":\\\\\\"false\\\\\\",\\\\\\"Bitrate\\\\\\":\\\\\\"44\\\\\\",\\\\\\"Samplerate\\\\\\":\\\\\\"32000\\\\\\",\\\\\\"Channels\\\\\\":\\\\\\"2\\\\\\",\\\\\\"Profile\\\\\\":\\\\\\"aac_low\\\\\\"}\\",\\n \\"TranscodeFileRegular\\": \\"{MediaId}/transcoce_1\\",\\n \\"Container\\": \\"\\\\\\"Format\\\\\\":\\\\\\"m3u8\\\\\\"\\",\\n \\"Clip\\": \\"{\\\\\\"TimeSpan\\\\\\":{\\\\\\"Seek\\\\\\":\\\\\\"1\\\\\\",\\\\\\"Duration\\\\\\":\\\\\\"5\\\\\\"}\\",\\n \\"Definition\\": \\"SD\\",\\n \\"PackageSetting\\": \\"\\\\\\"PackageType\\\\\\":\\\\\\"HLSPackage\\\\\\",\\\\\\"PackageConfig\\\\\\":{ \\\\\\"BandWidth\\\\\\":\\\\\\"900000\\\\\\" }\\",\\n \\"SubtitleList\\": \\"[{\\\\\\"SubtitleUrl\\\\\\":\\\\\\"http://outin-test.oss-cn-shanghai.aliyuncs.com/subtitles/c737fece-14f1-4364-b107-d5f7f8edde0e.ass\\\\\\",\\\\\\"CharEncode\\\\\\":\\\\\\"utf-8\\\\\\"}]\\",\\n \\"MuxConfig\\": \\"\\\\\\"Segment\\\\\\": { \\\\\\"Duration\\\\\\":\\\\\\"6\\\\\\" }\\",\\n \\"WatermarkIds\\": [\\n \\"\\\\\\"USER_DEFAULT_WATERMARK\\\\\\",\\\\\\"ddddddddd\\\\\\"\\"\\n ],\\n \\"TraceMark\\": \\"{\\\\n\\\\t\\\\\\"Enable\\\\\\": true\\\\n}\\",\\n \\"CopyrightMark\\": \\"{\\\\n\\\\t\\\\\\"Content\\\\\\": \\\\\\"测试版权水印文案\\\\\\"\\\\n}\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTranscodeTemplateGroupResponse>\\n<RequestId>6730AC93-7B12-4B*****7F-49EE1FE8BC49</RequestId>\\n<TranscodeTemplateGroup>\\n <IsDefault>NotDefault</IsDefault>\\n <Locked>Enabled</Locked>\\n <ModifyTime>2018-12-12T11:20:51Z</ModifyTime>\\n <AppId>app-****</AppId>\\n <TranscodeTemplateGroupId>a59b11f697c716*****6ae1502142d0</TranscodeTemplateGroupId>\\n <TranscodeMode>FastTranscode</TranscodeMode>\\n <TranscodeTemplateList>\\n <TailSlateList>[{\\"TailUrl\\":\\"http://outin-test.oss-cn-shanghai.aliyuncs.com/tailslates/b6e9ceed-b665-426f-9d9a-277f0f****.mov\\"}]</TailSlateList>\\n <PackageSetting>\\"PackageType\\":\\"HLSPackage\\",\\"PackageConfig\\":{ \\"BandWidth\\":\\"900000\\" }</PackageSetting>\\n <Rotate>90</Rotate>\\n <UserData>{}</UserData>\\n <Definition>SD</Definition>\\n <TranscodeFileRegular>{MediaId}/transcoce_1</TranscodeFileRegular>\\n <EncryptSetting>\\"EncryptType\\":\\"Private\\"</EncryptSetting>\\n <Clip>{\\\\\\"TimeSpan\\\\\\":{\\\\\\"Seek\\\\\\":\\\\\\"1\\\\\\",\\\\\\"Duration\\\\\\":\\\\\\"5\\\\\\"}</Clip>\\n <Type>Normal</Type>\\n <Container>\\"Format\\":\\"m3u8\\"</Container>\\n <TranscodeTemplateId>696d29a11erc057*****a3acc398d02f4</TranscodeTemplateId>\\n <TransConfig>{\\"IsCheckReso\\":\\"true\\",\\"IsCheckResoFail\\":\\"false\\",\\"IsCheckVideoBitrate\\":\\"false\\",\\"IsCheckVideoBitrateFail\\":\\"false\\",\\"IsCheckAudioBitrate\\":\\"false\\",\\"IsCheckAudioBitrateFail\\":\\"false\\"}</TransConfig>\\n <Video>{\\"Codec\\":\\"H.264\\",\\"Bitrate\\":\\"900\\",\\"Width\\":\\"960\\",\\"Remove\\":\\"false\\",\\"Fps\\":\\"30\\"}</Video>\\n <TemplateName>test</TemplateName>\\n <SubtitleList>[{\\"SubtitleUrl\\":\\"http://outin-test.oss-cn-shanghai.aliyuncs.com/subtitles/c737fece-14f1-4364-b107-d5f7f8edde0e.ass\\",\\"CharEncode\\":\\"utf-8\\"}]</SubtitleList>\\n <Audio>{\\\\\\"Codec\\\\\\":\\\\\\"AAC\\\\\\",\\\\\\"Remove\\\\\\":\\\\\\"false\\\\\\",\\\\\\"Bitrate\\\\\\":\\\\\\"44\\\\\\",\\\\\\"Samplerate\\\\\\":\\\\\\"32000\\\\\\",\\\\\\"Channels\\\\\\":\\\\\\"2\\\\\\",\\\\\\"Profile\\\\\\":\\\\\\"aac_low\\\\\\"}</Audio>\\n <MuxConfig>\\"Segment\\": { \\"Duration\\":\\"6\\" }</MuxConfig>\\n <OpeningList>[{\\"OpenUrl\\":\\"http://outin-test.oss-cn-shanghai.aliyuncs.com/tailslates/b6e9ceed-b665-426f-9d9a-277f0f****.mov\\"}]</OpeningList>\\n </TranscodeTemplateList>\\n <TranscodeTemplateList>\\n <WatermarkIds>\\"USER_DEFAULT_WATERMARK\\",\\"ddddddddd\\"</WatermarkIds>\\n </TranscodeTemplateList>\\n <CreationTime>2018-12-12T10:20:51Z</CreationTime>\\n <Name>test</Name>\\n</TranscodeTemplateGroup>\\n</GetTranscodeTemplateGroupResponse>","errorExample":""}]', + 'title' => '查询转码配置详情', + 'description' => '获取单个模板组信息，同时会返回该模板组下所有转码模板的配置信息。', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidTranscodeTemplateGroup.NotFound |The transcode template group does not exist. |404| 指定的转码模板组不存在。|', + ], + 'DeleteTranscodeTemplateGroup' => [ + 'summary' => '删除转码配置信息，可删除转码模板组下的部分转码模板，也可强制删除整个转码模板组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39844', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TranscodeTemplateGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '转码模板组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '4c71a339fec*****152b4fa6f4527', + ], + ], + [ + 'name' => 'TranscodeTemplateIds', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的转码模板ID列表。'."\n" + ."\n" + .'- 多个ID使用英文逗号（,）分隔。'."\n" + .'- 最大支持10个模板ID。'."\n" + .'- 当参数ForceDelGroup为空或false时该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => '["613702defdc4*****6a3b94cace1129e","bfd6c90253a2*****7fc054d7c5825"]', + ], + ], + [ + 'name' => 'ForceDelGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制删除整个转码模板组。取值：'."\n" + ."\n" + .'- **true**：删除整个模板组及其转码模板列表。'."\n" + .'- **false**（默认）：仅删除指定的转码模板。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'NonExistTranscodeTemplateIds' => [ + 'description' => '根据转码模板ID列表删除转码模板时，不存在的转码模板ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '根据转码模板ID列表删除转码模板时，不存在的转码模板ID列表。', + 'type' => 'string', + 'example' => '["613702defdc4*****6a3b94cace1129e","bfd6c90253a2*****7fc054d7c5825"]', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"NonExistTranscodeTemplateIds\\": [\\n \\"[\\\\\\"613702defdc4*****6a3b94cace1129e\\\\\\",\\\\\\"bfd6c90253a2*****7fc054d7c5825\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DeleteTranscodeTemplateGroupResponse>\\n <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\n <NonExistTranscodeTemplateIds>613702defdc4*****6a3b94cace1129e</NonExistTranscodeTemplateIds>\\n <NonExistTranscodeTemplateIds>bfd6c90253a2*****7fc054d7c5825</NonExistTranscodeTemplateIds>\\n</DeleteTranscodeTemplateGroupResponse>","errorExample":""}]', + 'title' => '删除转码配置', + 'description' => '- 默认的转码模板，不允许删除，可取消其默认后再进行删除。'."\n" + .' - 出于安全保护目的，处于锁定状态的转码模板组不能进行添加、修改、删除等操作。您可以调用[GetTranscodeTemplateGroup](~~GetTranscodeTemplateGroup~~)接口查询模板配置，通过返回的响应参数Locked，查看模板组是否被锁定；您可以调用[UpdateTranscodeTemplateGroup](~~UpdateTranscodeTemplateGroup~~)接口将模板解锁后，再进行更改操作。'."\n" + .' - 当参数ForceDelGroup为空或false时，参数TranscodeTemplateIds必填。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidTranscodeTemplateGroup.NotFound |The transcode template does not exist. |404| 指定的转码模板组不存在。|'."\n" + .'| Forbidden.LockedTemplateGroup |The transcode template group has been locked. |403| 指定的模板组被锁定，不可操作，请联系点播后台。|'."\n" + .'| Forbidden.DefaultTemplateGroup |The transcode template group is default. |403| 默认转码模板组不能进行删除操作。|'."\n", + ], + 'AddVodTemplate' => [ + 'summary' => '调用本接口添加截图或动图模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39791', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。'."\n" + ."\n" + .'- 长度不超过128个字节。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => '模板类型。取值：'."\n" + .'- **Snapshot**：截图。'."\n" + .'- **DynamicImage**：动图。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Snapshot', + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '模板配置数据（JSON格式）。数据结构详情，请参见[截图模板配置](~~98618~~)或[动图模板配置](~~98618~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"SnapshotConfig":{"Count":10,"SpecifiedOffsetTime":0,"Interval":1,"FrameType":"normal"},"SnapshotType":"NormalSnapshot"}', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。默认取值**app-1000000**。使用说明，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'VodTemplateId' => [ + 'description' => '截图或动图模板ID。'."\n" + .'可作为[SubmitSnapshotJob](~~SubmitSnapshotJob~~)或[SubmitDynamicImageJob](~~SubmitDynamicImageJob~~)接口的请求参数，发起截图或动图处理。', + 'type' => 'string', + 'example' => 'f5b228fe6930e*****0d6bf55bd87789', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"VodTemplateId\\": \\"f5b228fe6930e*****0d6bf55bd87789\\",\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\"\\n}","errorExample":""},{"type":"xml","example":"<AddVodTemplateResponse>\\r\\n <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\r\\n\\t<VodTemplateId>f5b228fe6930e*****0d6bf55bd87789</VodTemplateId>\\r\\n</AddVodTemplateResponse>","errorExample":""}]', + 'title' => '添加截图或动图模板', + 'description' => '- 添加模板后，可通过[SubmitSnapshotJob](~~SubmitSnapshotJob~~)或[SubmitDynamicImageJob](~~SubmitDynamicImageJob~~)接口传递截图或动图模板ID，发起截图或动图任务。'."\n" + .'- 您可以通过HTTP回调（兼容HTTPS）、MNS回调两种方式来接收[视频截图完成](~~57337~~)和[视频动图完成](~~143490~~)回调消息。具体详情，请参见[回调方式](~~55627~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'UpdateVodTemplate' => [ + 'summary' => '修改截图模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40235', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VodTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '截图模板ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8c75a02e339b*****0b0d2c48171a22', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。'."\n" + ."\n" + .'- 长度不超过128个字节。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '截图模板配置数据。（JSON格式）参数结构详情，请参见[SnapshotTemplateConfig](~~98618~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"SnapshotConfig":{"Count":10,"SpecifiedOffsetTime":0,"Interval":1}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'VodTemplateId' => [ + 'description' => '截图模板ID。', + 'type' => 'string', + 'example' => '8c75a02e339b*****0b0d2c48171a22', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"VodTemplateId\\": \\"8c75a02e339b*****0b0d2c48171a22\\",\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateVodTemplateResponse>\\r\\n <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\r\\n\\t<VodTemplateId>8c75a02e339b*****0b0d2c48171a22</VodTemplateId>\\r\\n</UpdateVodTemplateResponse>","errorExample":""}]', + 'title' => '修改截图模板', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetVodTemplate' => [ + 'summary' => '调用本接口查询单个截图模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40007', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VodTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '截图模板ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '7c49f2f4c0969*****fcd446690', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DE7A1F49-41C1-47*****DF-4CD0C02087DB', + ], + 'VodTemplateInfo' => [ + 'description' => '截图模板数据信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-11-30T08:05:59:57Z', + ], + 'IsDefault' => [ + 'description' => '是否默认。取值：'."\n" + ."\n" + .'- **Default**（默认）'."\n" + .'- **NotDefault**（非默认）', + 'type' => 'string', + 'example' => 'NotDefault', + ], + 'TemplateType' => [ + 'description' => '模板类型。取值：'."\n" + ."\n" + .'- **Snapshot**：截图。'."\n" + .'- **DynamicImage**：动图。', + 'type' => 'string', + 'example' => 'Snapshot', + ], + 'VodTemplateId' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '7c49f2f4c09*****69fcd446690', + ], + 'TemplateConfig' => [ + 'description' => '模板详细配置，JSON字符串。数据结构详情，请参见[SnapshotTemplateConfig](~~98618~~)。', + 'type' => 'string', + 'example' => '{\\"SnapshotConfig\\":{\\"Count\\":10,\\"SpecifiedOffsetTime\\":0,\\"Interval\\":1},\\"SnapshotType\\":\\"NormalSnapshot\\"}', + ], + 'Name' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ModifyTime' => [ + 'description' => '修改时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-11-30T09:05:59:57Z', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DE7A1F49-41C1-47*****DF-4CD0C02087DB\\",\\n \\"VodTemplateInfo\\": {\\n \\"CreationTime\\": \\"2018-11-30T08:05:59:57Z\\",\\n \\"IsDefault\\": \\"NotDefault\\",\\n \\"TemplateType\\": \\"Snapshot\\",\\n \\"VodTemplateId\\": \\"7c49f2f4c09*****69fcd446690\\",\\n \\"TemplateConfig\\": \\"{\\\\\\\\\\\\\\"SnapshotConfig\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"SpecifiedOffsetTime\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"Interval\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"SnapshotType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NormalSnapshot\\\\\\\\\\\\\\"}\\",\\n \\"Name\\": \\"test\\",\\n \\"ModifyTime\\": \\"2018-11-30T09:05:59:57Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetVodTemplateResponse>\\n <RequestId>DE7A1F49-41C1-47*****DF-4CD0C02087DB</RequestId>\\n <VodTemplateInfo>\\n <Name>test</Name>\\n <TemplateType>Snapshot</TemplateType>\\n <Source>Custom</Source>\\n <CreationTime>2018-11-30T08:05:59:57Z</CreationTime>\\n <VodTemplateId>7c49f2f4c09*****69fcd446690</VodTemplateId>\\n <IsDefault>NotDefault</IsDefault>\\n <TemplateConfig>{\\"SnapshotConfig\\":{\\"Count\\":10,\\"SpecifiedOffsetTime\\":0,\\"Interval\\":1},\\"SnapshotType\\":\\"NormalSnapshot\\"}</TemplateConfig>\\n <ModifyTime>2018-11-30T09:05:59:57Z</ModifyTime>\\n </VodTemplateInfo>\\n</GetVodTemplateResponse>","errorExample":""}]', + 'title' => '查询单个截图模板', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ListVodTemplate' => [ + 'summary' => '查询截图模板列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40083', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => '模板类型。固定取值：**Snapshot**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Snapshot', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。固定取值**app-1000000**。使用说明，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2A56B75B-B7E6-48*****27-A9BEAA3E50A8', + ], + 'VodTemplateInfoList' => [ + 'description' => '截图模板数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2018-11-30T08:05:59:57Z', + ], + 'IsDefault' => [ + 'description' => '是否默认。取值：'."\n" + ."\n" + .'- **Default**：默认。'."\n" + .'- **NotDefault**：非默认。', + 'type' => 'string', + 'example' => 'NotDefault', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'TemplateType' => [ + 'description' => '模板类型。取值：'."\n" + ."\n" + .'- **Snapshot**：截图。'."\n" + .'- **DynamicImage**：动图。', + 'type' => 'string', + 'example' => 'Snapshot', + ], + 'VodTemplateId' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '7c49f2f42b1c*****0969fcd446690', + ], + 'TemplateConfig' => [ + 'description' => '模板详细配置，JSON字符串。数据结构详情，请参见[SnapshotTemplateConfig](~~98618~~)。', + 'type' => 'string', + 'example' => '{\\"SnapshotConfig\\":{\\"Count\\":10,\\"SpecifiedOffsetTime\\":0,\\"Interval\\":1},\\"SnapshotType\\":\\"NormalSnapshot\\"}', + ], + 'Name' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ModifyTime' => [ + 'description' => '修改时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2018-11-30T09:05:59:97Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2A56B75B-B7E6-48*****27-A9BEAA3E50A8\\",\\n \\"VodTemplateInfoList\\": [\\n {\\n \\"CreationTime\\": \\"2018-11-30T08:05:59:57Z\\",\\n \\"IsDefault\\": \\"NotDefault\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"TemplateType\\": \\"Snapshot\\",\\n \\"VodTemplateId\\": \\"7c49f2f42b1c*****0969fcd446690\\",\\n \\"TemplateConfig\\": \\"{\\\\\\\\\\\\\\"SnapshotConfig\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Count\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"SpecifiedOffsetTime\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"Interval\\\\\\\\\\\\\\":1},\\\\\\\\\\\\\\"SnapshotType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NormalSnapshot\\\\\\\\\\\\\\"}\\",\\n \\"Name\\": \\"test\\",\\n \\"ModifyTime\\": \\"2018-11-30T09:05:59:97Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListVodTemplateResponse>\\n <RequestId>2A56B75B-B7E6-48*****27-A9BEAA3E50A8</RequestId>\\n <VodTemplateInfoList>\\n <CreationTime>2018-11-30T08:05:59:57Z</CreationTime>\\n <TemplateType>Snapshot</TemplateType>\\n <Name>test</Name>\\n <VodTemplateId>7c49f2f42b1c*****0969fcd446690</VodTemplateId>\\n <TemplateConfig>{\\"SnapshotConfig\\":{\\"Count\\":10,\\"SpecifiedOffsetTime\\":0,\\"Interval\\":1},\\"SnapshotType\\":\\"NormalSnapshot\\"}</TemplateConfig>\\n <IsDefault>NotDefault</IsDefault>\\n <ModifyTime>2018-11-30T09:05:59:57Z</ModifyTime>\\n </VodTemplateInfoList>\\n <VodTemplateInfoList>\\n <CreationTime>2018-11-29T09:58:01:20Z</CreationTime>\\n <TemplateType>Snapshot</TemplateType>\\n <Name>snapshottest</Name>\\n <VodTemplateId>ee014fd5889b6*****7828cae2bbb2b</VodTemplateId>\\n <TemplateConfig>{\\"SnapshotConfig\\":{\\"Count\\":10,\\"SpecifiedOffsetTime\\":0,\\"Interval\\":1},\\"SnapshotType\\":\\"NormalSnapshot\\"}</TemplateConfig>\\n <IsDefault>NotDefault</IsDefault>\\n <ModifyTime>2018-11-29T10:58:01:20Z</ModifyTime>\\n </VodTemplateInfoList>\\n</ListVodTemplateResponse>","errorExample":""}]', + 'title' => '查询截图模板列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DeleteVodTemplate' => [ + 'summary' => '调用本接口删除截图模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39851', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VodTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '截图模板ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'f5b228fe6930e*****d6bf55bd87789', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'VodTemplateId' => [ + 'description' => '截图模板ID。', + 'type' => 'string', + 'example' => 'f5b228fe6930e*****d6bf55bd87789', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"VodTemplateId\\": \\"f5b228fe6930e*****d6bf55bd87789\\",\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteVodTemplateResponse>\\r\\n\\t<RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\r\\n\\t<VodTemplateId>f5b228fe6930e*****d6bf55bd87789</VodTemplateId>\\r\\n</DeleteVodTemplateResponse>","errorExample":""}]', + 'title' => '删除截图模板', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'AddWatermark' => [ + 'summary' => '为了简化水印任务的处理过程，视频点播将复杂的水印位置、水印大小、水印文字的字体、颜色等水印参数固化成模板，并通过具有唯一性的水印模板ID来指代。调用本接口可以添加图片水印模板或文字水印模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39792', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '水印模板类型：'."\n" + .'- **Image**（默认）：图片水印模板。'."\n" + .'- **Text**：文字水印模板。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Image', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '水印模板名称。'."\n" + .'- 仅支持中英文、数字。'."\n" + .'- 长度不超过128个字节。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '图片水印模板', + ], + ], + [ + 'name' => 'WatermarkConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '图文水印的配置信息（JSON字符串），包括水印显示位置、水印效果等配置。图片水印和文字水印的配置参数不同，参数结构详情，请参见[WatermarkConfig](~~98618#section-h01-44s-2lr~~) 。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{'."\n" + .' "Width": "55",'."\n" + .' "Height": "55",'."\n" + .' "Dx": "9",'."\n" + .' "Dy": "9",'."\n" + .' "ReferPos": "BottomLeft"'."\n" + .'}', + ], + ], + [ + 'name' => 'FileUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '水印图片文件的OSS地址（不带鉴权）。'."\n" + .'>- 设置图片水印模板（`Type`为`Image`）时，本参数必传。'."\n" + .'>- 您可以调用[CreateUploadAttachedMedia](~~CreateUploadAttachedMedia~~)接口将水印图片上传到视频点播中，上传后返回参数`FileURL`的值可作为本参数的请求参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://outin-326268*****63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345*****E7FDEC-6-2.png', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。默认取值：**app-1000000**。若已开通多应用体系，传入应用ID，可将水印模板添加到指定应用下。使用说明，请参见[多应用体系](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'WatermarkInfo' => [ + 'description' => '水印模板信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '水印模板的创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-11-07T09:05:52Z', + ], + 'Type' => [ + 'description' => '水印模板的类型。'."\n" + .'- **Image**：图片水印模板。'."\n" + .'- **Text**：文字水印模板。', + 'type' => 'string', + 'example' => 'Image', + ], + 'IsDefault' => [ + 'description' => '是否是默认图文水印模板：'."\n" + .'- **Default**：默认图文水印模板。'."\n" + .'- **NotDefault**：非默认图文水印模板。', + 'type' => 'string', + 'example' => 'NotDefault', + ], + 'FileUrl' => [ + 'description' => '水印文件URL（OSS地址或CDN地址）。'."\n" + .'> 仅图片水印模板会返回此参数。', + 'type' => 'string', + 'example' => 'https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****', + ], + 'WatermarkConfig' => [ + 'description' => '图文水印的配置信息（JSON字符串），包括水印显示位置、水印效果等配置。图片水印和文字水印的配置参数不同，参数结构详情，请参见[WatermarkConfig](~~98618#section-h01-44s-2lr~~) 。', + 'type' => 'string', + 'example' => '{'."\n" + .' "Width": "55",'."\n" + .' "Height": "55",'."\n" + .' "Dx": "9",'."\n" + .' "Dy": "9",'."\n" + .' "ReferPos": "BottomLeft"'."\n" + .'}', + ], + 'Name' => [ + 'description' => '水印模板名称。', + 'type' => 'string', + 'example' => '图片水印模板', + ], + 'WatermarkId' => [ + 'description' => '水印模板ID。后续可使用该水印模板ID关联到转码模板组，或对水印模板进行查询、修改、删除、设置默认水印模板等操作。', + 'type' => 'string', + 'example' => '9bcc8bfadb84*****109a2671d0df97', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"WatermarkInfo\\": {\\n \\"CreationTime\\": \\"2018-11-07T09:05:52Z\\",\\n \\"Type\\": \\"Image\\",\\n \\"IsDefault\\": \\"NotDefault\\",\\n \\"FileUrl\\": \\"https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****\\",\\n \\"WatermarkConfig\\": \\"{\\\\n \\\\\\"Width\\\\\\": \\\\\\"55\\\\\\",\\\\n \\\\\\"Height\\\\\\": \\\\\\"55\\\\\\",\\\\n \\\\\\"Dx\\\\\\": \\\\\\"9\\\\\\",\\\\n \\\\\\"Dy\\\\\\": \\\\\\"9\\\\\\",\\\\n \\\\\\"ReferPos\\\\\\": \\\\\\"BottomLeft\\\\\\"\\\\n}\\",\\n \\"Name\\": \\"图片水印模板\\",\\n \\"WatermarkId\\": \\"9bcc8bfadb84*****109a2671d0df97\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddWatermarkResponse>\\n<RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\n<WatermarkInfo>\\n <IsDefault>NotDefault</IsDefault>\\n <FileUrl>https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****</FileUrl>\\n <Type>Text</Type>\\n <WatermarkId>9bcc8bfadb84*****109a2671d0df97</WatermarkId>\\n <CreationTime>2018-11-07T09:05:52Z</CreationTime>\\n <WatermarkConfig>{\\"FontColor\\": \\"Blue\\",\\"FontSize\\": 80, \\"Content\\": \\"水印测试\\" }</WatermarkConfig>\\n <Name>文字水印测试</Name>\\n</WatermarkInfo>\\n</AddWatermarkResponse>","errorExample":""}]', + 'title' => '添加图文水印模板', + 'description' => '- 调用本接口可以添加图片水印模板（`Image`）或文字水印模板（`Text`），其中，图片水印模板支持如下格式：静态图片（PNG）、动态图片（GIF、APNG、MOV）。'."\n" + .'- 调用本接口添加图文水印模板后，您还需调用[AddTranscodeTemplateGroup](~~AddTranscodeTemplateGroup~~)或[UpdateTranscodeTemplateGroup](~~UpdateTranscodeTemplateGroup~~)接口，将图文水印模板关联到转码模板组上，以便后续发起水印转码时选用。'."\n" + .'- 为视频添加图文水印的详细信息，请参见[视频图文水印](~~99369~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| NoSuchResource |The specified resource %s does not exist. |404| 用户相关的资源数据不存在，%s表示具体资源信息。|', + ], + 'UpdateWatermark' => [ + 'summary' => '添加图文水印模板后，可以调用本接口修改图文水印模板的模板名称和水印配置（WatermarkConfig）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40237', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '修改的水印模板名称。'."\n" + .'- 只支持中英文、数字。'."\n" + .'- 长度不超过128个字节。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'WatermarkId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改的图文水印模板ID，仅支持传入单个水印模板ID。可通过如下方式获取：'."\n" + .'- 调用[AddWatermark](~~AddWatermark~~)接口添加图文水印模板后会返回。'."\n" + .'- 调用[ListWatermark](~~ListWatermark~~)接口查询图文水印模板列表后会返回。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'af2afe4761992c*****bd947dae97337', + ], + ], + [ + 'name' => 'WatermarkConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '图文水印的配置信息（JSON字符串），包括水印显示位置、水印效果等配置。图片水印和文字水印的配置参数不同，参数结构详情，请参见[WatermarkConfig](~~98618#section-h01-44s-2lr~~) 。'."\n" + .'>暂不支持跨模板类型修改，您可以调用[GetWatermark](~~GetWatermark~~)接口查询水印模板所属类型后，再进行修改配置。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottomLeft"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'WatermarkInfo' => [ + 'description' => '水印模板信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '水印模板的创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-11-06T08:03:17Z', + ], + 'Type' => [ + 'description' => '水印模板的类型。'."\n" + .'- **Image**：图片水印模板。'."\n" + .'- **Text**：文字水印模板。', + 'type' => 'string', + 'example' => 'Image', + ], + 'IsDefault' => [ + 'description' => '是否是默认图文水印模板：'."\n" + .'- **Default**：默认图文水印模板。'."\n" + .'- **NotDefault**：非默认图文水印模板。', + 'type' => 'string', + 'example' => 'NotDefault', + ], + 'FileUrl' => [ + 'description' => '水印文件URL（OSS地址或CDN地址）。'."\n" + .'> 仅图片水印模板会返回此参数。', + 'type' => 'string', + 'example' => 'https://outin-32****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****', + ], + 'WatermarkConfig' => [ + 'description' => '图文水印的配置信息（JSON字符串），包括水印显示位置、水印效果等配置。图片水印和文字水印的配置参数不同，参数结构详情，请参见[WatermarkConfig](~~98618#section-h01-44s-2lr~~) 。', + 'type' => 'string', + 'example' => '{"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottomLeft"}', + ], + 'Name' => [ + 'description' => '水印模板名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'WatermarkId' => [ + 'description' => '水印模板ID。', + 'type' => 'string', + 'example' => '505e2e287ea*****ecfddd386d384', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"WatermarkInfo\\": {\\n \\"CreationTime\\": \\"2018-11-06T08:03:17Z\\",\\n \\"Type\\": \\"Image\\",\\n \\"IsDefault\\": \\"NotDefault\\",\\n \\"FileUrl\\": \\"https://outin-32****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****\\",\\n \\"WatermarkConfig\\": \\"{\\\\\\"Width\\\\\\":\\\\\\"55\\\\\\",\\\\\\"Height\\\\\\":\\\\\\"55\\\\\\",\\\\\\"Dx\\\\\\":\\\\\\"9\\\\\\",\\\\\\"Dy\\\\\\":\\\\\\"9\\\\\\",\\\\\\"ReferPos\\\\\\":\\\\\\"BottomLeft\\\\\\"}\\",\\n \\"Name\\": \\"test\\",\\n \\"WatermarkId\\": \\"505e2e287ea*****ecfddd386d384\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateWatermarkResponse>\\n<RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\n<WatermarkInfo>\\n <Name>图片水印测试</Name>\\n <CreationTime>2018-11-06T08:03:17Z</CreationTime>\\n <WatermarkId>505e2e287ea*****ecfddd386d384</WatermarkId>\\n <FileUrl>https://outin-32****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****</FileUrl>\\n <IsDefault>NotDefault</IsDefault>\\n <Type>Image</Type>\\n <WatermarkConfig>\\n <ReferPos>BottomRight</ReferPos>\\n <Height>55</Height>\\n <Width>55</Width>\\n <Dx>8</Dx>\\n <Dy>8</Dy>\\n </WatermarkConfig>\\n</WatermarkInfo>\\n</UpdateWatermarkResponse>","errorExample":""}]', + 'title' => '修改图文水印模板', + 'description' => '- 调用[AddWatermark](~~AddWatermark~~)添加图文水印模板后，可以调用本接口修改图文水印模板的名称和水印配置。'."\n" + .'- 调用本接口暂不支持替换图片水印模板中的图片，也不支持跨模板类型（例如将图片水印模板改为文字水印模板）的修改。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DeleteWatermark' => [ + 'summary' => '调用本接口通过水印模板ID删除图片水印模板或文字水印模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39852', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'WatermarkId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的图文水印模板ID，仅支持传入单个水印模板ID。可通过如下方式获取：'."\n" + .'- 调用[AddWatermark](~~AddWatermark~~)接口添加图文水印模板后会返回。'."\n" + .'- 调用[ListWatermark](~~ListWatermark~~)接口查询图文水印模板列表后会返回。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '9bcc8bfadb843f*****09a2671d0df97', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteWatermarkResponse>\\r\\n <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\r\\n</DeleteWatermarkResponse>","errorExample":""}]', + 'title' => '删除图文水印模板', + 'description' => '- **删除图片水印模板时，会将水印源文件物理删除，且无法恢复，请谨慎操作。**'."\n" + .'- 已经被设置为默认图文水印模板的水印模板不支持删除。如需删除，可调用[SetDefaultWatermark](~~SetDefaultWatermark~~)设置其他图文水印模板为默认模板，以此来解除默认后，再进行删除。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| NoSuchResource |The specified resource %s does not exist. |404| 用户相关的资源数据不存在， %s表示具体资源信息。|'."\n", + ], + 'SetDefaultWatermark' => [ + 'summary' => '调用本接口将指定水印模板设置为默认水印模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40142', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'WatermarkId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要设置为默认的图文水印模板ID，仅支持传入单个水印模板ID。可通过如下方式获取：'."\n" + .'- 调用[AddWatermark](~~AddWatermark~~)接口添加图文水印模板后会返回。'."\n" + .'- 调用[ListWatermark](~~ListWatermark~~)接口查询图文水印模板列表后会返回。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '9bcc8bfadb843f*****09a2671d0df97', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\"\\n}","errorExample":""},{"type":"xml","example":"<SetDefaultWatermarkResponse>\\r\\n <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\r\\n</SetDefaultWatermarkResponse>","errorExample":""}]', + 'title' => '设置默认图文水印模板', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| NoSuchResource |The specified resource %s does not exist. |404| 用户相关的资源数据不存在，%s表示具体资源信息。|', + ], + 'GetWatermark' => [ + 'summary' => '调用本接口通过水印模板ID查询单个图片水印模板或文字水印模板的配置信息，包括图片水印的位置、大小，展示时间，文字水印的内容、字体、颜色、位置等参数配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40009', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'WatermarkId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的图文水印模板ID，仅支持传入单个水印模板ID。可通过如下方式获取：'."\n" + .'- 调用[AddWatermark](~~AddWatermark~~)接口添加图文水印模板后会返回。'."\n" + .'- 调用[ListWatermark](~~ListWatermark~~)接口查询图文水印模板列表后会返回。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '9bcc8bfadb843f*****09a2671d0df97', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'WatermarkInfo' => [ + 'description' => '图文水印模板信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '水印模板的创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-11-06T08:03:17Z', + ], + 'Type' => [ + 'description' => '水印模板的类型：'."\n" + .'- **Image**：图片水印模板。'."\n" + .'- **Text**：文字水印模板。', + 'type' => 'string', + 'example' => 'Image', + ], + 'IsDefault' => [ + 'description' => '是否是默认图文水印模板：'."\n" + ."\n" + .'- **Default**：默认图文水印模板。'."\n" + .'- **NotDefault**：非默认图文水印模板。', + 'type' => 'string', + 'example' => 'NotDefault', + ], + 'FileUrl' => [ + 'description' => '水印文件URL（OSS地址或CDN地址）。'."\n" + .'> 仅图片水印模板会返回此参数。', + 'type' => 'string', + 'example' => 'https://outin-32*****f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/F85529C8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'WatermarkConfig' => [ + 'description' => '图文水印的配置信息（JSON字符串），包括水印显示位置、水印效果等配置。图片水印和文字水印的配置参数不同，参数结构详情，请参见[WatermarkConfig](~~98618#section-h01-44s-2lr~~) 。', + 'type' => 'string', + 'example' => '{"ReferPos": "BottomRight","Height": "55","Width": "55","Dx": "8","Dy": "8" }', + ], + 'Name' => [ + 'description' => '水印模板名称。', + 'type' => 'string', + 'example' => '图片水印测试', + ], + 'WatermarkId' => [ + 'description' => '水印模板ID。', + 'type' => 'string', + 'example' => '505e2e287ea*****ecfddd386d384', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"WatermarkInfo\\": {\\n \\"CreationTime\\": \\"2018-11-06T08:03:17Z\\",\\n \\"Type\\": \\"Image\\",\\n \\"IsDefault\\": \\"NotDefault\\",\\n \\"FileUrl\\": \\"https://outin-32*****f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/F85529C8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"WatermarkConfig\\": \\"{\\\\\\"ReferPos\\\\\\": \\\\\\"BottomRight\\\\\\",\\\\\\"Height\\\\\\": \\\\\\"55\\\\\\",\\\\\\"Width\\\\\\": \\\\\\"55\\\\\\",\\\\\\"Dx\\\\\\": \\\\\\"8\\\\\\",\\\\\\"Dy\\\\\\": \\\\\\"8\\\\\\" }\\",\\n \\"Name\\": \\"图片水印测试\\",\\n \\"WatermarkId\\": \\"505e2e287ea*****ecfddd386d384\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetWatermarkResponse>\\n<RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\n<WatermarkInfo>\\n <IsDefault>NotDefault</IsDefault>\\n <FileUrl>https://outin-32*****f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/F85529C8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****</FileUrl>\\n <Type>Text</Type>\\n <AppId>app-****</AppId>\\n <WatermarkId>505e2e287ea*****ecfddd386d384</WatermarkId>\\n <CreationTime>2018-11-06T08:03:17Z</CreationTime>\\n <WatermarkConfig>{\\"ReferPos\\": \\"BottomRight\\",\\"Height\\": \\"55\\",\\"Width\\": \\"55\\",\\"Dx\\": \\"8\\",\\"Dy\\": \\"8\\" }</WatermarkConfig>\\n <Name>图片水印测试</Name>\\n</WatermarkInfo>\\n</GetWatermarkResponse>","errorExample":""}]', + 'title' => '查询单个图文水印模板', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| NoSuchResource |The specified resource %s does not exist.| 404| 用户相关的资源数据不存在， %s表示具体资源信息。|', + ], + 'ListWatermark' => [ + 'summary' => '调用本接口查询当前服务地域下已添加的所有图片水印模板和文字水印模板的配置信息，包括图片水印的位置、大小，展示时间，文字水印的内容、字体、颜色、位置等参数配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40085', + 'abilityTreeNodes' => [ + 'FEATUREvodCOT3DK', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。默认取值：**app-1000000**。'."\n" + ."\n" + .'若已开通多应用体系，传入应用ID，可查询指定应用下的图文水印模板；不传，则默认返回所有应用下的图文水印模板。使用说明，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'WatermarkInfos' => [ + 'description' => '水印模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '水印模板的创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-11-07T09:05:52Z', + ], + 'Type' => [ + 'description' => '水印模板的类型。'."\n" + .'- **Image**：图片水印模板。'."\n" + .'- **Text**：文字水印模板。', + 'type' => 'string', + 'example' => 'Text', + ], + 'IsDefault' => [ + 'description' => '是否是默认图文水印模板：'."\n" + .'- **Default**：默认图文水印模板。'."\n" + .'- **NotDefault**：非默认图文水印模板。', + 'type' => 'string', + 'example' => 'NotDefault', + ], + 'FileUrl' => [ + 'description' => '水印文件URL（OSS地址或CDN地址）。'."\n" + .'> 仅图片水印模板会返回此参数。', + 'type' => 'string', + 'example' => 'https://outin-3262681cd*****89f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/8CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozB****', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'WatermarkConfig' => [ + 'description' => '图文水印的配置信息（JSON字符串），包括水印显示位置、水印效果等配置。图片水印和文字水印的配置参数不同，参数结构详情，请参见[WatermarkConfig](~~98618#section-h01-44s-2lr~~) 。', + 'type' => 'string', + 'example' => '{"FontColor": "Blue","FontSize": 80,"Content": "水印测试"}', + ], + 'Name' => [ + 'description' => '水印模板名称。', + 'type' => 'string', + 'example' => '文字水印测试', + ], + 'WatermarkId' => [ + 'description' => '水印模板ID。', + 'type' => 'string', + 'example' => '9bcc8bfadb843*****109a2671d0df97', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"WatermarkInfos\\": [\\n {\\n \\"CreationTime\\": \\"2018-11-07T09:05:52Z\\",\\n \\"Type\\": \\"Text\\",\\n \\"IsDefault\\": \\"NotDefault\\",\\n \\"FileUrl\\": \\"https://outin-3262681cd*****89f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/8CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozB****\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"WatermarkConfig\\": \\"{\\\\\\"FontColor\\\\\\": \\\\\\"Blue\\\\\\",\\\\\\"FontSize\\\\\\": 80,\\\\\\"Content\\\\\\": \\\\\\"水印测试\\\\\\"}\\",\\n \\"Name\\": \\"文字水印测试\\",\\n \\"WatermarkId\\": \\"9bcc8bfadb843*****109a2671d0df97\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListWatermarkResponse>\\n<RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\n<WatermarkInfos>\\n <IsDefault>NotDefault</IsDefault>\\n <FileUrl>https://outin-3262681cd*****89f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/8CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozB****</FileUrl>\\n <Type>Text</Type>\\n <AppId>app-****</AppId>\\n <WatermarkId>9bcc8bfadb843*****109a2671d0df97</WatermarkId>\\n <CreationTime>2018-11-07T09:05:52Z</CreationTime>\\n <WatermarkConfig>{\\"FontColor\\": \\"Blue\\",\\"FontSize\\": 80,\\"Content\\": \\"水印测试\\"}</WatermarkConfig>\\n <Name>文字水印测试</Name>\\n</WatermarkInfos>\\n</ListWatermarkResponse>","errorExample":""}]', + 'title' => '查询图文水印模板列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetTranscodeSummary' => [ + 'summary' => '调用本接口根据音视频ID查询音视频转码摘要，包括音视频转码状态、转码进展等汇总信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39982', + 'abilityTreeNodes' => [ + 'FEATUREvodAFH3DF', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoIds', + 'in' => 'query', + 'schema' => [ + 'description' => '音/视频ID。最多支持10个ID，多个ID之间使用半角逗号（,）分隔。音/视频ID可通过以下方式获取：'."\n" + .'- 通过控制台上传的音/视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看音/视频ID。'."\n" + .'- 通过[CreateUploadVideo](~~55407~~)接口获取上传地址和凭证时，音/视频ID为返回参数VideoId的值。'."\n" + .'- 音/视频上传后，可通过[SearchMedia](~~86044~~)接口查询音/视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '"d4860fcc6ae9fed52e8938244****,e1db68cc586644b83e562bcd94****,hhhhhhh"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'NonExistVideoIds' => [ + 'description' => '不存在的音/视频ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的音/视频ID列表。', + 'type' => 'string', + 'example' => '["hhhhhhh"]', + ], + ], + 'TranscodeSummaryList' => [ + 'description' => '音/视频转码基础信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '转码任务创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2019-01-23T12:35:12Z', + ], + 'VideoId' => [ + 'description' => '音/视频ID。', + 'type' => 'string', + 'example' => 'e1db68cc586644b83e562bcd94****', + ], + 'CompleteTime' => [ + 'description' => '转码任务完成时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2019-01-23T12:40:12Z', + ], + 'TranscodeStatus' => [ + 'description' => '转码处理状态。取值：'."\n" + ."\n" + .'- **Processing**：处理中。'."\n" + .'- **Partial**：部分转码完成。'."\n" + .'- **CompleteAllSucc**：全部处理完成，且全部转码成功。'."\n" + .'- **CompleteAllFail**：全部处理完成，且全部转码失败，如果源片有问题，则不会发起任何转码作业，整个转码任务失败。'."\n" + .'- **CompletePartialSucc**：全部转码完成，但仅部分转码成功。', + 'type' => 'string', + 'example' => 'Processing', + ], + 'TranscodeTemplateGroupId' => [ + 'description' => '转码使用的模板组ID。', + 'type' => 'string', + 'example' => '44f9e406bbb*****736a9abe876ecc0', + ], + 'TranscodeJobInfoSummaryList' => [ + 'description' => '转码作业摘要信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '转码作业创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2019-02-27T03:34:46Z', + ], + 'ErrorMessage' => [ + 'description' => '转码失败的错误信息。', + 'type' => 'string', + 'example' => 'ErrorMessage', + ], + 'Height' => [ + 'description' => '转码输出视频的画面高。单位：px。', + 'type' => 'string', + 'example' => '960', + ], + 'TranscodeProgress' => [ + 'description' => '转码进度。取值范围：`[0,100]`。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'TranscodeTemplateId' => [ + 'description' => '使用的转码模板ID。', + 'type' => 'string', + 'example' => '57496724ae2*****0968d6e08acc8f6', + ], + 'Bitrate' => [ + 'description' => '转码输出视频的平均码率。单位：Kbps。', + 'type' => 'string', + 'example' => '749', + ], + 'ErrorCode' => [ + 'description' => '转码失败的错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'CompleteTime' => [ + 'description' => '转码作业完成时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-02-27T03:40:51Z', + ], + 'Width' => [ + 'description' => '转码输出视频的画面宽。单位：px。', + 'type' => 'string', + 'example' => '544', + ], + 'Duration' => [ + 'description' => '转码输出视频时长。单位：秒。', + 'type' => 'string', + 'example' => '12', + ], + 'Fps' => [ + 'description' => '转码输出视频的帧率。单位：帧/秒。', + 'type' => 'string', + 'example' => '30', + ], + 'TranscodeJobStatus' => [ + 'description' => '转码作业状态。取值：'."\n" + ."\n" + .'- **Transcoding**：转码中。'."\n" + .'- **TranscodeSuccess**：转码成功。'."\n" + .'- **TranscodeFail**：转码失败。', + 'type' => 'string', + 'example' => 'Transcoding', + ], + 'Filesize' => [ + 'description' => '转码输出视频的文件大小。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1144259', + ], + 'Format' => [ + 'description' => '转码输出视频的封装格式。', + 'type' => 'string', + 'example' => 'mp4', + ], + 'WatermarkIdList' => [ + 'description' => '转码使用的水印列表。', + 'type' => 'array', + 'items' => [ + 'description' => '转码使用的水印列表。', + 'type' => 'string', + 'example' => '["af2afe4761992c*****d947dae97337"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"NonExistVideoIds\\": [\\n \\"[\\\\\\"hhhhhhh\\\\\\"]\\"\\n ],\\n \\"TranscodeSummaryList\\": [\\n {\\n \\"CreationTime\\": \\"2019-01-23T12:35:12Z\\",\\n \\"VideoId\\": \\"e1db68cc586644b83e562bcd94****\\",\\n \\"CompleteTime\\": \\"2019-01-23T12:40:12Z\\",\\n \\"TranscodeStatus\\": \\"Processing\\",\\n \\"TranscodeTemplateGroupId\\": \\"44f9e406bbb*****736a9abe876ecc0\\",\\n \\"TranscodeJobInfoSummaryList\\": [\\n {\\n \\"CreationTime\\": \\"2019-02-27T03:34:46Z\\",\\n \\"ErrorMessage\\": \\"ErrorMessage\\",\\n \\"Height\\": \\"960\\",\\n \\"TranscodeProgress\\": 100,\\n \\"TranscodeTemplateId\\": \\"57496724ae2*****0968d6e08acc8f6\\",\\n \\"Bitrate\\": \\"749\\",\\n \\"ErrorCode\\": \\"200\\",\\n \\"CompleteTime\\": \\"2019-02-27T03:40:51Z\\",\\n \\"Width\\": \\"544\\",\\n \\"Duration\\": \\"12\\",\\n \\"Fps\\": \\"30\\",\\n \\"TranscodeJobStatus\\": \\"Transcoding\\",\\n \\"Filesize\\": 1144259,\\n \\"Format\\": \\"mp4\\",\\n \\"WatermarkIdList\\": [\\n \\"[\\\\\\"af2afe4761992c*****d947dae97337\\\\\\"]\\"\\n ]\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetTranscodeSummaryResponse>\\r\\n<RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\r\\n\\t<TranscodeSummaryList>\\r\\n\\t\\t<VideoId>e1db68cc58664*****4b83e562bcd9</VideoId>\\r\\n\\t\\t<TranscodeStatus>Processing</TranscodeStatus>\\r\\n\\t\\t<TranscodeTemplateGroupId>44f9e406bbb*****736a9abe876ecc0</TranscodeTemplateGroupId>\\r\\n\\t\\t<CreationTime>2019-01-23T12:35:12Z</CreationTime>\\r\\n\\t\\t<CompleteTime>2019-01-23T12:40:12Z</CompleteTime>\\r\\n\\t\\t<TranscodeJobInfoSummaryList>\\r\\n\\t\\t\\t<Format>mp4</Format>\\r\\n\\t\\t\\t<Encryption>{}</Encryption>\\r\\n\\t\\t\\t<TranscodeProgress>100</TranscodeProgress>\\r\\n\\t\\t\\t<Height>960</Height>\\r\\n\\t\\t\\t<CreationTime>2019-02-27T03:34:46Z</CreationTime>\\r\\n\\t\\t\\t<CompleteTime>2019-02-27T03:40:51Z</CompleteTime>\\r\\n\\t\\t\\t<TranscodeJobStatus>TranscodeSuccess</TranscodeJobStatus>\\r\\n\\t\\t\\t<Filesize>1144259</Filesize>\\r\\n\\t\\t\\t<WatermarkIdList>af2afe4761992c*****d947dae97337</WatermarkIdList>\\r\\n\\t\\t\\t<Duration>12</Duration>\\r\\n\\t\\t\\t<TranscodeTemplateId>57496724ae2*****0968d6e08acc8f6</TranscodeTemplateId>\\r\\n\\t\\t\\t<Width>544</Width>\\r\\n\\t\\t\\t<Fps>30</Fps>\\r\\n\\t\\t\\t<Bitrate>749</Bitrate>\\r\\n\\t\\t\\t<Definition>LD</Definition>\\r\\n\\t\\t</TranscodeJobInfoSummaryList>\\r\\n\\t\\t<TranscodeJobInfoSummaryList>\\r\\n\\t\\t\\t<Format>m3u8</Format>\\r\\n\\t\\t\\t<Encryption>{"EncryptType":"AliyunVoDEncryption"}</Encryption>\\r\\n\\t\\t\\t<TranscodeProgress>100</TranscodeProgress>\\r\\n\\t\\t\\t<Height>640</Height>\\r\\n\\t\\t\\t<CreationTime>2019-02-27T03:34:46Z</CreationTime>\\r\\n\\t\\t\\t<CompleteTime>2019-02-27T03:40:50Z</CompleteTime>\\r\\n\\t\\t\\t<TranscodeJobStatus>TranscodeSuccess</TranscodeJobStatus>\\r\\n\\t\\t\\t<Filesize>759520</Filesize>\\r\\n\\t\\t\\t<Duration>12</Duration>\\r\\n\\t\\t\\t<TranscodeTemplateId>4733b3a55b27*****82dae36ac22d34</TranscodeTemplateId>\\r\\n\\t\\t\\t<Width>360</Width>\\r\\n\\t\\t\\t<Fps>25</Fps>\\r\\n\\t\\t\\t<Bitrate>499</Bitrate>\\r\\n\\t\\t\\t<Definition>LD</Definition>\\r\\n\\t\\t</TranscodeJobInfoSummaryList>\\r\\n\\t</TranscodeSummaryList>\\r\\n\\t<NonExistVideoIds>hhhhhhh</NonExistVideoIds>\\r\\n</GetTranscodeSummaryResponse>","errorExample":""}]', + 'title' => '查询音视频转码摘要', + 'description' => '- 由于音视频可能存在多次转码，故本接口只返回最近一次的转码摘要。'."\n" + .'- 支持批量查询，单次最多可查询10个音视频的转码摘要。'."\n" + .'- 如需查询历史转码任务信息，可调用[ListTranscodeTask](~~109120~~)接口查询。'."\n" + .'- **本接口仅支持查询一年内的转码任务数据。**', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTranscodeTask' => [ + 'summary' => '调用本接口根据音视频ID查询音视频历史转码任务信息，本接口不返回具体的作业信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40073', + 'abilityTreeNodes' => [ + 'FEATUREvodAFH3DF', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '音/视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的音/视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看音/视频ID。'."\n" + .'- 通过[CreateUploadVideo](~~55407~~)接口获取上传地址和凭证时，音/视频ID为返回参数VideoId的值。'."\n" + .'- 音/视频上传后，可通过[SearchMedia](~~86044~~)接口查询音/视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd4860fcc6a5*****bce9fed52e893824', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-23T12:35:12Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间（需晚于开始时间）。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-23T12:40:12Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '查询页数据大小，传入此参数，立刻设置返回数据每页显示的条数。最大值为**50**，默认值为**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的当前页码。传入此参数，可指定查询数据从第几页开始返回。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'TranscodeTaskList' => [ + 'description' => '转码处理信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '转码任务创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-01-23T12:35:12Z', + ], + 'Trigger' => [ + 'description' => '触发类型。取值：'."\n" + ."\n" + .'- **Auto**：上传视频，自动触发。'."\n" + .'- **Manual**：SubmitTranscodeJobs接口触发。', + 'type' => 'string', + 'example' => 'Auto', + ], + 'TaskStatus' => [ + 'description' => '转码任务状态。'."\n" + ."\n" + .'- **Processing**：处理中。'."\n" + .'- **Partial**：部分转码完成。'."\n" + .'- **CompleteAllSucc**：全部处理完成，且全部转码成功。'."\n" + .'- **CompleteAllFail**：全部处理完成，且全部转码失败，如果源片有问题，则不会发起任何转码作业，整个转码任务失败。'."\n" + .'- **CompletePartialSucc**：全部转码完成，但仅部分转码成功。', + 'type' => 'string', + 'example' => 'Processing', + ], + 'VideoId' => [ + 'description' => '音/视频ID。', + 'type' => 'string', + 'example' => 'd4860fcc6a5*****bce9fed52e893824', + ], + 'CompleteTime' => [ + 'description' => '转码任务完成时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-01-23T12:40:12Z', + ], + 'TranscodeTemplateGroupId' => [ + 'description' => '转码使用的模板组ID。', + 'type' => 'string', + 'example' => 'b500c7094bd24*****f3e9900752d7c3', + ], + 'TranscodeTaskId' => [ + 'description' => '转码任务ID。', + 'type' => 'string', + 'example' => 'b1b65ab107*****ba3dbb900f6c1fe0', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"TranscodeTaskList\\": [\\n {\\n \\"CreationTime\\": \\"2019-01-23T12:35:12Z\\",\\n \\"Trigger\\": \\"Auto\\",\\n \\"TaskStatus\\": \\"Processing\\",\\n \\"VideoId\\": \\"d4860fcc6a5*****bce9fed52e893824\\",\\n \\"CompleteTime\\": \\"2019-01-23T12:40:12Z\\",\\n \\"TranscodeTemplateGroupId\\": \\"b500c7094bd24*****f3e9900752d7c3\\",\\n \\"TranscodeTaskId\\": \\"b1b65ab107*****ba3dbb900f6c1fe0\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListTranscodeTaskResponse>\\r\\n <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\r\\n\\t<TranscodeTaskList>\\r\\n\\t\\t<TranscodeTaskId>b1b65ab107*****ba3dbb900f6c1fe0</TranscodeTaskId>\\r\\n\\t\\t<VideoId>d4860fcc6a5*****bce9fed52e893824</VideoId>\\r\\n\\t\\t<TaskStatus>Processing</TaskStatus>\\r\\n\\t\\t<TranscodeTemplateGroupId>b500c7094bd24*****f3e9900752d7c3</TranscodeTemplateGroupId>\\r\\n\\t\\t<CreationTime>2019-01-23T12:35:12Z</CreationTime>\\r\\n\\t\\t<CompleteTime>2019-01-23T12:40:12Z</CompleteTime>\\r\\n\\t</TranscodeTaskList>\\r\\n\\t<TranscodeTaskList>\\r\\n\\t\\t<TranscodeTaskId>91449a74a9d7*****31e179a1ec1e</TranscodeTaskId>\\r\\n\\t\\t<VideoId>d4860fcc6a5*****bce9fed52e893824</VideoId>\\r\\n\\t\\t<TaskStatus>CompeleteAllSucc</TaskStatus>\\r\\n\\t\\t<TranscodeTemplateGroupId>947b9f5b0eb*****3d985df69d76b7</TranscodeTemplateGroupId>\\r\\n\\t\\t<CreationTime>2019-01-23T12:35:12Z</CreationTime>\\r\\n\\t\\t<CompleteTime>2019-01-23T12:40:12Z</CompleteTime>\\r\\n\\t</TranscodeTaskList>\\r\\n</ListTranscodeTaskResponse>","errorExample":""}]', + 'title' => '查询转码任务列表', + 'description' => '### 使用说明'."\n" + .'- 如需查询详细的转码作业信息，可以调用[GetTranscodeTask](~~109121~~)接口查询。'."\n" + .'- **本接口仅支持查询一年内的转码任务数据。**'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetTranscodeTask' => [ + 'summary' => '调用本接口根据转码任务ID查询转码作业详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39984', + 'abilityTreeNodes' => [ + 'FEATUREvodAFH3DF', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TranscodeTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '转码任务ID，可通过以下方式获取：'."\n" + .'- 通过[SubmitTranscodeJobs](~~68570~~)接口发起转码任务时，为返回参数TranscodeTaskId的值。'."\n" + .'- 通过[ListTranscodeTask](~~109120~~)接口查询，为请求后返回参数TranscodeTaskId的值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'b1b65ab107e14*****3dbb900f6c1fe0', + ], + ], + [ + 'name' => 'JobIds', + 'in' => 'query', + 'schema' => [ + 'description' => '转码作业ID，最多支持10个ID，多个ID之间使用半角逗号（,）分隔。可通过以下方式获取：'."\n" + .'- 通过[SubmitTranscodeJobs](~~68570~~)接口发起转码任务时，为返回参数JobId的值。', + 'type' => 'string', + 'required' => false, + 'example' => '86c1925fba0****,7afb201e7fa****,2cc4997378****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F4C6D5BE-BF13-45*****6C-516EA8906DCD', + ], + 'NonExistJobIds' => [ + 'description' => '不存在的转码作业ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的转码作业ID列表。', + 'type' => 'string', + 'example' => '["hhhhhhh"]', + ], + ], + 'TranscodeJobInfoList' => [ + 'description' => '转码作业信息。', + 'type' => 'array', + 'items' => [ + 'description' => '转码作业信息。', + 'type' => 'object', + 'properties' => [ + 'Definition' => [ + 'description' => '视频清晰度。取值：'."\n" + ."\n" + .'- **LD**：流畅。'."\n" + .'- **SD**：标清。'."\n" + .'- **HD**：高清。'."\n" + .'- **FHD**：超清。'."\n" + .'- **OD**：原画。'."\n" + .'- **2K**：2K。'."\n" + .'- **4K**：4K。'."\n" + .'- **SQ**：普通音质。'."\n" + .'- **HQ**：高音质'."\n" + .'- **AUTO**：自适应码率。仅当转码模板中配置了打包时才会有该清晰度输出，请参见[转码模板配置-PackageSetting](~~52839~~)。'."\n" + ."\n" + .'> 该值为转码模板配置的清晰度标记，不表示转码输出文件实际的分辨率范围。', + 'type' => 'string', + 'example' => 'LD', + ], + 'CreationTime' => [ + 'description' => '转码作业创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-02-26T08:27:16Z', + ], + 'InputFileUrl' => [ + 'description' => '转码源文件的OSS地址。', + 'type' => 'string', + 'example' => 'http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/customerTrans/5b95e568f8e*****47f38e/31f1184c-*****b2a2-f94-c213f.wmv', + ], + 'ErrorMessage' => [ + 'description' => '转码失败错误信息。', + 'type' => 'string', + 'example' => 'ErrorMessage', + ], + 'ErrorCode' => [ + 'description' => '转码失败错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'CompleteTime' => [ + 'description' => '转码作业完成时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-02-26T08:30:16Z'."\n", + ], + 'TranscodeProgress' => [ + 'description' => '转码作业处理进度。取值范围：`[0,100]`。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2019-02-26T08:30:16Z'."\n", + ], + 'Priority' => [ + 'description' => '转码任务优先级。', + 'type' => 'string', + 'example' => '6', + ], + 'TranscodeJobStatus' => [ + 'description' => '转码作业状态。'."\n" + .'- **Transcoding**：转码中。'."\n" + .'- **TranscodeSuccess**：转码成功。'."\n" + .'- **TranscodeFail**：转码失败。', + 'type' => 'string', + 'example' => 'Transcoding', + ], + 'TranscodeTemplateId' => [ + 'description' => '转码使用的转码模板ID。', + 'type' => 'string', + 'example' => '174b0534fea3*****b51c8f0ad1374', + ], + 'TranscodeJobId' => [ + 'description' => '转码作业ID。', + 'type' => 'string', + 'example' => '38f0e513c88*****85515f9d50be188', + ], + 'OutputFile' => [ + 'description' => '转码输出文件的信息。', + 'type' => 'object', + 'properties' => [ + 'VideoStreamList' => [ + 'description' => '视频流列表。', + 'type' => 'string', + 'example' => '[{\\"AvgFPS\\":\\"30.0\\",\\"Bitrate\\":\\"933.814\\",\\"CodecLongName\\":\\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\"CodecName\\":\\"h264\\",\\"CodecTag\\":\\"0x31637661\\",\\"CodecTagString\\":\\"avc1\\",\\"CodecTimeBase\\":\\"1/60\\",\\"Dar\\":\\"9:16\\",\\"Duration\\":\\"12.033333\\",\\"Fps\\":\\"30.0\\",\\"HasBFrames\\":\\"2\\",\\"Height\\":\\"360\\",\\"Index\\":\\"0\\",\\"Lang\\":\\"und\\",\\"Level\\":\\"30\\",\\"PixFmt\\":\\"yuv420p\\",\\"Profile\\":\\"High\\",\\"Sar\\":\\"81:256\\",\\"StartTime\\":\\"0.000000\\",\\"Timebase\\":\\"1/15360\\",\\"Width\\":\\"640\\"}]', + ], + 'OutputFileUrl' => [ + 'description' => '转码输出文件的OSS地址。', + 'type' => 'string', + 'example' => 'http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/883f5d*****f20aaa352f/c3be4f073*****7d5193ec8-{DestMd5}-od-S00000001-200000.mp4', + ], + 'Encryption' => [ + 'description' => '转码输出文件使用的加密配置。取值：'."\n" + ."\n" + .'- **AliyunVoDEncryption**：阿里云视频加密（私有加密）。'."\n" + .'- **HLSEncryption**：HLS标准加密。', + 'type' => 'string', + 'example' => '{\\"EncryptType\\":\\"AliyunVoDEncryption\\"}', + ], + 'Height' => [ + 'description' => '转码输出文件视频画面高。单位：px。', + 'type' => 'string', + 'example' => '360', + ], + 'SubtitleStreamList' => [ + 'description' => '字幕流列表。', + 'type' => 'string', + 'example' => '[]', + ], + 'Bitrate' => [ + 'description' => '转码输出文件平均码率。单位：Kbps。', + 'type' => 'string', + 'example' => '964', + ], + 'AudioStreamList' => [ + 'description' => '音频流列表。', + 'type' => 'string', + 'example' => '"AudioStreamList": "[{\\"Bitrate\\":\\"64.533\\",\\"ChannelLayout\\":\\"stereo\\",\\"Channels\\":\\"2\\",\\"CodecLongName\\":\\"AAC (Advanced Audio Coding)\\",\\"CodecName\\":\\"aac\\",\\"CodecTag\\":\\"0x6134706d\\",\\"CodecTagString\\":\\"mp4a\\",\\"CodecTimeBase\\":\\"1/44100\\",\\"Duration\\":\\"12.615533\\",\\"Index\\":\\"1\\",\\"Lang\\":\\"und\\",\\"SampleFmt\\":\\"fltp\\",\\"Samplerate\\":\\"44100\\",\\"StartTime\\":\\"-0.046440\\",\\"Timebase\\":\\"1/44100\\"}]', + ], + 'Width' => [ + 'description' => '转码输出文件视频画面宽。单位：px。', + 'type' => 'string', + 'example' => '640', + ], + 'Fps' => [ + 'description' => '转码输出文件的帧率。单位：帧/秒。', + 'type' => 'string', + 'example' => '25', + ], + 'Duration' => [ + 'description' => '转码输出文件时长。单位：秒。', + 'type' => 'string', + 'example' => '12', + ], + 'Format' => [ + 'description' => '转码输出文件的封装格式。', + 'type' => 'string', + 'example' => 'm3u8', + ], + 'Filesize' => [ + 'description' => '转码输出文件大小。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '851076', + ], + 'WatermarkIdList' => [ + 'description' => '转码使用的水印列表。', + 'type' => 'array', + 'items' => [ + 'description' => '转码使用的水印列表。', + 'type' => 'string', + 'example' => '["64079a0e3e286*****b48a8c9413"]', + ], + ], + ], + ], + ], + ], + ], + 'TranscodeTask' => [ + 'description' => '转码任务信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '转码任务创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-01-23T12:35:12Z', + ], + 'Trigger' => [ + 'description' => '触发类型。取值：'."\n" + ."\n" + .'- **Auto**：上传视频，自动触发。'."\n" + .'- **Manual** ：SubmitTranscodeJobs接口触发。', + 'type' => 'string', + 'example' => 'Auto ', + ], + 'TaskStatus' => [ + 'description' => '转码任务状态。取值：'."\n" + ."\n" + .'- **Processing**：处理中。'."\n" + .'- **Partial**：部分转码完成。'."\n" + .'- **CompleteAllSucc**：全部处理完成，且全部转码成功。'."\n" + .'- **CompleteAllFail**：全部处理完成，且全部转码失败，如果源片有问题，则不会发起任何转码作业，整个转码任务失败。'."\n" + .'- **CompletePartialSucc**：全部转码完成，但仅部分转码成功。', + 'type' => 'string', + 'example' => 'Processing', + ], + 'VideoId' => [ + 'description' => '音/视频ID。', + 'type' => 'string', + 'example' => '883f5d98107*****b7f20aaa352f', + ], + 'CompleteTime' => [ + 'description' => '转码任务完成时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-01-23T12:40:12Z', + ], + 'TranscodeTemplateGroupId' => [ + 'description' => '转码使用的模板组ID。', + 'type' => 'string', + 'example' => 'b500c7094bd241*****3e9900752d7c3', + ], + 'TranscodeTaskId' => [ + 'description' => '转码任务ID。', + 'type' => 'string', + 'example' => 'b1b65ab107e14*****3dbb900f6c1fe0', + ], + 'TranscodeJobInfoList' => [ + 'description' => '转码作业信息。', + 'type' => 'array', + 'items' => [ + 'description' => '转码作业信息。', + 'type' => 'object', + 'properties' => [ + 'Definition' => [ + 'description' => "\n" + .'视频清晰度。取值：'."\n" + ."\n" + .'- **LD**：流畅。'."\n" + .'- **SD**：标清。'."\n" + .'- **HD**：高清。'."\n" + .'- **FHD**：超清。'."\n" + .'- **OD**：原画。'."\n" + .'- **2K**：2K。'."\n" + .'- **4K**：4K。'."\n" + .'- **SQ**：普通音质。'."\n" + .'- **HQ**：高音质'."\n" + .'- **AUTO**：自适应码率。仅当转码模板中配置了打包时才会有该清晰度输出，请参见[转码模板配置-PackageSetting](~~52839~~)。'."\n" + ."\n" + .'> 该值为转码模板配置的清晰度标记，不表示转码输出文件实际的分辨率范围。', + 'type' => 'string', + 'example' => 'LD', + ], + 'CreationTime' => [ + 'description' => '转码作业创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2019-02-26T08:27:16Z', + ], + 'InputFileUrl' => [ + 'description' => '转码源文件的OSS地址。', + 'type' => 'string', + 'example' => 'http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/customerTrans/5b95e568f8e*****47f38e/31f1184c-*****b2a2-f94-c213f.wmv', + ], + 'ErrorMessage' => [ + 'description' => '转码失败错误信息。', + 'type' => 'string', + 'example' => 'ErrorMessage', + ], + 'ErrorCode' => [ + 'description' => '转码失败错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'CompleteTime' => [ + 'description' => '转码作业完成时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2019-02-26T08:30:16Z', + ], + 'TranscodeProgress' => [ + 'description' => '转码作业处理进度。取值范围：`[0,100]`。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Priority' => [ + 'description' => '转码任务优先级。', + 'type' => 'string', + 'example' => '6', + ], + 'TranscodeJobStatus' => [ + 'description' => '转码作业状态。'."\n" + .'- **Transcoding**：转码中。'."\n" + .'- **TranscodeSuccess**：转码成功。'."\n" + .'- **TranscodeFail**：转码失败。', + 'type' => 'string', + 'example' => 'Transcoding', + ], + 'TranscodeTemplateId' => [ + 'description' => '转码使用的转码模板ID。', + 'type' => 'string', + 'example' => '174b0534fea3*****b51c8f0ad1374', + ], + 'TranscodeJobId' => [ + 'description' => '转码作业ID。', + 'type' => 'string', + 'example' => '38f0e513c88*****85515f9d50be188', + ], + 'OutputFile' => [ + 'description' => '转码输出文件的信息。', + 'type' => 'object', + 'properties' => [ + 'VideoStreamList' => [ + 'description' => '视频流列表。', + 'type' => 'string', + 'example' => '[{\\"AvgFPS\\":\\"30.0\\",\\"Bitrate\\":\\"933.814\\",\\"CodecLongName\\":\\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\"CodecName\\":\\"h264\\",\\"CodecTag\\":\\"0x31637661\\",\\"CodecTagString\\":\\"avc1\\",\\"CodecTimeBase\\":\\"1/60\\",\\"Dar\\":\\"9:16\\",\\"Duration\\":\\"12.033333\\",\\"Fps\\":\\"30.0\\",\\"HasBFrames\\":\\"2\\",\\"Height\\":\\"360\\",\\"Index\\":\\"0\\",\\"Lang\\":\\"und\\",\\"Level\\":\\"30\\",\\"PixFmt\\":\\"yuv420p\\",\\"Profile\\":\\"High\\",\\"Sar\\":\\"81:256\\",\\"StartTime\\":\\"0.000000\\",\\"Timebase\\":\\"1/15360\\",\\"Width\\":\\"640\\"}]', + ], + 'OutputFileUrl' => [ + 'description' => '转码输出文件的OSS地址。', + 'type' => 'string', + 'example' => 'http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/883f5d*****f20aaa352f/c3be4f073*****7d5193ec8-{DestMd5}-od-S00000001-200000.mp4', + ], + 'Encryption' => [ + 'description' => '转码输出文件使用的加密配置。取值：'."\n" + ."\n" + .'- **AliyunVoDEncryption**：阿里云视频加密（私有加密）。'."\n" + .'- **HLSEncryption**：HLS标准加密。', + 'type' => 'string', + 'example' => '{\\"EncryptType\\":\\"AliyunVoDEncryption\\"}', + ], + 'Height' => [ + 'description' => '转码输出文件视频画面高。单位：px。', + 'type' => 'string', + 'example' => '360', + ], + 'SubtitleStreamList' => [ + 'description' => '字幕流列表。', + 'type' => 'string', + 'example' => '[]', + ], + 'Bitrate' => [ + 'description' => '转码输出文件平均码率。单位：Kbps。', + 'type' => 'string', + 'example' => '964', + ], + 'AudioStreamList' => [ + 'description' => '音频流列表。', + 'type' => 'string', + 'example' => '"AudioStreamList": "[{\\"Bitrate\\":\\"64.533\\",\\"ChannelLayout\\":\\"stereo\\",\\"Channels\\":\\"2\\",\\"CodecLongName\\":\\"AAC (Advanced Audio Coding)\\",\\"CodecName\\":\\"aac\\",\\"CodecTag\\":\\"0x6134706d\\",\\"CodecTagString\\":\\"mp4a\\",\\"CodecTimeBase\\":\\"1/44100\\",\\"Duration\\":\\"12.615533\\",\\"Index\\":\\"1\\",\\"Lang\\":\\"und\\",\\"SampleFmt\\":\\"fltp\\",\\"Samplerate\\":\\"44100\\",\\"StartTime\\":\\"-0.046440\\",\\"Timebase\\":\\"1/44100\\"}]', + ], + 'Width' => [ + 'description' => '转码输出文件视频画面宽。单位：px。', + 'type' => 'string', + 'example' => '640', + ], + 'Fps' => [ + 'description' => '转码输出文件的帧率。单位：帧/秒。', + 'type' => 'string', + 'example' => '25', + ], + 'Duration' => [ + 'description' => '转码输出文件时长。单位：秒。', + 'type' => 'string', + 'example' => '12', + ], + 'Format' => [ + 'description' => '转码输出文件的封装格式。', + 'type' => 'string', + 'example' => 'm3u8', + ], + 'Filesize' => [ + 'description' => '转码输出文件大小。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '851076', + ], + 'WatermarkIdList' => [ + 'description' => '转码输出文件使用的水印ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '转码输出文件使用的水印ID列表。', + 'type' => 'string', + 'example' => '["64079a0e3e286*****b48a8c9413"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F4C6D5BE-BF13-45*****6C-516EA8906DCD\\",\\n \\"NonExistJobIds\\": [\\n \\"[\\\\\\"hhhhhhh\\\\\\"]\\"\\n ],\\n \\"TranscodeJobInfoList\\": [\\n {\\n \\"Definition\\": \\"LD\\",\\n \\"CreationTime\\": \\"2019-02-26T08:27:16Z\\",\\n \\"InputFileUrl\\": \\"http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/customerTrans/5b95e568f8e*****47f38e/31f1184c-*****b2a2-f94-c213f.wmv\\",\\n \\"ErrorMessage\\": \\"ErrorMessage\\",\\n \\"ErrorCode\\": \\"200\\",\\n \\"CompleteTime\\": \\"2019-02-26T08:30:16Z\\\\n\\",\\n \\"TranscodeProgress\\": 0,\\n \\"Priority\\": \\"6\\",\\n \\"TranscodeJobStatus\\": \\"Transcoding\\",\\n \\"TranscodeTemplateId\\": \\"174b0534fea3*****b51c8f0ad1374\\",\\n \\"TranscodeJobId\\": \\"38f0e513c88*****85515f9d50be188\\",\\n \\"OutputFile\\": {\\n \\"VideoStreamList\\": \\"[{\\\\\\\\\\\\\\"AvgFPS\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"30.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Bitrate\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"933.814\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecLongName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"h264\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecTag\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0x31637661\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecTagString\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"avc1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecTimeBase\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1/60\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Dar\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"9:16\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Duration\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"12.033333\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Fps\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"30.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"HasBFrames\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Height\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"360\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Index\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Lang\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"und\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"30\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PixFmt\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"yuv420p\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Profile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"High\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Sar\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"81:256\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"StartTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.000000\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Timebase\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1/15360\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Width\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"640\\\\\\\\\\\\\\"}]\\",\\n \\"OutputFileUrl\\": \\"http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/883f5d*****f20aaa352f/c3be4f073*****7d5193ec8-{DestMd5}-od-S00000001-200000.mp4\\",\\n \\"Encryption\\": \\"{\\\\\\\\\\\\\\"EncryptType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AliyunVoDEncryption\\\\\\\\\\\\\\"}\\",\\n \\"Height\\": \\"360\\",\\n \\"SubtitleStreamList\\": \\"[]\\",\\n \\"Bitrate\\": \\"964\\",\\n \\"AudioStreamList\\": \\"\\\\\\"AudioStreamList\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"Bitrate\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"64.533\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ChannelLayout\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"stereo\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Channels\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecLongName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AAC (Advanced Audio Coding)\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"aac\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecTag\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0x6134706d\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecTagString\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"mp4a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecTimeBase\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1/44100\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Duration\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"12.615533\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Index\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Lang\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"und\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SampleFmt\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"fltp\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Samplerate\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"44100\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"StartTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"-0.046440\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Timebase\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1/44100\\\\\\\\\\\\\\"}]\\",\\n \\"Width\\": \\"640\\",\\n \\"Fps\\": \\"25\\",\\n \\"Duration\\": \\"12\\",\\n \\"Format\\": \\"m3u8\\",\\n \\"Filesize\\": 851076,\\n \\"WatermarkIdList\\": [\\n \\"[\\\\\\"64079a0e3e286*****b48a8c9413\\\\\\"]\\"\\n ]\\n }\\n }\\n ],\\n \\"TranscodeTask\\": {\\n \\"CreationTime\\": \\"2019-01-23T12:35:12Z\\",\\n \\"Trigger\\": \\"Auto \\",\\n \\"TaskStatus\\": \\"Processing\\",\\n \\"VideoId\\": \\"883f5d98107*****b7f20aaa352f\\",\\n \\"CompleteTime\\": \\"2019-01-23T12:40:12Z\\",\\n \\"TranscodeTemplateGroupId\\": \\"b500c7094bd241*****3e9900752d7c3\\",\\n \\"TranscodeTaskId\\": \\"b1b65ab107e14*****3dbb900f6c1fe0\\",\\n \\"TranscodeJobInfoList\\": [\\n {\\n \\"Definition\\": \\"LD\\",\\n \\"CreationTime\\": \\"2019-02-26T08:27:16Z\\",\\n \\"InputFileUrl\\": \\"http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/customerTrans/5b95e568f8e*****47f38e/31f1184c-*****b2a2-f94-c213f.wmv\\",\\n \\"ErrorMessage\\": \\"ErrorMessage\\",\\n \\"ErrorCode\\": \\"200\\",\\n \\"CompleteTime\\": \\"2019-02-26T08:30:16Z\\",\\n \\"TranscodeProgress\\": 100,\\n \\"Priority\\": \\"6\\",\\n \\"TranscodeJobStatus\\": \\"Transcoding\\",\\n \\"TranscodeTemplateId\\": \\"174b0534fea3*****b51c8f0ad1374\\",\\n \\"TranscodeJobId\\": \\"38f0e513c88*****85515f9d50be188\\",\\n \\"OutputFile\\": {\\n \\"VideoStreamList\\": \\"[{\\\\\\\\\\\\\\"AvgFPS\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"30.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Bitrate\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"933.814\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecLongName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"h264\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecTag\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0x31637661\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecTagString\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"avc1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecTimeBase\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1/60\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Dar\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"9:16\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Duration\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"12.033333\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Fps\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"30.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"HasBFrames\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Height\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"360\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Index\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Lang\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"und\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Level\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"30\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PixFmt\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"yuv420p\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Profile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"High\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Sar\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"81:256\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"StartTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.000000\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Timebase\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1/15360\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Width\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"640\\\\\\\\\\\\\\"}]\\",\\n \\"OutputFileUrl\\": \\"http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/883f5d*****f20aaa352f/c3be4f073*****7d5193ec8-{DestMd5}-od-S00000001-200000.mp4\\",\\n \\"Encryption\\": \\"{\\\\\\\\\\\\\\"EncryptType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AliyunVoDEncryption\\\\\\\\\\\\\\"}\\",\\n \\"Height\\": \\"360\\",\\n \\"SubtitleStreamList\\": \\"[]\\",\\n \\"Bitrate\\": \\"964\\",\\n \\"AudioStreamList\\": \\"\\\\\\"AudioStreamList\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"Bitrate\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"64.533\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ChannelLayout\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"stereo\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Channels\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecLongName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AAC (Advanced Audio Coding)\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"aac\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecTag\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0x6134706d\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecTagString\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"mp4a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CodecTimeBase\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1/44100\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Duration\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"12.615533\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Index\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Lang\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"und\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SampleFmt\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"fltp\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Samplerate\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"44100\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"StartTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"-0.046440\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Timebase\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1/44100\\\\\\\\\\\\\\"}]\\",\\n \\"Width\\": \\"640\\",\\n \\"Fps\\": \\"25\\",\\n \\"Duration\\": \\"12\\",\\n \\"Format\\": \\"m3u8\\",\\n \\"Filesize\\": 851076,\\n \\"WatermarkIdList\\": [\\n \\"[\\\\\\"64079a0e3e286*****b48a8c9413\\\\\\"]\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTranscodeTaskResponse>\\n<RequestId>F4C6D5BE-BF13-45*****6C-516EA8906DCD</RequestId>\\n<TranscodeTask>\\n <TranscodeJobInfoList>\\n <TranscodeTemplateId>174b0534fea3*****b51c8f0ad1374</TranscodeTemplateId>\\n <Priority>6</Priority>\\n <InputFileUrl>http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/customerTrans/5b95e568f8e*****47f38e/31f1184c-*****b2a2-f94-c213f.wmv</InputFileUrl>\\n <Definition>LD</Definition>\\n <CreationTime>2019-02-26T08:27:16Z</CreationTime>\\n <TranscodeJobStatus>Transcoding</TranscodeJobStatus>\\n <TranscodeJobId>38f0e513c88*****85515f9d50be188</TranscodeJobId>\\n <ErrorCode>200</ErrorCode>\\n <TranscodeProgress>100</TranscodeProgress>\\n <ErrorMessage>ErrorMessage</ErrorMessage>\\n <CompleteTime>2019-02-26T08:30:16Z</CompleteTime>\\n </TranscodeJobInfoList>\\n <TranscodeJobInfoList>\\n <OutputFile>\\n <OutputFileUrl>http://outin-40564*****e1403e7.oss-cn-shanghai.aliyuncs.com/883f5d*****f20aaa352f/c3be4f073*****7d5193ec8-{DestMd5}-od-S00000001-200000.mp4</OutputFileUrl>\\n <Fps>25</Fps>\\n <VideoStreamList>[{\\\\\\"AvgFPS\\\\\\":\\\\\\"30.0\\\\\\",\\\\\\"Bitrate\\\\\\":\\\\\\"933.814\\\\\\",\\\\\\"CodecLongName\\\\\\":\\\\\\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\\\\\",\\\\\\"CodecName\\\\\\":\\\\\\"h264\\\\\\",\\\\\\"CodecTag\\\\\\":\\\\\\"0x31637661\\\\\\",\\\\\\"CodecTagString\\\\\\":\\\\\\"avc1\\\\\\",\\\\\\"CodecTimeBase\\\\\\":\\\\\\"1/60\\\\\\",\\\\\\"Dar\\\\\\":\\\\\\"9:16\\\\\\",\\\\\\"Duration\\\\\\":\\\\\\"12.033333\\\\\\",\\\\\\"Fps\\\\\\":\\\\\\"30.0\\\\\\",\\\\\\"HasBFrames\\\\\\":\\\\\\"2\\\\\\",\\\\\\"Height\\\\\\":\\\\\\"360\\\\\\",\\\\\\"Index\\\\\\":\\\\\\"0\\\\\\",\\\\\\"Lang\\\\\\":\\\\\\"und\\\\\\",\\\\\\"Level\\\\\\":\\\\\\"30\\\\\\",\\\\\\"PixFmt\\\\\\":\\\\\\"yuv420p\\\\\\",\\\\\\"Profile\\\\\\":\\\\\\"High\\\\\\",\\\\\\"Sar\\\\\\":\\\\\\"81:256\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"0.000000\\\\\\",\\\\\\"Timebase\\\\\\":\\\\\\"1/15360\\\\\\",\\\\\\"Width\\\\\\":\\\\\\"640\\\\\\"}]</VideoStreamList>\\n <Duration>12</Duration>\\n <AudioStreamList>\\"AudioStreamList\\": \\"[{\\\\\\"Bitrate\\\\\\":\\\\\\"64.533\\\\\\",\\\\\\"ChannelLayout\\\\\\":\\\\\\"stereo\\\\\\",\\\\\\"Channels\\\\\\":\\\\\\"2\\\\\\",\\\\\\"CodecLongName\\\\\\":\\\\\\"AAC (Advanced Audio Coding)\\\\\\",\\\\\\"CodecName\\\\\\":\\\\\\"aac\\\\\\",\\\\\\"CodecTag\\\\\\":\\\\\\"0x6134706d\\\\\\",\\\\\\"CodecTagString\\\\\\":\\\\\\"mp4a\\\\\\",\\\\\\"CodecTimeBase\\\\\\":\\\\\\"1/44100\\\\\\",\\\\\\"Duration\\\\\\":\\\\\\"12.615533\\\\\\",\\\\\\"Index\\\\\\":\\\\\\"1\\\\\\",\\\\\\"Lang\\\\\\":\\\\\\"und\\\\\\",\\\\\\"SampleFmt\\\\\\":\\\\\\"fltp\\\\\\",\\\\\\"Samplerate\\\\\\":\\\\\\"44100\\\\\\",\\\\\\"StartTime\\\\\\":\\\\\\"-0.046440\\\\\\",\\\\\\"Timebase\\\\\\":\\\\\\"1/44100\\\\\\"}]</AudioStreamList>\\n <Encryption>{\\\\\\"EncryptType\\\\\\":\\\\\\"AliyunVoDEncryption\\\\\\"}</Encryption>\\n <Filesize>851076</Filesize>\\n <Bitrate>964</Bitrate>\\n <WatermarkIdList>[\\"64079a0e3e286*****b48a8c9413\\"]</WatermarkIdList>\\n <Format>m3u8</Format>\\n <SubtitleStreamList>[]</SubtitleStreamList>\\n <Height>360</Height>\\n <Width>640</Width>\\n </OutputFile>\\n </TranscodeJobInfoList>\\n <Trigger>Auto </Trigger>\\n <VideoId>883f5d98107*****b7f20aaa352f</VideoId>\\n <TranscodeTemplateGroupId>b500c7094bd241*****3e9900752d7c3</TranscodeTemplateGroupId>\\n <CreationTime>2019-01-23T12:35:12Z</CreationTime>\\n <TaskStatus>Processing</TaskStatus>\\n <CompleteTime>2019-01-23T12:40:12Z</CompleteTime>\\n <TranscodeTaskId>b1b65ab107e14*****3dbb900f6c1fe0</TranscodeTaskId>\\n</TranscodeTask>\\n</GetTranscodeTaskResponse>","errorExample":""}]', + 'title' => '查询转码任务详情', + 'description' => '### 使用说明'."\n" + .'**本接口仅支持查询一年内的转码任务数据。**'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| NoSuchResource |The specified resource %s does not exist. |404 |特定的信息不存在，%s表示指定的信息。 |', + ], + 'ListJobInfo' => [ + 'summary' => '调用本接口根据媒资ID查询历史任务列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '248267', + 'abilityTreeNodes' => [ + 'FEATUREvodAFH3DF', + 'FEATUREvodW76Z9M', + 'FEATUREvod7BX3NA', + 'FEATUREvodFAR72I', + 'FEATUREvodIPBMLH', + 'FEATUREvod5413CB', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID', + 'type' => 'string', + 'required' => true, + 'example' => '30e5d7**********bd900764de7c0102', + ], + ], + [ + 'name' => 'JobType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，取值：'."\n" + ."\n" + .'- transcode'."\n" + ."\n" + .'- snapshot'."\n" + ."\n" + .'- ai', + 'type' => 'string', + 'required' => true, + 'example' => 'transcode', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求唯一标识', + 'type' => 'string', + 'example' => '6708D849-F109-1A6C-AC91-************'."\n", + ], + 'MediaId' => [ + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '30e5d7**********bd900764de7c0102'."\n", + ], + 'JobType' => [ + 'description' => '任务类型，取值：'."\n" + ."\n" + .'- transcode'."\n" + ."\n" + .'- snapshot'."\n" + ."\n" + .'- ai', + 'type' => 'string', + 'example' => 'transcode', + ], + 'JobInfoList' => [ + 'description' => '6个月内历史任务列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '5c9dff751ba**********59d50a967f5', + ], + 'Status' => [ + 'description' => '任务状态', + 'type' => 'string', + 'example' => 'TranscodeSuccess', + ], + 'UserId' => [ + 'description' => '发起该任务的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '139109*****84930', + ], + 'CreateTime' => [ + 'description' => '任务创建时间，UTC格式，YYYY-MM-DDTHH:MM:SSZ', + 'type' => 'string', + 'example' => '2024-10-14T07:39:25Z'."\n", + ], + 'CompleteTime' => [ + 'description' => '任务完成时间', + 'type' => 'string', + 'example' => '2024-10-14T07:39:34Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6708D849-F109-1A6C-AC91-************\\\\n\\",\\n \\"MediaId\\": \\"30e5d7**********bd900764de7c0102\\\\n\\",\\n \\"JobType\\": \\"transcode\\",\\n \\"JobInfoList\\": [\\n {\\n \\"JobId\\": \\"5c9dff751ba**********59d50a967f5\\",\\n \\"Status\\": \\"TranscodeSuccess\\",\\n \\"UserId\\": 0,\\n \\"CreateTime\\": \\"2024-10-14T07:39:25Z\\\\n\\",\\n \\"CompleteTime\\": \\"2024-10-14T07:39:34Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询任务列表', + 'description' => '**使用说明**'."\n" + ."\n" + .'- 如需查询详细的任务信息，可以调用 [GetJobDetail](~~2861326~~)接口查询。'."\n" + .'- 本接口仅支持查询6个月内的异步任务数据。可查询的任务种类：转码任务，截图任务，AI任务。'."\n" + ."\n" + .'**QPS 限制**'."\n" + ."\n" + .'本接口的单用户 QPS 限制为 15 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + ], + 'GetJobDetail' => [ + 'summary' => '调用本接口根据jobId查询异步任务详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '248075', + 'abilityTreeNodes' => [ + 'FEATUREvodAFH3DF', + 'FEATUREvodW76Z9M', + 'FEATUREvod7BX3NA', + 'FEATUREvodFAR72I', + 'FEATUREvodIPBMLH', + 'FEATUREvod5413CB', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务 ID', + 'type' => 'string', + 'required' => true, + 'example' => '5c9dff***************59d50a967f5', + ], + ], + [ + 'name' => 'JobType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，取值：'."\n" + ."\n" + .'- transcode'."\n" + ."\n" + .'- snapshot'."\n" + ."\n" + .'- ai', + 'type' => 'string', + 'required' => true, + 'example' => 'transcode', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求唯一标识', + 'type' => 'string', + 'example' => '6708D849-F109-1A6C-AC91-************', + ], + 'JobType' => [ + 'description' => '任务类型', + 'type' => 'string', + 'example' => 'transcode', + ], + 'TranscodeJobDetail' => [ + 'description' => '转码任务详细信息，仅当 jobType 为 Transcode，该字段有值。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '2dc1634e**********3f1d22d1a0174e', + ], + 'UserId' => [ + 'description' => '发起该任务的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '139109*****84930', + ], + 'VideoId' => [ + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '30e5d7**********bd900764de7c0102', + ], + 'Status' => [ + 'description' => '任务状态，取值：'."\n" + ."\n" + .'- Submitted，已提交'."\n" + .'- Transcoding，转码中'."\n" + .'- TranscodeSuccess，转码成功'."\n" + .'- TranscodeFail，转码失败'."\n" + .'- TranscodeCancelled，取消转码', + 'type' => 'string', + 'example' => 'TranscodeSuccess', + ], + 'TemplateId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => 'dbfaaec9e**********bf0b81219244c', + ], + 'Definition' => [ + 'description' => '清晰度', + 'type' => 'string', + 'example' => 'HD', + ], + 'CreateTime' => [ + 'description' => '任务创建时间，UTC格式，YYYY-MM-DDTHH:MM:SSZ', + 'type' => 'string', + 'example' => '2024-10-14T07:39:25Z', + ], + 'CompleteTime' => [ + 'description' => '任务完成时间', + 'type' => 'string', + 'example' => '2024-10-14T07:39:34Z', + ], + ], + ], + 'SnapshotJobDetail' => [ + 'description' => '截图任务详细信息，仅当 jobType 为 Snapshot，该字段有值', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '63df12s0**********4hdq249t82kr91', + ], + 'UserId' => [ + 'description' => '发起该任务的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '139109*****84930', + ], + 'VideoId' => [ + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '30e5d7**********bd900764de7c0102', + ], + 'Status' => [ + 'description' => '任务状态，取值：'."\n" + ."\n" + .'- Processing，处理中'."\n" + .'- Fail，任务失败'."\n" + .'- Success，任务成功', + 'type' => 'string', + 'example' => 'Success', + ], + 'Trigger' => [ + 'description' => '触发方式，取值：'."\n" + ."\n" + .'- Auto，工作流自动触发'."\n" + .'- Manual，手动提交任务', + 'type' => 'string', + 'example' => 'Auto', + ], + 'NormalConfig' => [ + 'description' => '普通截图配置', + 'type' => 'string', + 'example' => '{"inl":0,"num":32,"tm":5,"wd":"352","ft":"normal","hg":"640"}', + ], + 'SpriteConfig' => [ + 'description' => '雪碧图配置', + 'type' => 'string', + 'example' => '{"pad":"0","lines":"10","mgin":"0","cols":"10","ikcp":"false","hg":"68"}', + ], + 'CreateTime' => [ + 'description' => '任务创建时间，UTC格式，YYYY-MM-DDTHH:MM:SSZ', + 'type' => 'string', + 'example' => '2024-10-14T07:39:25Z', + ], + 'CompleteTime' => [ + 'description' => '任务完成时间', + 'type' => 'string', + 'example' => '2024-10-14T07:39:45Z', + ], + ], + ], + 'AIJobDetail' => [ + 'description' => 'AI任务详细信息，仅当 TaskType 为 AI，该字段有值', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '5c9dff751ba**********59d50a967f5', + ], + 'UserId' => [ + 'description' => '发起该任务的用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '139109*****84930'."\n", + ], + 'MediaId' => [ + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '30e5d7**********bd900764de7c0102', + ], + 'JobType' => [ + 'description' => 'AI任务类型', + 'type' => 'string', + 'example' => 'AIVideoCensor', + ], + 'Status' => [ + 'description' => '任务状态，取值：'."\n" + .'- reserved，已提交'."\n" + .'- init，已启动'."\n" + .'- success，执行成功'."\n" + .'- fail，执行失败'."\n" + .'- processing，处理中'."\n" + .'- analysing，分析中', + 'type' => 'string', + 'example' => 'success', + ], + 'Trigger' => [ + 'description' => '触发方式，取值：'."\n" + ."\n" + .'- Auto，工作流自动触发'."\n" + .'- Manual，手动提交任务', + 'type' => 'string', + 'example' => 'Auto', + ], + 'TemplateConfig' => [ + 'description' => '模板配置', + 'type' => 'string', + 'example' => '{"AuditRange":["video","image-cover","text-title"],"AuditContent":["screen"],"AuditItem":["terrorism","porn"],"AuditAutoBlock":"no"}', + ], + 'CreateTime' => [ + 'description' => '任务创建时间，UTC格式，YYYY-MM-DDTHH:MM:SSZ', + 'type' => 'string', + 'example' => '2024-10-14T07:39:25Z', + ], + 'CompleteTime' => [ + 'description' => '任务结束时间', + 'type' => 'string', + 'example' => '2024-10-14T07:39:46Z'."\n", + ], + ], + ], + 'WorkflowTaskDetail' => [ + 'description' => '工作流任务详细信息，仅当 TaskType 为 Workflow，该字段有值', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '46ecc024******92c8e26237e51', + ], + 'Status' => [ + 'description' => '任务状态，取值：'."\n" + ."\n" + .'- Init，已启动'."\n" + .'- Processing，处理中'."\n" + .'- Succeed，成功'."\n" + .'- Failed，失败'."\n" + .'- Canceled，取消'."\n" + .'- Skip，跳过', + 'type' => 'string', + 'example' => 'Succeed', + ], + 'TaskInput' => [ + 'description' => '媒资信息', + 'type' => 'string', + 'example' => '{\\"Type\\":\\"Media\\",\\"Media\\":\\"00f985a50ae371f0ad1c4106e0ea0102\\",\\"Title\\":\\"2.mp4\\",\\"StorageLocation\\":\\"yiming-pre.oss-cn-shanghai.aliyuncs.com\\"}', + ], + 'CreateTime' => [ + 'description' => '任务创建时间，UTC格式，YYYY-MM-DDTHH:MM:SSZ', + 'type' => 'string', + 'example' => '2025-03-27T08:15:46Z', + ], + 'FinishTime' => [ + 'description' => '任务完成时间', + 'type' => 'string', + 'example' => '2025-03-27T08:20:19Z', + ], + 'ActivityResults' => [ + 'description' => '工作流各节点处理结果，JSON格式', + 'type' => 'string', + 'example' => '{\\"VodSnapshot_123\\":{\\"ActivityId\\":\\"VodSnapshot\\",\\"ActivityInstanceId\\":\\"c8cf62d53bef4e04bf703976bae6d0b9\\",\\"EndTime\\":\\"2025-03-27T08:15:51Z\\",\\"Result\\":\\"{\\\\\\"RequestId\\\\\\":\\\\\\"8B3649AF-5A6B-1099-BEB6-164D81067398\\\\\\",\\\\\\"EventType\\\\\\":\\\\\\"SnapshotComplete\\\\\\",\\\\\\"UserId\\\\\\":1797131669910763,\\\\\\"MessageBody\\\\\\":{\\\\\\"Status\\\\\\":\\\\\\"success\\\\\\",\\\\\\"VideoId\\\\\\":\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\",\\\\\\"EventType\\\\\\":\\\\\\"SnapshotComplete\\\\\\",\\\\\\"EventTime\\\\\\":\\\\\\"2025-03-27T08:15:50Z\\\\\\",\\\\\\"TriggerSource\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"ActivityInstanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"c8cf62d53bef4e04bf703976bae6d0b9\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"BizType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ice-workflow\\\\\\\\\\\\\\"}\\\\\\"}}\\",\\"StartTime\\":\\"2025-03-27T08:15:47Z\\",\\"Status\\":\\"Succeed\\"},\\"Translate_zh_en\\":{\\"ActivityId\\":\\"VodTranslation\\",\\"ActivityInstanceId\\":\\"c043a872bb044763a3d293a5c2458b50\\",\\"EndTime\\":\\"2025-03-27T08:20:19Z\\",\\"Result\\":\\"{\\\\\\"Type\\\\\\":\\\\\\"VideoTranslationAll\\\\\\",\\\\\\"Success\\\\\\":false}\\",\\"StartTime\\":\\"2025-03-27T08:15:46Z\\",\\"Status\\":\\"Failed\\"},\\"Act_Start\\":{\\"ActivityId\\":\\"start\\",\\"ActivityInstanceId\\":\\"8a9402f4ff064084bf496707fb2d664a\\",\\"Result\\":\\"{\\\\\\"Type\\\\\\":\\\\\\"Media\\\\\\",\\\\\\"bizType\\\\\\":6,\\\\\\"Media\\\\\\":\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\",\\\\\\"Title\\\\\\":\\\\\\"2.mp4\\\\\\",\\\\\\"taskInput\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"userTaskInput\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Title\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2.mp4\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"StorageLocation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"yiming-pre.oss-cn-shanghai.aliyuncs.com\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"StorageLocation\\\\\\":\\\\\\"yiming-pre.oss-cn-shanghai.aliyuncs.com\\\\\\",\\\\\\"callerUid\\\\\\":1797131669910763,\\\\\\"CUR_NODE_NAME\\\\\\":\\\\\\"Act_Start\\\\\\"}\\",\\"StartTime\\":\\"2025-03-27T08:15:45Z\\",\\"Status\\":\\"Succeed\\"},\\"VodDynamicImage_123\\":{\\"ActivityId\\":\\"VodDynamicImage\\",\\"ActivityInstanceId\\":\\"26e8dab82ab84110b1150f146caf633c\\",\\"EndTime\\":\\"2025-03-27T08:15:55Z\\",\\"Result\\":\\"{\\\\\\"RequestId\\\\\\":\\\\\\"7120B5D5-430F-14AD-8922-577F072DDD64\\\\\\",\\\\\\"EventType\\\\\\":\\\\\\"DynamicImageComplete\\\\\\",\\\\\\"UserId\\\\\\":1797131669910763,\\\\\\"MessageBody\\\\\\":{\\\\\\"Status\\\\\\":\\\\\\"success\\\\\\",\\\\\\"VideoId\\\\\\":\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\",\\\\\\"EventType\\\\\\":\\\\\\"DynamicImageComplete\\\\\\",\\\\\\"EventTime\\\\\\":\\\\\\"2025-03-27T08:15:52Z\\\\\\",\\\\\\"TriggerSource\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"ActivityInstanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"26e8dab82ab84110b1150f146caf633c\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"BizType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ice-workflow\\\\\\\\\\\\\\"}\\\\\\"}}\\",\\"StartTime\\":\\"2025-03-27T08:15:47Z\\",\\"Status\\":\\"Succeed\\"}}', + ], + 'UserData' => [ + 'description' => '自定义设置。为 JSON 字符串，支持消息回调、上传加速等设置。', + 'type' => 'string', + 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}', + ], + 'Workflow' => [ + 'description' => '工作流详情', + 'type' => 'object', + 'properties' => [ + 'WorkflowId' => [ + 'description' => '工作流ID', + 'type' => 'string', + 'example' => 'vw_09d6*****b5c5b19a0c891e02', + ], + 'Name' => [ + 'description' => '工作流名称', + 'type' => 'string', + 'example' => 'All_Activity_New_1_app-1000000', + ], + 'Status' => [ + 'description' => '工作流状态，取值：'."\n" + .'- Active，已激活'."\n" + .'- Inactive，未激活'."\n" + .'- Deleted，已删除', + 'type' => 'string', + 'example' => 'Active', + ], + 'Type' => [ + 'description' => '工作流种类，默认不填充', + 'type' => 'string', + ], + 'CreateTime' => [ + 'description' => '工作流创建时间，UTC格式，YYYY-MM-DDTHH:MM:SSZ', + 'type' => 'string', + 'example' => '2025-03-26T05:50:14Z', + ], + 'ModifiedTime' => [ + 'description' => '工作流修改时间', + 'type' => 'string', + 'example' => '2025-03-26T07:51:55Z', + ], + 'AppId' => [ + 'description' => '应用ID', + 'type' => 'string', + 'example' => 'app-1000000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6708D849-F109-1A6C-AC91-************\\",\\n \\"JobType\\": \\"transcode\\",\\n \\"TranscodeJobDetail\\": {\\n \\"JobId\\": \\"2dc1634e**********3f1d22d1a0174e\\",\\n \\"UserId\\": 0,\\n \\"VideoId\\": \\"30e5d7**********bd900764de7c0102\\",\\n \\"Status\\": \\"TranscodeSuccess\\",\\n \\"TemplateId\\": \\"dbfaaec9e**********bf0b81219244c\\",\\n \\"Definition\\": \\"HD\\",\\n \\"CreateTime\\": \\"2024-10-14T07:39:25Z\\",\\n \\"CompleteTime\\": \\"2024-10-14T07:39:34Z\\"\\n },\\n \\"SnapshotJobDetail\\": {\\n \\"JobId\\": \\"63df12s0**********4hdq249t82kr91\\",\\n \\"UserId\\": 0,\\n \\"VideoId\\": \\"30e5d7**********bd900764de7c0102\\",\\n \\"Status\\": \\"Success\\",\\n \\"Trigger\\": \\"Auto\\",\\n \\"NormalConfig\\": \\"{\\\\\\"inl\\\\\\":0,\\\\\\"num\\\\\\":32,\\\\\\"tm\\\\\\":5,\\\\\\"wd\\\\\\":\\\\\\"352\\\\\\",\\\\\\"ft\\\\\\":\\\\\\"normal\\\\\\",\\\\\\"hg\\\\\\":\\\\\\"640\\\\\\"}\\",\\n \\"SpriteConfig\\": \\"{\\\\\\"pad\\\\\\":\\\\\\"0\\\\\\",\\\\\\"lines\\\\\\":\\\\\\"10\\\\\\",\\\\\\"mgin\\\\\\":\\\\\\"0\\\\\\",\\\\\\"cols\\\\\\":\\\\\\"10\\\\\\",\\\\\\"ikcp\\\\\\":\\\\\\"false\\\\\\",\\\\\\"hg\\\\\\":\\\\\\"68\\\\\\"}\\",\\n \\"CreateTime\\": \\"2024-10-14T07:39:25Z\\",\\n \\"CompleteTime\\": \\"2024-10-14T07:39:45Z\\"\\n },\\n \\"AIJobDetail\\": {\\n \\"JobId\\": \\"5c9dff751ba**********59d50a967f5\\",\\n \\"UserId\\": 0,\\n \\"MediaId\\": \\"30e5d7**********bd900764de7c0102\\",\\n \\"JobType\\": \\"AIVideoCensor\\",\\n \\"Status\\": \\"success\\",\\n \\"Trigger\\": \\"Auto\\",\\n \\"TemplateConfig\\": \\"{\\\\\\"AuditRange\\\\\\":[\\\\\\"video\\\\\\",\\\\\\"image-cover\\\\\\",\\\\\\"text-title\\\\\\"],\\\\\\"AuditContent\\\\\\":[\\\\\\"screen\\\\\\"],\\\\\\"AuditItem\\\\\\":[\\\\\\"terrorism\\\\\\",\\\\\\"porn\\\\\\"],\\\\\\"AuditAutoBlock\\\\\\":\\\\\\"no\\\\\\"}\\",\\n \\"CreateTime\\": \\"2024-10-14T07:39:25Z\\",\\n \\"CompleteTime\\": \\"2024-10-14T07:39:46Z\\\\n\\"\\n },\\n \\"WorkflowTaskDetail\\": {\\n \\"TaskId\\": \\"46ecc024******92c8e26237e51\\",\\n \\"Status\\": \\"Succeed\\",\\n \\"TaskInput\\": \\"{\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Title\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2.mp4\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"StorageLocation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"yiming-pre.oss-cn-shanghai.aliyuncs.com\\\\\\\\\\\\\\"}\\",\\n \\"CreateTime\\": \\"2025-03-27T08:15:46Z\\",\\n \\"FinishTime\\": \\"2025-03-27T08:20:19Z\\",\\n \\"ActivityResults\\": \\"{\\\\\\\\\\\\\\"VodSnapshot_123\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"ActivityId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"VodSnapshot\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ActivityInstanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"c8cf62d53bef4e04bf703976bae6d0b9\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EndTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2025-03-27T08:15:51Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Result\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"RequestId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"8B3649AF-5A6B-1099-BEB6-164D81067398\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"EventType\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"SnapshotComplete\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"UserId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1797131669910763,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"MessageBody\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Status\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"success\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"VideoId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"EventType\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"SnapshotComplete\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"EventTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"2025-03-27T08:15:50Z\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"TriggerSource\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"ActivityInstanceId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"c8cf62d53bef4e04bf703976bae6d0b9\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"BizType\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"ice-workflow\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"StartTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2025-03-27T08:15:47Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Succeed\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Translate_zh_en\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"ActivityId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"VodTranslation\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ActivityInstanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"c043a872bb044763a3d293a5c2458b50\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EndTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2025-03-27T08:20:19Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Result\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"VideoTranslationAll\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Success\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":false}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"StartTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2025-03-27T08:15:46Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Failed\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Act_Start\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"ActivityId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"start\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ActivityInstanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8a9402f4ff064084bf496707fb2d664a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Result\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"bizType\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":6,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Title\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"2.mp4\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"taskInput\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"userTaskInput\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Title\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"2.mp4\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"StorageLocation\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"yiming-pre.oss-cn-shanghai.aliyuncs.com\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"StorageLocation\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"yiming-pre.oss-cn-shanghai.aliyuncs.com\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"callerUid\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1797131669910763,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"CUR_NODE_NAME\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Act_Start\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"StartTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2025-03-27T08:15:45Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Succeed\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"VodDynamicImage_123\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"ActivityId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"VodDynamicImage\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ActivityInstanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"26e8dab82ab84110b1150f146caf633c\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EndTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2025-03-27T08:15:55Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Result\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"RequestId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"7120B5D5-430F-14AD-8922-577F072DDD64\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"EventType\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"DynamicImageComplete\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"UserId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1797131669910763,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"MessageBody\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"Status\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"success\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"VideoId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"EventType\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"DynamicImageComplete\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"EventTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"2025-03-27T08:15:52Z\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"TriggerSource\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"ActivityInstanceId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"26e8dab82ab84110b1150f146caf633c\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"BizType\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"ice-workflow\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"StartTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2025-03-27T08:15:47Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Succeed\\\\\\\\\\\\\\"}}\\",\\n \\"UserData\\": \\"{\\\\\\"MessageCallback\\\\\\":{\\\\\\"CallbackURL\\\\\\":\\\\\\"http://example.aliyundoc.com\\\\\\"},\\\\\\"Extend\\\\\\":{\\\\\\"localId\\\\\\":\\\\\\"*****\\\\\\",\\\\\\"test\\\\\\":\\\\\\"www\\\\\\"}}\\",\\n \\"Workflow\\": {\\n \\"WorkflowId\\": \\"vw_09d6*****b5c5b19a0c891e02\\",\\n \\"Name\\": \\"All_Activity_New_1_app-1000000\\",\\n \\"Status\\": \\"Active\\",\\n \\"Type\\": \\"\\",\\n \\"CreateTime\\": \\"2025-03-26T05:50:14Z\\",\\n \\"ModifiedTime\\": \\"2025-03-26T07:51:55Z\\",\\n \\"AppId\\": \\"app-1000000\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取任务详情', + 'description' => '**使用说明**'."\n" + ."\n" + .'本接口仅支持查询6个月内的异步任务数据。可查询的任务类型：转码任务，截图任务，AI任务。'."\n" + ."\n" + .'**QPS 限制**'."\n" + ."\n" + .'本接口的单用户 QPS 限制为 15 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 [QPS限制](~~342790~~)。', + ], + 'ProduceEditingProjectVideo' => [ + 'summary' => '将一个或多个视频合成为成品。可以通过时间线参数直接提交源视频，也可以先创建云剪辑工程，再提交合成。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40100', + 'abilityTreeNodes' => [ + 'FEATUREvod89J0DP', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程ID。可通过以下方式获取：'."\n" + .'- 登录[点播控制台](https://vod.console.aliyun.com)，选择**制作中心** > **视频剪辑**，查看ID。'."\n" + .'- 通过[创建云剪辑工程](~~69048~~)接口创建工程时，为返回参数ProjectId的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'fb2101bf24b4cb318787dc****', + ], + ], + [ + 'name' => 'Timeline', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程时间线，JSON格式。具体结构定义，请参见[Timeline](~~52839#07bc7fe0f2xuh~~)。'."\n" + .'>请确保每个VideoTrackClip对象中都包含有效的MediaId，否则会导致请求失败。', + 'type' => 'string', + 'required' => false, + 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"cc3308ac59615a54328bc3443****"},{"MediaId":"da87a9cff645cd88bc6d8326e4****"}]}]}', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程标题。', + 'type' => 'string', + 'required' => false, + 'example' => 'Cloud Clip Project Title', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'Cloud clip project description', + ], + ], + [ + 'name' => 'CoverURL', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程封面。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://example.aliyundoc.com/6AB4D0E1E1C7446888351****.png', + ], + ], + [ + 'name' => 'MediaMetadata', + 'in' => 'query', + 'schema' => [ + 'description' => '合成视频的元数据，JSON格式。具体结构定义，请参见[MediaMetadata](~~52839#title-rtf-ry5-gjp~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Description":"Synthetic Video Description","Title":"Synthetic userData test"}', + ], + ], + [ + 'name' => 'ProduceConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '合成配置，JSON格式。具体结构定义，请参见[ProduceConfig](~~52839#title-ybl-7cs-y7d~~)。'."\n" + .'<notice>'."\n" + .'StorageLocation字段在文件存储地域为上海时，可以忽略；在文件存储地域为其他地域时，为必填项。'."\n" + .'</notice>', + 'type' => 'string', + 'required' => false, + 'example' => '{"TemplateGroupId":"6d11e25ea30a4c465435c74****"}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置，为JSON字符串，最大允许256个字符，支持消息回调等设置。具体结构定义，请参见[UserData](~~86952#title-vz7-xzs-0c5~~)。'."\n" + ."\n" + .'> 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用，否则回调设置不生效。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Extend":{"width":1280,"id":"028a8e56b1ebf6bb7afc74****","height":720},"MessageCallback":{"CallbackURL":"https://example.aliyundoc.com/2016-08-15/proxy/httpcallback/testcallback/","CallbackType":"http"}}', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。默认取值： **app-1000000**。使用说明，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'MediaId' => [ + 'description' => '合成的视频ID。'."\n" + .'> - 视频合成接口同步返回合成的视频ID。'."\n" + .'> - 接口返回MediaId，表示视频合成已进入异步处理阶段。', + 'type' => 'string', + 'example' => '006204a11bb386bb25491f95f****', + ], + 'ProjectId' => [ + 'description' => '云剪辑工程ID。', + 'type' => 'string', + 'example' => 'fb2101bf24b4cb318787dc****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"MediaId\\": \\"006204a11bb386bb25491f95f****\\",\\n \\"ProjectId\\": \\"fb2101bf24b4cb318787dc****\\"\\n}","errorExample":""},{"type":"xml","example":"<ProduceEditingProjectVideoResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <MediaId>006204a11bb386bb25491f95f****</MediaId>\\n <ProjectId>fb2101bf24b4cb318787dc****</ProjectId>\\n</ProduceEditingProjectVideoResponse>","errorExample":""}]', + 'title' => '视频合成', + 'description' => '- **请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。云剪辑为付费功能，计费详情，请参见[剪辑合成计费](~~188310#section-pyv-b8h-bo7~~)。**'."\n" + .'- 该接口返回合成任务的提交结果，不保证接口返回时视频已合成完毕。合成任务将进入后台排队，异步执行。'."\n" + .'- 云剪辑时间线所使用的视频资源，既可以是素材管理中的素材，也可以是媒体库中的视频，使用媒体库中的视频需要确保其状态为正常（Normal）。'."\n" + .'- 合成视频依据ProjectId与Timeline进行，具体逻辑如下：'."\n" + .' - ProjectId与Timeline不能同时为空，否则合成视频没有任何依据。'."\n" + .' - 如果ProjectId为空，Timeline不为空，则自动创建一个云剪辑工程，以Timeline为时间线，同时提取Timeline中引用的素材并设置为云剪辑工程的素材，之后进行视频合成。'."\n" + .' - 如果ProjectId不为空，Timeline为空，则根据ProjectId获取最新保存的Timeline，并以此进行视频合成。'."\n" + .' - 如果ProjectId与Timeline均不为空，则以传入的Timeline为准，进行视频合成，同时更新对应的云剪辑工程（Timeline和云剪辑工程素材）。如果填写其他字段，则对相应的云剪辑工程字段进行更新。'."\n" + ."\n" + .'- 视频轨、图片轨、字幕轨的轨道数每种均限制最多100个。'."\n" + .'- 素材总数不能超过200个，素材文件总大小不能超过1 TB。'."\n" + .'- 输入或输出Bucket所在Region，必须和使用VOD服务的Region保持一致。'."\n" + .'- 当输出为视频时，成片分辨率有以下限制：'."\n" + .' - 宽高都不能小于128px。'."\n" + .' - 宽高都不能大于4096px。'."\n" + .' - 短边不能大于2160px。'."\n" + ."\n" + .'- 视频合成完成后，会自动上传到视频点播中，因此，视频合成完成之后，点播服务会发送**媒体合成完成**和**视频上传完成**的事件通知。合成视频转码完成后，会发送**视频单个清晰度转码完成**和**视频全部清晰度转码完成**的事件通知。'."\n" + .'- 您还可以为合成视频添加特效。更多详情，请参见[特效](~~69082~~)。', + 'requestParamsDescription' => ' ', + ], + 'AddEditingProject' => [ + 'summary' => '调用本接口创建云剪辑工程（视频编辑任务）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39785', + 'abilityTreeNodes' => [ + 'FEATUREvod89J0DP', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程标题。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testtimeline', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'testtimeline001desciption', + ], + ], + [ + 'name' => 'Timeline', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程时间线。JSON格式。具体结构定义，请参见[Timeline](~~52839~~)。'."\n" + ."\n" + .'当该字段为空时，则创建一个空的时间线，且云剪辑工程的总时长为0。', + 'type' => 'string', + 'required' => false, + 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"cc3308ac5006aed55a54328bc3443****"},{"MediaId":"95948ddba24446b6aed5db985e78****"}]}]}', + ], + ], + [ + 'name' => 'CoverURL', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程封面。如果为空且时间线上的video轨已经存在素材，则默认选取时间线上第一个素材封面。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://demo.aliyundoc.com/6AB4D0E1E1C74468883516C2349D1FC2-6-2.png', + ], + ], + [ + 'name' => 'Division', + 'in' => 'query', + 'schema' => [ + 'description' => '服务地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E4EBD2BF-5EB0-4476-8829-9D94E1B1****', + ], + 'Project' => [ + 'description' => '云剪辑工程。具体结构定义，请参见[EditingProject](~~52839~~)。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '云剪辑工程创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'Status' => [ + 'description' => '云剪辑工程状态。取值：'."\n" + ."\n" + .'- **Normal**：草稿。'."\n" + .'- **Producing**：合成中。'."\n" + .'- **Produced**：合成成功。'."\n" + .'- **ProduceFailed**：合成失败。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'ModifiedTime' => [ + 'description' => '云剪辑工程最新修改时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-01-11T13:00:00Z', + ], + 'Description' => [ + 'description' => '云剪辑工程描述。', + 'type' => 'string', + 'example' => 'testtimeline001desciption', + ], + 'ProjectId' => [ + 'description' => '云剪辑工程ID。', + 'type' => 'string', + 'example' => 'fb2101bf24bf4df34c4cb3187****', + ], + 'Title' => [ + 'description' => '云剪辑工程标题。', + 'type' => 'string', + 'example' => 'testtimeline', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4EBD2BF-5EB0-4476-8829-9D94E1B1****\\",\\n \\"Project\\": {\\n \\"CreationTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"ModifiedTime\\": \\"2017-01-11T13:00:00Z\\",\\n \\"Description\\": \\"testtimeline001desciption\\",\\n \\"ProjectId\\": \\"fb2101bf24bf4df34c4cb3187****\\",\\n \\"Title\\": \\"testtimeline\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddEditingProjectResponse>\\n <RequestId>E4EBD2BF-5EB0-4476-8829-9D94E1B1****</RequestId>\\n <Project>\\n <CreationTime>2017-01-11T12:00:00Z</CreationTime>\\n <Status>Normal</Status>\\n <ModifiedTime>2017-01-11T13:00:00Z</ModifiedTime>\\n <Description>testtimeline001desciption</Description>\\n <ProjectId>fb2101bf24bf4df34c4cb3187****</ProjectId>\\n <Title>testtimeline</Title>\\n </Project>\\n</AddEditingProjectResponse>","errorExample":""}]', + 'title' => '创建云剪辑工程', + 'description' => '- 更多有关云剪辑的详细内容，请参见[云剪辑](~~95482~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'UpdateEditingProject' => [ + 'summary' => '调用本接口修改云剪辑工程（视频编辑任务）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40219', + 'abilityTreeNodes' => [ + 'FEATUREvod7B2GUR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '4ee4b97e27*****b525142a6b2', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程标题。', + 'type' => 'string', + 'required' => false, + 'example' => 'testtimeline', + ], + ], + [ + 'name' => 'Timeline', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程时间线。具体结构定义，请参见[Timeline](~~52839~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"cc3308ac500c*****a54328bc3443"},{"MediaId":"da87a9cff64*****d88bc6d8326e4"}]}]}', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'testtimeline001desciption', + ], + ], + [ + 'name' => 'CoverURL', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程封面。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://****.com/6AB4D0E1E1C7446888****.png', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateEditingProjectResponse>\\r\\n <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\r\\n</UpdateEditingProjectResponse>","errorExample":""}]', + 'title' => '修改云剪辑工程', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DeleteEditingProject' => [ + 'summary' => '调用本接口删除云剪辑工程。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39832', + 'abilityTreeNodes' => [ + 'FEATUREvod8R2V42', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProjectIds', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程ID。多个ID使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'fb2101bf24bf41*****cb318787dc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteEditingProjectResponse>\\r\\n <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\r\\n</DeleteEditingProjectResponse>","errorExample":""}]', + 'title' => '删除云剪辑工程', + 'description' => '- 支持批量删除。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'SetEditingProjectMaterials' => [ + 'summary' => '调用本接口设置云剪辑工程的待剪辑素材。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40146', + 'abilityTreeNodes' => [ + 'FEATUREvod89J0DP', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'fb2101bf24bf4*****754cb318787dc', + ], + ], + [ + 'name' => 'MaterialIds', + 'in' => 'query', + 'schema' => [ + 'description' => '素材ID。即媒资ID，如视频VideoId、图片ImageId、辅助媒资MediaId等。多个素材ID，请使用英文逗号（,）分隔。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '9e3101bf24bf41c*****123318788ca', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '746FFA07-8BBB-46*****B1-3E94E3B2915E', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"746FFA07-8BBB-46*****B1-3E94E3B2915E\\"\\n}","errorExample":""},{"type":"xml","example":"<SetEditingProjectMaterialsResponse>\\r\\n <RequestId>746FFA07-8BBB-46*****B1-3E94E3B2915E</RequestId>\\r\\n</SetEditingProjectMaterialsResponse>","errorExample":""}]', + 'title' => '设置云剪辑工程素材', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetEditingProject' => [ + 'summary' => '调用本接口进行获取云剪辑工程（视频编辑任务）的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39953', + 'abilityTreeNodes' => [ + 'FEATUREvod89J0DP', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'fb2101bf24b27*****54cb318787dc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '63E8B7C7-4812-46*****AD-0FA56029AC86', + ], + 'Project' => [ + 'description' => '云剪辑工程。', + 'type' => 'object', + 'properties' => [ + 'StorageLocation' => [ + 'description' => '存储地址。'."\n" + .'> 您可以登录[点播控制台](https://vod.console.aliyun.com/?spm=a2c4g.11186623.2.15.6948257eaZ4m54#/vod/settings/censored)，选择**配置管理** > **媒资管理配置** > **存储管理**查看存储地址。', + 'type' => 'string', + 'example' => 'location_s', + ], + 'Status' => [ + 'description' => '云剪辑工程状态。多个状态使用英文逗号（,）分隔。默认获取所有云剪辑工程。取值：'."\n" + ."\n" + .'- **Normal**：草稿。'."\n" + .'- **Producing**：合成中。'."\n" + .'- **Produced**：合成成功。'."\n" + .'- **ProduceFailed**：合成失败。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CreationTime' => [ + 'description' => '云剪辑工程创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-10-23T13:33:40Z', + ], + 'ModifiedTime' => [ + 'description' => '云剪辑工程最新修改时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-10-23T14:27:26Z', + ], + 'Description' => [ + 'description' => '云剪辑工程描述。', + 'type' => 'string', + 'example' => 'testdescription', + ], + 'CoverURL' => [ + 'description' => '云剪辑工程封面URL。', + 'type' => 'string', + 'example' => 'https://****.com/6AB4D0E1E1C74468883516C2349****.png', + ], + 'ProjectId' => [ + 'description' => '云剪辑工程ID。', + 'type' => 'string', + 'example' => 'fb2101bf24b27*****54cb318787dc', + ], + 'Timeline' => [ + 'description' => '云剪辑工程时间线。', + 'type' => 'string', + 'example' => '{\\"TimelineIn\\":0,\\"TimelineOut\\":9.42}', + ], + 'Title' => [ + 'description' => '云剪辑工程标题。', + 'type' => 'string', + 'example' => '视频_1508736815000', + ], + 'RegionId' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"63E8B7C7-4812-46*****AD-0FA56029AC86\\",\\n \\"Project\\": {\\n \\"StorageLocation\\": \\"location_s\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreationTime\\": \\"2017-10-23T13:33:40Z\\",\\n \\"ModifiedTime\\": \\"2017-10-23T14:27:26Z\\",\\n \\"Description\\": \\"testdescription\\",\\n \\"CoverURL\\": \\"https://****.com/6AB4D0E1E1C74468883516C2349****.png\\",\\n \\"ProjectId\\": \\"fb2101bf24b27*****54cb318787dc\\",\\n \\"Timeline\\": \\"{\\\\\\\\\\\\\\"TimelineIn\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"TimelineOut\\\\\\\\\\\\\\":9.42}\\",\\n \\"Title\\": \\"视频_1508736815000\\",\\n \\"RegionId\\": \\"cn-shanghai\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetEditingProjectResponse>\\n<Project>\\n <Status>Normal</Status>\\n <Timeline>{\\\\\\"TimelineIn\\\\\\":0,\\\\\\"TimelineOut\\\\\\":9.42}</Timeline>\\n <Description>testdescription</Description>\\n <ModifiedTime>2017-10-23T14:27:26Z</ModifiedTime>\\n <CreationTime>2017-10-23T13:33:40Z</CreationTime>\\n <ProjectId>fb2101bf24b27*****54cb318787dc</ProjectId>\\n <Title>视频_1508736815000</Title>\\n <CoverURL>https://****.com/6AB4D0E1E1C74468883516C2349****.png</CoverURL>\\n <RegionId>cn-shanghai</RegionId>\\n <StorageLocation>location_s</StorageLocation>\\n</Project>\\n<RequestId>63E8B7C7-4812-46*****AD-0FA56029AC86</RequestId>\\n</GetEditingProjectResponse>","errorExample":""}]', + 'title' => '获取单个云剪辑工程', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetEditingProjectMaterials' => [ + 'summary' => '调用本接口获取云剪辑工程的待剪辑素材列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39954', + 'abilityTreeNodes' => [ + 'FEATUREvod89J0DP', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程ID。可通过以下方式获取：'."\n" + .'- 登录[点播控制台](https://vod.console.aliyun.com)，选择**制作中心** > **视频剪辑**，查看ID。'."\n" + .'- 通过**创建云剪辑工程**接口创建工程时，为返回参数ProjectId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1982361011093374****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '素材类型。取值：'."\n" + ."\n" + .'- **video**：视频'."\n" + .'- **audio**：纯音频', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'video', + ], + ], + [ + 'name' => 'MaterialType', + 'in' => 'query', + 'schema' => [ + 'description' => '素材类型。取值：'."\n" + ."\n" + .'- **video**：视频'."\n" + .'- **audio**：纯音频'."\n" + .'- **image**：图片', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '746FFA07-8BBB-46B1-3E94E3B2915E****', + ], + 'MaterialList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Material' => [ + 'description' => '素材列表。', + 'type' => 'array', + 'items' => [ + 'description' => '素材详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '素材状态。取值：'."\n" + ."\n" + .'- **Normal**：草稿 。'."\n" + .'- **Producing**：合成中。'."\n" + .'- **Produced** ：合成成功。'."\n" + .'- **ProduceFailed**：合成失败。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CreationTime' => [ + 'description' => '素材创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-10-19 10:48:17', + ], + 'CateId' => [ + 'description' => '素材分类ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100005****', + ], + 'MaterialType' => [ + 'description' => '素材类型。取值：'."\n" + ."\n" + .'- **video**：视频'."\n" + .'- **audio**：纯音频'."\n" + .'- **image**：图片', + 'type' => 'string', + 'example' => 'video', + ], + 'Tags' => [ + 'description' => '素材标签。多个使用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => '剪辑测试', + ], + 'SpriteConfig' => [ + 'description' => '雪碧图配置。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Source' => [ + 'description' => '雪碧图来源。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'CateName' => [ + 'description' => '素材分类名称。', + 'type' => 'string', + 'example' => '测试', + ], + 'ModifiedTime' => [ + 'description' => '素材更新时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2017-10-19 10:48:17', + ], + 'Description' => [ + 'description' => '素材描述。', + 'type' => 'string', + 'example' => '测试', + ], + 'MaterialId' => [ + 'description' => '素材ID。', + 'type' => 'string', + 'example' => '85befc4118b84c6723e53b80b1****', + ], + 'Size' => [ + 'description' => '素材源文件大小，单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1682694', + ], + 'CoverURL' => [ + 'description' => '素材封面URL。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/aivideocover/46fa444aa34065cb9250f6c****/image_01.jpg', + ], + 'Duration' => [ + 'description' => '素材时长，精确到小数点后4位，单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '15.16', + ], + 'Title' => [ + 'description' => '素材标题。', + 'type' => 'string', + 'example' => 'test', + ], + 'Sprites' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Sprite' => [ + 'description' => '素材雪碧图URL数组。', + 'type' => 'array', + 'items' => [ + 'description' => '素材雪碧图URL。', + 'type' => 'string', + 'example' => '"http://example.aliyundoc.com/material_big_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key="', + ], + ], + ], + ], + 'Snapshots' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Snapshot' => [ + 'description' => '素材截图URL数组。', + 'type' => 'array', + 'items' => [ + 'description' => '素材截图URL。', + 'type' => 'string', + 'example' => '"http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=","http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key="', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"746FFA07-8BBB-46B1-3E94E3B2915E****\\",\\n \\"MaterialList\\": {\\n \\"Material\\": [\\n {\\n \\"Status\\": \\"Normal\\",\\n \\"CreationTime\\": \\"2017-10-19 10:48:17\\",\\n \\"CateId\\": 0,\\n \\"MaterialType\\": \\"video\\",\\n \\"Tags\\": \\"剪辑测试\\",\\n \\"SpriteConfig\\": \\"xxx\\",\\n \\"Source\\": \\"xxx\\",\\n \\"CateName\\": \\"测试\\",\\n \\"ModifiedTime\\": \\"2017-10-19 10:48:17\\",\\n \\"Description\\": \\"测试\\",\\n \\"MaterialId\\": \\"85befc4118b84c6723e53b80b1****\\",\\n \\"Size\\": 1682694,\\n \\"CoverURL\\": \\"http://example.aliyundoc.com/aivideocover/46fa444aa34065cb9250f6c****/image_01.jpg\\",\\n \\"Duration\\": 15.16,\\n \\"Title\\": \\"test\\",\\n \\"Sprites\\": {\\n \\"Sprite\\": [\\n \\"\\\\\\"http://example.aliyundoc.com/material_big_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=\\\\\\"\\"\\n ]\\n },\\n \\"Snapshots\\": {\\n \\"Snapshot\\": [\\n \\"\\\\\\"http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=\\\\\\",\\\\\\"http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=\\\\\\"\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetEditingProjectMaterialsResponse>\\n <RequestId>746FFA07-8BBB-46B1-3E94E3B2915E****</RequestId>\\n <MaterialList>\\n <Status>Normal</Status>\\n <CreationTime>2017-10-19 10:48:17</CreationTime>\\n <MaterialType>video</MaterialType>\\n <Tags>剪辑测试</Tags>\\n <SpriteConfig>xxx</SpriteConfig>\\n <Source>xxx</Source>\\n <CateName>测试</CateName>\\n <ModifiedTime>2017-10-19 10:48:17</ModifiedTime>\\n <Description>测试</Description>\\n <MaterialId>85befc4118b84c6723e53b80b1****</MaterialId>\\n <Size>1682694</Size>\\n <CoverURL>http://example.aliyundoc.com/aivideocover/46fa444aa34065cb9250f6c****/image_01.jpg</CoverURL>\\n <Duration>15.16</Duration>\\n <Title>test</Title>\\n <Sprites>{\\"Sprite\\":[\\"http://example.aliyundoc.com/material_big_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=\\"]}</Sprites>\\n <Snapshots>[\\"http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=\\",\\"http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=\\"]</Snapshots>\\n </MaterialList>\\n</GetEditingProjectMaterialsResponse>","errorExample":""}]', + 'title' => '获取云剪辑工程素材', + 'description' => '在剪辑过程中，素材可添加到时间线上，但不一定完全被使用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'SearchEditingProject' => [ + 'summary' => '调用本接口搜索云剪辑工程（视频编辑列表）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40114', + 'abilityTreeNodes' => [ + 'FEATUREvod89J0DP', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'CreationTime（创建时间）的结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2017-01-11T13:00:00Z', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'CreationTime（创建时间）的开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2017-01-11T12:00:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程状态。多个用英文逗号（,）分隔。默认获取所有云剪辑工程。'."\n" + .'取值范围：'."\n" + ."\n" + .'- **Normal**：草稿。'."\n" + .'- **Producing**：合成中。'."\n" + .'- **Produced**：合成成功。'."\n" + .'- **ProduceFailed**：合成失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + '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' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '结果排序方式。取值范围：'."\n" + ."\n" + .'- **desc**（默认值）：按创建时间倒序。'."\n" + .'- **asc**：按创建时间升序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程标题。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '云剪辑工程总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9262E3DA-07FA-48*****62-FCBB6BC61D08', + ], + 'ProjectList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Project' => [ + 'description' => '云剪辑工程列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StorageLocation' => [ + 'description' => '存储区域。'."\n" + .'> 您可以登录[点播控制台](https://vod.console.aliyun.com/?spm=a2c4g.11186623.2.15.6948257eaZ4m54#/vod/settings/censored)，选择**配置管理** > **媒资管理配置** > **存储管理**查看存储地址。', + 'type' => 'string', + 'example' => 'location_s', + ], + 'Status' => [ + 'description' => '云剪辑工程状态。多个状态使用英文逗号（,）分隔。默认获取所有云剪辑工程。取值：'."\n" + ."\n" + .'- **Normal**：草稿。'."\n" + .'- **Producing**：合成中。'."\n" + .'- **Produced**：合成成功。'."\n" + .'- **ProduceFailed**：合成失败。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CreationTime' => [ + 'description' => '云剪辑工程创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'ModifiedTime' => [ + 'description' => '云剪辑工程最新修改时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2017-01-11T13:00:00Z', + ], + 'Description' => [ + 'description' => '云剪辑工程描述。', + 'type' => 'string', + 'example' => '故事板测试工程001', + ], + 'CoverURL' => [ + 'description' => '云剪辑工程封面URL。'."\n", + 'type' => 'string', + 'example' => 'cover_url', + ], + 'ProjectId' => [ + 'description' => '云剪辑工程ID。', + 'type' => 'string', + 'example' => '25cfc178d2de4*****e77aebed6afcd', + ], + 'Duration' => [ + 'description' => '云剪辑工程总时长，与Timeline的总时长一致。'."\n" + .'> 返回参数中不含Timeline字段。'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '22.65', + ], + 'Title' => [ + 'description' => '云剪辑工程标题。', + 'type' => 'string', + 'example' => '视频_150873681****', + ], + 'RegionId' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Total\\": 2,\\n \\"RequestId\\": \\"9262E3DA-07FA-48*****62-FCBB6BC61D08\\",\\n \\"ProjectList\\": {\\n \\"Project\\": [\\n {\\n \\"StorageLocation\\": \\"location_s\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreationTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"ModifiedTime\\": \\"2017-01-11T13:00:00Z\\",\\n \\"Description\\": \\"故事板测试工程001\\",\\n \\"CoverURL\\": \\"cover_url\\",\\n \\"ProjectId\\": \\"25cfc178d2de4*****e77aebed6afcd\\",\\n \\"Duration\\": 22.65,\\n \\"Title\\": \\"视频_150873681****\\",\\n \\"RegionId\\": \\"cn-shanghai\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchEditingProjectResponse>\\n<RequestId>9262E3DA-07FA-48*****62-FCBB6BC61D08</RequestId>\\n<Total>2</Total>\\n<ProjectList>\\n <Project>\\n <Status>Normal</Status>\\n <Description>故事板测试工程001</Description>\\n <ModifiedTime>2017-01-11T13:00:00Z</ModifiedTime>\\n <CreationTime>2017-01-11T12:00:00Z</CreationTime>\\n <ProjectId>25cfc178d2de4*****e77aebed6afcd</ProjectId>\\n <Title>视频_150873681****</Title>\\n <Duration>22.65</Duration>\\n <CoverURL>cover_url</CoverURL>\\n <RegionId>cn-shanghai</RegionId>\\n <StorageLocation>location_s</StorageLocation>\\n </Project>\\n</ProjectList>\\n</SearchEditingProjectResponse>","errorExample":""}]', + 'title' => '搜索云剪辑工程', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'AddEditingProjectMaterials' => [ + 'summary' => '将一个或多个素材添加到剪辑工程中。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39786', + 'abilityTreeNodes' => [ + 'FEATUREvod89J0DP', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'afa31b483b5c41609185de0e1b790579', + ], + ], + [ + 'name' => 'MaterialIds', + 'in' => 'query', + 'schema' => [ + 'description' => '素材ID，多个素材以逗号（,）分隔；最多支持10个素材ID。'."\n" + .'> 关联多个素材时应保证多个素材均为同一类型，且与MaterialType取值对应。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd3251979f9fd41f2acb29ccda5a6f772', + ], + ], + [ + 'name' => 'MaterialType', + 'in' => 'query', + 'schema' => [ + 'description' => '素材类型。取值：'."\n" + .'- **video**：视频。'."\n" + .'- **audio**：纯音频。'."\n" + .'- **image**：图片。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'video', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '85237CDA-0B54-5CED-BA10-A8A71AA13C1A', + ], + 'MaterialList' => [ + 'description' => '素材列表', + 'type' => 'array', + 'items' => [ + 'description' => '素材详情', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '素材状态。取值：'."\n" + ."\n" + .'- **Normal**：正常。'."\n" + .'- **Uploading**：上传中。'."\n" + .'- **UploadFail**：上传失败。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000487543', + ], + 'CreateTime' => [ + 'description' => '素材创建时间。格式为：<i>yyyy-mm-dd</i>t<i>hh:mm:ss</i>z（utc时间）。', + 'type' => 'string', + 'example' => '2019-10-02T08:26Z', + ], + 'MaterialType' => [ + 'description' => '素材类型。取值：'."\n" + ."\n" + .'- **video**：视频'."\n" + .'- **audio**：纯音频'."\n" + .'- **image**：图片', + 'type' => 'string', + 'example' => 'video', + ], + 'Tags' => [ + 'description' => '素材标签。多个使用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'tag1,tag2', + ], + 'SpriteConfig' => [ + 'description' => '雪碧图配置。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'CateName' => [ + 'description' => '素材分类名称。', + 'type' => 'string', + 'example' => '分类1', + ], + 'Description' => [ + 'description' => '素材描述。', + 'type' => 'string', + 'example' => '素材描述', + ], + 'MaterialId' => [ + 'description' => '素材ID。', + 'type' => 'string', + 'example' => '85befc4118b84c6723e53b80b1****', + ], + 'Size' => [ + 'description' => '文件大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1682694', + ], + 'CoverURL' => [ + 'description' => '素材封面url。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/aivideocover/46fa444aa34065cb9250f6c****/image_01.jpg', + ], + 'Duration' => [ + 'description' => '素材时长。单位（秒），精确到小数点后4位。', + 'type' => 'number', + 'format' => 'float', + 'example' => '3690.2332', + ], + 'CustomerId' => [ + 'description' => '用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234751840694470', + ], + 'Title' => [ + 'description' => '素材标题。', + 'type' => 'string', + 'example' => 'test', + ], + 'ModifyTime' => [ + 'description' => '素材更新时间。格式为：<i>yyyy-mm-dd</i>t<i>hh:mm:ss</i>z（utc时间）。', + 'type' => 'string', + 'example' => '2022-11-25T07:28:34Z', + ], + 'Sprites' => [ + 'description' => '素材雪碧图url数组。', + 'type' => 'array', + 'items' => [ + 'description' => '素材雪碧图url', + 'type' => 'string', + 'example' => '"http://example.aliyundoc.com/material_big_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=****"', + ], + ], + 'Snapshots' => [ + 'description' => '素材截图URL数组。', + 'type' => 'array', + 'items' => [ + 'description' => '素材截图url。', + 'type' => 'string', + 'example' => '"http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=","http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key="', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"85237CDA-0B54-5CED-BA10-A8A71AA13C1A\\",\\n \\"MaterialList\\": [\\n {\\n \\"Status\\": \\"Normal\\",\\n \\"CateId\\": 1000487543,\\n \\"CreateTime\\": \\"2019-10-02T08:26Z\\",\\n \\"MaterialType\\": \\"video\\",\\n \\"Tags\\": \\"tag1,tag2\\",\\n \\"SpriteConfig\\": \\"xxx\\",\\n \\"CateName\\": \\"分类1\\",\\n \\"Description\\": \\"素材描述\\",\\n \\"MaterialId\\": \\"85befc4118b84c6723e53b80b1****\\",\\n \\"Size\\": 1682694,\\n \\"CoverURL\\": \\"http://example.aliyundoc.com/aivideocover/46fa444aa34065cb9250f6c****/image_01.jpg\\",\\n \\"Duration\\": 3690.2332,\\n \\"CustomerId\\": 1234751840694470,\\n \\"Title\\": \\"test\\",\\n \\"ModifyTime\\": \\"2022-11-25T07:28:34Z\\",\\n \\"Sprites\\": [\\n \\"\\\\\\"http://example.aliyundoc.com/material_big_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=****\\\\\\"\\"\\n ],\\n \\"Snapshots\\": [\\n \\"\\\\\\"http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=\\\\\\",\\\\\\"http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=\\\\\\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '增加剪辑工程关联素材', + ], + 'DeleteEditingProjectMaterials' => [ + 'summary' => '删除云剪辑工程的待剪辑素材。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39833', + 'abilityTreeNodes' => [ + 'FEATUREvod8R2V42', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程id。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '198236101*****1093374', + ], + ], + [ + 'name' => 'MaterialIds', + 'in' => 'query', + 'schema' => [ + 'description' => '素材ID。即媒资ID，如视频VideoId、图片ImageId、辅助媒资MediaId等。多个素材ID使用英文逗号（,）分隔。'."\n" + ."\n" + .'获取素材ID，更多信息，请参见[搜索媒体信息](~~86044~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '9e3101bf24bf41c*****123318788ca', + ], + ], + [ + 'name' => 'MaterialType', + 'in' => 'query', + 'schema' => [ + 'description' => '素材类型。取值：'."\n" + .'- **video**：视频。'."\n" + .'- **audio**：纯音频。'."\n" + .'- **image**：图片。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'video', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '746FFA07-8BBB-46*****B1-3E94E3B2915E', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"746FFA07-8BBB-46*****B1-3E94E3B2915E\\"\\n}","type":"json"}]', + 'title' => '删除云剪辑工程素材', + ], + 'SetAuditSecurityIp' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '40122', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'SecurityGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '审核安全组名称。默认值为：**Default**。最多支持10个安全分组。', + 'type' => 'string', + 'required' => false, + 'example' => 'Default', + ], + ], + [ + 'name' => 'Ips', + 'in' => 'query', + 'schema' => [ + 'description' => '审核安全IP列表。每个分组最多支持100个，多个IP使用英文逗号（,）隔开，格式如下：'."\n" + ."\n" + .'- 精确IP：192.168.0.1'."\n" + .'- CIDR模式：192.168.0.1/24（无类域间路由，/24表示了地址中前缀的长度，范围：`[1,32]`）', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.1', + ], + ], + [ + 'name' => 'OperateMode', + 'in' => 'query', + 'schema' => [ + 'description' => '操作方式，取值范围：'."\n" + ."\n" + .'- **Append**：默认值，追加IP白名单。'."\n" + .'- **Cover**：覆盖原IP白名单。'."\n" + .'- **Delete**：删除IP白名单。'."\n" + .'> 当输入的参数取值不在上述取值范围内时，会使用默认值调用(即Append)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Cover', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetAuditSecurityIpResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n</SetAuditSecurityIpResponse>","errorExample":""}]', + 'title' => '设置审核安全IP', + 'summary' => '调用本接口设置审核安全IP。', + 'description' => '当视频状态为审核中（Checking）或屏蔽（Blocked）状态时，只有来自审核安全IP的请求才可以播放。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 接口错误码'."\n" + .'下表列举了本接口特有的错误码。'."\n" + ."\n\n" + .'| 错误代码 | 错误信息 | HTTP状态码 | 说明 |'."\n" + .'|--------|---------|----------| ---- |'."\n" + .'| IpsIsEmpty | The specified “Ips” can not be empty. | 400 | Ips不允许为空。|'."\n" + .'| IpsExceededMax | The specified Ips count has exceeded 100. |403 |添加的IP个数超过限制，每个分组最多支持100个。|'."\n" + .'|SecurityIpGroupExceededMax |The audit security group count has exceeded 10. |403 |审核安全IP分组个数超过限制。|'."\n" + ."\n\n", + ], + 'ListAuditSecurityIp' => [ + 'summary' => '调用本接口获取审核安全IP列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40047', + 'abilityTreeNodes' => [ + 'FEATUREvod7FWSSO', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SecurityGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '审核安全IP分组名称。默认获取所有。', + 'type' => 'string', + 'required' => false, + 'example' => 'Default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '664BBD08-C7DB-4E*****73-9D0958D9A899', + ], + 'SecurityIpList' => [ + 'description' => '审核安全IP详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-05-22T06:54:23Z', + ], + 'Ips' => [ + 'description' => '安全IP列表。', + 'type' => 'string', + 'example' => '30.27.14.0/24,30.39.127.245', + ], + 'ModificationTime' => [ + 'description' => '更新时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-05-22T06:55:14Z', + ], + 'SecurityGroupName' => [ + 'description' => '安全IP组名称。', + 'type' => 'string', + 'example' => 'Default', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"664BBD08-C7DB-4E*****73-9D0958D9A899\\",\\n \\"SecurityIpList\\": [\\n {\\n \\"CreationTime\\": \\"2018-05-22T06:54:23Z\\",\\n \\"Ips\\": \\"30.27.14.0/24,30.39.127.245\\",\\n \\"ModificationTime\\": \\"2018-05-22T06:55:14Z\\",\\n \\"SecurityGroupName\\": \\"Default\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListAuditSecurityIpResponse>\\r\\n\\t<SecurityGroupList>\\r\\n\\t\\t<SecurityGroupName>Default</SecurityGroupName>\\r\\n\\t\\t<Ips>30.27.14.0/24,30.39.127.245</Ips>\\r\\n\\t\\t<CreationTime>2018-05-22T06:54:23Z</CreationTime>\\r\\n\\t\\t<ModifyTime>2018-05-22T06:55:14Z</ModifyTime>\\r\\n\\t</SecurityGroupList>\\r\\n\\t<RequestId>664BBD08-C7DB-4E*****73-9D0958D9A899</RequestId>\\r\\n</ListAuditSecurityIpResponse>","errorExample":""}]', + 'title' => '获取审核安全IP列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'|错误代码|错误信息|HTTP状态码|说明|'."\n" + .'|-------|-------|-------|-----|'."\n" + .'|SecurityIp.NotFound|The audit security ip does not exist.|404|审核安全IP不存在。|'."\n" + .'|ListSecurityIpFailed|List audit security ip has failed due to some unknown error.|500|获取安全IP列表遇到未知错误，请刷新重试。|'."\n", + ], + 'SubmitAIMediaAuditJob' => [ + 'summary' => '调用本接口提交音视频智能审核作业。作业在提交成功后会异步执行，不保证接口返回时作业已处理完成。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40168', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '音/视频ID。可登录[点播控制台](https://vod.console.aliyun.com)，选择**审核管理** > **视频审核**查看音/视频ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'fe028d09441afffb138cd7ee****', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI模板ID。可通过以下方式获取：'."\n" + .'- 调用[添加AI模板](~~102930~~)接口添加AI模板时，AI模板ID为返回参数TemplateId的值。'."\n" + .'- AI模板添加后，可调用[查询AI模板列表](~~102936~~)接口查询AI模板ID，为请求后返回参数TemplateId的值。'."\n" + ."\n" + .'> 不指定AI模板ID时，则使用智能审核默认AI模板ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'a07a7f7d7d10eb9fd999e56ecc****', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置。为JSON字符串，支持消息回调等设置。更多详情，请参见[UserData](~~86952~~)。'."\n" + ."\n" + .'> 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用，否则回调设置不生效。控制台配置HTTP回调的操作，请参考[回调设置](~~86071~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"MessageCallback":{"CallbackURL":"http://test.test.com"},"Extend":{"localId":"xxx","test":"www"}}', + ], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体类型。目前仅支持：**video**。', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + ], + ], + [ + 'name' => 'MediaAuditConfiguration', + 'in' => 'query', + 'schema' => [ + 'description' => '审核任务配置信息。'."\n" + .'- 审核任务其他配置项，当前仅支持ResourceType字段，用于控制媒体文件类型，且可针对该类型调整审核标准和规则。'."\n" + .'- 需要针对ResourceType调整审核标准和规则，请提交工单获取技术支持，关于如何提交工单，请参见[联系我们](~~464625~~)。'."\n" + .'- ResourceType使用说明：只允许英文、数字、下划线。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ResourceType":"****_movie"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F4631053-8D9F-42B2-4A67281DB88E****', + ], + 'MediaId' => [ + 'description' => '音/视频ID。', + 'type' => 'string', + 'example' => 'fe028d09441afffb138cd7ee****', + ], + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => 'bdbc266af6893943a70176d92e99****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F4631053-8D9F-42B2-4A67281DB88E****\\",\\n \\"MediaId\\": \\"fe028d09441afffb138cd7ee****\\",\\n \\"JobId\\": \\"bdbc266af6893943a70176d92e99****\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitAIMediaAuditJobResponse>\\n <RequestId>F4631053-8D9F-42B2-4A67281DB88E****</RequestId>\\n <MediaId>fe028d09441afffb138cd7ee****</MediaId>\\n <JobId>bdbc266af6893943a70176d92e99****</JobId>\\n</SubmitAIMediaAuditJobResponse>","errorExample":""}]', + 'title' => '提交音视频智能审核作业', + 'description' => '- **请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。智能审核为付费功能，计费详情，<props="china">请参见[智能审核计费](~~188310#section-g7l-s3o-9ng~~)。</props><props="intl">请提交工单或联系阿里云商务经理了解。</props>**'."\n" + .'- 本接口目前仅支持**上海**、**北京**、**新加坡地域**。'."\n" + .'- 智能审核提交相关开发指南，请参见[智能审核](~~101148~~)。'."\n" + .'- 智能审核作业完成后，智能审核作业过程中产生的图片资源仅在视频点播分配的点播系统Bucket上免费保留2周，超过2周将自动删除。', + ], + 'SubmitAIImageAuditJob' => [ + 'summary' => '调用本接口来提交图片智能审核任务，作业在提交成功后会异步执行，不保证接口返回时作业已处理完成。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40163', + 'abilityTreeNodes' => [ + 'FEATUREvodIPBMLH', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '图片ID。'."\n" + ."\n" + .'上传图片到点播返回的图片唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'f1aa3024aee64*****6dc8ca20dbc320', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI模板ID。可通过以下方式获取：'."\n" + .'- 调用[添加AI模板](~~102930~~)接口添加AI模板时，AI模板ID为返回参数TemplateId的值。'."\n" + .'- AI模板添加后，可调用[查询AI模板列表](~~102936~~)接口查询AI模板ID，为请求后返回参数TemplateId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a07a7f7d7d10eb9fd999e56ecc****', + ], + ], + [ + 'name' => 'MediaAuditConfiguration', + 'in' => 'query', + 'schema' => [ + 'description' => '审核任务配置信息。'."\n" + .'- 审核任务其他配置项，当前仅支持ResourceType字段，用于控制媒体文件类型，且可针对该类型调整审核标准和规则。'."\n" + .'- ResourceType使用说明：只允许英文、数字、下划线。'."\n" + ."\n" + .'>- ResourceType字段可以按照使用说明自定义。自定义后需要[填写宜搭信息](https://yida.alibaba-inc.com/o/ticketapply)提交到阿里云后台处理后才会生效。'."\n" + .'>- 如需针对ResourceType调整审核标准和规则，您可以[填写宜搭信息](https://yida.alibaba-inc.com/o/ticketapply)申请技术支持。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ResourceType":"****_short_video"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '图片审核任务ID。', + 'type' => 'string', + 'example' => 'b1aa3024aee64*****6dc8ca20dbc328', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6F42D500-1956-4B*****30-C09E755F4F4B', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"JobId\\": \\"b1aa3024aee64*****6dc8ca20dbc328\\",\\n \\"RequestId\\": \\"6F42D500-1956-4B*****30-C09E755F4F4B\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitAIImageAuditJobResponse>\\n <RequestId>6F42D500-1956-4B*****30-C09E755F4F4B</RequestId>\\n <JobId>b1aa3024aee64*****6dc8ca20dbc328</JobId>\\n</SubmitAIImageAuditJobResponse>","errorExample":""}]', + 'title' => '提交图片智能审核作业', + 'description' => '- **请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。智能审核为付费功能，计费详情，<props="china">请参见[智能审核计费](~~188310#section-g7l-s3o-9ng~~)。</props><props="intl">请提交工单或联系阿里云商务经理了解。</props>**'."\n" + .'- <props="china">本接口目前仅支持**上海、北京、新加坡地域**。</props><props="intl">本接口仅支持新加坡地域。</props>'."\n" + .'- 单个图片大小不超过20 MB，高度或宽度不超过30000px，且图片总像素不超过2.5亿px。'."\n" + .'- （建议）图片像素不低于256×256px，像素过低可能会影响审核效果。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetAIMediaAuditJob' => [ + 'summary' => '调用本接口查询智能审核作业，在提交AI作业后，会进行异步处理，通过此接口可以实时查询作业信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39932', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能审核作业ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bdbc266af6894*****943a70176d92e9', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EAA3E96A-02E2-41*****85-08E1D568ED3A', + ], + 'MediaAuditJob' => [ + 'description' => '智能审核作业信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '作业开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'Type' => [ + 'description' => '作业类型。目前仅支持"智能审核"一种类型。', + 'type' => 'string', + 'example' => 'AIMediaAudit', + ], + 'Status' => [ + 'description' => '作业状态。取值：'."\n" + ."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。'."\n" + .'- **init**：初始化。'."\n" + .'- **processing**：处理中。', + 'type' => 'string', + 'example' => 'success', + ], + 'CompleteTime' => [ + 'description' => '作业结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-01-11T13:00:00Z', + ], + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => 'bdbc266af6894*****943a70176d92e9', + ], + 'Code' => [ + 'description' => '作业错误码。当Status为失败时，可关注该字段。', + 'type' => 'string', + 'example' => '0', + ], + 'Message' => [ + 'description' => '作业错误信息。当Status为失败时，可关注该字段。', + 'type' => 'string', + 'example' => 'OK', + ], + 'MediaId' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'example' => 'fe028d09441d*****d1afffb138cd7e', + ], + 'Data' => [ + 'description' => '作业结果数据。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'pass', + ], + 'AbnormalModules' => [ + 'description' => '违规的审核内容。多个使用英文逗号（,）分隔，取值：'."\n" + ."\n" + .'- **video**：视频。'."\n" + .'- **image-cover**：封面。'."\n" + .'- **text-title**：标题。', + 'type' => 'string', + 'example' => 'video', + ], + 'Label' => [ + 'description' => '审核结果分类。多个使用英文逗号（,）分隔，取值：'."\n" + ."\n" + .'- **porn**：涉黄。'."\n" + .'- **terrorism**：暴恐涉政。'."\n" + .'- **ad**：图文违规。'."\n" + .'- **live**：不良场景。'."\n" + .'- **logo**：图片logo。'."\n" + .'- **audio**：语音反垃圾。'."\n" + .'- **normal**：正常。', + 'type' => 'string', + 'example' => 'normal', + ], + 'ImageResult' => [ + 'description' => '图片审核结果。', + 'type' => 'array', + 'items' => [ + 'description' => '图片审核结果数据。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '图片分类。取值：**cover**（封面）。', + 'type' => 'string', + 'example' => 'cover', + ], + 'Url' => [ + 'description' => '图片的地址。', + 'type' => 'string', + 'example' => 'http://www.test.com/****.jpg', + ], + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => '图片审核结果分类。多个使用英文逗号（,）分隔，取值：'."\n" + ."\n" + .'- **porn**：涉黄。'."\n" + .'- **terrorism**：暴恐涉政。'."\n" + .'- **ad**：图文违规。'."\n" + .'- **live**：不良场景。'."\n" + .'- **logo**：图片logo。'."\n" + .'- **normal**：正常。', + 'type' => 'string', + 'example' => 'normal', + ], + 'Result' => [ + 'description' => '图片审结结果详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '命中Label的图片的分数。取值范围：`[0, 100]`，命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '0', + ], + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => '审核结果分类。'."\n" + ."\n" + .'当scene为**porn**时，取值：'."\n" + ."\n" + .'- **porn**：色情。'."\n" + .'- **sexy**：性感。'."\n" + .'- **normal**：正常。'."\n" + ."\n" + .'当scene为**terrorism**时，取值：'."\n" + ."\n" + .'- **normal**：正常。'."\n" + .'- **bloody**：血腥。'."\n" + .'- **explosion**：爆炸烟光。'."\n" + .'- **outfit**：特殊装束。'."\n" + .'- **logo**：特殊标识。'."\n" + .'- **weapon**：武器。'."\n" + .'- **politics**：渉政。'."\n" + .'- **violence**：打斗。'."\n" + .'- **crowd**：聚众。'."\n" + .'- **parade**：游行。'."\n" + .'- **carcrash**：车祸现场。'."\n" + .'- **flag**：旗帜。'."\n" + .'- **location**：地标。'."\n" + .'- **others**：其它。'."\n" + ."\n" + .'当scene为**ad**时，取值：'."\n" + ."\n" + .'- **normal**：正常。'."\n" + .'- **ad**：其他广告。'."\n" + .'- **politics**：文字含涉政内容。'."\n" + .'- **porn**：文字含涉黄内容。'."\n" + .'- **abuse**：文字含辱骂内容。'."\n" + .'- **terrorism**：文字含暴恐内容。'."\n" + .'- **contraband**：文字含违禁内容。'."\n" + .'- **spam**：文字含其他垃圾内容。'."\n" + .'- **npx**：牛皮癣广告。'."\n" + .'- **qrcode**：含二维码。'."\n" + .'- **programCode**：含小程序码。'."\n" + ."\n" + .'当scene为**live**时，取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **meaningless**：图片中无内容（例如黑屏、白屏）。'."\n" + .'- **PIP**：画中画。'."\n" + .'- **smoking**：吸烟。'."\n" + .'- **drivelive**：车内直播。'."\n" + ."\n" + .'当scene为**logo**时，取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **TV**：含受管控的logo。'."\n" + .'- **trademark**：含商标。', + 'type' => 'string', + 'example' => 'porn', + ], + 'Scene' => [ + 'description' => '审核场景。取值：'."\n" + ."\n" + .'- **porn**：鉴黄。'."\n" + .'- **terrorism**：暴恐涉政。'."\n" + .'- **ad**：图文违规。'."\n" + .'- **live**：不良场景。'."\n" + .'- **logo**：图片logo。', + 'type' => 'string', + 'example' => 'porn', + ], + ], + ], + ], + ], + ], + ], + 'TextResult' => [ + 'description' => '文本审核结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '文本分类。取值：**title**（标题）。', + 'type' => 'string', + 'example' => 'title', + ], + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'pass', + ], + 'Score' => [ + 'description' => '命中Label的图片的分数。取值范围：`[0, 100]`，命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Label' => [ + 'description' => '审核结果分类。取值：'."\n" + .'- **spam**：含垃圾信息。'."\n" + .'- **ad**：广告。'."\n" + .'- **abuse**：辱骂。'."\n" + .'- **flood**：灌水。'."\n" + .'- **contraband**：违禁。'."\n" + .'- **meaningless**：无意义。'."\n" + .'- **normal**：普通。', + 'type' => 'string', + 'example' => 'ad', + ], + 'Content' => [ + 'description' => '文本内容。', + 'type' => 'string', + 'example' => '测试', + ], + 'Scene' => [ + 'description' => '审核场景。取固定值：**antispam**。', + 'type' => 'string', + 'example' => 'antispam', + ], + ], + ], + ], + 'AudioResult' => [ + 'description' => '音频审核结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '结果分数。', + 'type' => 'string', + 'example' => '99.91', + ], + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => '审核结果分类：'."\n" + ."\n" + .'- **normal**：正常。'."\n" + .'- **spam**：含垃圾信息。'."\n" + .'- **ad**：广告。'."\n" + .'- **politics**：涉政。'."\n" + .'- **terrorism**：暴恐。'."\n" + .'- **abuse**：辱骂。'."\n" + .'- **porn**：色情。'."\n" + .'- **flood**：灌水。'."\n" + .'- **contraband**：违禁。'."\n" + .'- **meaningless**：无意义。', + 'type' => 'string', + 'example' => 'normal', + ], + 'Scene' => [ + 'description' => '审核场景。取固定值：**antispam**。', + 'type' => 'string', + 'example' => 'antispam', + ], + ], + ], + ], + 'VideoResult' => [ + 'description' => '视频审核结果。', + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => '审核结果分类。取值：'."\n" + .'- **porn**：涉黄。'."\n" + .'- **terrorism**：暴恐涉政。'."\n" + .'- **ad**：图文违规。'."\n" + .'- **live**：不良场景。'."\n" + .'- **logo**：图片logo。'."\n" + .'- **normal**：正常。', + 'type' => 'string', + 'example' => 'normal', + ], + 'Suggestion' => [ + 'description' => '视频审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'pass', + ], + 'TerrorismResult' => [ + 'description' => '暴恐涉政审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '暴恐涉政审核建议。取值：'."\n" + ."\n" + .'- **block**（违规）'."\n" + .'- **review**（疑似）'."\n" + .'- **pass**（通过）', + 'type' => 'string', + 'example' => 'pass', + ], + 'AverageScore' => [ + 'description' => '命中Label的视频截图的平均分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Label' => [ + 'description' => '暴恐涉政审核结果。取值范围：'."\n" + ."\n" + .'- **normal**：正常。'."\n" + .'- **bloody**：血腥。'."\n" + .'- **explosion**：爆炸烟光。'."\n" + .'- **outfit**：特殊装束。'."\n" + .'- **logo**：特殊标识。'."\n" + .'- **weapon**：武器。'."\n" + .'- **politics**：渉政。'."\n" + .'- **violence**：打斗。'."\n" + .'- **crowd**：聚众。'."\n" + .'- **parade**：游行。'."\n" + .'- **carcrash**：车祸现场。'."\n" + .'- **flag**：旗帜。'."\n" + .'- **location**：地标。'."\n" + .'- **others**：其它。', + 'type' => 'string', + 'example' => 'normal', + ], + 'MaxScore' => [ + 'description' => '命中Label的视频截图的最高分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'CounterList' => [ + 'description' => '包括暴恐涉政结果各分类及其视频截图张数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => '暴恐涉政审核结果。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **bloody**：血腥。'."\n" + .'- **explosion**：爆炸烟光。'."\n" + .'- **outfit**：特殊装束。'."\n" + .'- **logo**：特殊标识。'."\n" + .'- **weapon**：武器。'."\n" + .'- **politics**：渉政。'."\n" + .'- **violence**：打斗。'."\n" + .'- **crowd**：聚众。'."\n" + .'- **parade**：游行。'."\n" + .'- **carcrash**：车祸现场。'."\n" + .'- **flag**：旗帜。'."\n" + .'- **location**：地标。'."\n" + .'- **others**：其它。', + 'type' => 'string', + 'example' => 'terrorism', + ], + 'Count' => [ + 'description' => '视频截图张数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + 'TopList' => [ + 'description' => '命中Label下分数最高的视频截图信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '视频截图的地址。', + 'type' => 'string', + 'example' => 'http://ali*****.com/aivideocensor/yytysursrutyrxuq/****.jpg', + ], + 'Score' => [ + 'description' => '命中Label的视频截图的分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Timestamp' => [ + 'description' => '视频截图在视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '5', + ], + 'Label' => [ + 'description' => '暴恐涉政审核结果。取值范围：'."\n" + ."\n" + .'- **normal**：正常。'."\n" + .'- **bloody**：血腥。'."\n" + .'- **explosion**：爆炸烟光。'."\n" + .'- **outfit**：特殊装束。'."\n" + .'- **logo**：特殊标识。'."\n" + .'- **weapon**：武器。'."\n" + .'- **politics**：渉政。'."\n" + .'- **violence**：打斗。'."\n" + .'- **crowd**：聚众。'."\n" + .'- **parade**：游行。'."\n" + .'- **carcrash**：车祸现场。'."\n" + .'- **flag**：旗帜。'."\n" + .'- **location**：地标。'."\n" + .'- **others**：其它。', + 'type' => 'string', + 'example' => 'normal', + ], + ], + ], + ], + ], + ], + 'PornResult' => [ + 'description' => '鉴黄审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '鉴黄审核建议。取值范围：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'pass', + ], + 'AverageScore' => [ + 'description' => '命中Label的视频截图的平均分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Label' => [ + 'description' => '鉴黄审核结果。取值范围：'."\n" + ."\n" + .'- **porn**：色情。'."\n" + .'- **sexy**：性感。'."\n" + .'- **normal**：正常。', + 'type' => 'string', + 'example' => 'porn', + ], + 'MaxScore' => [ + 'description' => '命中Label的视频截图的最高分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'CounterList' => [ + 'description' => '审核结果各分类及其视频截图的张数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => '鉴黄审核结果。取值范围：'."\n" + ."\n" + .'- **porn**：色情。'."\n" + .'- **sexy**：性感。'."\n" + .'- **normal**：正常。', + 'type' => 'string', + 'example' => 'porn', + ], + 'Count' => [ + 'description' => '视频截图张数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + 'TopList' => [ + 'description' => '命中Label下分数最高的视频截图信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '视频截图的地址。', + 'type' => 'string', + 'example' => 'http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg', + ], + 'Score' => [ + 'description' => '命中Label的视频截图的分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Timestamp' => [ + 'description' => '视频截图在视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '3005', + ], + 'Label' => [ + 'description' => '鉴黄审核结果。取值范围：'."\n" + ."\n" + .'- **porn**：色情。'."\n" + .'- **sexy**：性感。'."\n" + .'- **normal**：正常。', + 'type' => 'string', + 'example' => 'porn', + ], + ], + ], + ], + ], + ], + 'AdResult' => [ + 'description' => '广告审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '审核结果建议。取值范围：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'block', + ], + 'AverageScore' => [ + 'description' => '广告审核结果平均分数。', + 'type' => 'string', + 'example' => '100', + ], + 'Label' => [ + 'description' => '广告审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **ad**：其他广告。'."\n" + .'- **politics**：文字含涉政内容。'."\n" + .'- **porn**：文字含涉黄内容。'."\n" + .'- **abuse**：文字含辱骂内容。'."\n" + .'- **terrorism**：文字含暴恐内容。'."\n" + .'- **contraband**：文字含违禁内容。'."\n" + .'- **spam**：文字含其他垃圾内容。'."\n" + .'- **npx**：牛皮癣广告。'."\n" + .'- **qrcode**：含二维码。'."\n" + .'- **programCode**：含小程序码。', + 'type' => 'string', + 'example' => 'ad', + ], + 'MaxScore' => [ + 'description' => '最高审核分数。', + 'type' => 'string', + 'example' => '100', + ], + 'CounterList' => [ + 'description' => '审核结果各分类及其视频截图的张数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => '广告审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **ad**：其他广告。'."\n" + .'- **politics**：文字含涉政内容。'."\n" + .'- **porn**：文字含涉黄内容。'."\n" + .'- **abuse**：文字含辱骂内容。'."\n" + .'- **terrorism**：文字含暴恐内容。'."\n" + .'- **contraband**：文字含违禁内容。'."\n" + .'- **spam**：文字含其他垃圾内容。'."\n" + .'- **npx**：牛皮癣广告。'."\n" + .'- **qrcode**：含二维码。'."\n" + .'- **programCode**：含小程序码。', + 'type' => 'string', + 'example' => 'ad', + ], + 'Count' => [ + 'description' => '视频截图张数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + 'TopList' => [ + 'description' => '命中Label下分数最高的视频截图信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '视频截图地址。', + 'type' => 'string', + 'example' => 'http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg', + ], + 'Score' => [ + 'description' => '命中Label的视频截图的分数。', + 'type' => 'string', + 'example' => '100', + ], + 'Timestamp' => [ + 'description' => '视频截图在视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '500', + ], + 'Label' => [ + 'description' => '广告审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **ad**：其他广告。'."\n" + .'- **politics**：文字含涉政内容。'."\n" + .'- **porn**：文字含涉黄内容。'."\n" + .'- **abuse**：文字含辱骂内容。'."\n" + .'- **terrorism**：文字含暴恐内容。'."\n" + .'- **contraband**：文字含违禁内容。'."\n" + .'- **spam**：文字含其他垃圾内容。'."\n" + .'- **npx**：牛皮癣广告。'."\n" + .'- **qrcode**：含二维码。'."\n" + .'- **programCode**：含小程序码。', + 'type' => 'string', + 'example' => 'ad', + ], + ], + ], + ], + ], + ], + 'LiveResult' => [ + 'description' => '不良内容审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'block', + ], + 'AverageScore' => [ + 'description' => '审核结果平均分数。', + 'type' => 'string', + 'example' => '100', + ], + 'Label' => [ + 'description' => '审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **meaningless**：图片中无内容（例如黑屏、白屏）。'."\n" + .'- **PIP**：画中画。'."\n" + .'- **smoking**：吸烟。'."\n" + .'- **drivelive**：车内直播。', + 'type' => 'string', + 'example' => 'smoking', + ], + 'MaxScore' => [ + 'description' => '最高审核分数。', + 'type' => 'string', + 'example' => '100', + ], + 'CounterList' => [ + 'description' => '审核结果各分类及其视频截图张数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => '审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **meaningless**：图片中无内容（例如黑屏、白屏）。'."\n" + .'- **PIP**：画中画。'."\n" + .'- **smoking**：吸烟。'."\n" + .'- **drivelive**：车内直播。', + 'type' => 'string', + 'example' => 'smoking', + ], + 'Count' => [ + 'description' => '视频截图张数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + ], + ], + ], + 'TopList' => [ + 'description' => '命中Label下分数最高的视频截图信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '视频截图的地址。', + 'type' => 'string', + 'example' => 'http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg', + ], + 'Score' => [ + 'description' => '命中Label的视频截图的分数。', + 'type' => 'string', + 'example' => '100', + ], + 'Timestamp' => [ + 'description' => '视频截图在视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '500', + ], + 'Label' => [ + 'description' => '审核结果分类。取值范围：'."\n" + .'- **normal**：正常。'."\n" + .'- **meaningless**：图片中无内容（例如黑屏、白屏）。'."\n" + .'- **PIP**：画中画。'."\n" + .'- **smoking**：吸烟。'."\n" + .'- **drivelive**：车内直播。', + 'type' => 'string', + 'example' => 'smoking', + ], + ], + ], + ], + ], + ], + 'LogoResult' => [ + 'description' => 'Logo审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => 'Logo审核建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'block', + ], + 'AverageScore' => [ + 'description' => '命中Label的视频截图的平均分值。', + 'type' => 'string', + 'example' => '100', + ], + 'Label' => [ + 'description' => 'Logo审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **TV**：含受管控的Logo。'."\n" + .'- **trademark**：含商标。', + 'type' => 'string', + 'example' => 'TV', + ], + 'MaxScore' => [ + 'description' => '命中Label的视频截图的最高分数。', + 'type' => 'string', + 'example' => '100', + ], + 'CounterList' => [ + 'description' => '审核结果各分类及其视频截图张数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => 'logo审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **TV**：含受管控的logo。'."\n" + .'- **trademark**：含商标。', + 'type' => 'string', + 'example' => 'TV', + ], + 'Count' => [ + 'description' => '视频截图张数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + 'TopList' => [ + 'description' => '命中Label下分数最高的视频截图信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '视频截图的地址。', + 'type' => 'string', + 'example' => 'http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg', + ], + 'Score' => [ + 'description' => '命中Label的视频截图的分数。', + 'type' => 'string', + 'example' => '100', + ], + 'Timestamp' => [ + 'description' => '视频截图在视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '5000', + ], + 'Label' => [ + 'description' => 'Logo审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **TV**：含受管控的Logo。'."\n" + .'- **trademark**：含商标。', + 'type' => 'string', + 'example' => 'TV', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EAA3E96A-02E2-41*****85-08E1D568ED3A\\",\\n \\"MediaAuditJob\\": {\\n \\"CreationTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"Type\\": \\"AIMediaAudit\\",\\n \\"Status\\": \\"success\\",\\n \\"CompleteTime\\": \\"2017-01-11T13:00:00Z\\",\\n \\"JobId\\": \\"bdbc266af6894*****943a70176d92e9\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"OK\\",\\n \\"MediaId\\": \\"fe028d09441d*****d1afffb138cd7e\\",\\n \\"Data\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"AbnormalModules\\": \\"video\\",\\n \\"Label\\": \\"normal\\",\\n \\"ImageResult\\": [\\n {\\n \\"Type\\": \\"cover\\",\\n \\"Url\\": \\"http://www.test.com/****.jpg\\",\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"Result\\": [\\n {\\n \\"Score\\": \\"0\\",\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"porn\\",\\n \\"Scene\\": \\"porn\\"\\n }\\n ]\\n }\\n ],\\n \\"TextResult\\": [\\n {\\n \\"Type\\": \\"title\\",\\n \\"Suggestion\\": \\"pass\\",\\n \\"Score\\": \\"100\\",\\n \\"Label\\": \\"ad\\",\\n \\"Content\\": \\"测试\\",\\n \\"Scene\\": \\"antispam\\"\\n }\\n ],\\n \\"AudioResult\\": [\\n {\\n \\"Score\\": \\"99.91\\",\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"antispam\\"\\n }\\n ],\\n \\"VideoResult\\": {\\n \\"Label\\": \\"normal\\",\\n \\"Suggestion\\": \\"pass\\",\\n \\"TerrorismResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"AverageScore\\": \\"100\\",\\n \\"Label\\": \\"normal\\",\\n \\"MaxScore\\": \\"100\\",\\n \\"CounterList\\": [\\n {\\n \\"Label\\": \\"terrorism\\",\\n \\"Count\\": 0\\n }\\n ],\\n \\"TopList\\": [\\n {\\n \\"Url\\": \\"http://ali*****.com/aivideocensor/yytysursrutyrxuq/****.jpg\\",\\n \\"Score\\": \\"100\\",\\n \\"Timestamp\\": \\"5\\",\\n \\"Label\\": \\"normal\\"\\n }\\n ]\\n },\\n \\"PornResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"AverageScore\\": \\"100\\",\\n \\"Label\\": \\"porn\\",\\n \\"MaxScore\\": \\"100\\",\\n \\"CounterList\\": [\\n {\\n \\"Label\\": \\"porn\\",\\n \\"Count\\": 0\\n }\\n ],\\n \\"TopList\\": [\\n {\\n \\"Url\\": \\"http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg\\",\\n \\"Score\\": \\"100\\",\\n \\"Timestamp\\": \\"3005\\",\\n \\"Label\\": \\"porn\\"\\n }\\n ]\\n },\\n \\"AdResult\\": {\\n \\"Suggestion\\": \\"block\\",\\n \\"AverageScore\\": \\"100\\",\\n \\"Label\\": \\"ad\\",\\n \\"MaxScore\\": \\"100\\",\\n \\"CounterList\\": [\\n {\\n \\"Label\\": \\"ad\\",\\n \\"Count\\": 10\\n }\\n ],\\n \\"TopList\\": [\\n {\\n \\"Url\\": \\"http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg\\",\\n \\"Score\\": \\"100\\",\\n \\"Timestamp\\": \\"500\\",\\n \\"Label\\": \\"ad\\"\\n }\\n ]\\n },\\n \\"LiveResult\\": {\\n \\"Suggestion\\": \\"block\\",\\n \\"AverageScore\\": \\"100\\",\\n \\"Label\\": \\"smoking\\",\\n \\"MaxScore\\": \\"100\\",\\n \\"CounterList\\": [\\n {\\n \\"Label\\": \\"smoking\\",\\n \\"Count\\": 4\\n }\\n ],\\n \\"TopList\\": [\\n {\\n \\"Url\\": \\"http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg\\",\\n \\"Score\\": \\"100\\",\\n \\"Timestamp\\": \\"500\\",\\n \\"Label\\": \\"smoking\\"\\n }\\n ]\\n },\\n \\"LogoResult\\": {\\n \\"Suggestion\\": \\"block\\",\\n \\"AverageScore\\": \\"100\\",\\n \\"Label\\": \\"TV\\",\\n \\"MaxScore\\": \\"100\\",\\n \\"CounterList\\": [\\n {\\n \\"Label\\": \\"TV\\",\\n \\"Count\\": 2\\n }\\n ],\\n \\"TopList\\": [\\n {\\n \\"Url\\": \\"http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg\\",\\n \\"Score\\": \\"100\\",\\n \\"Timestamp\\": \\"5000\\",\\n \\"Label\\": \\"TV\\"\\n }\\n ]\\n }\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAIMediaAuditJobResponse>\\n<RequestId>EAA3E96A-02E2-41*****85-08E1D568ED3A</RequestId>\\n<MediaAuditJob>\\n <Status>success</Status>\\n <Type>AIMediaAudit</Type>\\n <Message>OK</Message>\\n <MediaId>fe028d09441d*****d1afffb138cd7e</MediaId>\\n <CreationTime>2017-01-11T12:00:00Z</CreationTime>\\n <Data>\\n <Suggestion>pass</Suggestion>\\n <TextResult>\\n <Suggestion>pass</Suggestion>\\n <Type>title</Type>\\n <Score>100</Score>\\n <Content>测试</Content>\\n <Label>ad</Label>\\n <Scene>antispam</Scene>\\n </TextResult>\\n <AbnormalModules>video</AbnormalModules>\\n <ImageResult>\\n <Label>normal</Label>\\n <Suggestion>pass</Suggestion>\\n <Type>cover</Type>\\n <Url>http://www.test.com/****.jpg</Url>\\n </ImageResult>\\n <ImageResult>\\n <Result>\\n <Label>porn</Label>\\n <Suggestion>pass</Suggestion>\\n <Score>0</Score>\\n <Scene>porn</Scene>\\n </Result>\\n </ImageResult>\\n <VideoResult>\\n <Suggestion>pass</Suggestion>\\n <LogoResult>\\n <TopList>\\n <Label>logo</Label>\\n <Score>100</Score>\\n <Timestamp>5000</Timestamp>\\n <Url>http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg</Url>\\n </TopList>\\n <Suggestion>block</Suggestion>\\n <MaxScore>100</MaxScore>\\n <AverageScore>100</AverageScore>\\n <Label>logo</Label>\\n <CounterList>\\n <Label>logo</Label>\\n <Count>2</Count>\\n </CounterList>\\n </LogoResult>\\n <Label>normal</Label>\\n <TerrorismResult>\\n <TopList>\\n <Label>normal</Label>\\n <Score>100</Score>\\n <Timestamp>5</Timestamp>\\n <Url>http://ali*****.com/aivideocensor/yytysursrutyrxuq/****.jpg</Url>\\n </TopList>\\n <Suggestion>pass</Suggestion>\\n <MaxScore>100</MaxScore>\\n <AverageScore>100</AverageScore>\\n <Label>normal</Label>\\n <CounterList>\\n <Label>terrorism</Label>\\n <Count>0</Count>\\n </CounterList>\\n </TerrorismResult>\\n <LiveResult>\\n <TopList>\\n <Label>live</Label>\\n <Score>100</Score>\\n <Timestamp>500</Timestamp>\\n <Url>http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg</Url>\\n </TopList>\\n <Suggestion>block</Suggestion>\\n <MaxScore>100</MaxScore>\\n <AverageScore>100</AverageScore>\\n <Label>live</Label>\\n <CounterList>\\n <Label>live</Label>\\n <Count>0</Count>\\n </CounterList>\\n </LiveResult>\\n <PornResult>\\n <TopList>\\n <Label>porn</Label>\\n <Score>100</Score>\\n <Timestamp>3005</Timestamp>\\n <Url>http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg</Url>\\n </TopList>\\n <Suggestion>pass</Suggestion>\\n <MaxScore>100</MaxScore>\\n <AverageScore>100</AverageScore>\\n <Label>porn</Label>\\n <CounterList>\\n <Label>porn</Label>\\n <Count>0</Count>\\n </CounterList>\\n </PornResult>\\n <AdResult>\\n <TopList>\\n <Label>ad</Label>\\n <Score>100</Score>\\n <Timestamp>500</Timestamp>\\n <Url>http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg</Url>\\n </TopList>\\n <Suggestion>block</Suggestion>\\n <MaxScore>100</MaxScore>\\n <AverageScore>100</AverageScore>\\n <Label>ad</Label>\\n <CounterList>\\n <Label>ad</Label>\\n <Count>10</Count>\\n </CounterList>\\n </AdResult>\\n </VideoResult>\\n <Label>normal</Label>\\n </Data>\\n <CompleteTime>2017-01-11T13:00:00Z</CompleteTime>\\n <Code>0</Code>\\n <JobId>bdbc266af6894*****943a70176d92e9</JobId>\\n</MediaAuditJob>\\n</GetAIMediaAuditJobResponse>","errorExample":""}]', + 'title' => '查询智能审核作业', + 'description' => '<props="intl">'."\n" + .'- 本接口仅支持新加坡地域。'."\n" + .'</props>'."\n" + .'- 智能审核作业结果中的图片资源仅在点播提供的免费存储上保留2周，超过2周将自动删除。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetMediaAuditResult' => [ + 'summary' => '调用本接口获取智能审核结果摘要信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39959', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '支持查询视频ID和图片ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '93ab850b4f6f*****54b6e91d24d81d4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB7D7232-1AB2-40FE-B8D5-****', + ], + 'MediaAuditResult' => [ + 'description' => '审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'pass', + ], + 'AbnormalModules' => [ + 'description' => '违规的审核内容。多个使用英文逗号（,）分隔，取值：'."\n" + ."\n" + .'- **video**：视频。'."\n" + .'- **image-cover**：封面。'."\n" + .'- **text-title**：标题。', + 'type' => 'string', + 'example' => 'video', + ], + 'Label' => [ + 'description' => '审核结果分类。多个使用英文逗号（,）分隔，取值：'."\n" + .'- **porn**：涉黄。'."\n" + .'- **terrorism**：暴恐涉政。'."\n" + .'- **ad**：图文违规。'."\n" + .'- **live**：不良场景。'."\n" + .'- **logo**：图片logo。'."\n" + .'- **audio**：语音反垃圾。'."\n" + .'- **normal**：正常。', + 'type' => 'string', + 'example' => 'porn', + ], + 'AudioResult' => [ + 'description' => '音频审核结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '命中Label音频的分数。取值范围：`[0, 100]`，命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '99.91', + ], + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => '审核结果分类：'."\n" + ."\n" + .'- **normal**：正常。'."\n" + .'- **spam**：含垃圾信息。'."\n" + .'- **ad**：广告。'."\n" + .'- **politics**：涉政。'."\n" + .'- **terrorism**：暴恐。'."\n" + .'- **abuse**：辱骂。'."\n" + .'- **porn**：色情。'."\n" + .'- **flood**：灌水。'."\n" + .'- **contraband**：违禁。'."\n" + .'- **meaningless**：无意义。', + 'type' => 'string', + 'example' => 'normal', + ], + 'Scene' => [ + 'description' => '审核场景。取固定值：**antispam**。', + 'type' => 'string', + 'example' => 'antispam', + ], + ], + ], + ], + 'ImageResult' => [ + 'description' => '图片审核结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '图片分类。取值：**cover**（封面）。', + 'type' => 'string', + 'example' => 'cover', + ], + 'Url' => [ + 'description' => '图片的地址。', + 'type' => 'string', + 'example' => 'http://www.test.com/****.jpg', + ], + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => '图片审核结果分类。多个使用英文逗号（,）分隔，取值：'."\n" + ."\n" + .'- **porn**：涉黄。'."\n" + .'- **terrorism**：暴恐涉政。'."\n" + .'- **ad**：图文违规。'."\n" + .'- **live**：不良场景。'."\n" + .'- **logo**：图片logo。'."\n" + .'- **normal**：正常。', + 'type' => 'string', + 'example' => 'porn', + ], + 'Result' => [ + 'description' => '图片审核结果详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '命中Label的图片的分数。取值范围：`[0, 100]`，命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100.00000', + ], + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => '审核结果分类。'."\n" + ."\n" + .'当scene为**porn**时，取值：'."\n" + ."\n" + .'- **porn**：色情。'."\n" + .'- **sexy**：性感。'."\n" + .'- **normal**：正常。'."\n" + ."\n" + .'当scene为**terrorism**时，取值：'."\n" + ."\n" + .'- **normal**：正常。'."\n" + .'- **bloody**：血腥。'."\n" + .'- **explosion**：爆炸烟光。'."\n" + .'- **outfit**：特殊装束。'."\n" + .'- **logo**：特殊标识。'."\n" + .'- **weapon**：武器。'."\n" + .'- **politics**：渉政。'."\n" + .'- **violence**：打斗。'."\n" + .'- **crowd**：聚众。'."\n" + .'- **parade**：游行。'."\n" + .'- **carcrash**：车祸现场。'."\n" + .'- **flag**：旗帜。'."\n" + .'- **location**：地标。'."\n" + .'- **others**：其它。'."\n" + ."\n" + .'当scene为**ad**时，取值：'."\n" + ."\n" + .'- **normal**：正常。'."\n" + .'- **ad**：其他广告。'."\n" + .'- **politics**：文字含涉政内容。'."\n" + .'- **porn**：文字含涉黄内容。'."\n" + .'- **abuse**：文字含辱骂内容。'."\n" + .'- **terrorism**：文字含暴恐内容。'."\n" + .'- **contraband**：文字含违禁内容。'."\n" + .'- **spam**：文字含其他垃圾内容。'."\n" + .'- **npx**：牛皮癣广告。'."\n" + .'- **qrcode**：含二维码。'."\n" + .'- **programCode**：含小程序码。'."\n" + ."\n" + .'当scene为**live**时，取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **meaningless**：图片中无内容（例如黑屏、白屏）。'."\n" + .'- **PIP**：画中画。'."\n" + .'- **smoking**：吸烟。'."\n" + .'- **drivelive**：车内直播。'."\n" + ."\n" + .'当scene为**logo**时，取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **TV**：含受管控的logo。'."\n" + .'- **trademark**：含商标。', + 'type' => 'string', + 'example' => 'porn', + ], + 'Scene' => [ + 'description' => '审核场景。取值：'."\n" + ."\n" + .'- **porn**：鉴黄。'."\n" + .'- **terrorism**：暴恐涉政。'."\n" + .'- **ad**：图文违规。'."\n" + .'- **live**：不良场景。'."\n" + .'- **logo**：图片logo。', + 'type' => 'string', + 'example' => 'porn', + ], + ], + ], + ], + ], + ], + ], + 'TextResult' => [ + 'description' => '文本审核结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '文本分类。取值：**title**（标题）。', + 'type' => 'string', + 'example' => 'title', + ], + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'pass', + ], + 'Score' => [ + 'description' => '命中Label的文本截图的分数。取值范围：`[0, 100]`，命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100.00000', + ], + 'Label' => [ + 'description' => '审核结果分类。取值：'."\n" + ."\n" + .'- **spam**：含垃圾信息。'."\n" + .'- **ad**：广告。'."\n" + .'- **abuse**：辱骂。'."\n" + .'- **flood**：灌水。'."\n" + .'- **contraband**：违禁。'."\n" + .'- **meaningless**：无意义。'."\n" + .'- **normal**：正常。', + 'type' => 'string', + 'example' => 'ad', + ], + 'Content' => [ + 'description' => '审核文本内容。', + 'type' => 'string', + 'example' => '热线电话123****', + ], + 'Scene' => [ + 'description' => '审核场景。取固定值：**antispam**。', + 'type' => 'string', + 'example' => 'antispam', + ], + ], + ], + ], + 'VideoResult' => [ + 'description' => '视频审核结果。', + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => '审核结果分类。取值：'."\n" + .'- **porn**：涉黄。'."\n" + .'- **terrorism**：暴恐涉政。'."\n" + .'- **ad**：图文违规。'."\n" + .'- **live**：不良场景。'."\n" + .'- **logo**：图片logo。'."\n" + .'- **normal**：正常。', + 'type' => 'string', + 'example' => 'porn', + ], + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'pass', + ], + 'PornResult' => [ + 'description' => '鉴黄审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '鉴黄审核建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'pass', + ], + 'AverageScore' => [ + 'description' => '命中Label的视频截图的平均分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Label' => [ + 'description' => '鉴黄审核结果。取值：'."\n" + ."\n" + .'- **porn**：色情。'."\n" + .'- **sexy**：性感。'."\n" + .'- **normal**：正常。', + 'type' => 'string', + 'example' => 'porn', + ], + 'MaxScore' => [ + 'description' => '命中Label的视频截图的最高分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'CounterList' => [ + 'description' => '审核结果各分类及其视频截图的张数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => '鉴黄审核结果。取值：'."\n" + ."\n" + .'- **porn**：色情。'."\n" + .'- **sexy**：性感。'."\n" + .'- **normal**：正常。', + 'type' => 'string', + 'example' => 'porn', + ], + 'Count' => [ + 'description' => '视频截图张数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'TopList' => [ + 'description' => '命中Label下分数最高的视频截图信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '视频截图的地址。', + 'type' => 'string', + 'example' => 'http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg', + ], + 'Score' => [ + 'description' => '命中Label的视频截图的分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100.0000', + ], + 'Timestamp' => [ + 'description' => '视频截图在视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '3005', + ], + 'Label' => [ + 'description' => '鉴黄审核结果。取值：'."\n" + ."\n" + .'- **porn**：色情。'."\n" + .'- **sexy**：性感。'."\n" + .'- **normal**：正常。', + 'type' => 'string', + 'example' => 'porn', + ], + ], + ], + ], + ], + ], + 'AdResult' => [ + 'description' => '广告审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'block', + ], + 'AverageScore' => [ + 'description' => '命中Label的视频截图的平均分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Label' => [ + 'description' => '广告审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **ad**：其他广告。'."\n" + .'- **politics**：文字含涉政内容。'."\n" + .'- **porn**：文字含涉黄内容。'."\n" + .'- **abuse**：文字含辱骂内容。'."\n" + .'- **terrorism**：文字含暴恐内容。'."\n" + .'- **contraband**：文字含违禁内容。'."\n" + .'- **spam**：文字含其他垃圾内容。'."\n" + .'- **npx**：牛皮癣广告。'."\n" + .'- **qrcode**：含二维码。'."\n" + .'- **programCode**：含小程序码。', + 'type' => 'string', + 'example' => 'ad', + ], + 'MaxScore' => [ + 'description' => '命中Label的视频截图的最高分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'CounterList' => [ + 'description' => '审核结果各分类及其视频截图的张数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => '广告审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **ad**：其他广告。'."\n" + .'- **politics**：文字含涉政内容。'."\n" + .'- **porn**：文字含涉黄内容。'."\n" + .'- **abuse**：文字含辱骂内容。'."\n" + .'- **terrorism**：文字含暴恐内容。'."\n" + .'- **contraband**：文字含违禁内容。'."\n" + .'- **spam**：文字含其他垃圾内容。'."\n" + .'- **npx**：牛皮癣广告。'."\n" + .'- **qrcode**：含二维码。'."\n" + .'- **programCode**：含小程序码。', + 'type' => 'string', + 'example' => 'ad', + ], + 'Count' => [ + 'description' => '视频截图张数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + 'TopList' => [ + 'description' => '命中Label下分数最高的视频截图信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '视频截图的地址。', + 'type' => 'string', + 'example' => 'http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg', + ], + 'Score' => [ + 'description' => '命中Label的视频截图的分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Timestamp' => [ + 'description' => '视频截图在视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '10', + ], + 'Label' => [ + 'description' => '广告审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **ad**：其他广告。'."\n" + .'- **politics**：文字含涉政内容。'."\n" + .'- **porn**：文字含涉黄内容。'."\n" + .'- **abuse**：文字含辱骂内容。'."\n" + .'- **terrorism**：文字含暴恐内容。'."\n" + .'- **contraband**：文字含违禁内容。'."\n" + .'- **spam**：文字含其他垃圾内容。'."\n" + .'- **npx**：牛皮癣广告。'."\n" + .'- **qrcode**：含二维码。'."\n" + .'- **programCode**：含小程序码。', + 'type' => 'string', + 'example' => 'ad', + ], + ], + ], + ], + ], + ], + 'LogoResult' => [ + 'description' => 'Logo审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'block', + ], + 'AverageScore' => [ + 'description' => '命中Label的视频截图的平均分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Label' => [ + 'description' => 'Logo审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **TV**：含受管控的Logo。'."\n" + .'- **trademark**：含商标。', + 'type' => 'string', + 'example' => 'TV', + ], + 'MaxScore' => [ + 'description' => '命中Label的视频截图的最高分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'CounterList' => [ + 'description' => '审核结果各分类及其视频截图张数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => 'Logo审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **TV**：含受管控的Logo。'."\n" + .'- **trademark**：含商标。', + 'type' => 'string', + 'example' => 'TV', + ], + 'Count' => [ + 'description' => '视频截图张数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'TopList' => [ + 'description' => '命中Label下分数最高的视频截图信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '视频截图的地址。', + 'type' => 'string', + 'example' => 'http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg', + ], + 'Score' => [ + 'description' => '命中Label的视频截图的分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Timestamp' => [ + 'description' => '视频截图在视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '16', + ], + 'Label' => [ + 'description' => 'Logo审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **TV**：含受管控的Logo。'."\n" + .'- **trademark**：含商标。', + 'type' => 'string', + 'example' => 'TV', + ], + ], + ], + ], + ], + ], + 'LiveResult' => [ + 'description' => '不良内容审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '审核结果建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'block', + ], + 'AverageScore' => [ + 'description' => '命中Label的视频截图的平均分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Label' => [ + 'description' => '审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **meaningless**：图片中无内容（例如黑屏、白屏）。'."\n" + .'- **PIP**：画中画。'."\n" + .'- **smoking**：吸烟。'."\n" + .'- **drivelive**：车内直播。', + 'type' => 'string', + 'example' => 'smoking', + ], + 'MaxScore' => [ + 'description' => '命中Label的视频截图的最高分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'CounterList' => [ + 'description' => '包括不良审核结果的分类及其视频截图张数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => '审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **meaningless**：图片中无内容（例如黑屏、白屏）。'."\n" + .'- **PIP**：画中画。'."\n" + .'- **smoking**：吸烟。'."\n" + .'- **drivelive**：车内直播。', + 'type' => 'string', + 'example' => 'smoking', + ], + 'Count' => [ + 'description' => '视频截图张数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + 'TopList' => [ + 'description' => '命中Label下分数最高的视频截图信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '视频截图的地址。', + 'type' => 'string', + 'example' => 'http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg', + ], + 'Score' => [ + 'description' => '命中Label的视频截图的分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Timestamp' => [ + 'description' => '视频截图在视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '10', + ], + 'Label' => [ + 'description' => '审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **meaningless**：图片中无内容（例如黑屏、白屏）。'."\n" + .'- **PIP**：画中画。'."\n" + .'- **smoking**：吸烟。'."\n" + .'- **drivelive**：车内直播。', + 'type' => 'string', + 'example' => 'smoking', + ], + ], + ], + ], + ], + ], + 'TerrorismResult' => [ + 'description' => '暴恐涉政审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '暴恐涉政审核建议。取值：'."\n" + ."\n" + .'- **block**：违规。'."\n" + .'- **review**：疑似。'."\n" + .'- **pass**：通过。', + 'type' => 'string', + 'example' => 'pass', + ], + 'AverageScore' => [ + 'description' => '命中Label的视频截图的平均分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Label' => [ + 'description' => '暴恐涉政审核结果。取值：'."\n" + ."\n" + .'- **normal**：正常。'."\n" + .'- **bloody**：血腥。'."\n" + .'- **explosion**：爆炸烟光。'."\n" + .'- **outfit**：特殊装束。'."\n" + .'- **logo**：特殊标识。'."\n" + .'- **weapon**：武器。'."\n" + .'- **politics**：渉政。'."\n" + .'- **violence**：打斗。'."\n" + .'- **crowd**：聚众。'."\n" + .'- **parade**：游行。'."\n" + .'- **carcrash**：车祸现场。'."\n" + .'- **flag**：旗帜。'."\n" + .'- **location**：地标。'."\n" + .'- **others**：其它。', + 'type' => 'string', + 'example' => 'normal', + ], + 'MaxScore' => [ + 'description' => '命中Label的视频截图的最高分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'CounterList' => [ + 'description' => '包括暴恐涉政结果各分类及其视频截图张数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => '暴恐涉政审核结果。取值：'."\n" + ."\n" + .'- **normal**：正常。'."\n" + .'- **bloody**：血腥。'."\n" + .'- **explosion**：爆炸烟光。'."\n" + .'- **outfit**：特殊装束。'."\n" + .'- **logo**：特殊标识。'."\n" + .'- **weapon**：武器。'."\n" + .'- **politics**：渉政。'."\n" + .'- **violence**：打斗。'."\n" + .'- **crowd**：聚众。'."\n" + .'- **parade**：游行。'."\n" + .'- **carcrash**：车祸现场。'."\n" + .'- **flag**：旗帜。'."\n" + .'- **location**：地标。'."\n" + .'- **others**：其它。', + 'type' => 'string', + 'example' => 'outfit', + ], + 'Count' => [ + 'description' => '包括暴恐涉政结果的视频截图张数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'TopList' => [ + 'description' => '命中Label下分数最高的视频截图信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '视频截图的地址。', + 'type' => 'string', + 'example' => 'http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg', + ], + 'Score' => [ + 'description' => '命中Label的视频截图的分数。取值范围：`[0, 100`]，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100.000', + ], + 'Timestamp' => [ + 'description' => '视频截图在视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '3005', + ], + 'Label' => [ + 'description' => '暴恐涉政审核结果。取值：'."\n" + ."\n" + .'- **normal**：正常。'."\n" + .'- **bloody**：血腥。'."\n" + .'- **explosion**：爆炸烟光。'."\n" + .'- **outfit**：特殊装束。'."\n" + .'- **logo**：特殊标识。'."\n" + .'- **weapon**：武器。'."\n" + .'- **politics**：渉政。'."\n" + .'- **violence**：打斗。'."\n" + .'- **crowd**：聚众。'."\n" + .'- **parade**：游行。'."\n" + .'- **carcrash**：车祸现场。'."\n" + .'- **flag**：旗帜。'."\n" + .'- **location**：地标。'."\n" + .'- **others**：其它。', + 'type' => 'string', + 'example' => 'normal', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB7D7232-1AB2-40FE-B8D5-****\\",\\n \\"MediaAuditResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"AbnormalModules\\": \\"video\\",\\n \\"Label\\": \\"porn\\",\\n \\"AudioResult\\": [\\n {\\n \\"Score\\": \\"99.91\\",\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"antispam\\"\\n }\\n ],\\n \\"ImageResult\\": [\\n {\\n \\"Type\\": \\"cover\\",\\n \\"Url\\": \\"http://www.test.com/****.jpg\\",\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"porn\\",\\n \\"Result\\": [\\n {\\n \\"Score\\": \\"100.00000\\",\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"porn\\",\\n \\"Scene\\": \\"porn\\"\\n }\\n ]\\n }\\n ],\\n \\"TextResult\\": [\\n {\\n \\"Type\\": \\"title\\",\\n \\"Suggestion\\": \\"pass\\",\\n \\"Score\\": \\"100.00000\\",\\n \\"Label\\": \\"ad\\",\\n \\"Content\\": \\"热线电话123****\\",\\n \\"Scene\\": \\"antispam\\"\\n }\\n ],\\n \\"VideoResult\\": {\\n \\"Label\\": \\"porn\\",\\n \\"Suggestion\\": \\"pass\\",\\n \\"PornResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"AverageScore\\": \\"100\\",\\n \\"Label\\": \\"porn\\",\\n \\"MaxScore\\": \\"100\\",\\n \\"CounterList\\": [\\n {\\n \\"Label\\": \\"porn\\",\\n \\"Count\\": 1\\n }\\n ],\\n \\"TopList\\": [\\n {\\n \\"Url\\": \\"http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg\\",\\n \\"Score\\": \\"100.0000\\",\\n \\"Timestamp\\": \\"3005\\",\\n \\"Label\\": \\"porn\\"\\n }\\n ]\\n },\\n \\"AdResult\\": {\\n \\"Suggestion\\": \\"block\\",\\n \\"AverageScore\\": \\"100\\",\\n \\"Label\\": \\"ad\\",\\n \\"MaxScore\\": \\"100\\",\\n \\"CounterList\\": [\\n {\\n \\"Label\\": \\"ad\\",\\n \\"Count\\": 12\\n }\\n ],\\n \\"TopList\\": [\\n {\\n \\"Url\\": \\"http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg\\",\\n \\"Score\\": \\"100\\",\\n \\"Timestamp\\": \\"10\\",\\n \\"Label\\": \\"ad\\"\\n }\\n ]\\n },\\n \\"LogoResult\\": {\\n \\"Suggestion\\": \\"block\\",\\n \\"AverageScore\\": \\"100\\",\\n \\"Label\\": \\"TV\\",\\n \\"MaxScore\\": \\"100\\",\\n \\"CounterList\\": [\\n {\\n \\"Label\\": \\"TV\\",\\n \\"Count\\": 1\\n }\\n ],\\n \\"TopList\\": [\\n {\\n \\"Url\\": \\"http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg\\",\\n \\"Score\\": \\"100\\",\\n \\"Timestamp\\": \\"16\\",\\n \\"Label\\": \\"TV\\"\\n }\\n ]\\n },\\n \\"LiveResult\\": {\\n \\"Suggestion\\": \\"block\\",\\n \\"AverageScore\\": \\"100\\",\\n \\"Label\\": \\"smoking\\",\\n \\"MaxScore\\": \\"100\\",\\n \\"CounterList\\": [\\n {\\n \\"Label\\": \\"smoking\\",\\n \\"Count\\": 2\\n }\\n ],\\n \\"TopList\\": [\\n {\\n \\"Url\\": \\"http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg\\",\\n \\"Score\\": \\"100\\",\\n \\"Timestamp\\": \\"10\\",\\n \\"Label\\": \\"smoking\\"\\n }\\n ]\\n },\\n \\"TerrorismResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"AverageScore\\": \\"100\\",\\n \\"Label\\": \\"normal\\",\\n \\"MaxScore\\": \\"100\\",\\n \\"CounterList\\": [\\n {\\n \\"Label\\": \\"outfit\\",\\n \\"Count\\": 1\\n }\\n ],\\n \\"TopList\\": [\\n {\\n \\"Url\\": \\"http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg\\",\\n \\"Score\\": \\"100.000\\",\\n \\"Timestamp\\": \\"3005\\",\\n \\"Label\\": \\"normal\\"\\n }\\n ]\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取智能审核结果摘要', + 'description' => '<props="intl">'."\n" + .'### 使用说明'."\n" + .'本接口仅支持新加坡地域。</props>'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetMediaAuditResultDetail' => [ + 'summary' => '调用本接口获取智能审核结果详情。通过此接口可实时查询审核结果详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39960', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '93ab850b4f6f*****54b6e91d24d81d4', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '视频内容审核结果页码。默认值为**1**，每页最多返回**20**条记录。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6438BD76-D523-46FC-956F-****', + ], + 'MediaAuditResultDetail' => [ + 'description' => '审核结果详情。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '视频审核结果截图总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'List' => [ + 'description' => '视频审核结果详情列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TerrorismScore' => [ + 'description' => '暴恐涉政审核结果的视频截图的命中分数。取值为：`[0-100]`，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100.00', + ], + 'AdLabel' => [ + 'description' => '广告审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **ad**：其他广告。'."\n" + .'- **politics**：文字含涉政内容。'."\n" + .'- **porn**：文字含涉黄内容。'."\n" + .'- **abuse**：文字含辱骂内容。'."\n" + .'- **terrorism**：文字含暴恐内容。'."\n" + .'- **contraband**：文字含违禁内容。'."\n" + .'- **spam**：文字含其他垃圾内容。'."\n" + .'- **npx**：牛皮癣广告。'."\n" + .'- **qrcode**：含二维码。'."\n" + .'- **programCode**：含小程序码。', + 'type' => 'string', + 'example' => 'normal', + ], + 'PornLabel' => [ + 'description' => '鉴黄审核结果分类。取值：'."\n" + ."\n" + .'- **normal**：普通。'."\n" + .'- **porn**：色情。'."\n" + .'- **sexy**：性感。', + 'type' => 'string', + 'example' => 'normal', + ], + 'PornScore' => [ + 'description' => '鉴黄审核结果的视频截图的命中分数。取值为：`[0-100]`，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100.00', + ], + 'LiveLabel' => [ + 'description' => '不良场景审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **meaningless**：图片中无内容（例如黑屏、白屏）。'."\n" + .'- **PIP**：画中画。'."\n" + .'- **smoking**：吸烟。'."\n" + .'- **drivelive**：车内直播。', + 'type' => 'string', + 'example' => 'normal', + ], + 'Url' => [ + 'description' => '视频截图的地址。', + 'type' => 'string', + 'example' => 'http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg', + ], + 'Timestamp' => [ + 'description' => '视频截图在视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '3005', + ], + 'AdScore' => [ + 'description' => '广告审核结果的视频截图的命中分数。取值为：`[0-100]`，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'LiveScore' => [ + 'description' => '不良场景审核结果的视频截图的命中分数。取值为：`[0-100]`，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'LogoScore' => [ + 'description' => 'Logo审核结果的视频截图的命中分数。取值为：`[0-100]`，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'LogoLabel' => [ + 'description' => 'Logo审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **TV**：含受管控的Logo。'."\n" + .'- **trademark**：含商标。', + 'type' => 'string', + 'example' => 'normal', + ], + 'TerrorismLabel' => [ + 'description' => '暴恐涉政审核结果。取值范围：'."\n" + ."\n" + .'- **normal**：正常。'."\n" + .'- **bloody**：血腥。'."\n" + .'- **explosion**：爆炸烟光。'."\n" + .'- **outfit**：特殊装束。'."\n" + .'- **logo**：特殊标识。'."\n" + .'- **weapon**：武器。'."\n" + .'- **politics**：渉政。'."\n" + .'- **violence**：打斗。'."\n" + .'- **crowd**：聚众。'."\n" + .'- **parade**：游行。'."\n" + .'- **carcrash**：车祸现场。'."\n" + .'- **flag**：旗帜。'."\n" + .'- **location**：地标。'."\n" + .'- **others**：其它。', + 'type' => 'string', + 'example' => 'normal', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6438BD76-D523-46FC-956F-****\\",\\n \\"MediaAuditResultDetail\\": {\\n \\"Total\\": 2,\\n \\"List\\": [\\n {\\n \\"TerrorismScore\\": \\"100.00\\",\\n \\"AdLabel\\": \\"normal\\",\\n \\"PornLabel\\": \\"normal\\",\\n \\"PornScore\\": \\"100.00\\",\\n \\"LiveLabel\\": \\"normal\\",\\n \\"Url\\": \\"http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg\\",\\n \\"Timestamp\\": \\"3005\\",\\n \\"AdScore\\": \\"100\\",\\n \\"LiveScore\\": \\"100\\",\\n \\"LogoScore\\": \\"100\\",\\n \\"LogoLabel\\": \\"normal\\",\\n \\"TerrorismLabel\\": \\"normal\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMediaAuditResultDetailResponse>\\n<RequestId>6438BD76-D523-46FC-956F-****</RequestId>\\n<MediaAuditResultDetail>\\n <Total>2</Total>\\n <List>\\n <LogoLabel>normal</LogoLabel>\\n <LiveScore>100</LiveScore>\\n <PornLabel>normal</PornLabel>\\n <TerrorismLabel>normal</TerrorismLabel>\\n <TerrorismScore>100.00</TerrorismScore>\\n <AdScore>100</AdScore>\\n <PornScore>100.00</PornScore>\\n <AdLabel>normal</AdLabel>\\n <LogoScore>100</LogoScore>\\n <LiveLabel>normal</LiveLabel>\\n <Timestamp>3005</Timestamp>\\n <Url>http://temp-testbucket.oss-cn-shanghai.aliyuncs.com/aivideocensor/****.jpg</Url>\\n </List>\\n</MediaAuditResultDetail>\\n</GetMediaAuditResultDetailResponse>","errorExample":""}]', + 'title' => '获取智能审核结果详情', + 'description' => '- 默认只返回违规、疑似违规的审核截图详情。不违规的视频与图片，查询不到结果。'."\n" + .'- 审核结果的图片资源仅在点播提供的免费存储上保留2周，超过2周将自动删除。'."\n" + ."\n" + .'<props="intl">'."\n" + .'- 本接口仅支持新加坡地域。</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetMediaAuditResultTimeline' => [ + 'summary' => '调用本接口获取到所有违规内容截图的时间点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39961', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '93ab850b4f6f*****54b6e91d24d81d4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6438BD76-D523-46FC-956F-****', + ], + 'MediaAuditResultTimeline' => [ + 'description' => '审核结果时间线的集合。', + 'type' => 'object', + 'properties' => [ + 'Porn' => [ + 'description' => '鉴黄时间线集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '鉴黄审核结果的视频截图的命中分数。取值为：`[0-100]`，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100.00', + ], + 'Timestamp' => [ + 'description' => '视频截图在视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '3005', + ], + 'Label' => [ + 'description' => '鉴黄审核结果分类，取值：'."\n" + ."\n" + .'- **porn**：色情。'."\n" + .'- **sexy**：性感。'."\n" + .'- **normal**：普通。', + 'type' => 'string', + 'example' => 'porn', + ], + ], + ], + ], + 'Terrorism' => [ + 'description' => '暴恐时间线集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '暴恐涉政审核结果的视频截图的命中分数。取值为：`[0-100]`，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100.00', + ], + 'Timestamp' => [ + 'description' => '视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '3005', + ], + 'Label' => [ + 'description' => '暴恐涉政审核结果。取值范围：'."\n" + ."\n" + .'- **normal**：正常。'."\n" + .'- **bloody**：血腥。'."\n" + .'- **explosion**：爆炸烟光。'."\n" + .'- **outfit**：特殊装束。'."\n" + .'- **logo**：特殊标识。'."\n" + .'- **weapon**：武器。'."\n" + .'- **politics**：渉政。'."\n" + .'- **violence**：打斗。'."\n" + .'- **crowd**：聚众。'."\n" + .'- **parade**：游行。'."\n" + .'- **carcrash**：车祸现场。'."\n" + .'- **flag**：旗帜。'."\n" + .'- **location**：地标。'."\n" + .'- **others**：其它。', + 'type' => 'string', + 'example' => 'normal', + ], + ], + ], + ], + 'Logo' => [ + 'description' => 'logo时间线集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => 'Logo审核结果的视频截图的命中分数。取值为：`[0-100]`，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Timestamp' => [ + 'description' => '视频截图在视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '13', + ], + 'Label' => [ + 'description' => 'Logo审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **TV**：含受管控的Logo。'."\n" + .'- **trademark**：含商标。', + 'type' => 'string', + 'example' => 'normal', + ], + ], + ], + ], + 'Live' => [ + 'description' => '不良场景时间线集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '不良内容审核结果的视频截图的命中分数。取值为：`[0-100]`，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Timestamp' => [ + 'description' => '视频截图在视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '12', + ], + 'Label' => [ + 'description' => '不良内容审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **meaningless**：图片中无内容（例如黑屏、白屏）。'."\n" + .'- **PIP**：画中画。'."\n" + .'- **smoking**：吸烟。'."\n" + .'- **drivelive**：车内直播。', + 'type' => 'string', + 'example' => 'smoking', + ], + ], + ], + ], + 'Ad' => [ + 'description' => '广告时间线集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '广告审核结果的视频截图的命中分数。取值为：`[0-100]`，精度小数点后10位。命中结果为对应分类Label的概率，值越高则命中准确性越高。', + 'type' => 'string', + 'example' => '100', + ], + 'Timestamp' => [ + 'description' => '视频截图在视频中的位置。单位：毫秒。', + 'type' => 'string', + 'example' => '10', + ], + 'Label' => [ + 'description' => '广告审核结果分类。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **ad**：其他广告。'."\n" + .'- **politics**：文字含涉政内容。'."\n" + .'- **porn**：文字含涉黄内容。'."\n" + .'- **abuse**：文字含辱骂内容。'."\n" + .'- **terrorism**：文字含暴恐内容。'."\n" + .'- **contraband**：文字含违禁内容。'."\n" + .'- **spam**：文字含其他垃圾内容。'."\n" + .'- **npx**：牛皮癣广告。'."\n" + .'- **qrcode**：含二维码。'."\n" + .'- **programCode**：含小程序码。', + 'type' => 'string', + 'example' => 'ad', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6438BD76-D523-46FC-956F-****\\",\\n \\"MediaAuditResultTimeline\\": {\\n \\"Porn\\": [\\n {\\n \\"Score\\": \\"100.00\\",\\n \\"Timestamp\\": \\"3005\\",\\n \\"Label\\": \\"porn\\"\\n }\\n ],\\n \\"Terrorism\\": [\\n {\\n \\"Score\\": \\"100.00\\",\\n \\"Timestamp\\": \\"3005\\",\\n \\"Label\\": \\"normal\\"\\n }\\n ],\\n \\"Logo\\": [\\n {\\n \\"Score\\": \\"100\\",\\n \\"Timestamp\\": \\"13\\",\\n \\"Label\\": \\"normal\\"\\n }\\n ],\\n \\"Live\\": [\\n {\\n \\"Score\\": \\"100\\",\\n \\"Timestamp\\": \\"12\\",\\n \\"Label\\": \\"smoking\\"\\n }\\n ],\\n \\"Ad\\": [\\n {\\n \\"Score\\": \\"100\\",\\n \\"Timestamp\\": \\"10\\",\\n \\"Label\\": \\"ad\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMediaAuditResultTimelineResponse>\\n<RequestId>6438BD76-D523-46FC-956F-****</RequestId>\\n<MediaAuditResultTimeline>\\n <Ad>\\n <Score>100</Score>\\n <Label>porn</Label>\\n <Timestamp>3005</Timestamp>\\n </Ad>\\n <Ad>\\n <Score>100</Score>\\n <Label>normal</Label>\\n <Timestamp>3005</Timestamp>\\n </Ad>\\n <Ad>\\n <Score>100</Score>\\n <Label>logo</Label>\\n <Timestamp>13</Timestamp>\\n </Ad>\\n <Ad>\\n <Score>100</Score>\\n <Label>pip</Label>\\n <Timestamp>12</Timestamp>\\n </Ad>\\n <Ad>\\n <Score>100</Score>\\n <Label>ad</Label>\\n <Timestamp>10</Timestamp>\\n </Ad>\\n <Terrorism>\\n <Score>100</Score>\\n <Label>porn</Label>\\n <Timestamp>3005</Timestamp>\\n </Terrorism>\\n <Terrorism>\\n <Score>100</Score>\\n <Label>normal</Label>\\n <Timestamp>3005</Timestamp>\\n </Terrorism>\\n <Terrorism>\\n <Score>100</Score>\\n <Label>logo</Label>\\n <Timestamp>13</Timestamp>\\n </Terrorism>\\n <Terrorism>\\n <Score>100</Score>\\n <Label>pip</Label>\\n <Timestamp>12</Timestamp>\\n </Terrorism>\\n <Terrorism>\\n <Score>100</Score>\\n <Label>ad</Label>\\n <Timestamp>10</Timestamp>\\n </Terrorism>\\n <Live>\\n <Score>100</Score>\\n <Label>porn</Label>\\n <Timestamp>3005</Timestamp>\\n </Live>\\n <Live>\\n <Score>100</Score>\\n <Label>normal</Label>\\n <Timestamp>3005</Timestamp>\\n </Live>\\n <Live>\\n <Score>100</Score>\\n <Label>logo</Label>\\n <Timestamp>13</Timestamp>\\n </Live>\\n <Live>\\n <Score>100</Score>\\n <Label>pip</Label>\\n <Timestamp>12</Timestamp>\\n </Live>\\n <Live>\\n <Score>100</Score>\\n <Label>ad</Label>\\n <Timestamp>10</Timestamp>\\n </Live>\\n <Porn>\\n <Score>100</Score>\\n <Label>porn</Label>\\n <Timestamp>3005</Timestamp>\\n </Porn>\\n <Porn>\\n <Score>100</Score>\\n <Label>normal</Label>\\n <Timestamp>3005</Timestamp>\\n </Porn>\\n <Porn>\\n <Score>100</Score>\\n <Label>logo</Label>\\n <Timestamp>13</Timestamp>\\n </Porn>\\n <Porn>\\n <Score>100</Score>\\n <Label>pip</Label>\\n <Timestamp>12</Timestamp>\\n </Porn>\\n <Porn>\\n <Score>100</Score>\\n <Label>ad</Label>\\n <Timestamp>10</Timestamp>\\n </Porn>\\n <Logo>\\n <Score>100</Score>\\n <Label>porn</Label>\\n <Timestamp>3005</Timestamp>\\n </Logo>\\n <Logo>\\n <Score>100</Score>\\n <Label>normal</Label>\\n <Timestamp>3005</Timestamp>\\n </Logo>\\n <Logo>\\n <Score>100</Score>\\n <Label>logo</Label>\\n <Timestamp>13</Timestamp>\\n </Logo>\\n <Logo>\\n <Score>100</Score>\\n <Label>pip</Label>\\n <Timestamp>12</Timestamp>\\n </Logo>\\n <Logo>\\n <Score>100</Score>\\n <Label>ad</Label>\\n <Timestamp>10</Timestamp>\\n </Logo>\\n</MediaAuditResultTimeline>\\n</GetMediaAuditResultTimelineResponse>","errorExample":""}]', + 'title' => '获取智能审核结果时间线', + 'description' => '> 默认只返回违规、疑似违规的审核截图详情。不违规的视频与图片，查询不到结果。'."\n" + ."\n" + .'<props="intl">'."\n" + .'本接口仅支持新加坡地域。</props>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetMediaAuditAudioResultDetail' => [ + 'summary' => '调用本接口获取音频审核详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39958', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '音频ID。可通过点播控制台查询音频ID或通过[SearchMedia](~~86044~~)接口请求后会返回音频ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '93ab850b4f6f*****54b6e91d24d81d4', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页号。可选填，不填则返回所有结果不分页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CB7D7232-1AB2-40FE-B8D3-****', + ], + 'MediaAuditAudioResultDetail' => [ + 'description' => '审核结果。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageTotal' => [ + 'description' => '当前页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'List' => [ + 'description' => '结果列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '问题音频结束时间点，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'StartTime' => [ + 'description' => '问题音频开始时间点。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'Text' => [ + 'description' => '音频对应文本内容。', + 'type' => 'string', + 'example' => '天安门', + ], + 'Label' => [ + 'description' => '音频审核结果分类，取值：'."\n" + ."\n" + .'- **normal**：正常。'."\n" + .'- **spam**：含垃圾信息。'."\n" + .'- **ad**：广告。'."\n" + .'- **politics**：涉政。'."\n" + .'- **terrorism**：暴恐。'."\n" + .'- **abuse**：辱骂。'."\n" + .'- **porn**：色情。'."\n" + .'- **flood**：灌水。'."\n" + .'- **contraband**：违禁。'."\n" + .'- **meaningless**：无意义。', + 'type' => 'string', + 'example' => 'abuse', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CB7D7232-1AB2-40FE-B8D3-****\\",\\n \\"MediaAuditAudioResultDetail\\": {\\n \\"Total\\": 10,\\n \\"PageTotal\\": 1,\\n \\"List\\": [\\n {\\n \\"EndTime\\": 10,\\n \\"StartTime\\": 8,\\n \\"Text\\": \\"天安门\\",\\n \\"Label\\": \\"abuse\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMediaAuditAudioResultDetailResponse>\\n <RequestId>CB7D7232-1AB2-40FE-B8D3-****</RequestId>\\n <MediaAuditAudioResultDetail>\\n <Total>10</Total>\\n <PageTotal>1</PageTotal>\\n <List>\\n <EndTime>10</EndTime>\\n <StartTime>8</StartTime>\\n <Text>天安门</Text>\\n <Label>abuse</Label>\\n </List>\\n </MediaAuditAudioResultDetail>\\n</GetMediaAuditAudioResultDetailResponse>","errorExample":""}]', + 'title' => '获取智能音频审核结果详情', + 'description' => '### 使用说明'."\n" + .'<props="china">智能审核处理完成后，配置了[智能审核完成](~~89576~~)的事件通知，则会通过消息回调方式通知回调URL，可调用本接口查询音频审核结果详情。</props>'."\n" + ."\n" + .'<props="intl">'."\n" + .'- 本接口仅支持新加坡地域。'."\n" + .'- 智能审核处理完成后，配置了[智能审核完成](~~89576~~)的事件通知，则会通过消息回调方式通知回调URL，可调用本接口查询音频审核结果详情。</props>', + ], + 'CreateAudit' => [ + 'summary' => '调用本接口进行人工审核，可用于审核视频、音频等媒体信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39808', + 'abilityTreeNodes' => [ + 'FEATUREvodL077M7', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AuditContent', + 'in' => 'query', + 'schema' => [ + 'description' => '审核内容数组。'."\n" + .'一次最多支持**100**个音/视频的审核内容。需将数组转为字符串后作为参数值。 '."\n" + .'具体参数结构定义，参见下表**AuditContent**。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"VideoId":"93ab850b4f*****b54b6e91d24d81d4","Status":"Normal"},{"VideoId":"f867fbfb58*****8bbab65c4480ae1d","Status":"Blocked","Reason":"色情视频","Comment":"有露点镜"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAuditResponse>\\r\\n <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>\\r\\n</CreateAuditResponse>","errorExample":""}]', + 'title' => '人工审核', + 'requestParamsDescription' => '## 审核内容AuditContent'."\n" + ."\n" + .'|名称 |类型 |必填项 |描述|'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'|VideoId |String |是 |音/视频ID。|'."\n" + .'|Status |String |是 |音/视频审核状态。取值范围：**Blocked**（屏蔽），**Normal**（正常）。|'."\n" + .'|Reason |String |否 |若审核状态为屏蔽时，需给出屏蔽的理由。最长支持128字节。|'."\n" + .'|Comment|String |否 |审核备注。最长支持512字节。|', + 'responseParamsDescription' => ' ', + ], + 'GetAuditHistory' => [ + 'summary' => '调用本接口获取人工审核的历史记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39940', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'required' => true, + 'example' => '93ab850b4f6f44*****6e91d24d81d4', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页号。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为**10**，最大值为**100**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '结果排序。取值范围：'."\n" + ."\n" + .'- **CreationTime:Desc**（默认值）：按创建时间倒序。'."\n" + .'- **CreationTime:Asc**：按创建时间升序。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreationTime:Desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '本次审核结果。表示当前人工审核的结果，取值范围：'."\n" + .'- **Normal**：正常。'."\n" + .'- **Blocked**：屏蔽。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-43*****D7-6C044FE73368', + ], + 'Total' => [ + 'description' => '审核历史记录总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Histories' => [ + 'description' => '审核历史记录列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '本次审核结果。取值范围：'."\n" + .'- **Normal**（正常）'."\n" + .'- **Blocked**（屏蔽）', + 'type' => 'string', + 'example' => 'Blocked', + ], + 'CreationTime' => [ + 'description' => '记录创建的时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'Comment' => [ + 'description' => '审核详情，审核员给出的具体评价。', + 'type' => 'string', + 'example' => '有露点镜头', + ], + 'Reason' => [ + 'description' => '审核不通过理由。若审核结果为不通过，需给出不通过的理由。', + 'type' => 'string', + 'example' => '色情视频', + ], + 'Auditor' => [ + 'description' => '审核员。', + 'type' => 'string', + 'example' => 'auditor', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Normal\\",\\n \\"RequestId\\": \\"04F0F334-1335-43*****D7-6C044FE73368\\",\\n \\"Total\\": 2,\\n \\"Histories\\": [\\n {\\n \\"Status\\": \\"Blocked\\",\\n \\"CreationTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"Comment\\": \\"有露点镜头\\",\\n \\"Reason\\": \\"色情视频\\",\\n \\"Auditor\\": \\"auditor\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetAuditHistoryResponse>\\r\\n <RequestId>04F0F334-1335-43*****D7-6C044FE73368</RequestId>\\r\\n\\t<Status>Blocked</Status>\\r\\n\\t<Total>2</Total>\\r\\n\\t<Histories>\\r\\n\\t\\t<CreationTime>2017-12-18T07:39:00Z</CreationTime>\\r\\n\\t\\t<Status>Blocked</Status>\\r\\n\\t\\t<Reason>色情视频</Reason>\\r\\n\\t\\t<Comment>有露点镜头</Comment>\\r\\n\\t</Histories>\\r\\n\\t<Histories>\\r\\n\\t\\t<CreationTime>2017-12-18T07:30:00Z</CreationTime>\\r\\n\\t\\t<Status>Normal</Status>\\r\\n\\t\\t<Reason></Reason>\\r\\n\\t\\t<Comment></Comment>\\r\\n\\t</Histories>\\r\\n</GetAuditHistoryResponse>","errorExample":""}]', + 'title' => '获取人工审核历史', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'AddAITemplate' => [ + 'summary' => '调用本接口添加智能审核和智能封面任务需要使用的AI模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39782', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI模板名称。最大128字节。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'AI-media-test', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI模板类型。取值：'."\n" + .'- **AIMediaAudit**：智能审核。'."\n" + .'- **AIImage**：智能封面。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'AIMediaAudit', + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI模板详细配置，JSON字符串。'."\n" + .'具体配置，请参见[AITemplateConfig](~~89863#title-vd3-499-o36~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"AuditItem":["terrorism","porn"],"AuditRange":["image-cover","text-title","video"],"AuditContent":["screen"],"AuditAutoBlock":"yes"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => 'AI模板ID。', + 'type' => 'string', + 'example' => '1706a0063dd733f6a823ef32e0a5****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TemplateId\\": \\"1706a0063dd733f6a823ef32e0a5****\\",\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddAITemplateResponse>\\n <TemplateId>1706a0063dd733f6a823ef32e0a5****</TemplateId>\\n <RequestId>25818875-5F78-4A13-BEF6-****</RequestId>\\n</AddAITemplateResponse>","errorExample":""}]', + 'title' => '添加AI模板', + 'description' => '- 目前本接口支持的服务地域：**华北2（北京）**、**华东2（上海）**、**新加坡**。'."\n" + .'- 添加智能审核和智能封面任务需要使用的AI模板前，请确保已开通[智能审核](https://ai.aliyun.com/vi/censor)或[智能封面](https://ai.aliyun.com/vi/cover)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DeleteAITemplate' => [ + 'summary' => '调用本接口删除AI模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39823', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI模板ID。可通过以下方式获取：'."\n" + .'- 调用[AddAITemplate](~~102930~~)接口添加AI模板时，AI模板ID为返回参数TemplateId的值。'."\n" + .'- AI模板添加后，可调用[ListAITemplate](~~102936~~)接口查询AI模板ID，为请求后返回参数TemplateId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1706a0063dd733f6a823ef32e0a5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => 'AI模板ID。', + 'type' => 'string', + 'example' => '1706a0063dd733f6a823ef32e0a5****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TemplateId\\": \\"1706a0063dd733f6a823ef32e0a5****\\",\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAITemplateResponse>\\n <TemplateId>1706a0063dd733f6a823ef32e0a5****</TemplateId>\\n <RequestId>25818875-5F78-4A13-BEF6-****</RequestId>\\n</DeleteAITemplateResponse>","errorExample":""}]', + 'title' => '删除AI模板', + 'description' => '- 目前本接口支持的服务地域：**华北2（北京）**、**华东2（上海）**、**新加坡**。'."\n" + .'- 已设置为默认的AI模板不能删除。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'UpdateAITemplate' => [ + 'summary' => '调用本接口修改AI模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40205', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI模板ID。可通过以下方式获取：'."\n" + .'- 调用[AddAITemplate](~~102930~~)接口添加AI模板时，AI模板ID为返回参数TemplateId的值。'."\n" + .'- AI模板添加后，可调用[ListAITemplate](~~102936~~)接口查询AI模板ID，为请求后返回参数TemplateId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1706a0063dd733f6a823ef32e0a5****', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI模板名称。最大128字节。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DemoAITemplate', + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI模板详细配置，JSON字符串。具体配置，请参见[AITemplateConfig](~~89863#title-vd3-499-o36~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"AuditItem":["terrorism","porn"],"AuditRange":["text-title","video"],"AuditContent":["screen"],"AuditAutoBlock":"yes"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '1706a0063dd733f6a823ef32e0a5****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TemplateId\\": \\"1706a0063dd733f6a823ef32e0a5****\\",\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAITemplateResponse>\\n <TemplateId>1706a0063dd733f6a823ef32e0a5****</TemplateId>\\n <RequestId>25818875-5F78-4A13-BEF6-****</RequestId>\\n</UpdateAITemplateResponse>","errorExample":""}]', + 'title' => '修改AI模板', + 'description' => '- 目前本接口支持的服务地域：**华北2（北京）**、**华东2（上海）**、**新加坡**。'."\n" + .'- 调用[AddAITemplate](~~102930~~)接口添加AI模板后，可通过本接口修改AI模板。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'SetDefaultAITemplate' => [ + 'summary' => '调用本接口设置默认AI模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40130', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI模板ID。可通过以下方式获取：'."\n" + .'- 调用[AddAITemplate](~~102930~~)接口添加AI模板时，AI模板ID为返回参数TemplateId的值。'."\n" + .'- AI模板添加后，可调用[ListAITemplate](~~102936~~)接口查询AI模板ID，为请求后返回参数TemplateId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1706a0063dd733f6a823ef32e0a5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => 'AI模板ID。', + 'type' => 'string', + 'example' => '1706a0063dd733f6a823ef32e0a5****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8E70E3F8-E2EE-47BC-4677-379D6F28****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TemplateId\\": \\"1706a0063dd733f6a823ef32e0a5****\\",\\n \\"RequestId\\": \\"8E70E3F8-E2EE-47BC-4677-379D6F28****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetDefaultAITemplateResponse>\\n <TemplateId>1706a0063dd733f6a823ef32e0a5****</TemplateId>\\n <RequestId>8E70E3F8-E2EE-47BC-4677-379D6F28****</RequestId>\\n</SetDefaultAITemplateResponse>","errorExample":""}]', + 'title' => '设置默认AI模板', + 'description' => '- 目前本接口支持的服务地域：**华北2（北京）**、**华东2（上海）**、**新加坡**。'."\n" + .'- 先获取AI模板ID，再调用本接口设置为默认AI模板。已设置为默认的AI模板不能删除。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetAITemplate' => [ + 'summary' => '调用本接口查询AI模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39935', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI模板ID。可通过以下方式获取：'."\n" + .'- 调用[AddAITemplate](~~102930~~)接口添加AI模板时，AI模板ID为返回参数TemplateId的值。'."\n" + .'- AI模板添加后，可调用[ListAITemplate](~~102936~~)接口查询AI模板ID，为请求后返回参数TemplateId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1706a0063dd733f6a823ef32e0a5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '080DA371-8AC0-4CD4-4476-33E64282****', + ], + 'TemplateInfo' => [ + 'description' => 'AI模板信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'AI模板的创建时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z。'."\n", + 'type' => 'string', + 'example' => '2020-07-08T06:50:45Z', + ], + 'IsDefault' => [ + 'description' => '是否为默认AI模板。取值：'."\n" + .'- **Default**：是。'."\n" + .'- **NotDefault**：否。', + 'type' => 'string', + 'example' => 'NotDefault', + ], + 'TemplateType' => [ + 'description' => 'AI模板类型。取值：'."\n" + ."\n" + .'- **AIMediaAudit**：智能审核。'."\n" + .'- **AIImage**：智能封面。', + 'type' => 'string', + 'example' => 'AIMediaAudit', + ], + 'TemplateConfig' => [ + 'description' => 'AI模板详细配置，JSON字符串。具体配置，请参见[AITemplateConfig](~~89863#title-vd3-499-o36~~)。', + 'type' => 'string', + 'example' => '{"AuditRange":["text-title","video"],"AuditContent":["screen"],"AuditItem":["terrorism","porn"],"AuditAutoBlock":"yes"}', + ], + 'TemplateName' => [ + 'description' => 'AI模板名称。', + 'type' => 'string', + 'example' => 'DemoAITemplate', + ], + 'Source' => [ + 'description' => 'AI模板来源。取值：'."\n" + .'- **System**：系统。'."\n" + .'- **Custom**：自定义。', + 'type' => 'string', + 'example' => 'Custom', + ], + 'TemplateId' => [ + 'description' => 'AI模板ID。', + 'type' => 'string', + 'example' => '1706a0063dd733f6a823ef32e0a5****', + ], + 'ModifyTime' => [ + 'description' => 'AI模板修改时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z。'."\n", + 'type' => 'string', + 'example' => '2020-07-08T06:58:45Z', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"080DA371-8AC0-4CD4-4476-33E64282****\\",\\n \\"TemplateInfo\\": {\\n \\"CreationTime\\": \\"2020-07-08T06:50:45Z\\",\\n \\"IsDefault\\": \\"NotDefault\\",\\n \\"TemplateType\\": \\"AIMediaAudit\\",\\n \\"TemplateConfig\\": \\"{\\\\\\"AuditRange\\\\\\":[\\\\\\"text-title\\\\\\",\\\\\\"video\\\\\\"],\\\\\\"AuditContent\\\\\\":[\\\\\\"screen\\\\\\"],\\\\\\"AuditItem\\\\\\":[\\\\\\"terrorism\\\\\\",\\\\\\"porn\\\\\\"],\\\\\\"AuditAutoBlock\\\\\\":\\\\\\"yes\\\\\\"}\\",\\n \\"TemplateName\\": \\"DemoAITemplate\\",\\n \\"Source\\": \\"Custom\\",\\n \\"TemplateId\\": \\"1706a0063dd733f6a823ef32e0a5****\\",\\n \\"ModifyTime\\": \\"2020-07-08T06:58:45Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAITemplateResponse>\\n <RequestId>080DA371-8AC0-4CD4-4476-33E64282****</RequestId>\\n <TemplateInfo>\\n <CreationTime>2020-07-08T06:50:45Z</CreationTime>\\n <IsDefault>NotDefault</IsDefault>\\n <TemplateType>AIMediaAudit</TemplateType>\\n <TemplateConfig>{\\"AuditRange\\":[\\"text-title\\",\\"video\\"],\\"AuditContent\\":[\\"screen\\"],\\"AuditItem\\":[\\"terrorism\\",\\"porn\\"],\\"AuditAutoBlock\\":\\"yes\\"}</TemplateConfig>\\n <TemplateName>DemoAITemplate</TemplateName>\\n <Source>Custom</Source>\\n <TemplateId>1706a0063dd733f6a823ef32e0a5****</TemplateId>\\n <ModifyTime>2020-07-08T06:58:45Z</ModifyTime>\\n </TemplateInfo>\\n</GetAITemplateResponse>","errorExample":""}]', + 'title' => '查询AI模板', + 'description' => '- 目前本接口支持的服务地域：**华北2（北京）**、**华东2（上海）**、**新加坡**。'."\n" + .'- 先获取AI模板ID，再调用本接口查询AI模板的配置信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ListAITemplate' => [ + 'summary' => '调用本接口查询AI模板列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40026', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI模板类型。取值：'."\n" + .'- **AIMediaAudit**：智能审核。'."\n" + .'- **AIImage**：智能封面。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'AIMediaAudit', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '75B7BC67-FB8C-4653-4788-F4B01ED2****', + ], + 'TemplateInfoList' => [ + 'description' => 'AI模板信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'AI模板详情。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'AI模板创建时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z。', + 'type' => 'string', + 'example' => '2020-07-08T06:50:45Z', + ], + 'IsDefault' => [ + 'description' => '是否为默认AI模板。取值：'."\n" + .'- **Default**：是。'."\n" + .'- **NotDefault**：否。', + 'type' => 'string', + 'example' => 'NoDefault', + ], + 'TemplateType' => [ + 'description' => 'AI模板类型。取值：'."\n" + .'- **AIMediaAudit**：智能审核。'."\n" + .'- **AIImage**：智能封面。', + 'type' => 'string', + 'example' => 'AIMediaAudit', + ], + 'TemplateConfig' => [ + 'description' => 'AI模板详细配置，JSON字符串。具体配置，请参见[AITemplateConfig](~~89863#title-vd3-499-o36~~)。', + 'type' => 'string', + 'example' => '{"AuditRange":["text-title","video"],"AuditContent":["screen"],"AuditItem":["terrorism","porn"],"AuditAutoBlock":"yes"}', + ], + 'TemplateName' => [ + 'description' => 'AI模板名称。', + 'type' => 'string', + 'example' => 'DemoAITemplate', + ], + 'Source' => [ + 'description' => 'AI模板来源。取值：'."\n" + .'- **System**：系统。'."\n" + .'- **Custom**：自定义。', + 'type' => 'string', + 'example' => 'Custom', + ], + 'TemplateId' => [ + 'description' => 'AI模板ID。', + 'type' => 'string', + 'example' => '1706a0063dd733f6a823ef32e0a5****', + ], + 'ModifyTime' => [ + 'description' => 'AI模板修改时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z。', + 'type' => 'string', + 'example' => '2020-07-08T06:58:45Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"75B7BC67-FB8C-4653-4788-F4B01ED2****\\",\\n \\"TemplateInfoList\\": [\\n {\\n \\"CreationTime\\": \\"2020-07-08T06:50:45Z\\",\\n \\"IsDefault\\": \\"NoDefault\\",\\n \\"TemplateType\\": \\"AIMediaAudit\\",\\n \\"TemplateConfig\\": \\"{\\\\\\"AuditRange\\\\\\":[\\\\\\"text-title\\\\\\",\\\\\\"video\\\\\\"],\\\\\\"AuditContent\\\\\\":[\\\\\\"screen\\\\\\"],\\\\\\"AuditItem\\\\\\":[\\\\\\"terrorism\\\\\\",\\\\\\"porn\\\\\\"],\\\\\\"AuditAutoBlock\\\\\\":\\\\\\"yes\\\\\\"}\\",\\n \\"TemplateName\\": \\"DemoAITemplate\\",\\n \\"Source\\": \\"Custom\\",\\n \\"TemplateId\\": \\"1706a0063dd733f6a823ef32e0a5****\\",\\n \\"ModifyTime\\": \\"2020-07-08T06:58:45Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListAITemplateResponse>\\n <RequestId>75B7BC67-FB8C-4653-4788-F4B01ED2****</RequestId>\\n <TemplateInfoList>\\n <CreationTime>2020-07-08T06:50:45Z</CreationTime>\\n <IsDefault>NoDefault</IsDefault>\\n <TemplateType>AIMediaAudit</TemplateType>\\n <TemplateConfig>{\\"AuditRange\\":[\\"text-title\\",\\"video\\"],\\"AuditContent\\":[\\"screen\\"],\\"AuditItem\\":[\\"terrorism\\",\\"porn\\"],\\"AuditAutoBlock\\":\\"yes\\"}</TemplateConfig>\\n <TemplateName>DemoAITemplate</TemplateName>\\n <Source>Custom</Source>\\n <TemplateId>1706a0063dd733f6a823ef32e0a5****</TemplateId>\\n <ModifyTime>2020-07-08T06:58:45Z</ModifyTime>\\n </TemplateInfoList>\\n</ListAITemplateResponse>","errorExample":""}]', + 'title' => '查询AI模板列表', + 'description' => '- 目前本接口支持的服务地域：**华北2（北京）**、**华东2（上海）**、**新加坡**。'."\n" + .'- 可调用本接口查询指定类型的AI模板列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetDefaultAITemplate' => [ + 'summary' => '调用本接口查询默认AI模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39949', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI模板类型。固定取值：**AIMediaAudit**（智能审核）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'AIMediaAudit', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A017F1DE-3DC3-4441-6755-37E81113****', + ], + 'TemplateInfo' => [ + 'description' => 'AI模板信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'AI模板的创建时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z。', + 'type' => 'string', + 'example' => '2020-07-08T06:50:45Z', + ], + 'IsDefault' => [ + 'description' => '是否为默认AI模板。取值：'."\n" + .'- **Default**：是。'."\n" + .'- **NotDefault**：否。', + 'type' => 'string', + 'example' => 'Default', + ], + 'TemplateType' => [ + 'description' => 'AI模板类型。固定取值：**AIMediaAudit**（智能审核）。', + 'type' => 'string', + 'example' => 'AIMediaAudit', + ], + 'TemplateConfig' => [ + 'description' => 'AI模板详细配置，JSON字符串。具体配置，请参见[AITemplateConfig](~~89863#title-vd3-499-o36~~)。', + 'type' => 'string', + 'example' => '{"AuditRange":["text-title","video"],"AuditContent":["screen"],"AuditItem":["terrorism","porn"],"AuditAutoBlock":"yes"}', + ], + 'TemplateName' => [ + 'description' => 'AI模板名称。', + 'type' => 'string', + 'example' => 'DemoAITemplate', + ], + 'Source' => [ + 'description' => 'AI模板来源。取值：'."\n" + .'- **System**：系统。'."\n" + .'- **Custom**：自定义。', + 'type' => 'string', + 'example' => 'Custom', + ], + 'TemplateId' => [ + 'description' => 'AI模板ID。', + 'type' => 'string', + 'example' => '1706a0063dd733f6a823ef32e0a5****', + ], + 'ModifyTime' => [ + 'description' => 'AI模板的修改时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z。', + 'type' => 'string', + 'example' => '2020-07-08T06:58:45Z', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A017F1DE-3DC3-4441-6755-37E81113****\\",\\n \\"TemplateInfo\\": {\\n \\"CreationTime\\": \\"2020-07-08T06:50:45Z\\",\\n \\"IsDefault\\": \\"Default\\",\\n \\"TemplateType\\": \\"AIMediaAudit\\",\\n \\"TemplateConfig\\": \\"{\\\\\\"AuditRange\\\\\\":[\\\\\\"text-title\\\\\\",\\\\\\"video\\\\\\"],\\\\\\"AuditContent\\\\\\":[\\\\\\"screen\\\\\\"],\\\\\\"AuditItem\\\\\\":[\\\\\\"terrorism\\\\\\",\\\\\\"porn\\\\\\"],\\\\\\"AuditAutoBlock\\\\\\":\\\\\\"yes\\\\\\"}\\",\\n \\"TemplateName\\": \\"DemoAITemplate\\",\\n \\"Source\\": \\"Custom\\",\\n \\"TemplateId\\": \\"1706a0063dd733f6a823ef32e0a5****\\",\\n \\"ModifyTime\\": \\"2020-07-08T06:58:45Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDefaultAITemplateResponse>\\n <RequestId>A017F1DE-3DC3-4441-6755-37E81113****</RequestId>\\n <TemplateInfo>\\n <CreationTime>2020-07-08T06:50:45Z</CreationTime>\\n <IsDefault>Default</IsDefault>\\n <TemplateType>AIMediaAudit</TemplateType>\\n <TemplateConfig>{\\"AuditRange\\":[\\"text-title\\",\\"video\\"],\\"AuditContent\\":[\\"screen\\"],\\"AuditItem\\":[\\"terrorism\\",\\"porn\\"],\\"AuditAutoBlock\\":\\"yes\\"}</TemplateConfig>\\n <TemplateName>DemoAITemplate</TemplateName>\\n <Source>Custom</Source>\\n <TemplateId>1706a0063dd733f6a823ef32e0a5****</TemplateId>\\n <ModifyTime>2020-07-08T06:58:45Z</ModifyTime>\\n </TemplateInfo>\\n</GetDefaultAITemplateResponse>","errorExample":""}]', + 'title' => '查询默认AI模板', + 'description' => '- 目前本接口支持的服务地域：**华北2（北京）**、**华东2（上海）**、**新加坡**。'."\n" + .'- 目前仅支持查询智能审核的默认AI模板。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ListAIJob' => [ + 'summary' => '调用本接口查询智能标签或视频DNA作业。在提交智能标签或视频DNA作业后，会进行异步处理，通过此接口可以实时查询作业信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40022', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'JobIds', + 'in' => 'query', + 'schema' => [ + 'description' => '作业ID列表。JobId可以通过[GetPlayInfo](~~56124~~)接口中返回的PlayInfo结构体中获取。'."\n" + ."\n" + .'> 多个ID之间用半角逗号（,）分隔，一次最多可以查询10个作业ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a718a3a1e8bb42ee3bc88921e94****,aasdcsfg782740asd3****,k2l3ibaskod98wrns9d****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8233A0E4-E112-44*****58-2BCED1B88173', + ], + 'NonExistAIJobIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => '不存在的作业ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的作业ID列表。', + 'type' => 'string', + 'example' => '["aasdcsfg782740asd3****", "k2l3ibaskod98wrns9d****"]', + ], + ], + ], + ], + 'AIJobList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AIJob' => [ + 'description' => '作业信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '作业开始时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z。'."\n", + 'type' => 'string', + 'example' => '2020-06-28T02:04:32Z', + ], + 'Status' => [ + 'description' => '作业状态。取值：'."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。'."\n" + .'- **init**：初始化。'."\n" + .'- **processing**：处理中。', + 'type' => 'string', + 'example' => 'success', + ], + 'Type' => [ + 'description' => '作业类型。取值：'."\n" + ."\n" + .'- **AIMediaDNA**：视频DNA。'."\n" + .'- **AIVideoTag**：智能标签。', + 'type' => 'string', + 'example' => 'AIVideoTag', + ], + 'Data' => [ + 'description' => '作业结果数据，JSON数据格式。具体数据结构请参见[AITemplateConfig](~~89863~~)。', + 'type' => 'string', + 'example' => '{"OrigASRData":{"AsrTextList":[{"EndTime":700,"StartTime":0,"Text":"嗯。","ChannelId":0,"SpeechRate":85},{"EndTime":3750,"StartTime":1630,"Text":"的。","ChannelId":0,"SpeechRate":28},{"EndTime":5910,"StartTime":4020,"Text":"听不厌。","ChannelId":0,"SpeechRate":95},{"EndTime":12750,"StartTime":10090,"Text":"留言。","ChannelId":0,"SpeechRate":45},{"EndTime":25230,"StartTime":13590,"Text":"hello，中午好。","ChannelId":0,"SpeechRate":20},{"EndTime":30000,"StartTime":28220,"Text":"嗯。","ChannelId":0,"SpeechRate":33}],"Duration":"30016"}}', + ], + 'CompleteTime' => [ + 'description' => '作业结束时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z。'."\n", + 'type' => 'string', + 'example' => '2020-06-28T02:04:47Z', + ], + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => 'a718a3a1e8bb42ee3bc88921e94****', + ], + 'Code' => [ + 'description' => '作业错误码。当Status为失败时，可关注该字段。', + 'type' => 'string', + 'example' => '0', + ], + 'Message' => [ + 'description' => '作业错误信息。当Status为失败时，可关注该字段。', + 'type' => 'string', + 'example' => 'OK', + ], + 'MediaId' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'example' => '3D3D12340d9401fab46a0b847****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8233A0E4-E112-44*****58-2BCED1B88173\\",\\n \\"NonExistAIJobIds\\": {\\n \\"String\\": [\\n \\"[\\\\\\"aasdcsfg782740asd3****\\\\\\", \\\\\\"k2l3ibaskod98wrns9d****\\\\\\"]\\"\\n ]\\n },\\n \\"AIJobList\\": {\\n \\"AIJob\\": [\\n {\\n \\"CreationTime\\": \\"2020-06-28T02:04:32Z\\",\\n \\"Status\\": \\"success\\",\\n \\"Type\\": \\"AIVideoTag\\",\\n \\"Data\\": \\"{\\\\\\"OrigASRData\\\\\\":{\\\\\\"AsrTextList\\\\\\":[{\\\\\\"EndTime\\\\\\":700,\\\\\\"StartTime\\\\\\":0,\\\\\\"Text\\\\\\":\\\\\\"嗯。\\\\\\",\\\\\\"ChannelId\\\\\\":0,\\\\\\"SpeechRate\\\\\\":85},{\\\\\\"EndTime\\\\\\":3750,\\\\\\"StartTime\\\\\\":1630,\\\\\\"Text\\\\\\":\\\\\\"的。\\\\\\",\\\\\\"ChannelId\\\\\\":0,\\\\\\"SpeechRate\\\\\\":28},{\\\\\\"EndTime\\\\\\":5910,\\\\\\"StartTime\\\\\\":4020,\\\\\\"Text\\\\\\":\\\\\\"听不厌。\\\\\\",\\\\\\"ChannelId\\\\\\":0,\\\\\\"SpeechRate\\\\\\":95},{\\\\\\"EndTime\\\\\\":12750,\\\\\\"StartTime\\\\\\":10090,\\\\\\"Text\\\\\\":\\\\\\"留言。\\\\\\",\\\\\\"ChannelId\\\\\\":0,\\\\\\"SpeechRate\\\\\\":45},{\\\\\\"EndTime\\\\\\":25230,\\\\\\"StartTime\\\\\\":13590,\\\\\\"Text\\\\\\":\\\\\\"hello，中午好。\\\\\\",\\\\\\"ChannelId\\\\\\":0,\\\\\\"SpeechRate\\\\\\":20},{\\\\\\"EndTime\\\\\\":30000,\\\\\\"StartTime\\\\\\":28220,\\\\\\"Text\\\\\\":\\\\\\"嗯。\\\\\\",\\\\\\"ChannelId\\\\\\":0,\\\\\\"SpeechRate\\\\\\":33}],\\\\\\"Duration\\\\\\":\\\\\\"30016\\\\\\"}}\\",\\n \\"CompleteTime\\": \\"2020-06-28T02:04:47Z\\",\\n \\"JobId\\": \\"a718a3a1e8bb42ee3bc88921e94****\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"OK\\",\\n \\"MediaId\\": \\"3D3D12340d9401fab46a0b847****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListAIJobResponse>\\n<RequestId>8233A0E4-E112-44*****58-2BCED1B88173</RequestId>\\n<NonExistAIJobIds>\\n <String>[\\"aasdcsfg*****782740asd\\", \\"k2l3ibask*****od98wrns9\\"]</String>\\n</NonExistAIJobIds>\\n<AIJobList>\\n <AIJob>\\n <Status>success</Status>\\n <Type>AIVideoTag</Type>\\n <Message>OK</Message>\\n <MediaId>a718a3a1e8*****bb42ee3bc88921e9</MediaId>\\n <CreationTime>2020-06-28T02:04:32Z</CreationTime>\\n <Data>{\\"OrigASRData\\":{\\"AsrTextList\\":[{\\"EndTime\\":700,\\"StartTime\\":0,\\"Text\\":\\"嗯。\\",\\"ChannelId\\":0,\\"SpeechRate\\":85},{\\"EndTime\\":3750,\\"StartTime\\":1630,\\"Text\\":\\"的。\\",\\"ChannelId\\":0,\\"SpeechRate\\":28},{\\"EndTime\\":5910,\\"StartTime\\":4020,\\"Text\\":\\"听不厌。\\",\\"ChannelId\\":0,\\"SpeechRate\\":95},{\\"EndTime\\":12750,\\"StartTime\\":10090,\\"Text\\":\\"留言。\\",\\"ChannelId\\":0,\\"SpeechRate\\":45},{\\"EndTime\\":25230,\\"StartTime\\":13590,\\"Text\\":\\"hello，中午好。\\",\\"ChannelId\\":0,\\"SpeechRate\\":20},{\\"EndTime\\":30000,\\"StartTime\\":28220,\\"Text\\":\\"嗯。\\",\\"ChannelId\\":0,\\"SpeechRate\\":33}],\\"Duration\\":\\"30016\\"}}</Data>\\n <CompleteTime>2020-06-28T02:04:47Z</CompleteTime>\\n <Code>0</Code>\\n <JobId>53d4a9c7b00c*****cdcb4b0c2c854c7</JobId>\\n </AIJob>\\n</AIJobList>\\n</ListAIJobResponse>","errorExample":""}]', + 'title' => '查询智能标签或视频DNA作业', + 'description' => '- 视频DNA支持的服务地域：**华北2（北京）**、**华东2（上海）**、**新加坡**。'."\n" + .'- 智能标签支持的服务地域：**华北2（北京）**、**华东2（上海）**。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'SubmitAIJob' => [ + 'summary' => '调用本接口提交智能标签或视频DNA作业。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40167', + 'abilityTreeNodes' => [ + 'FEATUREvodW76Z9M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[获取视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，视频ID为返回参数VideoId的值。'."\n" + .'- 视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '3D3D12340d9401fab46a0b847****', + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI作业类型。多个作业类型之间用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **AIMediaDNA**：视频DNA。'."\n" + .'- **AIVideoTag**：智能标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'AIVideoTag', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI作业配置，JSON格式。'."\n" + .'- 当`Types`设置为`AIVideoTag`时，`Config`支持配置`AnalyseTypes`，设置智能标签作业分析算法的类型，取值如下：'."\n" + .' - ASR：语音识别，从视频的⾳频语⾳中识别出标签 。'."\n" + .' - OCR：图文识别，从视频的图像⽂字中识别出标签 。'."\n" + .'- 当`Types`设置为`AIMediaDNA`时，`Config`支持配置`DNADBId`，设置DNA指纹库ID，用于指定视频DNA作业的指纹库。', + 'type' => 'string', + 'required' => false, + 'example' => '{"AIVideoTag": {"AnalyseTypes": "ASR"} }', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置，为JSON字符串。参数结构详情参考[UserData](~~86952#h2--userdata-div-id-userdata-div-3~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Extend":{"localId":"***","test":"www"}}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D73936****', + ], + 'AIJobList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AIJob' => [ + 'description' => 'AI作业信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'AI作业信息详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'AI作业类型。取值：'."\n" + ."\n" + .'- **AIMediaDNA**：视频DNA。'."\n" + .'- **AIVideoTag**：智能标签。', + 'type' => 'string', + 'example' => 'AIVideoTag', + ], + 'JobId' => [ + 'description' => 'AI作业ID。', + 'type' => 'string', + 'example' => '9e82640c85114bf5af23edfaf****', + ], + 'MediaId' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'example' => '3D3D12340d92c641401fab46a0b847****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D73936****\\",\\n \\"AIJobList\\": {\\n \\"AIJob\\": [\\n {\\n \\"Type\\": \\"AIVideoTag\\",\\n \\"JobId\\": \\"9e82640c85114bf5af23edfaf****\\",\\n \\"MediaId\\": \\"3D3D12340d92c641401fab46a0b847****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SubmitAIJobResponse>\\n <RequestId>25818875-5F78-4A13-BEF6-D73936****</RequestId>\\n <AIJobList>\\n <Type>AIVideoTag</Type>\\n <JobId>9e82640c85114bf5af23edfaf****</JobId>\\n <MediaId>3D3D12340d92c641401fab46a0b847****</MediaId>\\n </AIJobList>\\n</SubmitAIJobResponse>","errorExample":""}]', + 'title' => '提交智能标签或视频DNA作业', + 'description' => '- **请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。智能标签和视频DNA为付费功能，计费详情，请参见[视频AI计费](~~188310#section-g7l-s3o-9ng~~)。**'."\n" + .'- 视频DNA支持的服务地域：**华北2（北京）**、**华东2（上海）**、**新加坡**；智能标签支持的服务地域：**华北2（北京）**、**华东2（上海）**。'."\n" + .'- 您需要先开通视频DNA或智能标签服务后，才能调用此接口提交AI作业。开通详情，请参见[视频AI](~~101148~~)。'."\n" + .'- 初次使用视频DNA时，您需提供uid及地域信息，提交工单申请免费开通DNA指纹库，否则将影响后续视频DNA的功能使用。关于如何提交工单，请参见[联系我们](~~464625~~)。'."\n" + .'- AI作业在提交成功后会异步执行，不保证接口返回时AI作业已处理完成。建议您配置[事件通知](~~55627~~)功能，指定回调事件为**视频AI处理完成**，当接收到**视频AI处理完成**的事件通知回调后，再获取AI作业的结果。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetMediaDNAResult' => [ + 'summary' => '调用本接口获取视频DNA结果。视频DNA作业完成后，可通过此接口实时查询DNA结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39962', + 'abilityTreeNodes' => [ + 'FEATUREvod5413CB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'required' => true, + 'example' => '88c6ca184c0e*****a5b665e2a126797', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '63FC4896-E956-4B*****7D-134FF1BC597A', + ], + 'DNAResult' => [ + 'description' => 'DNA结果。', + 'type' => 'object', + 'properties' => [ + 'VideoDNA' => [ + 'description' => '视频DNA识别结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PrimaryKey' => [ + 'description' => '相似视频ID。', + 'type' => 'string', + 'example' => '6ad8987da46f4b*****490ce2873745', + ], + 'Similarity' => [ + 'description' => '视频相似度。相似度1是指相似度100%。', + 'type' => 'string', + 'example' => '0.98', + ], + 'Detail' => [ + 'description' => '相似视频详情。包括视频的位置、时长等。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Input' => [ + 'description' => '输入视频的开始时间和时长。', + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'description' => '视频的时长。单位：秒。', + 'type' => 'string', + 'example' => '12.0', + ], + 'Start' => [ + 'description' => '视频的开始时间。单位：秒。', + 'type' => 'string', + 'example' => '2.0', + ], + ], + ], + 'Duplication' => [ + 'description' => '库中视频的开始时间和时长。', + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'description' => '视频的时长。单位：秒。', + 'type' => 'string', + 'example' => '12.0', + ], + 'Start' => [ + 'description' => '视频的开始时间。单位：秒。', + 'type' => 'string', + 'example' => '2.0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"63FC4896-E956-4B*****7D-134FF1BC597A\\",\\n \\"DNAResult\\": {\\n \\"VideoDNA\\": [\\n {\\n \\"PrimaryKey\\": \\"6ad8987da46f4b*****490ce2873745\\",\\n \\"Similarity\\": \\"0.98\\",\\n \\"Detail\\": [\\n {\\n \\"Input\\": {\\n \\"Duration\\": \\"12.0\\",\\n \\"Start\\": \\"2.0\\"\\n },\\n \\"Duplication\\": {\\n \\"Duration\\": \\"12.0\\",\\n \\"Start\\": \\"2.0\\"\\n }\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMediaDNAResultResponse>\\r\\n\\t<RequestId>63FC4896-E956-4B*****7D-134FF1BC597A</RequestId>\\r\\n\\t<DNAResult>\\r\\n\\t\\t<VideoDNA>\\r\\n\\t\\t\\t<Similarity>0.98</Similarity>\\r\\n\\t\\t\\t<PrimaryKey>6ad8987da46f4b*****490ce2873745</PrimaryKey>\\r\\n\\t\\t\\t<Detail>\\r\\n\\t\\t\\t\\t<Input>\\r\\n\\t\\t\\t\\t\\t<Start>2.0</Start>\\r\\n\\t\\t\\t\\t\\t<Duration>12.0</Duration>\\r\\n\\t\\t\\t\\t</Input>\\r\\n\\t\\t\\t\\t<Duplication>\\r\\n\\t\\t\\t\\t\\t<Start>2.0</Start>\\r\\n\\t\\t\\t\\t\\t<Duration>12.1</Duration>\\r\\n\\t\\t\\t\\t</Duplication>\\r\\n\\t\\t\\t</Detail>\\r\\n\\t\\t</VideoDNA>\\r\\n\\t</DNAResult>\\r\\n</GetMediaDNAResultResponse>","errorExample":""}]', + 'title' => '获取视频DNA结果', + 'description' => '目前本接口支持的服务地域：**华北2（北京）**、**华东2（上海）**、**新加坡**。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'SubmitMediaDNADeleteJob' => [ + 'summary' => '调用本接口删除视频DNA作业。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40187', + 'abilityTreeNodes' => [ + 'FEATUREvod5413CB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '656eaaa8c43a4597******1f09a36', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'e5b1a2e7bee******b632c2710b9423f', + ], + 'JobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '6805B2EC-CE87-****-8FF6-9C0E97719A26', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"e5b1a2e7bee******b632c2710b9423f\\",\\n \\"JobId\\": \\"6805B2EC-CE87-****-8FF6-9C0E97719A26\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitMediaDNADeleteJobResponse>\\n<JobId>e5b1a2e7bee******b632c2710b9423f</JobId>\\n<RequestId>6805B2EC-CE87-****-8FF6-9C0E97719A26</RequestId>\\n</SubmitMediaDNADeleteJobResponse>","errorExample":""}]', + 'title' => '删除视频DNA作业', + 'description' => '目前本接口支持的服务地域：**华北2（北京）**、**华东2（上海）**、**新加坡**。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetAIVideoTagResult' => [ + 'summary' => '调用本接口获取智能标签结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39936', + 'abilityTreeNodes' => [ + 'FEATUREvod7BX3NA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID，即视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[获取视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，视频ID为返回参数VideoId的值。'."\n" + .'- 视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '595d020bad37421f37433451720****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8829B4DB-AFD9-4FF6-12965DBFFA14****', + ], + 'VideoTagResult' => [ + 'description' => '结果数据。', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'description' => '视频分类的集合。', + 'type' => 'array', + 'items' => [ + 'description' => '视频分类详情。', + 'type' => 'object', + 'properties' => [ + 'Tag' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => '美容', + ], + ], + ], + ], + 'Person' => [ + 'description' => '人物标签的集合。', + 'type' => 'array', + 'items' => [ + 'description' => '人物标签详情。', + 'type' => 'object', + 'properties' => [ + 'FaceUrl' => [ + 'description' => '人脸URL。'."\n" + ."\n" + .'> 只有人物标签结果会返回该字段。', + 'type' => 'string', + 'example' => 'http://example.com/aivideotag/8829B4DB-AFD9-4F*****F6-12965DBFFA14/Index_****.jpg', + ], + 'Tag' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => '小王', + ], + 'Times' => [ + 'description' => '时间点的集合。单位：毫秒。', + 'type' => 'array', + 'items' => [ + 'description' => '时间点的集合。单位：毫秒。', + 'type' => 'string', + 'example' => '["10760"]', + ], + ], + ], + ], + ], + 'Time' => [ + 'description' => '时间标签的集合。', + 'type' => 'array', + 'items' => [ + 'description' => '时间标签详情。', + 'type' => 'object', + 'properties' => [ + 'Tag' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => '毫秒', + ], + 'Times' => [ + 'description' => '时间点的集合。单位：毫秒。', + 'type' => 'array', + 'items' => [ + 'description' => '时间点的集合。单位：毫秒。', + 'type' => 'string', + 'example' => '["3260","4000","5000","8410","12000","13000","14000"]', + ], + ], + ], + ], + ], + 'Location' => [ + 'description' => '地点标签的集合。', + 'type' => 'array', + 'items' => [ + 'description' => '地点标签详情。', + 'type' => 'object', + 'properties' => [ + 'Tag' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => '亚洲', + ], + 'Times' => [ + 'description' => '时间点的集合。单位：毫秒。', + 'type' => 'array', + 'items' => [ + 'description' => '时间点的集合。单位：毫秒。', + 'type' => 'string', + 'example' => '["8410"]', + ], + ], + ], + ], + ], + 'Keyword' => [ + 'description' => '关键词标签的集合。', + 'type' => 'array', + 'items' => [ + 'description' => '关键词标签详情。', + 'type' => 'object', + 'properties' => [ + 'Tag' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => '气垫', + ], + 'Times' => [ + 'description' => '时间点的集合。单位：毫秒。', + 'type' => 'array', + 'items' => [ + 'description' => '时间点的集合。单位：毫秒。', + 'type' => 'string', + 'example' => '["3260","4000","5000","8410","12000","13000","14000"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8829B4DB-AFD9-4FF6-12965DBFFA14****\\",\\n \\"VideoTagResult\\": {\\n \\"Category\\": [\\n {\\n \\"Tag\\": \\"美容\\"\\n }\\n ],\\n \\"Person\\": [\\n {\\n \\"FaceUrl\\": \\"http://example.com/aivideotag/8829B4DB-AFD9-4F*****F6-12965DBFFA14/Index_****.jpg\\",\\n \\"Tag\\": \\"小王\\",\\n \\"Times\\": [\\n \\"[\\\\\\"10760\\\\\\"]\\"\\n ]\\n }\\n ],\\n \\"Time\\": [\\n {\\n \\"Tag\\": \\"毫秒\\",\\n \\"Times\\": [\\n \\"[\\\\\\"3260\\\\\\",\\\\\\"4000\\\\\\",\\\\\\"5000\\\\\\",\\\\\\"8410\\\\\\",\\\\\\"12000\\\\\\",\\\\\\"13000\\\\\\",\\\\\\"14000\\\\\\"]\\"\\n ]\\n }\\n ],\\n \\"Location\\": [\\n {\\n \\"Tag\\": \\"亚洲\\",\\n \\"Times\\": [\\n \\"[\\\\\\"8410\\\\\\"]\\"\\n ]\\n }\\n ],\\n \\"Keyword\\": [\\n {\\n \\"Tag\\": \\"气垫\\",\\n \\"Times\\": [\\n \\"[\\\\\\"3260\\\\\\",\\\\\\"4000\\\\\\",\\\\\\"5000\\\\\\",\\\\\\"8410\\\\\\",\\\\\\"12000\\\\\\",\\\\\\"13000\\\\\\",\\\\\\"14000\\\\\\"]\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAIVideoTagResultResponse>\\n <RequestId>8829B4DB-AFD9-4FF6-12965DBFFA14****</RequestId>\\n <VideoTagResult>\\n <Category>\\n <Tag>美容</Tag>\\n </Category>\\n <Person>\\n <FaceUrl>http://example.com/aivideotag/8829B4DB-AFD9-4F*****F6-12965DBFFA14/Index_****.jpg</FaceUrl>\\n <Tag>小王</Tag>\\n <Times>[\\"10760\\"]</Times>\\n </Person>\\n <Time>\\n <Tag>毫秒</Tag>\\n <Times>[\\"3260\\",\\"4000\\",\\"5000\\",\\"8410\\",\\"12000\\",\\"13000\\",\\"14000\\"]</Times>\\n </Time>\\n <Location>\\n <Tag>亚洲</Tag>\\n <Times>[\\"8410\\"]</Times>\\n </Location>\\n <Keyword>\\n <Tag>气垫</Tag>\\n <Times>[\\"3260\\",\\"4000\\",\\"5000\\",\\"8410\\",\\"12000\\",\\"13000\\",\\"14000\\"]</Times>\\n </Keyword>\\n </VideoTagResult>\\n</GetAIVideoTagResultResponse>","errorExample":""}]', + 'title' => '获取智能标签结果', + 'description' => '- 目前本接口支持的服务地域：**华北2（北京）**、**华东2（上海）**。'."\n" + .'- 通过视频ID获取智能标签结果。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'SubmitAIImageJob' => [ + 'summary' => '调用本接口提交AI图片处理任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40165', + 'abilityTreeNodes' => [ + 'FEATUREvodIPBMLH', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[CreateUploadVideo](~~55407~~)接口上传视频时，视频ID为返回参数VideoId的值。'."\n" + .'- 视频上传后，可通过[SearchMedia](~~86044~~)接口查询视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '357a8748c5774*****89d2726e6436aa', + ], + ], + [ + 'name' => 'AITemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI图片模板ID。可通过以下方式获取：'."\n" + .'- 通过[AddAITemplate](~~102930~~)接口创建图片模板时，返回参数TemplateId的值。'."\n" + .'- 模板创建后，可通过[ListAITemplate](~~102936~~)接口查询AI图片模板ID，为请求后返回参数TemplateId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ef1a8842cb9f*****cea80cad902e416', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置。'."\n" + .'- 必须是JSON字符串。'."\n" + .'- 需要包含MessageCallback或者Extend参数。'."\n" + .'- 最大长度为512个字节。'."\n" + ."\n" + .'参数构造详情，请参见[UserData](~~86952~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Extend":{"localId":"****","test":"www"}}', + ], + ], + [ + 'name' => 'AIPipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI任务管道ID。'."\n" + ."\n" + .'> 有默认ID，可不填写。如果需要批量导入，需要使用单独的任务管道，请提交工单申请配置或联系阿里云售后进行配置，关于如何提交工单，请参见[联系我们](~~464625~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '6492025b8f*****6ba5bb755a33438', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => 'AI图片处理任务ID。', + 'type' => 'string', + 'example' => 'cf08a2c6e11e*****de1711b738b9067', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '218A6807-A21E-43*****54-C0512880B0B0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"JobId\\": \\"cf08a2c6e11e*****de1711b738b9067\\",\\n \\"RequestId\\": \\"218A6807-A21E-43*****54-C0512880B0B0\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitAIImageJobResponse>\\n <JobId>cf08a2c6e11e*****de1711b738b9067</JobId>\\n <RequestId>218A6807-A21E-43*****54-C0512880B0B0</RequestId>\\n</SubmitAIImageJobResponse>","errorExample":""}]', + 'title' => '提交AI图片任务', + 'description' => '- 目前本接口支持的服务地域：**华北2（北京）**、**华东2（上海）**。'."\n" + .'- 调用本接口处理AI图片后，可以通过[GetAIImageJobs](~~186923~~)接口查询任务执行结果。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'GetAIImageJobs' => [ + 'summary' => '调用本接口查询AI图片任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39931', + 'abilityTreeNodes' => [ + 'FEATUREvodIPBMLH', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'JobIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI图片处理任务ID。由一个或多个JobId组成，JobId为调用[SubmitAIImageJob](~~186922~~)接口返回参数JobId的值。'."\n" + .'- 最多支持10个ID。'."\n" + .'- 多个ID之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cf08a2c6e11e*****de1711b738b9067', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7721B494-1F78-4E*****E8-A7CEE7315BFA', + ], + 'AIImageJobList' => [ + 'description' => 'AI图片处理任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'AI图片处理任务详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态：'."\n" + .'- **success**：成功。'."\n" + .'- **fail**：失败。', + 'type' => 'string', + 'example' => 'success', + ], + 'CreationTime' => [ + 'description' => 'AI图片处理任务的创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2020-10-15T03:30:03Z', + ], + 'AIImageResult' => [ + 'description' => 'AI图片的OSS地址。'."\n" + .'>为任务结果，因此该地址不提供完整的鉴权信息，需要鉴权信息需用户生成或者调用[ListAIImage](~~186924~~)接口获取媒资结果。', + 'type' => 'string', + 'example' => '[{"Score":5.035636554444242,"Url":"http://outin-*****.oss-cn-shanghai.aliyuncs.com/357a8748c577*****789d2726e6436aa/image/ai/b0a7612554d*****5cbe3-00001.gif"}]', + ], + 'VideoId' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'example' => '357a8748c577*****789d2726e6436aa', + ], + 'JobId' => [ + 'description' => 'AI图片处理任务ID。', + 'type' => 'string', + 'example' => 'cf08a2c6e11e*****de1711b738b9067', + ], + 'UserData' => [ + 'description' => '自定义设置。'."\n" + .'- 必须是JSON字符串。'."\n" + .'- 需要包含MessageCallback或者Extend参数。'."\n" + .'- 最大长度为512个字节。'."\n" + ."\n" + .'参数构造详情，请参见[UserData](~~86952~~)。', + 'type' => 'string', + 'example' => '{"Extend":{"localId":"****","test":"www"}}', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'TemplateConfig' => [ + 'description' => '提交任务时，对指定模板的配置信息的快照。', + 'type' => 'string', + 'example' => '{"Format":"gif","SetDefaultCover":"true"}', + ], + 'TemplateId' => [ + 'description' => 'AI模板ID。', + 'type' => 'string', + 'example' => '5a86a00f15194*****d7fe7de1b4a173', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7721B494-1F78-4E*****E8-A7CEE7315BFA\\",\\n \\"AIImageJobList\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"CreationTime\\": \\"2020-10-15T03:30:03Z\\",\\n \\"AIImageResult\\": \\"[{\\\\\\"Score\\\\\\":5.035636554444242,\\\\\\"Url\\\\\\":\\\\\\"http://outin-*****.oss-cn-shanghai.aliyuncs.com/357a8748c577*****789d2726e6436aa/image/ai/b0a7612554d*****5cbe3-00001.gif\\\\\\"}]\\",\\n \\"VideoId\\": \\"357a8748c577*****789d2726e6436aa\\",\\n \\"JobId\\": \\"cf08a2c6e11e*****de1711b738b9067\\",\\n \\"UserData\\": \\"{\\\\\\"Extend\\\\\\":{\\\\\\"localId\\\\\\":\\\\\\"****\\\\\\",\\\\\\"test\\\\\\":\\\\\\"www\\\\\\"}}\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"TemplateConfig\\": \\"{\\\\\\"Format\\\\\\":\\\\\\"gif\\\\\\",\\\\\\"SetDefaultCover\\\\\\":\\\\\\"true\\\\\\"}\\",\\n \\"TemplateId\\": \\"5a86a00f15194*****d7fe7de1b4a173\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetAIImageJobsResponse>\\n <RequestId>7721B494-1F78-4E*****E8-A7CEE7315BFA</RequestId>\\n <AIImageJobList>\\n <Status>success</Status>\\n <CreationTime>2020-10-15T03:30:03Z</CreationTime>\\n <AIImageResult>[{\\"Score\\":5.035636554444242,\\"Url\\":\\"http://outin-*****.oss-cn-shanghai.aliyuncs.com/357a8748c577*****789d2726e6436aa/image/ai/b0a7612554d*****5cbe3-00001.gif\\"}]</AIImageResult>\\n <VideoId>357a8748c577*****789d2726e6436aa</VideoId>\\n <JobId>cf08a2c6e11e*****de1711b738b9067</JobId>\\n <UserData>{\\"Extend\\":{\\"localId\\":\\"****\\",\\"test\\":\\"www\\"}}</UserData>\\n <Code>Success</Code>\\n <Message>success</Message>\\n <TemplateConfig>{\\"Format\\":\\"gif\\",\\"SetDefaultCover\\":\\"true\\"}</TemplateConfig>\\n <TemplateId>5a86a00f15194*****d7fe7de1b4a173</TemplateId>\\n </AIImageJobList>\\n</GetAIImageJobsResponse>","errorExample":""}]', + 'title' => '查询AI图片任务列表', + 'description' => '- 目前本接口支持的服务地域：**华北2（北京）**、**华东2（上海）**。'."\n" + .'- 先通过[SubmitAIImageJob](~~SubmitAIImageJob~~)接口提交AI图片处理任务，再调用本接口查询AI图片任务列表信息。'."\n" + .'- 本接口一次最多可查询10个AI图片处理任务。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ListAIImageInfo' => [ + 'summary' => '调用本接口查询指定视频下的AI图片信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40020', + 'abilityTreeNodes' => [ + 'FEATUREvodYRQNEN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[获取视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，视频ID为返回参数VideoId的值。'."\n" + .'- 视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '357a8748c5789d2726e6436aa****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D73420CD-D221-9122-5B8FA995A511****', + ], + 'AIImageInfoList' => [ + 'description' => 'AI图片文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'AI图片文件详情。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '数据创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2020-10-15T03:30:03Z', + ], + 'AIImageInfoId' => [ + 'description' => '图片数据信息ID。', + 'type' => 'string', + 'example' => 'b89a6aabf1b6197ebd6fe6cf29****', + ], + 'FileURL' => [ + 'description' => 'AI图片文件地址。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/357a8748c5789d2726e6436aa****/image/ai/b0a7612554d6400013-0****.gif?auth_key=1602745717-0-0-005ee05616c5925596d****', + ], + 'Version' => [ + 'description' => '数据版本ID。', + 'type' => 'string', + 'example' => 'b547f3f0e199c3b457369f3cf****', + ], + 'VideoId' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'example' => '357a8748c5789d2726e6436aa****', + ], + 'JobId' => [ + 'description' => 'AI图片处理任务ID。', + 'type' => 'string', + 'example' => 'cf08a2c6e11ee1711b738b9067****', + ], + 'Score' => [ + 'description' => '图片评分。', + 'type' => 'string', + 'example' => '5.035636554444242', + ], + 'Format' => [ + 'description' => '图片格式。取值：**gif**或**png**。', + 'type' => 'string', + 'example' => 'gif', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D73420CD-D221-9122-5B8FA995A511****\\",\\n \\"AIImageInfoList\\": [\\n {\\n \\"CreationTime\\": \\"2020-10-15T03:30:03Z\\",\\n \\"AIImageInfoId\\": \\"b89a6aabf1b6197ebd6fe6cf29****\\",\\n \\"FileURL\\": \\"http://example.aliyundoc.com/357a8748c5789d2726e6436aa****/image/ai/b0a7612554d6400013-0****.gif?auth_key=1602745717-0-0-005ee05616c5925596d****\\",\\n \\"Version\\": \\"b547f3f0e199c3b457369f3cf****\\",\\n \\"VideoId\\": \\"357a8748c5789d2726e6436aa****\\",\\n \\"JobId\\": \\"cf08a2c6e11ee1711b738b9067****\\",\\n \\"Score\\": \\"5.035636554444242\\",\\n \\"Format\\": \\"gif\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListAIImageInfoResponse>\\n <RequestId>D73420CD-D221-9122-5B8FA995A511****</RequestId>\\n <AIImageInfoList>\\n <CreationTime>2020-10-15T03:30:03Z</CreationTime>\\n <AIImageInfoId>b89a6aabf1b6197ebd6fe6cf29****</AIImageInfoId>\\n <FileURL>http://example.aliyundoc.com/357a8748c5789d2726e6436aa****/image/ai/b0a7612554d6400013-0****.gif?auth_key=1602745717-0-0-005ee05616c5925596d****</FileURL>\\n <Version>b547f3f0e199c3b457369f3cf****</Version>\\n <VideoId>357a8748c5789d2726e6436aa****</VideoId>\\n <JobId>cf08a2c6e11ee1711b738b9067****</JobId>\\n <Score>5.035636554444242</Score>\\n <Format>gif</Format>\\n </AIImageInfoList>\\n</ListAIImageInfoResponse>","errorExample":""}]', + 'title' => '查询智能封面信息', + 'description' => '- 目前本接口支持的服务地域：**华北2（北京）**、**华东2（上海）**。'."\n" + .'- 本接口只能查询单个视频下的AI图片信息，**不支持批量查询**。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DeleteAIImageInfos' => [ + 'summary' => '调用本接口删除AI图片信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39822', + 'abilityTreeNodes' => [ + 'FEATUREvodIPBMLH', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AIImageInfoIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI图片数据信息ID。由一个或多个AIImageInfoId组成，AIImageInfoId为调用[ListAIImageInfo](~~186924~~)接口返回参数AIImageInfoId的值。'."\n" + .'- 最多支持10个ID。'."\n" + .'- 多个ID之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'b89a6aabf144*****6197ebd6fe6cf29', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FCDC80EA-363C-41*****B8-0DF14033D643', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FCDC80EA-363C-41*****B8-0DF14033D643\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAIImageInfosResponse>\\n <RequestId>FCDC80EA-363C-41*****B8-0DF14033D643</RequestId>\\n</DeleteAIImageInfosResponse>","errorExample":""}]', + 'title' => '删除AI图片信息', + 'description' => '- 目前本接口支持的服务地域：**华北2（北京）**、**华东2（上海）**。'."\n" + .'- **本接口只会删除AI图片信息，并不会实际删除图片文件**。'."\n" + .'- 最多支持10个ID进行删除。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'ListLiveRecordVideo' => [ + 'summary' => '调用本接口获取直播转点播视频列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40057', + 'abilityTreeNodes' => [ + 'FEATUREvodKX7ANE', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '录制时使用的直播流名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'live-test', + ], + ], + [ + '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' => 'testApp', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页号。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '页长。最大值：**100**，默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '结果排序。取值：'."\n" + ."\n" + .'- **CreationTime:Desc**（默认值）：按创建时间倒序。'."\n" + .'- **CreationTime:Asc**：按创建时间升序。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreationTime:Desc', + ], + ], + [ + '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-01-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' => '2017-01-11T13:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '视频总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-****-D7393642CA58', + ], + 'LiveRecordVideoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveRecordVideo' => [ + 'description' => '视频列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => 'App名称。', + 'type' => 'string', + 'example' => 'testApp', + ], + 'PlaylistId' => [ + 'description' => '播单ID。', + 'type' => 'string', + 'example' => '****', + ], + 'StreamName' => [ + 'description' => '直播流名称。', + 'type' => 'string', + 'example' => 'live-test', + ], + 'RecordEndTime' => [ + 'description' => '录制结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2017-12-08T08:44:56Z', + ], + 'RecordStartTime' => [ + 'description' => '录制开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-12-08T07:40:56Z', + ], + 'DomainName' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Video' => [ + 'description' => '视频信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '视频创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-12-08T07:40:56Z', + ], + 'Status' => [ + 'description' => '视频状态。取值：'."\n" + .'- **Uploading**：上传中。'."\n" + .'- **UploadFail**：上传失败。'."\n" + .'- **UploadSuccess**：上传完成。'."\n" + .'- **Transcoding**：转码中。'."\n" + .'- **TranscodeFail**：转码失败。'."\n" + .'- **Blocked**：屏蔽。'."\n" + .'- **Normal**：正常。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CateId' => [ + 'description' => '视频分类ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '78', + ], + 'VideoId' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'example' => '93ab850b4f6f*****54b6e91d24d81d4', + ], + 'Tags' => [ + 'description' => '视频标签。多个标签使用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '标签1, 标签2', + ], + 'CateName' => [ + 'description' => '视频分类名称。', + 'type' => 'string', + 'example' => '分类名', + ], + 'Description' => [ + 'description' => '视频描述。', + 'type' => 'string', + 'example' => '阿里云VOD视频描述', + ], + 'Size' => [ + 'description' => '视频源文件大小。单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10897890', + ], + 'CoverURL' => [ + 'description' => '视频封面URL。', + 'type' => 'string', + 'example' => 'https://image.example.com/coversample.jpg', + ], + 'TemplateGroupId' => [ + 'description' => '视频转码时使用的转码模板组ID。', + 'type' => 'string', + 'example' => '1', + ], + 'Duration' => [ + 'description' => '视频时长。单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '135.6', + ], + 'Title' => [ + 'description' => '视频标题。', + 'type' => 'string', + 'example' => '阿里云VOD视频标题', + ], + 'ModifyTime' => [ + 'description' => '视频更新时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-12-08T09:40:56Z', + ], + 'Snapshots' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Snapshot' => [ + 'description' => '视频截图URL数组。', + 'type' => 'array', + 'items' => [ + 'description' => '视频截图URL数组。', + 'type' => 'string', + 'example' => '{"Snapshot":["http://image.example.com/snapshot/sample000001.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e273334f52","http://image.example.com/snapshot/sample00002.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e272434f52"]}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Total\\": 123,\\n \\"RequestId\\": \\"25818875-5F78-4A13-****-D7393642CA58\\",\\n \\"LiveRecordVideoList\\": {\\n \\"LiveRecordVideo\\": [\\n {\\n \\"AppName\\": \\"testApp\\",\\n \\"PlaylistId\\": \\"****\\",\\n \\"StreamName\\": \\"live-test\\",\\n \\"RecordEndTime\\": \\"2017-12-08T08:44:56Z\\",\\n \\"RecordStartTime\\": \\"2017-12-08T07:40:56Z\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"Video\\": {\\n \\"CreationTime\\": \\"2017-12-08T07:40:56Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CateId\\": 78,\\n \\"VideoId\\": \\"93ab850b4f6f*****54b6e91d24d81d4\\",\\n \\"Tags\\": \\"标签1, 标签2\\",\\n \\"CateName\\": \\"分类名\\",\\n \\"Description\\": \\"阿里云VOD视频描述\\",\\n \\"Size\\": 10897890,\\n \\"CoverURL\\": \\"https://image.example.com/coversample.jpg\\",\\n \\"TemplateGroupId\\": \\"1\\",\\n \\"Duration\\": 135.6,\\n \\"Title\\": \\"阿里云VOD视频标题\\",\\n \\"ModifyTime\\": \\"2017-12-08T09:40:56Z\\",\\n \\"Snapshots\\": {\\n \\"Snapshot\\": [\\n \\"{\\\\\\"Snapshot\\\\\\":[\\\\\\"http://image.example.com/snapshot/sample000001.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e273334f52\\\\\\",\\\\\\"http://image.example.com/snapshot/sample00002.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e272434f52\\\\\\"]}\\"\\n ]\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListLiveRecordVideoResponse>\\n<RequestId>25818875-5F78-4A13-****-D7393642CA58</RequestId>\\n<Total>123</Total>\\n<LiveRecordVideoList>\\n <LiveRecordVideo>\\n <PlaylistId>****</PlaylistId>\\n <StreamName>live-test</StreamName>\\n <RecordStartTime>2017-12-08T07:40:56Z</RecordStartTime>\\n <RecordEndTime>2017-12-08T08:40:56Z</RecordEndTime>\\n <DomainName>example.com</DomainName>\\n <AppName>testApp</AppName>\\n </LiveRecordVideo>\\n <LiveRecordVideo>\\n <Video>\\n <Status>Normal</Status>\\n <ModifyTime>2017-12-08T09:40:56Z</ModifyTime>\\n <Description>阿里云VOD视频描述</Description>\\n <VideoId>93ab850b4f6f*****54b6e91d24d81d4</VideoId>\\n <Size>10897890</Size>\\n <Title>阿里云VOD视频标题</Title>\\n <Duration>135.6</Duration>\\n <CateName>分类名</CateName>\\n <CateId>78</CateId>\\n <CreationTime>2017-12-08T07:40:56Z</CreationTime>\\n <CoverURL>https://image.example.com/coversample.jpg</CoverURL>\\n <Snapshots>\\n <Snapshot>{\\"Snapshot\\":[\\"http://image.example.com/snapshot/sample000001.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e273334f52\\",\\"http://image.example.com/snapshot/sample00002.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e272434f52\\"]}</Snapshot>\\n </Snapshots>\\n <Tags>标签1, 标签2</Tags>\\n <TemplateGroupId>1</TemplateGroupId>\\n </Video>\\n </LiveRecordVideo>\\n</LiveRecordVideoList>\\n</ListLiveRecordVideoResponse>","errorExample":""}]', + 'title' => '获取直播转点播视频列表', + 'description' => '最多支持获取指定筛选条件的前5000条。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' 下表列举了本接口特有的错误码。视频点播通用的错误码信息，请参见[错误码表](~~52841~~)。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| IpsIsEmpty | The specified “Ips” can not be empty. | 400 | Ips不允许为空。| '."\n" + .'| IpsExceededMax | The specified Ips count has exceeded 100. | 403 | 添加的IP超过个数限制，每个分组最多支持100个。'."\n" + .'| SecurityIpGroupExceededMax | The audit security group count has exceeded 10. | 403 | 审核安全IP分组个数超过限制。| ', + ], + 'DescribeVodDomainTrafficData' => [ + 'summary' => '调用本接口查询加速域名的流量数据，相比DescribeVodDomainRealTimeTrafficData接口，本接口支持可查询的历史数据时间范围更长（最长可查询最近366天的数据），但其数据时间粒度更大（最小为5分钟），数据延迟更高。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39903', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的加速域名。'."\n" + ."\n" + .'- 不传入该参数，则默认返回所有加速域名的合并数据。'."\n" + .'- 支持批量查询，多个域名之间用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + .'- 您可以登录[视频点播控制台](https://vod.console.aliyun.com)，从左侧导航选择**配置管理 > 分发加速配置 > 域名管理**，查看您已接入到视频点播的加速域名，或者调用[DescribeVodUserDomains](~~455030~~)接口查询加速域名列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。 '."\n" + ."\n" + .'日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-20T13:59:58Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-20T14:59:58Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询数据的时间粒度。单位：秒。取值：**300**、**3600**和**86400**。不传和传的值不支持时，使用默认值。根据您指定的`StartTime`和`EndTime`的时间跨度，支持设置的时间粒度如下：'."\n" + ."\n" + .'- 3天以内（不包含3天整）支持：**300**（默认）、**3600**、**86400**。'."\n" + .'- 3-31天（不包含31天整）支持：**3600**（默认）和**86400**。'."\n" + .'- 31天以上支持：**86400**（默认）。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。不传入该参数，默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名。不传入该参数，默认查询所有地域。目前仅支持上海地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '数据的结束时间点。', + 'type' => 'string', + 'example' => '2019-01-20T14:59:58Z', + ], + 'StartTime' => [ + 'description' => '数据的起始时间点。', + 'type' => 'string', + 'example' => '2019-01-20T13:59:58Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D94E471F-1A27-442E-552D-D4D2000C****', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'TotalTraffic' => [ + 'description' => '总流量。', + 'type' => 'string', + 'example' => '5906662826', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，即数据的时间粒度。单位：秒。', + 'type' => 'string', + 'example' => '300'."\n", + ], + 'TrafficDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的流量数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HttpsDomesticValue' => [ + 'description' => 'L1节点的HTTPS流量（中国内地）。单位：Byte。', + 'type' => 'string', + 'example' => '0', + ], + 'Value' => [ + 'description' => '总流量。单位：Byte。', + 'type' => 'string', + 'example' => '0', + ], + 'OverseasValue' => [ + 'description' => '全球（不包含中国内地）流量。单位：Byte。', + 'type' => 'string', + 'example' => '0', + ], + 'HttpsValue' => [ + 'description' => 'L1节点的HTTPS总流量。单位：Byte。', + 'type' => 'string', + 'example' => '0', + ], + 'HttpsOverseasValue' => [ + 'description' => 'L1节点的HTTPS流量（全球（不包含中国内地））。单位：Byte。', + 'type' => 'string', + 'example' => '0', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳。日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2019-01-20T13:59:58Z', + ], + 'DomesticValue' => [ + 'description' => '中国内地流量。单位：Byte。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-01-20T14:59:58Z\\",\\n \\"StartTime\\": \\"2019-01-20T13:59:58Z\\",\\n \\"RequestId\\": \\"D94E471F-1A27-442E-552D-D4D2000C****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"TotalTraffic\\": \\"5906662826\\",\\n \\"DataInterval\\": \\"300\\\\n\\",\\n \\"TrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"HttpsDomesticValue\\": \\"0\\",\\n \\"Value\\": \\"0\\",\\n \\"OverseasValue\\": \\"0\\",\\n \\"HttpsValue\\": \\"0\\",\\n \\"HttpsOverseasValue\\": \\"0\\",\\n \\"TimeStamp\\": \\"2019-01-20T13:59:58Z\\",\\n \\"DomesticValue\\": \\"0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVodDomainTrafficDataResponse>\\n <RequestId>D94E471F-1A27-442E-552D-D4D2000C****</RequestId>\\n <EndTime>2019-01-20T14:59:58Z</EndTime>\\n <TrafficDataPerInterval>\\n <DataModule>\\n <OverseasValue>0</OverseasValue>\\n <HttpsValue>0</HttpsValue>\\n <Value>0</Value>\\n <HttpsDomesticValue>0</HttpsDomesticValue>\\n <HttpsOverseasValue>0</HttpsOverseasValue>\\n <TimeStamp>2019-01-15T14:00:00Z</TimeStamp>\\n <DomesticValue>0</DomesticValue>\\n </DataModule>\\n <DataModule>\\n <OverseasValue>0</OverseasValue>\\n <HttpsValue>0</HttpsValue>\\n <Value>0</Value>\\n <HttpsDomesticValue>0</HttpsDomesticValue>\\n <HttpsOverseasValue>0</HttpsOverseasValue>\\n <TimeStamp>2019-01-15T14:00:00Z</TimeStamp>\\n <DomesticValue>0</DomesticValue>\\n </DataModule>\\n </TrafficDataPerInterval>\\n <DomainName>example.com</DomainName>\\n <DataInterval>3600</DataInterval>\\n <StartTime>2019-01-15T13:59:59Z</StartTime>\\n</DescribeVodDomainTrafficDataResponse>","errorExample":""}]', + 'title' => '查询流量', + 'description' => '- 目前该接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 支持批量查询，一次最多查询500个域名数据。'."\n" + .'- 如果您不指定`StartTime`和`EndTime`，该接口默认返回过去24小时的数据；指定`StartTime`和`EndTime`，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**返回数据时间粒度**'."\n" + ."\n" + .'根据您指定`StartTime`和`EndTime`的时间跨度，且未同时设置`Interval`的情况下，默认返回的数据时间粒度，以及对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的时间跨度 | 可查询历史数据时间范围 | 数据延迟 |'."\n" + .'| ------------- |------------ | ----------- | ----------- |'."\n" + .'|5分钟 | 单次查询的时间跨度 ＜ 3天 |93天 |15分钟 |'."\n" + .'|1小时 | 3天 ≤ 单次查询的时间跨度 ＜ 31天 |186 天 |一般延迟 3-4 小时 |'."\n" + .'| 1天 | 31天 ≤ 单次查询的时间跨度 ≤ 366天 |366 天 |一般延迟 4 小时，不超过 24 小时 |', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\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 CDN service yet. | 403 | 未开通CDN服务。|'."\n" + .'| OperationDenied | Your CDN service is suspended. | 403 | CDN服务已被停止。|'."\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" + .'| MissingParameter | StartTime and EndTime can not be single. | 400 | StartTime和EndTime不能单独设置。|'."\n" + .'| InvalidStartTime.Malformed | Specified start time is malformed. | 400 | StartTime格式错误。|'."\n" + .'| InvalidEndTime.Malformed | Specified end time is malformed. | 400 | EndTime格式错误。|'."\n" + .'| InvalidEndTime.Mismatch | Specified end time does not match the specified start time. | 400 | EndTime小于StartTime。|'."\n" + .'| InvalidStartTime.ValueNotSupported | Specified end time does not match the specified start time. | 400 | EndTime和StartTime差值超过90天。|', + ], + 'DescribeVodDomainBpsData' => [ + 'summary' => '调用本接口查询加速域名的带宽数据，相比DescribeVodDomainRealTimeBpsData接口，本接口支持可查询的历史数据时间范围更长（最长可查询最近366天的数据），但其数据时间粒度更大（最小为5分钟），数据延迟更高。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39876', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的加速域名。'."\n" + ."\n" + .'- 不传入该参数，则默认返回所有加速域名的合并数据。'."\n" + .'- 支持批量查询，多个域名之间用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + .'- 您可以登录[视频点播控制台](https://vod.console.aliyun.com)，从左侧导航选择**配置管理 > 分发加速配置 > 域名管理**，查看您已接入到视频点播的加速域名，或者调用[DescribeVodUserDomains](~~DescribeVodUserDomains~~)接口查询加速域名列表。', + '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' => '2015-12-10T13:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2015-12-10T14:00:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询数据的时间粒度。单位：秒。取值：**300**、**3600**和**86400**。不传和传的值不支持时，使用默认值。根据您指定的`StartTime`和`EndTime`的时间跨度，支持设置的时间粒度如下：'."\n" + ."\n" + .'- 3天以内（不包含3天整）支持：**300**（默认）、**3600**、**86400**。'."\n" + .'- 3-31天（不包含31天整）支持：**3600**（默认）和**86400**。'."\n" + .'- 31天以上支持：**86400**（默认）。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。不传入该参数，默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名。不传入该参数，默认查询所有地域。目前仅支持上海地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '数据的结束时间点。', + 'type' => 'string', + 'example' => '2015-12-10T14:00:00Z', + ], + 'StartTime' => [ + 'description' => '数据的起始时间点。', + 'type' => 'string', + 'example' => '2015-12-10T13:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3C6CCEC4-6B88-4D4A-****-D47B3D92CF8F', + ], + 'IspNameEn' => [ + 'description' => '运营商英文名。', + 'type' => 'string', + 'example' => 'unicom', + ], + 'LocationNameEn' => [ + 'description' => '地域英文名。', + 'type' => 'string', + 'example' => 'shanghai', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，即数据的时间粒度。单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'BpsDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的网络带宽数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HttpsDomesticValue' => [ + 'description' => 'L1节点HTTPS中国内地带宽。单位：bit/s。当按区域运营商查询时，此值为空。', + 'type' => 'string', + 'example' => '11286111', + ], + 'Value' => [ + 'description' => '总带宽数据。单位：bit/s。', + 'type' => 'string', + 'example' => '11288111', + ], + 'OverseasValue' => [ + 'description' => '全球（不包含中国内地）带宽数据。当按区域运营商查询时，此值为空。单位：bit/s。', + 'type' => 'string', + 'example' => '2000', + ], + 'HttpsValue' => [ + 'description' => 'L1节点HTTPS的带宽数据。单位：bit/s。', + 'type' => 'string', + 'example' => '11288111', + ], + 'HttpsOverseasValue' => [ + 'description' => 'L1节点全球（不包含中国内地）HTTPS 带宽。当按区域运营商查询时，此值为空。。单位：bit/s。', + 'type' => 'string', + 'example' => '2000', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳。日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2015-12-10T13:00:00Z', + ], + 'DomesticValue' => [ + 'description' => '中国内地带宽。当按区域运营商查询时，此值为空。单位：bit/s。', + 'type' => 'string', + 'example' => '11286111', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'The specified EndTime is earlier than the StartTime.', + ], + [ + 'errorCode' => 'Invalid.IspNameEn', + 'errorMessage' => 'The IspNameEn is invalid.', + ], + [ + 'errorCode' => 'Invalid.LocationNameEn', + 'errorMessage' => 'The LocationNameEn is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2015-12-10T14:00:00Z\\",\\n \\"StartTime\\": \\"2015-12-10T13:00:00Z\\",\\n \\"RequestId\\": \\"3C6CCEC4-6B88-4D4A-****-D47B3D92CF8F\\",\\n \\"IspNameEn\\": \\"unicom\\",\\n \\"LocationNameEn\\": \\"shanghai\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"BpsDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"HttpsDomesticValue\\": \\"11286111\\",\\n \\"Value\\": \\"11288111\\",\\n \\"OverseasValue\\": \\"2000\\",\\n \\"HttpsValue\\": \\"11288111\\",\\n \\"HttpsOverseasValue\\": \\"2000\\",\\n \\"TimeStamp\\": \\"2015-12-10T13:00:00Z\\",\\n \\"DomesticValue\\": \\"11286111\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVodDomainBpsDataResponse>\\n <BpsDataPerInterval>\\n <DataModule>\\n <TimeStamp>2015-12-10T13:00:00Z</TimeStamp>\\n <Value>11288111</Value>\\n <DomesticValue>11286111</DomesticValue>\\n <OverseasValue>2000</OverseasValue>\\n <HttpsValue>11288111</HttpsValue>\\n <HttpsDomesticValue>11286111</HttpsDomesticValue>\\n <HttpsOverseasValue>2000</HttpsOverseasValue>\\n </DataModule>\\n <DataModule>\\n <TimeStamp>2015-12-10T13:05:00Z</TimeStamp>\\n <Value>12124821</Value>\\n <DomesticValue>12112821</DomesticValue>\\n <OverseasValue>12000</OverseasValue>\\n <HttpsValue>11288111</HttpsValue>\\n <HttpsDomesticValue>11286111</HttpsDomesticValue>\\n <HttpsOverseasValue>2000</HttpsOverseasValue>\\n </DataModule>\\n </BpsDataPerInterval>\\n <DomainName>example.com</DomainName>\\n <DataInterval>300</DataInterval>\\n <RequestId>3C6CCEC4-6B88-4D4A-****-D47B3D92CF8F</RequestId>\\n <StartTime>2015-12-10T13:00:00Z</StartTime>\\n <EndTime>2015-12-10T14:00:00Z</EndTime>\\n</DescribeVodDomainBpsDataResponse>","errorExample":""}]', + 'title' => '查询带宽', + 'description' => '- 目前该接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 支持批量查询，一次最多查询500个域名数据。'."\n" + .'- 如果您不指定`StartTime`和`EndTime`，该接口默认返回过去24小时的数据；指定`StartTime`和`EndTime`，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**返回数据时间粒度**'."\n" + ."\n" + .'根据您指定`StartTime`和`EndTime`的时间跨度，且未同时设置`Interval`的情况下，默认返回的数据时间粒度，以及对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的时间跨度 | 可查询历史数据时间范围 | 数据延迟 |'."\n" + .'| ------------- |------------ | ----------- | ----------- |'."\n" + .'|5分钟 | 单次查询的时间跨度 ＜ 3天 |93天 |15分钟 |'."\n" + .'|1小时 | 3天 ≤ 单次查询的时间跨度 ＜ 31天 |186 天 |一般延迟 3-4 小时 |'."\n" + .'| 1天 | 31天 ≤ 单次查询的时间跨度 ≤ 90天 |366 天 |一般延迟 4 小时，不超过 24 小时 |', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidStartTime.Malformed | Specified StartTime is malformed. | 400 | StartTime格式错误。|'."\n" + .'| InvalidEndTime.Malformed | Specified EndTime is malformed. | 400 | EndTime格式错误。|'."\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。|', + ], + 'DescribeVodDomainBpsDataByLayer' => [ + 'summary' => '调用本接口按协议类型查询加速域名的带宽数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '178978', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的加速域名。'."\n" + ."\n" + .'- 不传入该参数，则默认返回所有加速域名的合并数据。'."\n" + .'- 支持批量查询，多个域名之间用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + .'- 您可以登录[视频点播控制台](https://vod.console.aliyun.com)，从左侧导航选择**配置管理 > 分发加速配置 > 域名管理**，查看您已接入到视频点播的加速域名，或者调用[DescribeVodUserDomains](~~DescribeVodUserDomains~~)接口查询加速域名列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-23T12:35:12Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-23T12:40:12Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询数据的时间粒度。单位：秒。取值：**300**、**3600**和**86400**。不传和传的值不支持时，使用默认值。根据您指定的`StartTime`和`EndTime`的时间跨度，支持设置的时间粒度如下：'."\n" + ."\n" + .'- 3天以内（不包含3天整）支持：**300**（默认）、**3600**、**86400**。'."\n" + .'- 3-31天（不包含31天整）支持：**3600**（默认）和**86400**。'."\n" + .'- 31天以上支持：**86400**（默认）。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。不传入该参数，默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名。不传入该参数，默认查询所有地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'beijing', + ], + ], + [ + 'name' => 'Layer', + 'in' => 'query', + 'schema' => [ + 'description' => '协议类型。可按网络层或应用层的维度指定查询的协议类型。'."\n" + ."\n" + .'默认取值：'."\n" + .'- all：包含网络层和应用层'."\n" + ."\n" + .'网络层取值：'."\n" + .'- IPv4'."\n" + .'- IPv6'."\n" + ."\n" + .'应用层取值：'."\n" + .'- http'."\n" + .'- https'."\n" + .'- quic', + 'type' => 'string', + 'required' => false, + 'example' => 'IPv4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，即数据的时间粒度。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'BpsDataInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的每秒访问次数Bps数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '峰值带宽，单位：bps。', + 'type' => 'number', + 'format' => 'double', + 'example' => '75.33', + ], + 'TrafficValue' => [ + 'description' => '总流量，单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳。日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2019-01-23T12:35:12Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified start time has invalid value.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataInterval\\": 300,\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"BpsDataInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": 75.33,\\n \\"TrafficValue\\": 1000,\\n \\"TimeStamp\\": \\"2019-01-23T12:35:12Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询带宽-按协议', + 'description' => '- 目前该接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 支持批量查询，一次最多查询500个域名数据。'."\n" + .'- 如果您不指定`StartTime`和`EndTime`，该接口默认返回过去24小时的数据；指定`StartTime`和`EndTime`，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**返回数据时间粒度**'."\n" + ."\n" + .'根据您指定`StartTime`和`EndTime`的时间跨度，且未同时设置`Interval`的情况下，默认返回的数据时间粒度，以及对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的时间跨度 | 可查询历史数据时间范围 | 数据延迟 |'."\n" + .'| ------------- |------------ | ----------- | ----------- |'."\n" + .'|5分钟 | 单次查询的时间跨度 ＜ 3天 |93天 |15分钟 |'."\n" + .'|1小时 | 3天 ≤ 单次查询的时间跨度 ＜ 31天 |186 天 |一般延迟 3-4 小时 |'."\n" + .'| 1天 | 31天 ≤ 单次查询的时间跨度 ≤ 366天 |366 天 |一般延迟 4 小时，不超过 24 小时 |', + ], + 'DescribeVodDomainQpsData' => [ + 'summary' => '获取5分钟计算粒度加速域名的每秒访问次数QPS，支持获取最近90天的数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39886', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持 500 个域名查询。'."\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' => false, + 'example' => '2024-05-02T15:50: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' => '2024-05-02T15:59:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的时间粒度。单位：秒。支持**300**、**3600**和**86400**。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。默认为所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名。不传该参数默认查询所有地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。格式为：<i>yyyy-mm-dd</i>t<i>hh:mm:ss</i>z（utc时间）。', + 'type' => 'string', + 'example' => '2024-05-02T15:59:00Z', + ], + 'StartTime' => [ + 'description' => '开始时间。格式为：<i>yyyy-mm-dd</i>t<i>hh:mm:ss</i>z（utc时间）。', + 'type' => 'string', + 'example' => '2024-05-02T15:50:00Z', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58*****', + ], + 'DomainName' => [ + 'description' => '加速域名信息。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔。单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'QpsDataInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的QPS数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '每个时间间隔的每秒访问次数qps。', + 'type' => 'object', + 'properties' => [ + 'AccValue' => [ + 'description' => '总访问次数。', + 'type' => 'string', + 'example' => '0', + ], + 'AccDomesticValue' => [ + 'description' => '中国内地访问次数。', + 'type' => 'string', + 'example' => '0', + ], + 'AccOverseasValue' => [ + 'description' => '全球（不包含中国内地）访问次数。', + 'type' => 'string', + 'example' => '0', + ], + 'HttpsValue' => [ + 'description' => '节点https的qps值。', + 'type' => 'string', + 'example' => '1', + ], + 'HttpsOverseasValue' => [ + 'description' => '节点https海外qps值。', + 'type' => 'string', + 'example' => '1', + ], + 'DomesticValue' => [ + 'description' => '中国内地qps。', + 'type' => 'string', + 'example' => '0', + ], + 'HttpsAccOverseasValue' => [ + 'description' => '节点https请求数。', + 'type' => 'string', + 'example' => '1', + ], + 'HttpsDomesticValue' => [ + 'description' => '节点https中国内地qps值。', + 'type' => 'string', + 'example' => '1', + ], + 'HttpsAccValue' => [ + 'description' => '节点https请求数。', + 'type' => 'string', + 'example' => '1', + ], + 'Value' => [ + 'description' => '总qps。', + 'type' => 'string', + 'example' => '0', + ], + 'OverseasValue' => [ + 'description' => '海外qps。', + 'type' => 'string', + 'example' => '0', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。使用utc时间，格式：yyyy-mm-ddthh:mm:ssz。', + 'type' => 'string', + 'example' => '2023-06-27 10:10:58', + ], + 'HttpsAccDomesticValue' => [ + 'description' => '节点https中国内地qps值。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2024-05-02T15:59:00Z\\",\\n \\"StartTime\\": \\"2024-05-02T15:50:00Z\\",\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58*****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"QpsDataInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"AccValue\\": \\"0\\",\\n \\"AccDomesticValue\\": \\"0\\",\\n \\"AccOverseasValue\\": \\"0\\",\\n \\"HttpsValue\\": \\"1\\",\\n \\"HttpsOverseasValue\\": \\"1\\",\\n \\"DomesticValue\\": \\"0\\",\\n \\"HttpsAccOverseasValue\\": \\"1\\",\\n \\"HttpsDomesticValue\\": \\"1\\",\\n \\"HttpsAccValue\\": \\"1\\",\\n \\"Value\\": \\"0\\",\\n \\"OverseasValue\\": \\"0\\",\\n \\"TimeStamp\\": \\"2023-06-27 10:10:58\\",\\n \\"HttpsAccDomesticValue\\": \\"1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询QPS', + 'description' => '- 目前该接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 单用户调用频率：100 次/秒。'."\n" + .'- 如果您不指定 StartTime 和 EndTime，该接口返回过去 24 小时的数据；指定 StartTime 和 EndTime，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，请求参数 Interval 支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + ."\n" + .'|时间粒度 |单次查询的最大时间跨度 |可查询历史数据时间范围 |数据延迟'."\n" + .'| ------------- |------------ | ----------- | ----------- |'."\n" + .'|5 分钟 |3 天 |93 天 |15 分钟'."\n" + .'|1 小时 |31 天 |186 天 |一般延迟 3-4 小时'."\n" + .'|1 天 |366 天 |366 天 |一般延迟 4 小时，不超过 24 小时'."\n" + .'*********', + ], + 'DescribeVodDomainHitRateData' => [ + 'summary' => '调用本接口查询加速域名的字节命中率（命中字节百分比）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39881', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的加速域名。'."\n" + ."\n" + .'- 不传入该参数，则默认返回所有加速域名的合并数据。'."\n" + .'- 支持批量查询，多个域名之间用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + .'- 您可以登录[视频点播控制台](https://vod.console.aliyun.com)，从左侧导航选择**配置管理 > 分发加速配置 > 域名管理**，查看您已接入到视频点播的加速域名，或者调用[DescribeVodUserDomains](~~DescribeVodUserDomains~~)接口查询加速域名列表。', + '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' => '2024-01-20T13:59:58Z'."\n", + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-20T14:59:58Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询数据的时间粒度。单位：秒。取值：**300**、**3600**和**86400**。不传和传的值不支持时，使用默认值。根据您指定的`StartTime`和`EndTime`的时间跨度，支持设置的时间粒度如下：'."\n" + ."\n" + .'- 3天以内（不包含3天整）支持：**300**（默认）、**3600**、**86400**。'."\n" + .'- 3-31天（不包含31天整）支持：**3600**（默认）和**86400**。'."\n" + .'- 31天以上支持：**86400**（默认）。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '数据的结束时间点。', + 'type' => 'string', + 'example' => '2024-01-20T14:59:58Z', + ], + 'StartTime' => [ + 'description' => '数据的起始时间点。', + 'type' => 'string', + 'example' => '2024-01-20T13:59:58Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D94E471F-1A27-442E-552D-D4D2000C****', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条数据的时间间隔，即数据的时间粒度。单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'HitRateInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的字节命中率数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '总字节命中率。', + 'type' => 'string', + 'example' => '100', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳。日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2024-01-20T13:59:58Z', + ], + 'HttpsValue' => [ + 'description' => 'HTTPS字节命中率。', + 'type' => 'string', + 'example' => '50', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2024-01-20T14:59:58Z\\",\\n \\"StartTime\\": \\"2024-01-20T13:59:58Z\\",\\n \\"RequestId\\": \\"D94E471F-1A27-442E-552D-D4D2000C****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"HitRateInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"100\\",\\n \\"TimeStamp\\": \\"2024-01-20T13:59:58Z\\",\\n \\"HttpsValue\\": \\"50\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询字节命中率', + 'description' => '- 目前该接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 支持批量查询，一次最多查询500个域名数据。'."\n" + .'- 如果您不指定`StartTime`和`EndTime`，该接口默认返回过去24小时的数据；指定`StartTime`和`EndTime`，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**返回数据时间粒度**'."\n" + ."\n" + .'根据您指定`StartTime`和`EndTime`的时间跨度，且未同时设置`Interval`的情况下，默认返回的数据时间粒度，以及对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的时间跨度 | 可查询历史数据时间范围 | 数据延迟 |'."\n" + .'| ------------- |------------ | ----------- | ----------- |'."\n" + .'|5分钟 | 单次查询的时间跨度 ＜ 3天 |93天 |15分钟 |'."\n" + .'|1小时 | 3天 ≤ 单次查询的时间跨度 ＜ 31天 |186 天 |一般延迟 3-4 小时 |'."\n" + .'| 1天 | 31天 ≤ 单次查询的时间跨度 ≤ 366天 |366 天 |一般延迟 4 小时，不超过 24 小时 |', + ], + 'DescribeVodDomainReqHitRateData' => [ + 'summary' => '调用本接口查询加速域名的请求命中率（命中请求百分比）。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '219327', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的加速域名。'."\n" + ."\n" + .'- 不传入该参数，则默认返回所有加速域名的合并数据。'."\n" + .'- 支持批量查询，多个域名之间用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + .'- 您可以登录[视频点播控制台](https://vod.console.aliyun.com)，从左侧导航选择**配置管理 > 分发加速配置 > 域名管理**，查看您已接入到视频点播的加速域名，或者调用[DescribeVodUserDomains](~~DescribeVodUserDomains~~)接口查询加速域名列表。', + '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' => '2023-12-21T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-12-22T08:00:00Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询数据的时间粒度。单位：秒。取值：**300**、**3600**和**86400**。不传和传的值不支持时，使用默认值。根据您指定的`StartTime`和`EndTime`的时间跨度，支持设置的时间粒度如下：'."\n" + ."\n" + .'- 3天以内（不包含3天整）支持：**300**（默认）、**3600**、**86400**。'."\n" + .'- 3-31天（不包含31天整）支持：**3600**（默认）和**86400**。'."\n" + .'- 31天以上支持：**86400**（默认）。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '数据的结束时间点。', + 'type' => 'string', + 'example' => '2023-12-22T08:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D94E471F-1A27-442E-552D-D4D2000C****', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的请求命中率数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '总请求命中率。', + 'type' => 'string', + 'example' => '100', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳。日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2023-12-21T08:00:00Z', + ], + 'HttpsValue' => [ + 'description' => 'HTTPS请求命中率。', + 'type' => 'string', + 'example' => '50', + ], + ], + ], + ], + ], + ], + 'StartTime' => [ + 'description' => '数据的起始时间点。', + 'type' => 'string', + 'example' => '2023-12-21T08:00:00Z', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条数据的时间间隔，即数据的时间粒度。单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidTime.ValueNotSupported', + 'errorMessage' => 'StartTime or EndTime is miss match.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2023-12-22T08:00:00Z\\",\\n \\"RequestId\\": \\"D94E471F-1A27-442E-552D-D4D2000C****\\",\\n \\"Data\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"100\\",\\n \\"TimeStamp\\": \\"2023-12-21T08:00:00Z\\",\\n \\"HttpsValue\\": \\"50\\"\\n }\\n ]\\n },\\n \\"StartTime\\": \\"2023-12-21T08:00:00Z\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\"\\n}","type":"json"}]', + 'title' => '查询请求命中率', + 'description' => '- 目前该接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 支持批量查询，一次最多查询500个域名数据。'."\n" + .'- 如果您不指定`StartTime`和`EndTime`，该接口默认返回过去24小时的数据；指定`StartTime`和`EndTime`，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**返回数据时间粒度**'."\n" + ."\n" + .'根据您指定`StartTime`和`EndTime`的时间跨度，且未同时设置`Interval`的情况下，默认返回的数据时间粒度，以及对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的时间跨度 | 可查询历史数据时间范围 | 数据延迟 |'."\n" + .'| ------------- |------------ | ----------- | ----------- |'."\n" + .'|5分钟 | 单次查询的时间跨度 ＜ 3天 |93天 |15分钟 |'."\n" + .'|1小时 | 3天 ≤ 单次查询的时间跨度 ＜ 31天 |186 天 |一般延迟 3-4 小时 |'."\n" + .'| 1天 | 31天 ≤ 单次查询的时间跨度 ≤ 90天 |366 天 |一般延迟 4 小时，不超过 24 小时 |', + ], + 'DescribeVodRangeDataByLocateAndIspService' => [ + 'summary' => '调用本接口按运营商或地域查询加速域名的访问数据，包括带宽、响应平均速率、页面浏览量、缓存命中率、请求命中率等数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '219275', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的加速域名。'."\n" + ."\n" + .'您可以登录[视频点播控制台](https://vod.console.aliyun.com)，从左侧导航选择**配置管理 > 分发加速配置 > 域名管理**，查看您已接入到视频点播的加速域名，或者调用[DescribeVodUserDomains](~~DescribeVodUserDomains~~)接口查询加速域名列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。 日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-05-29T03:50:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n" + .'> 结束时间需大于起始时间，并且结束时间和起始时间相差不超过1小时。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-05-29T03:55:00Z', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名。不传入该参数，默认查询所有地域。多个地域名之间用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'shanghai', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。不传入该参数，默认查询所有运营商。每次只能传入一个运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JsonResult' => [ + 'description' => 'JSON格式的返回结果。 从左到右依次为：unix时间，地区，运营商，HTTP状态码分布，响应时长，带宽（单位：bps），响应平均速率，页面浏览量，缓存命中率，请求命中率。', + 'type' => 'string', + 'example' => '{"1472659200":{"天津市":{"电信":{"http_codes":{"000":0,"200":6,"400":0},"rt":4183,"bandwidth":46639,"avg_speed":7773,"pv":6,"hit_rate":0.93,"request_hit_rate":0.66}}}}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C74802AA-C277-5A80-BDF2-072B05F119C7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidTime.ValueNotSupported', + 'errorMessage' => 'StartTime or EndTime is miss match.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JsonResult\\": \\"{\\\\\\"1472659200\\\\\\":{\\\\\\"天津市\\\\\\":{\\\\\\"电信\\\\\\":{\\\\\\"http_codes\\\\\\":{\\\\\\"000\\\\\\":0,\\\\\\"200\\\\\\":6,\\\\\\"400\\\\\\":0},\\\\\\"rt\\\\\\":4183,\\\\\\"bandwidth\\\\\\":46639,\\\\\\"avg_speed\\\\\\":7773,\\\\\\"pv\\\\\\":6,\\\\\\"hit_rate\\\\\\":0.93,\\\\\\"request_hit_rate\\\\\\":0.66}}}}\\",\\n \\"RequestId\\": \\"C74802AA-C277-5A80-BDF2-072B05F119C7\\"\\n}","type":"json"}]', + 'title' => '查询访问数据-按运营商和地域', + 'description' => '- 目前本接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 单次查询的时间跨度（即StartTime和EndTime的时间跨度）最大为1小时。'."\n" + ."\n" + .'**支持查询的时间粒度**'."\n" + ."\n" + .'根据您指定`StartTime`和`EndTime`的时间跨度，默认返回的数据时间粒度，以及对应的可查询历史数据时间范围和数据延迟如下：'."\n" + ."\n" + .'|时间粒度 |单次查询的时间跨度|可查询历史数据时间范围|数据延迟|'."\n" + .'| ------------- |------------ | ----------- | ----------- |'."\n" + .'|5分钟 |≤ 1小时 |93天 |15分钟|', + ], + 'DescribeVodDomainSrcTrafficData' => [ + 'summary' => '调用本接口查询加速域名的回源流量数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39899', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的加速域名。'."\n" + ."\n" + .'- 不传入该参数，则默认返回所有加速域名的合并数据。'."\n" + .'- 支持批量查询，多个域名之间用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + .'- 您可以登录[视频点播控制台](https://vod.console.aliyun.com)，从左侧导航选择**配置管理 > 分发加速配置 > 域名管理**，查看您已接入到视频点播的加速域名，或者调用[DescribeVodUserDomains](~~DescribeVodUserDomains~~)接口查询加速域名列表。', + '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-03-22T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-09-24T15:59:59Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询数据的时间粒度。单位：秒。取值：**300**、**3600**和**86400**。不传和传的值不支持时，使用默认值。根据您指定的`StartTime`和`EndTime`的时间跨度，支持设置的时间粒度如下：'."\n" + ."\n" + .'- 3天以内（不包含3天整）支持：**300**（默认）、**3600**、**86400**。'."\n" + .'- 3-31天（不包含31天整）支持：**3600**（默认）和**86400**。'."\n" + .'- 31天以上支持：**86400**（默认）。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '数据的结束时间点。', + 'type' => 'string', + 'example' => '2022-09-23T15:59:59Z', + ], + 'StartTime' => [ + 'description' => '数据的起始时间点。', + 'type' => 'string', + 'example' => '2022-08-29T16:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'TotalTraffic' => [ + 'description' => '总流量数据，单位：Byte。', + 'type' => 'string', + 'example' => '5906662826', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，即数据的时间粒度。单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'SrcTrafficDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的回源流量数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '总回源流量数据，单位：Byte。', + 'type' => 'string', + 'example' => '0', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳。日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2022-08-29T16:00:00Z', + ], + 'HttpsValue' => [ + 'description' => 'Https回源流量数据，单位：Byte。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2022-09-23T15:59:59Z\\",\\n \\"StartTime\\": \\"2022-08-29T16:00:00Z\\",\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"TotalTraffic\\": \\"5906662826\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"SrcTrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"0\\",\\n \\"TimeStamp\\": \\"2022-08-29T16:00:00Z\\",\\n \\"HttpsValue\\": \\"0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询回源流量', + 'description' => '- 目前该接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 支持批量查询，一次最多查询500个域名数据。'."\n" + .'- 如果您不指定`StartTime`和`EndTime`，该接口默认返回过去24小时的数据；指定`StartTime`和`EndTime`，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**返回数据时间粒度**'."\n" + ."\n" + .'根据您指定`StartTime`和`EndTime`的时间跨度，且未同时设置`Interval`的情况下，默认返回的数据时间粒度，以及对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的时间跨度 | 可查询历史数据时间范围 | 数据延迟 |'."\n" + .'| ------------- |------------ | ----------- | ----------- |'."\n" + .'|5分钟 | 单次查询的时间跨度 ＜ 3天 |93天 |15分钟 |'."\n" + .'|1小时 | 3天 ≤ 单次查询的时间跨度 ＜ 31天 |186 天 |一般延迟 3-4 小时 |'."\n" + .'| 1天 | 31天 ≤ 单次查询的时间跨度 ≤ 366天 |366 天 |一般延迟 4 小时，不超过 24 小时 |', + ], + 'DescribeVodDomainSrcBpsData' => [ + 'summary' => '调用本接口查询加速域名的回源带宽数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39898', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的加速域名。'."\n" + ."\n" + .'- 不传入该参数，则默认返回所有加速域名的合并数据。'."\n" + .'- 支持批量查询，多个域名之间用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + .'- 您可以登录[视频点播控制台](https://vod.console.aliyun.com)，从左侧导航选择**配置管理 > 分发加速配置 > 域名管理**，查看您已接入到视频点播的加速域名，或者调用[DescribeVodUserDomains](~~DescribeVodUserDomains~~)接口查询加速域名列表。', + '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-04-25T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-04-26T15:59:59Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询数据的时间粒度。单位：秒。取值：**300**、**3600**和**86400**。不传和传的值不支持时，使用默认值。根据您指定的`StartTime`和`EndTime`的时间跨度，支持设置的时间粒度如下：'."\n" + ."\n" + .'- 3天以内（不包含3天整）支持：**300**（默认）、**3600**、**86400**。'."\n" + .'- 3-31天（不包含31天整）支持：**3600**（默认）和**86400**。'."\n" + .'- 31天以上支持：**86400**（默认）。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '数据的结束时间点。', + 'type' => 'string', + 'example' => '2022-08-23T02:02:57Z', + ], + 'StartTime' => [ + 'description' => '数据的起始时间点。', + 'type' => 'string', + 'example' => '2022-07-12T16:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-****', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'sample.com', + ], + 'DataInterval' => [ + 'description' => '每条记录的时间间隔，即数据的时间粒度。单位：秒。', + 'type' => 'string', + 'example' => '300', + ], + 'SrcBpsDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的回源带宽数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '总回源带宽数据，单位：bit/s。', + 'type' => 'string', + 'example' => '0', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳。日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2022-07-12T16:00:00Z', + ], + 'HttpsValue' => [ + 'description' => 'Https回源带宽数据，单位：bit/s。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2022-08-23T02:02:57Z\\",\\n \\"StartTime\\": \\"2022-07-12T16:00:00Z\\",\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-****\\",\\n \\"DomainName\\": \\"sample.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"SrcBpsDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"0\\",\\n \\"TimeStamp\\": \\"2022-07-12T16:00:00Z\\",\\n \\"HttpsValue\\": \\"0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询回源带宽', + 'description' => '- 目前该接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 支持批量查询，一次最多查询500个域名数据。'."\n" + .'- 如果您不指定`StartTime`和`EndTime`，该接口默认返回过去24小时的数据；指定`StartTime`和`EndTime`，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**返回数据时间粒度**'."\n" + ."\n" + .'根据您指定`StartTime`和`EndTime`的时间跨度，且未同时设置`Interval`的情况下，默认返回的数据时间粒度，以及对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的时间跨度 | 可查询历史数据时间范围 | 数据延迟 |'."\n" + .'| ------------- |------------ | ----------- | ----------- |'."\n" + .'|5分钟 | 单次查询的时间跨度 ＜ 3天 |93天 |15分钟 |'."\n" + .'|1小时 | 3天 ≤ 单次查询的时间跨度 ＜ 31天 |186 天 |一般延迟 3-4 小时 |'."\n" + .'| 1天 | 31天 ≤ 单次查询的时间跨度 ≤ 366天 |366 天 |一般延迟 4 小时，不超过 24 小时 |', + ], + 'DescribeVodDomainRealTimeTrafficData' => [ + 'summary' => '调用本接口查询加速域名的流量数据，相比DescribeVodDomainTrafficData接口，本接口支持查询的数据时间粒度更小（最小为1分钟），数据延迟更低（最少为5分钟），但可查询的历史数据时间范围更短（最长可查询最近186天的数据）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39896', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的加速域名。'."\n" + .'- 多个域名用半角逗号（,）分隔，一次最多支持100个域名查询。 '."\n" + .'- 查询多个域名时，返回的数据为各域名合并后的数据值。'."\n" + .'- 您可以登录[视频点播控制台](https://vod.console.aliyun.com)，从左侧导航选择**配置管理 > 分发加速配置 > 域名管理**，查看您已接入到视频点播的加速域名，或者调用[DescribeVodUserDomains](~~DescribeVodUserDomains~~)接口查询加速域名列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-10T20:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。'."\n" + ."\n" + .'日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-10T20:01:00Z', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。不传该参数默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'telecom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名。不传该参数默认查询所有地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '数据的结束时间点。', + 'type' => 'string', + 'example' => '2019-12-10T20:01:00Z', + ], + 'StartTime' => [ + 'description' => '数据的起始时间点。', + 'type' => 'string', + 'example' => '2019-12-10T20:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A666D44F-19D6-490E-97CF-1A64AB962C57', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条数据的时间间隔，即数据的时间粒度，单位：秒。'."\n" + ."\n" + .'根据单次查询的时间跨度不同，该参数固定返回60（1分钟）、300（5分钟）或3600（1小时），具体请参见**接口说明**中的**返回数据时间粒度**。', + 'type' => 'string', + 'example' => '60', + ], + 'RealTimeTrafficDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => '每个时间间隔的流量数据详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '流量数据，单位：Byte。', + 'type' => 'string', + 'example' => '0', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳。日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2019-12-10T20:00: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.', + ], + [ + 'errorCode' => 'InvalidIspParameter', + 'errorMessage' => 'The specified Isp is invalid.', + ], + [ + 'errorCode' => 'InvalidLocName', + 'errorMessage' => 'The specified LocName is not supported.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2019-12-10T20:01:00Z\\",\\n \\"StartTime\\": \\"2019-12-10T20:00:00Z\\",\\n \\"RequestId\\": \\"A666D44F-19D6-490E-97CF-1A64AB962C57\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"60\\",\\n \\"RealTimeTrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"0\\",\\n \\"TimeStamp\\": \\"2019-12-10T20:00:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询实时流量', + 'description' => '- 目前该接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 支持批量查询，一次最多查询100个域名数据。'."\n" + .'- 如果您不指定`StartTime`和`EndTime`，该接口默认返回过去1小时的数据；指定`StartTime`和`EndTime`，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**返回数据时间粒度**'."\n" + ."\n" + .'根据您指定`StartTime`和`EndTime`时间跨度，会返回不同的数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的时间跨度 | 可查询历史数据时间范围 | 数据延迟 |'."\n" + .'| ------------- |------------ | ----------- | ----------- |'."\n" + .'|1分钟 | 单次查询的时间跨度 ≤ 1小时 |7天 |5分钟 |'."\n" + .'|5分钟 | 1小时 ＜ 单次查询的时间跨度 ＜ 3天 |93天 |15分钟 |'."\n" + .'|1小时 | 3天 ≤ 单次查询的时间跨度 ＜31天 |186天 |一般延迟 3-4 小时 |', + ], + 'DescribeVodDomainRealTimeBpsData' => [ + 'summary' => '调用本接口查询加速域名的带宽数据，相比DescribeVodDomainBpsData接口，本接口支持查询的数据时间粒度更小（最小为1分钟），数据延迟更低（最少为5分钟），但可查询的历史数据时间范围更短（最长可查询最近186天的数据）。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39887', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的加速域名。'."\n" + .'- 多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + .'- 查询多个域名时，返回的数据为各域名合并后的数据值。'."\n" + .'- 您可以登录[视频点播控制台](https://vod.console.aliyun.com)，从左侧导航选择**配置管理 > 分发加速配置 > 域名管理**，查看您已接入到视频点播的加速域名，或者调用[DescribeVodUserDomains](~~DescribeVodUserDomains~~)接口查询加速域名列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。不传该参数默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'telecom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名。不传该参数默认查询所有地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:33:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:40:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B49E6DDA-F413-422B-B58E-2FA23F286726', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'BpsModel' => [ + 'description' => '返回数据详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Bps' => [ + 'description' => '带宽数据，单位：bit/s。', + 'type' => 'number', + 'format' => 'float', + 'example' => '16710625.733333332', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳。日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2019-11-30T05:33:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'Specified domain name is malformed.', + ], + [ + 'errorCode' => 'InvalidIspParameter', + 'errorMessage' => 'The specified Isp is invalid.', + ], + [ + 'errorCode' => 'InvalidLocName', + 'errorMessage' => 'The specified LocName is not supported.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B49E6DDA-F413-422B-B58E-2FA23F286726\\",\\n \\"Data\\": {\\n \\"BpsModel\\": [\\n {\\n \\"Bps\\": 16710625.733333332,\\n \\"TimeStamp\\": \\"2019-11-30T05:33:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询实时带宽', + 'description' => '- 目前该接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 支持批量查询，一次最多查询500个域名数据。'."\n" + .'- 如果您不指定`StartTime`和`EndTime`，该接口默认返回过去1小时的数据；指定`StartTime`和`EndTime`，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**返回数据时间粒度**'."\n" + ."\n" + .'根据您指定`StartTime`和`EndTime`时间跨度，会返回不同的数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的时间跨度 | 可查询历史数据时间范围 | 数据延迟 |'."\n" + .'| ------------- |------------ | ----------- | ----------- |'."\n" + .'|1分钟 | 单次查询的时间跨度 ≤ 1小时 |7天 |5分钟 |'."\n" + .'|5分钟 | 1小时 ＜ 单次查询的时间跨度 ＜ 3天 |93天 |15分钟 |'."\n" + .'|1小时 | 3天 ≤ 单次查询的时间跨度 ＜ 31天 |186天 |一般延迟 3-4 小时 |', + ], + 'DescribeVodDomainRealTimeHttpCodeData' => [ + 'summary' => '调用本接口查询加速域名HTTP状态码的总数和占比数据。本接口支持查询的数据时间粒度最小为1分钟，数据延迟最少为5分钟，最长可查询最近186天的数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39890', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的加速域名。'."\n" + .'- 多个域名用半角逗号（,）分隔，一次最多支持100个域名查询。'."\n" + .'- 查询多个域名时，返回的数据为各域名合并后的数据值。'."\n" + .'- 您可以登录[视频点播控制台](https://vod.console.aliyun.com)，从左侧导航选择**配置管理 > 分发加速配置 > 域名管理**，查看您已接入到视频点播的加速域名，或者调用[DescribeVodUserDomains](~~DescribeVodUserDomains~~)接口查询加速域名列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:39:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-11-30T05:40:00Z', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。不传该参数默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名。不传该参数默认查询所有地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '数据的结束时间点。', + 'type' => 'string', + 'example' => '2019-11-30T05:40:00Z', + ], + 'StartTime' => [ + 'description' => '数据的起始时间点。', + 'type' => 'string', + 'example' => '2019-11-30T05:39:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC858082-736F-4A25-867B-E5B67C85ACF7', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DataInterval' => [ + 'description' => '每条数据的时间间隔，单位：秒。'."\n" + ."\n" + .'根据单次查询的时间跨度不同，该参数固定返回60（1分钟）、300（5分钟）或3600（1小时），具体请参见**接口说明**中的**返回数据时间粒度**。', + 'type' => 'string', + 'example' => '60', + ], + 'RealTimeHttpCodeData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UsageData' => [ + 'description' => '每个时间间隔的HTTP状态码占比数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '数据时间戳。日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2019-11-30T05:39:00Z', + ], + 'Value' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RealTimeCodeProportionData' => [ + 'description' => '各状态码占比使用数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '500', + ], + 'Proportion' => [ + 'description' => '该HTTP状态码的占比（百分比数据）。', + 'type' => 'string', + 'example' => '28.4496124031008', + ], + 'Count' => [ + 'description' => '该HTTP状态码的总数。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2019-11-30T05:40:00Z\\",\\n \\"StartTime\\": \\"2019-11-30T05:39:00Z\\",\\n \\"RequestId\\": \\"BC858082-736F-4A25-867B-E5B67C85ACF7\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"60\\",\\n \\"RealTimeHttpCodeData\\": {\\n \\"UsageData\\": [\\n {\\n \\"TimeStamp\\": \\"2019-11-30T05:39:00Z\\",\\n \\"Value\\": {\\n \\"RealTimeCodeProportionData\\": [\\n {\\n \\"Code\\": \\"500\\",\\n \\"Proportion\\": \\"28.4496124031008\\",\\n \\"Count\\": \\"100\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询实时HTTP状态码', + 'description' => '- 目前该接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 支持批量查询，一次最多查询100个域名数据。'."\n" + .'- 如果您不指定`StartTime`和`EndTime`，该接口默认返回过去1小时的数据；指定`StartTime`和`EndTime`，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**返回数据时间粒度**'."\n" + ."\n" + .'根据您指定`StartTime`和`EndTime`时间跨度，会返回不同的数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的时间跨度 | 可查询历史数据时间范围 | 数据延迟 |'."\n" + .'| ------------- |------------ | ----------- | ----------- |'."\n" + .'|1分钟 | 单次查询的时间跨度 ≤ 1小时 |7天 |5分钟 |'."\n" + .'|5分钟 | 1小时 ＜ 单次查询的时间跨度 ＜ 3天 |93天 |15分钟 |'."\n" + .'|1小时 | 3天 ≤ 单次查询的时间跨度 ＜31天 |186天 |一般延迟 3-4 小时 |', + ], + 'DescribeVodDomainRealTimeQpsData' => [ + 'summary' => '调用本接口查询加速域名每秒访问次数的数据。本接口支持查询的数据时间粒度最小为1分钟，数据延迟最少为5分钟，最长可查询最近186天的数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39892', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的加速域名。'."\n" + .'- 多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。'."\n" + .'- 查询多个域名时，返回的数据为各域名合并后的数据值。'."\n" + .'- 您可以登录[视频点播控制台](https://vod.console.aliyun.com)，从左侧导航选择**配置管理 > 分发加速配置 > 域名管理**，查看您已接入到视频点播的加速域名，或者调用[DescribeVodUserDomains](~~DescribeVodUserDomains~~)接口查询加速域名列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。不传该参数默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名。不传该参数默认查询所有地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-02T11:25:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-12-02T11:26:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '32DC9806-E9F9-4490-BBDC-B3A9E32FCC1D', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'QpsModel' => [ + 'description' => '返回数据详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Qps' => [ + 'description' => 'QPS（每秒访问次数）数据。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1851.25', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳。日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2019-12-02T11:25:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'Specified domain name is malformed.', + ], + [ + 'errorCode' => 'InvalidIspParameter', + 'errorMessage' => 'The specified Isp is invalid.', + ], + [ + 'errorCode' => 'InvalidLocName', + 'errorMessage' => 'The specified LocName is not supported.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32DC9806-E9F9-4490-BBDC-B3A9E32FCC1D\\",\\n \\"Data\\": {\\n \\"QpsModel\\": [\\n {\\n \\"Qps\\": 1851.25,\\n \\"TimeStamp\\": \\"2019-12-02T11:25:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询实时QPS', + 'description' => '- 目前该接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 支持批量查询，一次最多查询500个域名数据。'."\n" + .'- 如果您不指定`StartTime`和`EndTime`，该接口默认返回过去1小时的数据；指定`StartTime`和`EndTime`，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**返回数据时间粒度**'."\n" + ."\n" + .'根据您指定`StartTime`和`EndTime`时间跨度，会返回不同的数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的时间跨度 | 可查询历史数据时间范围 | 数据延迟 |'."\n" + .'| ------------- |------------ | ----------- | ----------- |'."\n" + .'|1分钟 | 单次查询的时间跨度 ≤ 1小时 |7天 |5分钟 |'."\n" + .'|5分钟 | 1小时 ＜ 单次查询的时间跨度 ＜ 3天 |93天 |15分钟 |'."\n" + .'|1小时 | 3天 ≤ 单次查询的时间跨度 ＜31天 |186天 |一般延迟 3-4 小时 |', + ], + 'DescribeVodDomainRealTimeReqHitRateData' => [ + 'summary' => '调用本接口查询加速域名的请求命中率数据。本接口支持查询的数据时间粒度最小为1分钟，数据延迟最少为5分钟，最长可查询最近186天的数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39893', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名，多个域名用半角逗号（,）分隔，一次最多支持100个域名查询。查询多个域名时，返回的数据为各域名合并后的数据值。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-02T11:23:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-02T11:26:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '70A26B11-3673-479C-AEA8-E03FC5D3496D', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReqHitRateDataModel' => [ + 'description' => '返回数据详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReqHitRate' => [ + 'description' => '请求命中率（百分比数据）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8956940476262277', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳，日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2024-01-02T11:26:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'Specified domain name is malformed.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"70A26B11-3673-479C-AEA8-E03FC5D3496D\\",\\n \\"Data\\": {\\n \\"ReqHitRateDataModel\\": [\\n {\\n \\"ReqHitRate\\": 0.8956940476262277,\\n \\"TimeStamp\\": \\"2024-01-02T11:26:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询实时请求命中率', + 'description' => '- 目前该接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 支持批量查询，一次最多查询100个域名数据。'."\n" + .'- 如果您不指定`StartTime`和`EndTime`，该接口默认返回过去1小时的数据；指定`StartTime`和`EndTime`，该接口返回指定时间段的数据。'."\n" + .'- Go语言默认是用POST方式请求，需手动修改使用GET方式请求，声明`request.Method="GET"`。'."\n" + ."\n" + .'**返回数据时间粒度**'."\n" + ."\n" + .'根据您指定`StartTime`和`EndTime`时间跨度，会返回不同的数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的时间跨度 | 可查询历史数据时间范围 | 数据延迟 |'."\n" + .'| ------------- |------------ | ----------- | ----------- |'."\n" + .'|1分钟 | 单次查询的时间跨度 ≤ 1小时 |7天 |5分钟 |'."\n" + .'|5分钟 | 1小时 ＜ 单次查询的时间跨度 ＜ 3天 |93天 |15分钟 |'."\n" + .'|1小时 | 3天 ≤ 单次查询的时间跨度 ＜ 31天 |186天 |一般延迟 3-4 小时 |', + ], + 'DescribeVodDomainRealTimeByteHitRateData' => [ + 'summary' => '调用本接口查询加速域名的字节命中率数据。本接口支持查询的数据时间粒度最小为1分钟，数据延迟最少为5分钟，最长可查询最近186天的数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39888', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的加速域名。'."\n" + .'- 多个域名用半角逗号（,）分隔，一次最多支持100个域名查询。'."\n" + .'- 查询多个域名时，返回的数据为各域名合并后的数据值。'."\n" + .'- 您可以登录[视频点播控制台](https://vod.console.aliyun.com)，从左侧导航选择**配置管理 > 分发加速配置 > 域名管理**，查看您已接入到视频点播的加速域名，或者调用[DescribeVodUserDomains](~~455030~~)接口查询加速域名列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的起始时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-05-15T09:13:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-05-15T09:15:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '70A26B11-3673-479C-AEA8-E03FC5D3496D', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ByteHitRateDataModel' => [ + 'description' => '返回数据详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ByteHitRate' => [ + 'description' => '字节命中率（百分比数据）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8956940476262277', + ], + 'TimeStamp' => [ + 'description' => '数据时间戳，日期格式按照ISO8601表示法，并使用UTC时间。', + 'type' => 'string', + 'example' => '2020-05-15T09:13:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'Specified domain name is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidParameterType', + 'errorMessage' => 'The specified Type is invalid.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid input parameter.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"70A26B11-3673-479C-AEA8-E03FC5D3496D\\",\\n \\"Data\\": {\\n \\"ByteHitRateDataModel\\": [\\n {\\n \\"ByteHitRate\\": 0.8956940476262277,\\n \\"TimeStamp\\": \\"2020-05-15T09:13:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询实时字节命中率', + 'description' => '- 目前该接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 支持批量查询，一次最多查询100个域名数据。'."\n" + .'- 如果您不指定`StartTime`和`EndTime`，该接口默认返回过去1小时的数据；指定`StartTime`和`EndTime`，该接口返回指定时间段的数据。'."\n" + ."\n" + .'**返回数据时间粒度**'."\n" + ."\n" + .'根据您指定`StartTime`和`EndTime`时间跨度，会返回不同的数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：'."\n" + .'|时间粒度 |单次查询的时间跨度 | 可查询历史数据时间范围 | 数据延迟 |'."\n" + .'| ------------- |------------ | ----------- | ----------- |'."\n" + .'|1分钟 | 单次查询的时间跨度 ≤ 1小时 |7天 |5分钟 |'."\n" + .'|5分钟 | 1小时 ＜ 单次查询的时间跨度 ＜ 3天 |93天 |15分钟 |'."\n" + .'|1小时 | 3天 ≤ 单次查询的时间跨度 ＜ 31天 |186天 |一般延迟 3-4 小时 |', + ], + 'DescribeVodDomainRealTimeDetailData' => [ + 'summary' => '调用本接口查询加速域名的实时访问数据，可查询最近7天内的QPS、带宽、HTTP状态码数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39889', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的加速域名。'."\n" + ."\n" + .'- 支持批量查询，多个域名之间用半角逗号（,）分隔，一次最多支持20个域名查询。'."\n" + .'- 您可以登录[视频点播控制台](https://vod.console.aliyun.com)，从左侧导航选择**配置管理 > 分发加速配置 > 域名管理**，查看您已接入到视频点播的加速域名，或者调用[DescribeVodUserDomains](~~DescribeVodUserDomains~~)接口查询加速域名列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。 日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-01-23T12:35:12Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据的结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 结束时间需大于起始时间，并且结束时间和起始时间相差不超过10分钟。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-01-23T12:40:00Z', + ], + ], + [ + 'name' => 'Field', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询的访问数据类型，可同时指定多个访问数据，多个访问数据之间用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **qps**：每秒访问次数。'."\n" + .'- **bps**：带宽数据。'."\n" + .'- **http_code**：HTTP状态码。', + 'type' => 'string', + 'required' => true, + 'example' => 'qps', + ], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '地域英文名。不传入该参数，默认查询所有地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'shanghai', + ], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商英文名。不传入该参数，默认查询所有运营商。', + 'type' => 'string', + 'required' => false, + 'example' => 'unicom', + ], + ], + [ + 'name' => 'Merge', + 'in' => 'query', + 'schema' => [ + 'description' => '是否按域名维度返回汇总后的数据。取值：'."\n" + ."\n" + .'- **true**：是，返回的数据为各域名汇总后的值。'."\n" + .'- **false**（默认值）：否，返回的数据将按域名维度进行分组展示。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'MergeLocIsp', + 'in' => 'query', + 'schema' => [ + 'description' => '是否按地域和运营商维度返回汇总后的数据。取值：'."\n" + ."\n" + .'- **true**：是，返回的数据，仅按域名维度进行分组，会汇总各地域和运营商的值。'."\n" + .'- **false**（默认值）：否，返回的数据，按域名、地域、运营商的维度进行分组展示。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据详情。按JSON字符串返回，具体结构及字段描述如下：'."\n" + .'> 如对应字段没有数据则不返回该字段。'."\n" + ."\n" + .'|字段名称 |类型 | 描述 |'."\n" + .'| ------------- |------------ | ----------- | '."\n" + .'|domain_name | String |查询的加速域名。 |'."\n" + .'|isp | String |运营商名称。 |'."\n" + .'| location | String |地域名称。 |'."\n" + .'| qps | Long |每秒访问次数。 |'."\n" + .'| bps | Long |带宽数据，单位：bit/s。 |'."\n" + .'| http_code | Map |HTTP状态码详情。键为状态码名称，值为状态码数量。 |'."\n" + .'| time_stp | String |数据时间戳。日期格式按照ISO8601表示法，并使用UTC时间。 |', + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "time_stp": "2018-06-05T20:00:00Z",'."\n" + .' "domain_name": "example.com",'."\n" + .' "location": "Guangdong",'."\n" + .' "isp": "telecom",'."\n" + .' "qps": 10'."\n" + .' },'."\n" + .' {'."\n" + .' "time_stp": "2018-06-05T20:00:00Z",'."\n" + .' "domain_name": "example.com",'."\n" + .' "location": "Jiangsu",'."\n" + .' "isp": "unicom",'."\n" + .' "qps": 11.1'."\n" + .' }'."\n" + .']', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1710298E-8AFA-5F6D-A3E9-47103C52177D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'Specified domain name is malformed.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"[\\\\n {\\\\n \\\\\\"time_stp\\\\\\": \\\\\\"2018-06-05T20:00:00Z\\\\\\",\\\\n \\\\\\"domain_name\\\\\\": \\\\\\"example.com\\\\\\",\\\\n \\\\\\"location\\\\\\": \\\\\\"Guangdong\\\\\\",\\\\n \\\\\\"isp\\\\\\": \\\\\\"telecom\\\\\\",\\\\n \\\\\\"qps\\\\\\": 10\\\\n },\\\\n {\\\\n \\\\\\"time_stp\\\\\\": \\\\\\"2018-06-05T20:00:00Z\\\\\\",\\\\n \\\\\\"domain_name\\\\\\": \\\\\\"example.com\\\\\\",\\\\n \\\\\\"location\\\\\\": \\\\\\"Jiangsu\\\\\\",\\\\n \\\\\\"isp\\\\\\": \\\\\\"unicom\\\\\\",\\\\n \\\\\\"qps\\\\\\": 11.1\\\\n }\\\\n]\\",\\n \\"RequestId\\": \\"1710298E-8AFA-5F6D-A3E9-47103C52177D\\"\\n}","type":"json"}]', + 'title' => '查询实时访问详细数据', + 'description' => '- 目前本接口服务地址仅支持：**华东 2（上海）**。'."\n" + .'- 支持批量查询，一次最多查询20个域名数据。'."\n" + .'- 单次查询的时间跨度（即StartTime和EndTime的时间跨度）最大为10分钟，数据返回的时间粒度为1分钟。'."\n" + .'- 仅支持查询最近7天内的数据。', + ], + 'AddVodDomain' => [ + 'summary' => '调用本接口添加点播加速域名。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39790', + 'abilityTreeNodes' => [ + 'FEATUREvodHI57GB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要接入点播的加速域名。支持泛域名，以英文句号（.）开头，如：.example.com。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'schema' => [ + 'description' => '回源地址列表。参数详情，请参见下表**Sources**。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"content":"1.1.1.1","type":"ipaddr","priority":"20","port":80}]', + ], + ], + [ + 'name' => 'CheckUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '健康检测URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com/test.html', + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'schema' => [ + 'description' => '国际用户、中国内地L3及以上用户设置有效。 取值范围：'."\n" + .'- **domestic**（默认）：中国大陆。'."\n" + .'- **overseas**：港澳台及海外。'."\n" + .'- **global**：全球加速。', + 'type' => 'string', + 'required' => false, + 'example' => 'domestic', + ], + ], + [ + 'name' => 'TopLevelDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '顶级接入域。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-****-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'Specified DomainName is malformed.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The input parameter cdnType that is mandatory for processing this request is not supplied.', + ], + [ + 'errorCode' => 'InvalidCdnType.Malformed', + 'errorMessage' => 'Specified CdnType is malformed.', + ], + [ + 'errorCode' => 'InvalidSources.Malformed', + 'errorMessage' => 'Specified Sources is malformed.', + ], + [ + 'errorCode' => 'InvalidSourceStr.Malformed', + 'errorMessage' => 'Specified SourceStr is malformed.', + ], + [ + 'errorCode' => 'InvalidSourceType.Malformed', + 'errorMessage' => 'Specified CdnType is malformed.', + ], + [ + 'errorCode' => 'InvalidSource.Priority.Malformed', + 'errorMessage' => 'The specified Source Priority is invalid.', + ], + [ + 'errorCode' => 'InvalidTypeAndContent.MissMatch', + 'errorMessage' => 'The specified source type does not match the specified source content.', + ], + [ + 'errorCode' => 'InvalidScope.Malformed', + 'errorMessage' => 'Specified Scope is malformed.', + ], + [ + 'errorCode' => 'DomainOverLimit', + 'errorMessage' => 'The Number of Domain is over the limit', + ], + [ + 'errorCode' => 'DomainAlreadyExist', + 'errorMessage' => 'This domain name is exist already', + ], + [ + 'errorCode' => 'DomainNotRegistration', + 'errorMessage' => 'The Domain name is not registered', + ], + [ + 'errorCode' => 'InvaildParameter', + 'errorMessage' => 'Source name can not equal to domain name', + ], + [ + 'errorCode' => 'IllegalSources', + 'errorMessage' => 'The specified origin site information is invalid.', + ], + [ + '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' => 'DomainReserved', + 'errorMessage' => 'The root domain of your domain is reserved by another account. Submit a ticket to contact customer support.', + ], + [ + 'errorCode' => 'InvalidDomainNameLevel', + 'errorMessage' => 'Domain name suffixed with alicdn.com only support third level.', + ], + [ + 'errorCode' => 'InvalidTopLevelDomain.Malformed', + 'errorMessage' => 'Specified TopLevelDomain is malformed.', + ], + [ + 'errorCode' => 'TopLevelDomain.NotFound', + 'errorMessage' => 'The specified TopLevelDomain does 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' => 'TopLevelDomain.Mismatch', + 'errorMessage' => 'The specified TopLevelDomain does not match webSiteType.', + ], + [ + 'errorCode' => 'DomainOwnerVerifyFail', + 'errorMessage' => 'Owner verification of the root domain failed.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-****-2C4477247A74\\"\\n}","errorExample":""},{"type":"xml","example":"<AddVodDomainResponse>\\r\\n <RequestId>15C66C7B-671A-4297-****-2C4477247A74</RequestId>\\r\\n</AddVodDomainResponse>","errorExample":""}]', + 'title' => '添加加速域名', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 创建加速域名之前，您需要先开通[点播服务](~~51512~~)，并且加速域名必须已备案完成。 '."\n" + .'- 源站内容。如果不在阿里云平台上，需要审核，审核工作会在下一工作日前完成。'."\n" + .'- 每次只能提交一个加速域名，一个用户最多添加20个域名。', + 'requestParamsDescription' => '## Sources '."\n" + .'| 名称 | 类型 | 是否必需 | 描述 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| type |String |是 |源站类型。取值：<br>**ipaddr**：IP源站。<br>**domain**：域名源站。<br>**oss**：OSS Bucket为源站。|'."\n" + .'| content |String |是 |回源地址，可以是IP或域名。|'."\n" + .'| port |Integer |否 |端口号。可以指定**443**、**80**。默认值**80**。**443**端口使用HTTPS回源。也可以自定义端口。|'."\n" + .'| priority |String |否 |源站地址对应的优先级。支持**20**和**30**，默认值为**20**。**20**是主源，**30**是备源。|', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidDomainName.Malformed | Specified DomainName is malformed. | 400 | DomainName 参数错误|'."\n" + .'| InvalidCdnType.Malformed | Specified CdnType is malformed. | 400 | CdnType 参数错误。|'."\n" + .'| InvalidSourceType.Malformed | Specified SourceType is malformed. | 400 | SourceType 参数错误。|'."\n" + .'| InvalidSources.Malformed | Specified Sources is malformed. | 400 | 回源地址与源站类型不一致。|'."\n" + .'| InvalidScope.Malformed | Specified Scope is malformed. | 400 | Scope 参数错误。|'."\n" + .'| InvaildParameter | The Certificate you provided is malformed! | 400 | HTTPS安全加速时证书和密钥长度和过长。|'."\n" + .'| BusinessExist | Business exist do not repeated submission | 400 | 该域名正在添加，不用重复提交。|'."\n" + .'| DomainAlreadyExist | This domain name is exist already | 400 | 该域名已经添加。|'."\n" + .'| DomainOverLimit | The Number of Domain is over the limit | 403 | 超过域名个数限制。|'."\n" + .'| DomainNotRegistration | The Domain name is not registered | 404 | 该域名没有备案。|'."\n" + .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 没有权限执行当前操作。|'."\n" + .'| ServiceBusy | The specified Domain is configuring, please retry later. | 403 | 域名正在配置中, 请稍后再试。|'."\n" + .'| InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不属于当前用户。|'."\n" + .'| InnerAddDomainDenied | Your account haven’t bind aoneId, can not add domain. | 400 | 内部账号未绑定aoneId，不能添加域名。|'."\n" + .'| ExtensiveAndAllBothExist | Extensive domain and the domain begins with ‘all.’ can not exist at the same time. | 400 | 泛域名与all.开头域名不能同时存在。|'."\n" + .'| CdnTypeNotSupportExtensiveDomain | Extensive domain not supported for this cdn type. | 400 | 泛域名不支持该业务类型。|'."\n" + .'| ExtensiveAndSpecificDomainConflict | Extensive domain and corresponding specific domain are mutually exclusive. | 400 | 泛域名与对应同级别精确域名互斥。|'."\n" + .'| InvalidParameter | Add live region parameters have error. | 400 | 添加的直播region信息时出错。|'."\n" + .'| InvalidRegion.Malformed | Specified Region is malformed. | 400 | region参数不正确。|'."\n" + .'| InvalidResourceGroupId.Malformed | Specified ResourceGroupId is malformed. | 400 | ResourceGroupId参数不正确。|'."\n" + .'| EntityNotExists.ResourceGroup | The resource group does not exist. | 400 | 资源组不存在。|'."\n" + .'| InvalidStatus.ResourceGroup | It’s now allowed to do this operation because of the current status of resource-group. | 400 | 资源组状态检查失败。|'."\n" + .'| InvalidPriorities.Malformed | The length of priorities is not the same with source. | 400 | 优先级个数与源站个数不同。|'."\n" + .'| NotInternationRealIdentity | You need to do real name authentication when you use Chinese mainland resources. | 400 | 用中国大陆资源时，账号需要国际认证。|', + ], + 'DeleteVodDomain' => [ + 'summary' => '调用本接口删除已添加的点播加速域名。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39847', + 'abilityTreeNodes' => [ + 'FEATUREvodHI57GB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + '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' => '15C66C7B-671A-4297-****-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ServiceBusy', + 'errorMessage' => 'The specified Domain is configuring, please retry later', + ], + ], + [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not belong to you.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-****-2C4477247A74\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteVodDomainResponse>\\r\\n <RequestId>15C66C7B-671A-4297-****-2C4477247A74</RequestId>\\r\\n</DeleteVodDomainResponse>","errorExample":""}]', + 'title' => '删除加速域名', + 'description' => '>- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'>- 此操作会导致域名不可访问，请慎重操作。建议您删除域名前到域名解析服务商处恢复域名A记录。'."\n" + .'>- 删除域名调用成功后，将删除本条点播域名的全部相关记录。对于仅需要暂停使用该点播域名，推荐使用[停用加速域名](~~120208~~)接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvaildParameter |The specific value of parameter DomainName is malformed. | 400 |DomainName参数错误。|', + ], + 'UpdateVodDomain' => [ + 'summary' => '调用本接口修改加速域名。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40233', + 'abilityTreeNodes' => [ + 'FEATUREvodHI57GB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The accelerated domain name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Sources', + 'in' => 'query', + 'schema' => [ + 'description' => 'The addresses of the origin server. For more information about the Sources parameter, see the **Sources** section.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"content":"1.1.1.1","type":"ipaddr","priority":"20","port":80}]', + ], + ], + [ + 'name' => 'TopLevelDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The top-level domain.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-****-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingDomainName', + 'errorMessage' => 'The domainName parameter is required.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + [ + 'errorCode' => 'InvalidSource.Content.Malformed', + 'errorMessage' => 'The specified Source Content is invalid.', + ], + [ + 'errorCode' => 'InvalidTypeContent.Mismatch', + 'errorMessage' => 'The specified source type does not match the specified source content.', + ], + [ + 'errorCode' => 'MissingSource.Content', + 'errorMessage' => 'The Source Content must be specified.', + ], + [ + 'errorCode' => 'MissingSource.Type', + 'errorMessage' => 'The Source Type must be specified.', + ], + [ + 'errorCode' => 'InvalidSource.Type.Malformed', + 'errorMessage' => 'The specified Source Type is invalid.', + ], + [ + 'errorCode' => 'InvalidSource.Priority.Malformed', + 'errorMessage' => 'The specified Source Priority is invalid.', + ], + [ + 'errorCode' => 'InvalidSources.Malformed', + 'errorMessage' => 'Specified Sources is malformed.', + ], + [ + 'errorCode' => 'IllegalSources', + 'errorMessage' => 'The specified origin site information is invalid.', + ], + [ + 'errorCode' => 'TopLevelDomain.NotFound', + 'errorMessage' => 'The specified TopLevelDomain does not exist.', + ], + ], + 403 => [ + [ + 'errorCode' => 'DomainInProtectedMode', + 'errorMessage' => 'The domain is in protection mode. To request permission, contact Customer Service.', + ], + [ + 'errorCode' => 'ServiceBusy', + 'errorMessage' => 'The specified Domain is configuring, please retry later', + ], + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => 'Illegal domain operate is not permitted.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not belong to you.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-****-2C4477247A74\\"\\n}","type":"json"}]', + 'title' => '修改加速域名', + 'description' => '> This operation is available only in the **China (Shanghai)** region.', + 'requestParamsDescription' => '## Sources'."\n" + ."\n" + .'|Parameter|Type|Required|Description|'."\n" + .'|---|---|---|---|'."\n" + .'|type|String|Yes|The type of the origin server. Valid values:**ipaddr**: an IP address domain: a domain name oss: the OSS domain of an Object Storage Service (OSS) bucket|'."\n" + .'|content|String|Yes|The address of the origin server. You can specify an IP address or domain name.|'."\n" + .'|port|Integer|No|The port number. You can specify port **443** or **80**. Default value: **80**. If you specify **443**, requests are redirected to the origin server over HTTPS. You can also specify a custom port.|'."\n" + .'|priority|String|No|The priority of the origin server if multiple origin servers are specified. Valid values: **20** and **30**. Default value: **20**. **20** specifies the primary origin server and **30** specifies the secondary origin server.|', + 'responseParamsDescription' => ' ', + 'extraInfo' => 'The following table describes the error codes that this operation can return. For more information about errors common in ApsaraVideo VOD, see [Error codes](~~52841~~).'."\n" + ."\n" + .'|Error code|Error message|HTTP status code|Description|'."\n" + .'|---|---|---|---|'."\n" + .'|InvalidDomainName.Malformed|Specified DomainName is malformed.|400|The error message returned because the value of the DomainName parameter is invalid.|'."\n" + .'|InvalidSource.Content.Malformed|Specified source content is malformed.|400|The error message returned because the origin address is invalid.|'."\n" + .'|InvalidSource.Type.Malformed|Specified source type is malformed.|400|The error message returned because the origin type is invalid.|'."\n" + .'|InvalidTypeContent.Mismatch|Specified source type does not math the specified source content.|400|The error message returned because the origin address does not match the origin type.|'."\n" + .'|InvalidSource.Priority.Malformed|Specified source priority is malformed.|400|The error message returned because the priority is invalid.|'."\n" + .'|InvalidScope.Malformed|Specified Scope is malformed.|400|The error message returned because the value of the Scope parameter is invalid.|'."\n" + .'|IllegalOperation|Illegal domain operate is not permitted.|403|The error message returned because you are not authorized to perform this operation.|'."\n" + .'|InvalidDomain.NotFound|The domain provided does not belong to you.|404|The error message returned because the specified domain name does not exist or does not belong to the current account.|', + ], + 'DescribeVodUserDomains' => [ + 'summary' => '调用本接口查询用户名下所有的点播加速域名列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39917', + 'abilityTreeNodes' => [ + 'FEATUREvodHI57GB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值为**20**，最大值为**50**。取值：**1**~**50**之间的任意整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'minimum' => '1', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '点播加速域名，支持域名模糊匹配过滤。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.aliyundoc.com', + ], + ], + [ + 'name' => 'DomainStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '域名状态过滤。取值意义：'."\n" + ."\n" + .'- **online**：表示启用。'."\n" + .'- **offline**：表示停用。'."\n" + .'- **configuring**：表示配置中。'."\n" + .'- **configure_failed**：表示配置失败。'."\n" + .'- **checking**：表示正在审核。'."\n" + .'- **check_failed**：表示审核失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'online', + ], + ], + [ + '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', + 'default' => 'fuzzy_match', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签对象。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'key标签键，N的取值范围：**1**~**20**。'."\n" + ."\n" + .'默认查询所有标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'Value' => [ + 'description' => 'value标签值，N的取值范围：**1**~**20**。'."\n" + ."\n" + .'默认查询所有标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E4EBD2BF-5EB0-4476-****-9D94E1B15267', + ], + 'PageNumber' => [ + 'description' => '返回数据的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Domains' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PageData' => [ + 'description' => '由PageData组成的数组格式，返回点播域名的状态信息。', + 'type' => 'array', + 'items' => [ + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'GmtCreated' => [ + 'description' => '点播域名创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-08-29T08:40:53Z', + ], + 'SslProtocol' => [ + 'description' => 'HTTPS开关。'."\n" + .'- **on**：已开启。'."\n" + .'- **off**：未开启。', + 'type' => 'string', + 'example' => 'on', + ], + 'Description' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => '浙ICP备****号', + ], + 'Sandbox' => [ + 'description' => '沙箱。', + 'type' => 'string', + 'example' => 'normal', + ], + 'Cname' => [ + 'description' => '点播域名对应的CNAME域名。', + 'type' => 'string', + 'example' => 'learn.developer.aliyundoc.com', + ], + 'DomainStatus' => [ + 'description' => '点播域名状态，取值含义：'."\n" + ."\n" + .'- **online**：表示启用。'."\n" + .'- **offline**：表示停用。'."\n" + .'- **configuring**：表示配置中。'."\n" + .'- **configure_failed**：表示配置失败。'."\n" + .'- **checking**：表示正在审核。'."\n" + .'- **check_failed**：表示审核失败。', + 'type' => 'string', + 'example' => 'online', + ], + 'GmtModified' => [ + 'description' => '点播域名修改时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-12-29T09:24:12Z', + ], + 'DomainName' => [ + 'description' => '点播加速域名。', + 'type' => 'string', + 'example' => 'example.aliyundoc.com', + ], + 'Sources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Source' => [ + 'description' => '源站信息。', + 'type' => 'array', + 'items' => [ + 'description' => '源站详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '源站类型，取值含义：'."\n" + .'- **ipaddr**：IP源站。'."\n" + .'- **domain**：域名源站。'."\n" + .'- **oss**：OSS Bucket为源站。', + 'type' => 'string', + 'example' => 'oss', + ], + 'Priority' => [ + 'description' => '优先级。', + 'type' => 'string', + 'example' => '5', + ], + 'Port' => [ + 'description' => '端口，支持**443**和**80**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Content' => [ + 'description' => '回源地址。', + 'type' => 'string', + 'example' => '192.168.0.1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPageNumber.ValueNotSupported', + 'errorMessage' => 'The specified value of PageNumber is not supported.', + ], + [ + 'errorCode' => 'InvalidPageSize.ValueNotSupported', + 'errorMessage' => 'The specified value of PageSize is invalid.', + ], + [ + 'errorCode' => 'InvalidDomainStatus.ValueNotSupported', + 'errorMessage' => 'The specified value of DomainStatus is invalid.', + ], + [ + 'errorCode' => 'InvalidDomainName.Malformed', + 'errorMessage' => 'The specified DomainName is invalid.', + ], + [ + 'errorCode' => 'InvalidDomainSearchType.ValueNotSupported', + 'errorMessage' => 'The specified value of DomainSearchType is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4EBD2BF-5EB0-4476-****-9D94E1B15267\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Domains\\": {\\n \\"PageData\\": [\\n {\\n \\"GmtCreated\\": \\"2017-08-29T08:40:53Z\\",\\n \\"SslProtocol\\": \\"on\\",\\n \\"Description\\": \\"浙ICP备****号\\",\\n \\"Sandbox\\": \\"normal\\",\\n \\"Cname\\": \\"learn.developer.aliyundoc.com\\",\\n \\"DomainStatus\\": \\"online\\",\\n \\"GmtModified\\": \\"2017-12-29T09:24:12Z\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"Sources\\": {\\n \\"Source\\": [\\n {\\n \\"Type\\": \\"oss\\",\\n \\"Priority\\": \\"5\\",\\n \\"Port\\": 80,\\n \\"Content\\": \\"192.168.0.1\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVodUserDomainsResponse>\\n <RequestId>E4EBD2BF-5EB0-4476-****-9D94E1B15267</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>20</PageSize>\\n <TotalCount>2</TotalCount>\\n <Domains>\\n <GmtCreated>2017-08-29T08:40:53Z</GmtCreated>\\n <SslProtocol>on</SslProtocol>\\n <Description>浙ICP备****号</Description>\\n <Sandbox>normal</Sandbox>\\n <Cname>learn.developer.aliyundoc.com</Cname>\\n <DomainStatus>online</DomainStatus>\\n <GmtModified>2017-12-29T09:24:12Z</GmtModified>\\n <DomainName>example.aliyundoc.com</DomainName>\\n <Sources>\\n <Type>oss</Type>\\n <Priority>5</Priority>\\n <Port>80</Port>\\n <Content>192.168.0.1</Content>\\n </Sources>\\n </Domains>\\n</DescribeVodUserDomainsResponse>","errorExample":""}]', + 'title' => '查询加速域名列表', + 'description' => '- 支持域名模糊匹配过滤和域名状态过滤查询。'."\n" + .'- 本接口目前仅支持如下服务地域：**华东2（上海）**。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidPageNumber.ValueNotSupported | The specified value of parameter PageNumber is not supported. | 400 | 输入的PageNumber参数值不支持。|'."\n" + .'| InvalidPageSize.ValueNotSupported | The specified value of parameter PageSize is not supported. | 400 | 输入的PageSize参数值不支持。|'."\n" + .'| InvalidDomainName.Malformed | The specific value of parameter DomainName is malformed. | 400 | 输入的DomainName参数值不支持。|'."\n" + .'| InvalidDomainStatus.ValueNotSupported | The specified value of parameter DomainStatus is not supported. | 400 | 输入的DomainStatus参数值不支持。|'."\n" + .'| InvalidDomainSearchType.ValueNotSupported | The specified value of parameter DomainSearchType is not supported. | 400 | 输入的DomainSearchType参数值不支持。|', + ], + 'DescribeVodDomainDetail' => [ + 'summary' => '调用本接口获取指定点播域名配置的基本信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39880', + 'abilityTreeNodes' => [ + 'FEATUREvodHI57GB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + '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' => '09ABE829-6CD3-4FE0-556113E2****', + ], + 'DomainDetail' => [ + 'description' => '域名配置的基本信息。', + 'type' => 'object', + 'properties' => [ + 'GmtCreated' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-11-27T06:51:26Z', + ], + 'Weight' => [ + 'description' => '回源权重。', + 'type' => 'string', + 'example' => '1', + ], + 'SSLPub' => [ + 'description' => '如果开启HTTPS安全加速，此处为HTTPS证书的公钥；如果未开启HTTPS安全加速，则不返回此参数。', + 'type' => 'string', + 'example' => 'yourSSLPub', + ], + 'Description' => [ + 'description' => '点播加速域名描述。', + 'type' => 'string', + 'example' => 'testDescription', + ], + 'SSLProtocol' => [ + 'description' => '是否开启SSL证书。取值：'."\n" + ."\n" + .'- **on**：开启。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'CertName' => [ + 'description' => '如果开启HTTPS安全加速，此处为HTTPS证书的名称；如果未开启HTTPS安全加速，则不返回此参数。', + 'type' => 'string', + 'example' => 'testCertName', + ], + 'Scope' => [ + 'description' => ' 加速区域。取值：'."\n" + ."\n" + .'- **domestic**（默认）：仅中国内地。'."\n" + .'- **overseas**：全球（不包含中国内地）。'."\n" + .'- **global**：全球。', + 'type' => 'string', + 'example' => 'domestic', + ], + 'Cname' => [ + 'description' => '为加速域名生成的一个CNAME域名，需要在域名解析服务商处将此加速域名CNAME解析到该域名。详细操作请参见[配置CNAME](~~86075~~)。', + 'type' => 'string', + 'example' => 'example.com.w.alikunlun.net', + ], + 'DomainStatus' => [ + 'description' => '加速域名运行状态。取值意义：'."\n" + ."\n" + .'- **online**：表示启用。'."\n" + .'- **offline**：表示停用。'."\n" + .'- **configuring**：表示配置中。'."\n" + .'- **configure_failed**：表示配置失败。'."\n" + .'- **checking**：表示正在审核。'."\n" + .'- **check_failed**：表示审核失败。', + 'type' => 'string', + 'example' => 'online', + ], + 'GmtModified' => [ + 'description' => '最近修改时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2017-11-27T06:55:26Z', + ], + 'DomainName' => [ + 'description' => '点播加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Sources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Source' => [ + 'description' => '源站信息。', + 'type' => 'array', + 'items' => [ + 'description' => '源站详细信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '源站类型。取值：'."\n" + ."\n" + .'- **ipaddr**：IP源站。'."\n" + .'- **domain**：域名源站。'."\n" + .'- **oss**：OSS Bucket为源站。', + 'type' => 'string', + 'example' => 'oss', + ], + 'Priority' => [ + 'description' => '优先级。', + 'type' => 'string', + 'example' => '50', + ], + 'Port' => [ + 'description' => '端口。支持443和80。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Content' => [ + 'description' => '回源地址。', + 'type' => 'string', + 'example' => '****.oss-cn-hangzhou.aliyuncs.com', + ], + 'Enabled' => [ + 'description' => '源站状态。取值：'."\n" + ."\n" + .'- **online**：启用。'."\n" + .'- **offline**：停用。', + 'type' => 'string', + 'example' => 'online', + ], + 'Weight' => [ + 'description' => '回源权重。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not belong to you.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"09ABE829-6CD3-4FE0-556113E2****\\",\\n \\"DomainDetail\\": {\\n \\"GmtCreated\\": \\"2017-11-27T06:51:26Z\\",\\n \\"Weight\\": \\"1\\",\\n \\"SSLPub\\": \\"yourSSLPub\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"SSLProtocol\\": \\"on\\",\\n \\"CertName\\": \\"testCertName\\",\\n \\"Scope\\": \\"domestic\\",\\n \\"Cname\\": \\"example.com.w.alikunlun.net\\",\\n \\"DomainStatus\\": \\"online\\",\\n \\"GmtModified\\": \\"2017-11-27T06:55:26Z\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"Sources\\": {\\n \\"Source\\": [\\n {\\n \\"Type\\": \\"oss\\",\\n \\"Priority\\": \\"50\\",\\n \\"Port\\": 80,\\n \\"Content\\": \\"****.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"Enabled\\": \\"online\\",\\n \\"Weight\\": \\"1\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVodDomainDetailResponse>\\n <RequestId>09ABE829-6CD3-4FE0-556113E2****</RequestId>\\n <DomainDetail>\\n <GmtCreated>2017-11-27T06:51:26Z</GmtCreated>\\n <Weight>1</Weight>\\n <SSLPub>yourSSLPub</SSLPub>\\n <Description>testDescription</Description>\\n <SSLProtocol>on</SSLProtocol>\\n <CertName>testCertName</CertName>\\n <Scope>domestic</Scope>\\n <Cname>example.com.w.alikunlun.net</Cname>\\n <DomainStatus>online</DomainStatus>\\n <GmtModified>2017-11-27T06:55:26Z</GmtModified>\\n <DomainName>example.com</DomainName>\\n <Sources>\\n <Type>oss</Type>\\n <Priority>50</Priority>\\n <Port>80</Port>\\n <Content>****.oss-cn-hangzhou.aliyuncs.com</Content>\\n <Enabled>online</Enabled>\\n </Sources>\\n </DomainDetail>\\n</DescribeVodDomainDetailResponse>","errorExample":""}]', + 'title' => '查询域名基本信息', + 'description' => '目前服务地址仅支持：**华东2（上海）**。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。视频点播通用的错误码信息，请参见[错误码表](~~52841~~)。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidDomain.NotFound |The domain provided does not belong to you. | 404 |域名不存在或不属于当前用户。|'."\n" + .'| ServiceBusy |The specified Domain is configuring, please retry again later. | 403 |域名正在配置中，请稍后再试。|', + ], + 'BatchStartVodDomain' => [ + 'summary' => '调用本接口启用状态为“停用”的加速域名。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39800', + 'abilityTreeNodes' => [ + 'FEATUREvodHI57GB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainNames', + 'in' => 'query', + 'schema' => [ + 'description' => '点播加速域名。多个域名使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-****-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'ServiceBusy', + 'errorMessage' => 'The specified Domain is configuring, please retry later', + ], + ], + [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not belong to you.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-****-2C4477247A74\\"\\n}","errorExample":""},{"type":"xml","example":"<BatchStartVodDomainResponse>\\r\\n <RequestId>15C66C7B-671A-4297-****-2C4477247A74</RequestId>\\r\\n</BatchStartVodDomainResponse>","errorExample":""}]', + 'title' => '启用加速域名', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 如果域名对应账号欠费或域名处于非法状态，则无法正常调用该接口启用点播域名。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BatchStopVodDomain' => [ + 'summary' => '调用本接口暂停域名加速。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39801', + 'abilityTreeNodes' => [ + 'FEATUREvodHI57GB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainNames', + 'in' => 'query', + 'schema' => [ + 'description' => '点播加速域名。多个域名使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15C66C7B-671A-4297-****-2C4477247A74', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'ServiceBusy', + 'errorMessage' => 'The specified Domain is configuring, please retry later', + ], + ], + [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not belong to you.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-****-2C4477247A74\\"\\n}","errorExample":""},{"type":"xml","example":"<BatchStopVodDomainResponse>\\r\\n <RequestId>15C66C7B-671A-4297-****-2C4477247A74</RequestId>\\r\\n</BatchStopVodDomainResponse>","errorExample":""}]', + 'title' => '停用加速域名', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 停用该加速域名后，该条加速域名信息仍保留。对于加速域名的请求系统将做自动回源处理。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'VerifyVodDomainOwner' => [ + 'summary' => '调用本接口验证域名归属权。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40244', + 'abilityTreeNodes' => [ + 'FEATUREvodHI57GB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + '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' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '校验内容。', + 'type' => 'string', + 'example' => 'verify_dffeb661*********a59c32cd91f', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E4EBD2BF-5EB0-4476-8829-9D94E1B1****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DomainOwnerVerifyFail', + 'errorMessage' => 'Owner verification of the root domain failed.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Content\\": \\"verify_dffeb661*********a59c32cd91f\\",\\n \\"RequestId\\": \\"E4EBD2BF-5EB0-4476-8829-9D94E1B1****\\"\\n}","errorExample":""},{"type":"xml","example":"<VerifyVodDomainOwnerResponse>\\n <Content>verify_dffeb661*********a59c32cd91f</Content>\\n <RequestId>E4EBD2BF-5EB0-4476-8829-9D94E1B1****</RequestId>\\n</VerifyVodDomainOwnerResponse>","errorExample":""}]', + 'title' => '域名归属权验证', + 'description' => '目前服务地域仅支持：**华东2（上海）**。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVodVerifyContent' => [ + 'summary' => '调用本接口获取归属校验内容。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39922', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '校验的域名。仅支持单域名校验。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '校验内容。', + 'type' => 'string', + 'example' => 'verify_dffeb661*****3a59c31cd91f', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34AB41F1-04A5-4688-634BDBE6****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Content\\": \\"verify_dffeb661*****3a59c31cd91f\\",\\n \\"RequestId\\": \\"34AB41F1-04A5-4688-634BDBE6****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeVodVerifyContentResponse>\\n <Content>verify_dffeb661*****3a59c31cd91f</Content>\\n <RequestId>34AB41F1-04A5-4688-634BDBE6****</RequestId>\\n</DescribeVodVerifyContentResponse>","errorExample":""}]', + 'title' => '获取归属校验内容', + 'description' => '- 目前服务地域仅支持：**华东2（上海）**。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteVodSpecificConfig' => [ + 'summary' => '调用本接口删除点播加速域名的配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39850', + 'abilityTreeNodes' => [ + 'FEATUREvodHI57GB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '点播加速域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。', + 'type' => 'string', + 'required' => true, + 'example' => '2317****', + ], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => [ + 'description' => '删除配置的环境。取值：'."\n" + .'- online：生产环境'."\n" + .'- gray：模拟环境', + 'type' => 'string', + 'required' => false, + 'example' => 'online', + 'default' => 'online', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-****-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Invalid%s.ValueNotSupported', + 'errorMessage' => 'FunctionName [%s] is not supported.', + ], + [ + 'errorCode' => 'EdgeScriptCountExceedLimit', + 'errorMessage' => 'The number of rules exceeds the default limit (1). To increase the limit, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScripOptionsHasInnerConfig', + 'errorMessage' => 'The extension has a background configuration or a parameter of this configuration is invalid. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScriptGrammarNotSupport', + 'errorMessage' => 'A background customization rule exists or a parameter of this configuration is invalid. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScriptNotSupportJs', + 'errorMessage' => 'JavaScript rules are not supported. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'InvalidRule.Malformed ', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ConfigurationConflicts', + 'errorMessage' => 'Failed to modify the parameter settings in the production environment because the parameter settings are different from those in the staging'."\n" + .'environment. Set parameters in the staging environment before you publish them to the production environment.', + ], + [ + 'errorCode' => 'GrayConfigIsNull', + 'errorMessage' => 'You cannot delete all gary configurations. You can clear them by rolling back the simulation environment.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ServiceBusy', + 'errorMessage' => 'The specified Domain is configuring, please retry later', + ], + ], + [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not belong to you.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-****-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteVodSpecificConfigResponse>\\r\\n<RequestId>04F0F334-1335-436C-****-6C044FE73368</RequestId>\\r\\n</DeleteVodSpecificConfigResponse>","errorExample":""}]', + 'title' => '删除域名配置', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 执行此操作会导致域名不可访问，建议您建议删除域名前到域名解析服务商处恢复域名A记录。'."\n" + .'- 删除域名调用成功后将删除本条点播域名的全部相关记录。如果您仅需要暂停使用该点播域名，推荐您使用[停用加速域名](~~120208~~)接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' 下表列举了本接口特有的错误码。视频点播通用的错误码信息，请参见[错误码表](~~52841~~)。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| MissingParameter | The specified value of parameter DomainName can not be empty. | 400 | DomainName为空| '."\n" + .'| MissingParameter | The specified value of parameter ConfigId can not be empty. | 400 | ConfigId为空| '."\n" + .'| Invalid%s.ValueNotSupported | FunctionName [%s] is not supported. | 400 | FunctionName不支持| ', + ], + 'SetVodDomainCertificate' => [ + 'summary' => '调用本接口设置某域名下证书功能是否启用及修改证书信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40153', + 'abilityTreeNodes' => [ + 'FEATUREvodHI57GB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '指定证书所属加速域名。需属于HTTPS加速类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'CertName', + 'in' => 'query', + 'schema' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cert_name', + ], + ], + [ + 'name' => 'SSLProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTPS证书是否启用。取值：'."\n" + ."\n" + .'- **on**：启用。'."\n" + .'- **off**（默认值）：不启用。', + 'type' => 'string', + 'required' => true, + 'example' => 'off', + ], + ], + [ + 'name' => 'SSLPub', + 'in' => 'query', + 'schema' => [ + 'description' => '安全证书内容。不启用证书则无需输入，配置证书请输入证书内容。', + 'type' => 'string', + 'required' => false, + 'example' => '****', + ], + ], + [ + 'name' => 'SSLPri', + 'in' => 'query', + 'schema' => [ + 'description' => '私钥内容。不启用证书则无需输入，配置证书请输入私钥内容。', + 'type' => 'string', + 'required' => false, + 'example' => '****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-****-6C044FE73368', + ], + ], + ], + ], + ], + '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' => 'Certificate.NotPermittedOff', + 'errorMessage' => 'Turn off certificate will change domain scheduling, please contact customer service', + ], + [ + 'errorCode' => 'Certificate.SetNotEffect', + 'errorMessage' => 'Certificate was successfully set but doesn\'t take effect for protecting current service. Please contact customer service.', + ], + [ + '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.NotFind', + 'errorMessage' => 'Not find the certificate info.', + ], + [ + '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!', + ], + ], + 403 => [ + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => 'Illegal domain operate is not permitted.', + ], + [ + 'errorCode' => 'ServiceBusy', + 'errorMessage' => 'The specified Domain is configuring, please retry later', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-****-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<SetVodDomainCertificateResponse>\\r\\n <RequestId>04F0F334-1335-436C-****-6C044FE73368</RequestId>\\r\\n</SetVodDomainCertificateResponse>","errorExample":""}]', + 'title' => '设置域名证书启用及修改信息', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不属于当前用户。|'."\n" + .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 没有权限执行当前操作。|'."\n" + .'| ServiceBusy | The specified Domain is configuring, please retry later. | 403 | 域名正在配置中, 请稍后再试。|'."\n" + .'| InvalidDomain.Offline | The domain provided is offline. | 400 | 域名已下线。|'."\n" + .'| OperationDenied | Your CDN service is suspended. | 403 | 该账号已经欠费，请充值。|'."\n" + .'| InvalidSSLProtocol.ValueNotSupported | The specified value of parameter Enable is not supported. | 400 | SSLProtocol的值不合法。|'."\n" + .'| SSLPub.MissingParameter | An input parameter SSLPub that is mandatory for processing the request is not supplied. | 400 | SSLPub参数缺失。|'."\n" + .'| SSLPri.MissingParameter | An input parameter SSLPri that is mandatory for processing the request is not supplied. | 400 | SSLPri参数缺失。|'."\n" + .'| InvalidCertificate | The Certificate you provided is malformed! | 400 | 证书内容不合法。|'."\n" + .'| InvalidSSLPri | The SSLPri you provided is malformed! | 400 | 私钥内容不合法。|'."\n" + .'| Certificate.MissMatch | The SSLPri does not math the specified Certificate! | 400 | 证书和私钥不匹配。|'."\n" + .'| InvalidCertificate.TooLong | The Certificate you provided is over the max length! | 400 | 证书内容超过长度限制。|'."\n" + .'| InvalidCertName.TooLong | The Certificate name you provided is over the max length 128! | 400 | 证书名称不能超过128个字符。|'."\n" + .'| SetDomainSSLPub.ParameterError | Parameters have error. | 400 | 参数错误。|'."\n" + .'| Certificate.StatusError | Certificate is not exist or its status is error. | 400 | 证书不存在或证书状态错误。|'."\n" + .'| DeleteFailed | Delete certificate is failed. | 400 | 删除证书失败。|'."\n" + .'| Certificate.NotFind | Not find the certificate info. | 400 | 没有查到相应证书。|'."\n" + .'| Certificate.Duplicated | The certificate name is duplicated. | 400 | 证书名称重复。|'."\n" + .'| Certificate.FormatError | The certificate format is error. | 400 | 证书格式错误。|'."\n" + .'| Certificate.StatusError | The certificate status is error. | 400 | 证书状态错误。|'."\n" + .'| Certificate.KeyNull | The SSLPri is not null. | 400 | 私钥不能为空。|'."\n" + .'| SSLPri.Malformed | The SSLPri format is error. | 400 | 私钥格式错误。|'."\n" + .'| Certificate.NotPermittedOff | Turn off certificate will change domain scheduling, please contact customer service. | 400 | 关闭证书会影响该域名调度，请联系客户调整。|'."\n" + .'| Certificate.SettedNotEffect | Certificate was successfully set but doesn\'t take effect for protecting current service, please contact customer service. | 400 | 证书已经设置成功，但为保护当前服务还未生效，请联系客服处理。|', + ], + 'DescribeVodDomainConfigs' => [ + 'summary' => '调用本接口查询域名配置，一次可查询多个功能配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39879', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '点播加速域名，仅支持查询单个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'FunctionNames', + 'in' => 'query', + 'schema' => [ + 'description' => '功能名称。一次可查询多个功能配置信息，多个功能名称之间使用半角逗号（,）分隔。点播加速域名支持配置的功能及各功能名称，请参见[域名配置功能函数](~~2411639~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'filetype_based_ttl_set,set_req_host_header', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F8AA0364-0FDB-4AD5-****-D69FAB8924ED', + ], + 'DomainConfigs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DomainConfig' => [ + 'description' => '域名配置。', + 'type' => 'array', + 'items' => [ + 'description' => '域名配置详情。', + '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' => [ + 'description' => '功能配置详情。', + 'type' => 'object', + 'properties' => [ + 'ArgName' => [ + 'description' => '参数名称，为functionName的配置项。', + 'type' => 'string', + 'example' => 'domain_name', + ], + 'ArgValue' => [ + 'description' => '参数值，为functionName的配置项的取值。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Invalid%s.ValueNotSupported', + 'errorMessage' => 'FunctionName [%s] is not supported.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F8AA0364-0FDB-4AD5-****-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\\": \\"example.com\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVodDomainConfigsResponse>\\r\\n <RequestId>F8AA0364-0FDB-4AD5-****-D69FAB8924ED</RequestId>\\r\\n\\t<DomainConfigs>\\r\\n\\t\\t<DomainConfig>\\r\\n\\t\\t\\t<FunctionArgs>\\r\\n\\t\\t\\t\\t<FunctionArg>\\r\\n\\t\\t\\t\\t\\t<ArgName>domain_name</ArgName>\\r\\n\\t\\t\\t\\t\\t<ArgValue>www.example.com</ArgValue>\\r\\n\\t\\t\\t\\t</FunctionArg>\\r\\n\\t\\t\\t</FunctionArgs>\\r\\n\\t\\t\\t<ConfigId>5003576</ConfigId>\\r\\n\\t\\t\\t<FunctionName>set_req_host_header</FunctionName>\\r\\n\\t\\t</DomainConfig>\\r\\n\\t\\t<DomainConfig>\\r\\n\\t\\t\\t<FunctionArgs>\\r\\n\\t\\t\\t\\t<FunctionArg>\\r\\n\\t\\t\\t\\t\\t<ArgName>file_type</ArgName>\\r\\n\\t\\t\\t\\t\\t<ArgValue>txt</ArgValue>\\r\\n\\t\\t\\t\\t</FunctionArg>\\r\\n\\t\\t\\t\\t<FunctionArg>\\r\\n\\t\\t\\t\\t\\t<ArgName>ttl</ArgName>\\r\\n\\t\\t\\t\\t\\t<ArgValue>13</ArgValue>\\r\\n\\t\\t\\t\\t</FunctionArg>\\r\\n\\t\\t\\t\\t<FunctionArg>\\r\\n\\t\\t\\t\\t\\t<ArgName>weight</ArgName>\\r\\n\\t\\t\\t\\t\\t<ArgValue>8</ArgValue>\\r\\n\\t\\t\\t\\t</FunctionArg>\\r\\n\\t\\t\\t</FunctionArgs>\\r\\n\\t\\t\\t<ConfigId>5068995</ConfigId>\\r\\n\\t\\t\\t<FunctionName>filetype_based_ttl_set</FunctionName>\\r\\n\\t\\t</DomainConfig>\\r\\n\\t</DomainConfigs>\\r\\n</DescribeVodDomainConfigsResponse>","errorExample":""}]', + 'title' => '查询域名配置', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| DeleteFunctionFailed | Batch delete functions failed. | 400 | 批量删除配置失败。|'."\n" + .'| InvalidFunctionName.ValueNotSupported | FunctionName %s is not supported. | 400 | 不支持的FunctionName %s（%s为具体功能名）。|', + ], + 'DescribeVodCertificateList' => [ + 'summary' => '调用本接口获取证书列表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39875', + 'abilityTreeNodes' => [ + 'FEATUREvod0O92P0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '点播加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FC0E34AC-0239-44A7-****-800DE522C8DA', + ], + 'CertificateListModel' => [ + 'description' => '证书列表信息。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '证书个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CertList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Cert' => [ + 'description' => '证书列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LastTime' => [ + 'description' => '证书签发时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1512388610', + ], + 'Fingerprint' => [ + 'description' => '证书指纹。', + 'type' => 'string', + 'example' => '****', + ], + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => '证书', + ], + 'Issuer' => [ + 'description' => '证书发行商。', + 'type' => 'string', + 'example' => '****', + ], + 'CertId' => [ + 'description' => '证书ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '235437', + ], + 'Common' => [ + 'description' => '证书公用名。', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1725206400000', + ], + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1725207200000', + ], + 'Algorithm' => [ + 'description' => '算法名称。', + 'type' => 'string', + 'example' => 'RSA', + ], + 'CertIdentifier' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => '14173772-cn-hangzhou', + ], + 'DomainMatchCert' => [ + 'description' => '域名匹配。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'cert-cn-cd806ae0fdfbfa60', + ], + 'SignAlgorithm' => [ + 'description' => '签名算法。', + 'type' => 'string', + 'example' => 'sha256withrsa', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FC0E34AC-0239-44A7-****-800DE522C8DA\\",\\n \\"CertificateListModel\\": {\\n \\"Count\\": 2,\\n \\"CertList\\": {\\n \\"Cert\\": [\\n {\\n \\"LastTime\\": 1512388610,\\n \\"Fingerprint\\": \\"****\\",\\n \\"CertName\\": \\"证书\\",\\n \\"Issuer\\": \\"****\\",\\n \\"CertId\\": 235437,\\n \\"Common\\": \\"test\\",\\n \\"CreateTime\\": 1725206400000,\\n \\"EndTime\\": 1725207200000,\\n \\"Algorithm\\": \\"RSA\\",\\n \\"CertIdentifier\\": \\"14173772-cn-hangzhou\\",\\n \\"DomainMatchCert\\": false,\\n \\"InstanceId\\": \\"cert-cn-cd806ae0fdfbfa60\\",\\n \\"SignAlgorithm\\": \\"sha256withrsa\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVodCertificateListResponse>\\n<RequestId>FC0E34AC-0239-44A7-****-800DE522C8DA</RequestId>\\n<CertificateListModel>\\n <CertList>\\n <Cert>\\n <Fingerprint>****</Fingerprint>\\n <Issuer>****</Issuer>\\n <CertId>235437</CertId>\\n <CertName>证书</CertName>\\n <LastTime>1512388610</LastTime>\\n <Common>test</Common>\\n </Cert>\\n </CertList>\\n <Count>2</Count>\\n</CertificateListModel>\\n</DescribeVodCertificateListResponse>","errorExample":""}]', + 'title' => '查询证书列表', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVodDomainCertificateInfo' => [ + 'summary' => '调用本接口获取指定加速域名的证书信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39877', + 'abilityTreeNodes' => [ + 'FEATUREvodHI57GB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + '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' => '5C1E43DC-9E51-4771-****-7D5ECEB547A1', + ], + 'CertInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CertInfo' => [ + 'description' => '证书信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CertExpireTime' => [ + 'description' => '证书过期时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2018-06-03T13:03:39Z', + ], + 'CertLife' => [ + 'description' => '证书时长。单位：months（月），years（年）。', + 'type' => 'string', + 'example' => '3 months', + ], + 'Status' => [ + 'description' => '证书状态。'."\n" + .'- **success**：已生效'."\n" + .'- **checking**：检测域名是否在阿里云点播'."\n" + .'- **cname_error**：域名没有切到阿里云点播'."\n" + .'- **domain_invalid**：域名包含非法字符'."\n" + .'- **unsupport_wildcard**：不支持泛域名'."\n" + .'- **applying**：证书申请中'."\n" + .'- **failed**：证书申请失败'."\n" + ."\n" + .'> 仅当`CertType`为`free`时，该字段才会返回值，其他类型的证书该字段返回为空。', + 'type' => 'string', + 'example' => 'success', + ], + 'CertUpdateTime' => [ + 'description' => '证书更新时间。', + 'type' => 'string', + 'example' => '2023-04-26T20:23:38Z', + ], + 'CertDomainName' => [ + 'description' => '证书匹配的域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'ServerCertificateStatus' => [ + 'description' => 'HTTPS证书开启状态。'."\n" + .'- **on**：已开启'."\n" + .'- **off**：未开启', + 'type' => 'string', + 'example' => 'on', + ], + 'CertOrg' => [ + 'description' => '证书组织。', + 'type' => 'string', + 'example' => 'Let\'s Encrypt', + ], + 'DomainName' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'CertStartTime' => [ + 'description' => '证书开始时间。', + 'type' => 'string', + 'example' => '2023-04-26T20:23:38Z', + ], + 'CertType' => [ + 'description' => '证书类型。取值：'."\n" + .'- **free**：免费证书'."\n" + .'- **cas**：云盾证书'."\n" + .'- **upload**：自定义上传', + 'type' => 'string', + 'example' => 'free', + ], + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'cert-example.com', + ], + 'DomainCnameStatus' => [ + 'description' => '域名的CNAME状态：'."\n" + ."\n" + .'- ok:'."\n" + .'域名指向了阿里云CDN分配的CNAME。'."\n" + .'cname_error: 发生错误，域名无法指向CNAME。'."\n" + ."\n" + .'- op_domain_cname_error:'."\n" + .'顶级域名的CNAME发生错误，域名无法指向CNAME。'."\n" + ."\n" + .'- unsupport_wildcard:'."\n" + .'不支持通配符域名。', + 'type' => 'string', + 'example' => 'ok', + ], + 'ServerCertificate' => [ + 'description' => '证书公钥。', + 'type' => 'string', + 'example' => '****', + ], + 'CertId' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => '13227737-cn-hangzhou', + ], + 'CertRegion' => [ + 'description' => '证书使用地区。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5C1E43DC-9E51-4771-****-7D5ECEB547A1\\",\\n \\"CertInfos\\": {\\n \\"CertInfo\\": [\\n {\\n \\"CertExpireTime\\": \\"2018-06-03T13:03:39Z\\",\\n \\"CertLife\\": \\"3 months\\",\\n \\"Status\\": \\"success\\",\\n \\"CertUpdateTime\\": \\"2023-04-26T20:23:38Z\\",\\n \\"CertDomainName\\": \\"example.com\\",\\n \\"ServerCertificateStatus\\": \\"on\\",\\n \\"CertOrg\\": \\"Let\'s Encrypt\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"CertStartTime\\": \\"2023-04-26T20:23:38Z\\",\\n \\"CertType\\": \\"free\\",\\n \\"CertName\\": \\"cert-example.com\\",\\n \\"DomainCnameStatus\\": \\"ok\\",\\n \\"ServerCertificate\\": \\"****\\",\\n \\"CertId\\": \\"13227737-cn-hangzhou\\",\\n \\"CertRegion\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVodDomainCertificateInfoResponse>\\r\\n <CertInfos>\\r\\n\\t\\t<CertInfo>\\r\\n\\t\\t\\t<Status>success</Status>\\r\\n\\t\\t\\t<CertLife>3 months</CertLife>\\r\\n\\t\\t\\t<SSLProtocol>on</SSLProtocol>\\r\\n\\t\\t\\t<CertType>cas</CertType>\\r\\n\\t\\t\\t<CertName>cert-example.com</CertName>\\r\\n\\t\\t\\t<CertDomainName>example.com</CertDomainName>\\r\\n\\t\\t\\t<DomainName>example.com</DomainName>\\r\\n\\t\\t\\t<CertOrg>Let\'s Encrypt</CertOrg>\\r\\n\\t\\t\\t<CertExpireTime>2018-06-03T13:03:39Z</CertExpireTime>\\r\\n\\t\\t</CertInfo>\\r\\n\\t</CertInfos>\\r\\n\\t<RequestId>5C1E43DC-9E51-4771-****-7D5ECEB547A1</RequestId>\\r\\n</DescribeVodDomainCertificateInfoResponse>","errorExample":""}]', + 'title' => '查询域名证书', + 'description' => '目前服务地域仅支持：**华东2（上海）**。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不属于当前用户。|', + ], + 'BatchSetVodDomainConfigs' => [ + 'summary' => '调用本接口批量配置加速域名。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39799', + 'abilityTreeNodes' => [ + 'FEATUREvodHI57GB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainNames', + 'in' => 'query', + 'schema' => [ + 'description' => '点播加速域名。多个域名之间使用半角逗号（,）分隔。一次最多支持配置50个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Functions', + 'in' => 'query', + 'schema' => [ + 'description' => '功能列表。'."\n" + .'- functionName（功能名称，必填）：可配置的功能及功能名称参数请参见[域名配置功能函数](~~2411639~~)。'."\n" + .'- argName（参数名称，必填）：functionName的配置项（可配置多个配置项）。'."\n" + .'- argValue（参数值，必填）：functionName的配置项的取值。'."\n" + ."\n" + .'点播加速域名支持配置的功能及各功能名称和参数名称等详细信息，请参见[域名配置功能函数](~~2411639~~)。'."\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":5068995}]`', + 'type' => 'string', + 'required' => true, + 'example' => '[{"functionArgs":[{"argName":"domain_name","argValue":"www.example.com"}],"functionName":"set_req_host_header"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-****-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidFunctions.Malformed', + 'errorMessage' => 'The specified Functions is incorrectly formatted.', + ], + [ + 'errorCode' => 'InvalidArgValue.Malformed', + 'errorMessage' => 'The specified ArgValue is invalid.', + ], + [ + 'errorCode' => 'Invalid%s.ValueNotSupported', + 'errorMessage' => '[%s] is not supported.', + ], + [ + 'errorCode' => 'Invalid%s.Malformed', + 'errorMessage' => 'The specified ArgValue [%s] is invalid.', + ], + [ + 'errorCode' => 'MissingParameter%s', + 'errorMessage' => 'The specified value of ArgName[%s] is missing.', + ], + [ + 'errorCode' => 'InvalidFunctionArgs.Malformed', + 'errorMessage' => 'The specified FunctionArgs is invalid.', + ], + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified ArgValue is missing.', + ], + [ + 'errorCode' => 'InvalidHeaderKey.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter HeaderKey is not supported.', + ], + [ + 'errorCode' => 'TooManyDomains', + 'errorMessage' => 'The count of domain is over 50.', + ], + [ + 'errorCode' => 'InvalidRule.Malformed', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidFunction.NotSupported', + 'errorMessage' => 'The domain is not supported to set the function.', + ], + [ + 'errorCode' => 'InvalidDomain.BelongToConfigGroup', + 'errorMessage' => 'This Domain activated in configuration group and should modify by config group.', + ], + [ + 'errorCode' => 'EntityNotExist.Role', + 'errorMessage' => 'EntityNotExist.Role', + ], + [ + 'errorCode' => 'MissingParameterFunctions', + 'errorMessage' => 'The specified value of Functions is missing.', + ], + [ + 'errorCode' => 'NoPermission.SLR', + 'errorMessage' => 'The current user does not have permission to create servicelinkedrole. Please contact the Alibaba Cloud account or administrator to authorize AliyunCDNFullAccess or custom policy:Service Name:cdn-ddos.cdn.aliyuncs.com,Role: AliyunServiceRoleForCDNAccessingDDoS,Permission: ram: CreateServiceLinkedRole', + ], + [ + 'errorCode' => 'ConfigExceedLimit', + 'errorMessage' => 'Count of config entries exceeds the limit.', + ], + [ + 'errorCode' => 'EdgeScriptCountExceedLimit', + 'errorMessage' => 'The number of rules exceeds the default limit (1). To increase the limit, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScripOptionsHasInnerConfig', + 'errorMessage' => 'The extension has a background configuration or a parameter of this configuration is invalid. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScriptGrammarNotSupport', + 'errorMessage' => 'A background customization rule exists or a parameter of this configuration is invalid. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'EdgeScriptNotSupportJs', + 'errorMessage' => 'JavaScript rules are not supported. For more information, submit a ticket.', + ], + [ + 'errorCode' => 'ServiceInvokeFailed', + 'errorMessage' => 'Failed to invoke service.', + ], + [ + 'errorCode' => 'ConfigurationConflicts', + 'errorMessage' => 'Failed to modify the parameter settings in the production environment because the parameter settings are different from those in the staging'."\n" + .'environment. Set parameters in the staging environment before you publish them to the production environment.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-****-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<BatchSetVodDomainConfigsResponse>\\r\\n<RequestId>04F0F334-1335-436C-****-6C044FE73368</RequestId>\\r\\n</BatchSetVodDomainConfigsResponse>","errorExample":""}]', + 'title' => '批量配置域名', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 一次最多支持配置50个域名。'."\n" + .'- 调用本接口给域名配置某些功能后，将会生成唯一的ConfigId，通过ConfigId可以完成更新和删除域名配置的操作。本接口调用成功后不返回ConfigId，需要通过[DescribeVodDomainConfigs](~~DescribeVodDomainConfigs~~)接口查询。', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InvalidFunctions.Malformed | Specified Functions is malformed. | 400 | 指定的Functions不合法|'."\n" + .'| InvalidFunctionName.ValueNotSupported | FunctionName %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不合法|', + ], + 'DescribeVodRefreshTasks' => [ + 'summary' => '调用本接口查询刷新和预热状态是否生效。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39909', + 'abilityTreeNodes' => [ + 'FEATUREvod59E0PR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '按任务ID查询刷新状态。', + 'type' => 'string', + 'required' => false, + 'example' => '70422****', + ], + ], + [ + 'name' => 'ObjectPath', + 'in' => 'query', + 'schema' => [ + 'description' => '按路径查询，准确匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example.com/***.txt', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '42949672', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ObjectType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。取值范围：'."\n" + .'- **file**：文件刷新。'."\n" + .'- **directory**：目录刷新。'."\n" + .'- **preload**：文件预热。'."\n" + ."\n" + .'> 当指定DomainName或Status时，ObjectType该项为必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'file', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态。取值：'."\n" + ."\n" + .'- **Complete**：完成。'."\n" + .'- **Refreshing**：刷新中。'."\n" + .'- **Failed**：刷新失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'Complete', + 'enum' => [ + 'Complete', + 'Refreshing', + 'Failed', + ], + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示的条目数。默认值：**20**。最大值：**50**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + ."\n" + .'> 仅能查询3天内的数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-01-01T12:12:20Z', + ], + ], + [ + '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-01-01T12:30:20Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '174F6032-AA26-470D-****-36F0EB205BEE', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '整页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Tasks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Task' => [ + 'description' => 'TaskItem组成的Task任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态。取值：'."\n" + .'- **Complete**：完成。'."\n" + .'- **Refreshing**：刷新中。'."\n" + .'- **Failed**：刷新失败。'."\n" + .'- **Pending**：等待刷新。', + 'type' => 'string', + 'example' => 'Complete', + ], + 'CreationTime' => [ + 'description' => '任务对象创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2014-11-27T08:23:22Z', + ], + 'ObjectType' => [ + 'description' => '任务类型。取值：'."\n" + .'- **file**默认：文件刷新。'."\n" + .'- **directory**：目录刷新。'."\n" + .'- **preload**：文件预热。', + 'type' => 'string', + 'example' => 'file', + ], + 'Process' => [ + 'description' => '进度百分比。', + 'type' => 'string', + 'example' => '100%', + ], + 'Description' => [ + 'description' => '刷新预热失败返回的错误描述。目前有三种：'."\n" + .'- **Internal Error**：内部错误。'."\n" + .'- **Origin Timeout**：源站响应超时。'."\n" + .'- **Origin Return StatusCode 5XX**：源站返回5XX状态码。'."\n", + 'type' => 'string', + 'example' => 'Internal Error', + ], + 'ObjectPath' => [ + 'description' => '刷新对象路径。', + 'type' => 'string', + 'example' => 'http://example.com/****.txt', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '704225667', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidTaskId.Malformed', + 'errorMessage' => 'The specified TaskId is invalid.', + ], + [ + 'errorCode' => 'MissingTimeParameter', + 'errorMessage' => 'The StartTime and EndTime must be both specified.', + ], + [ + 'errorCode' => 'MissingParameter.ObjectType', + 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is 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.', + ], + [ + 'errorCode' => 'InvalidObjectType.ValueNotSupported', + 'errorMessage' => 'The specified ObjectType is not supported.', + ], + [ + 'errorCode' => 'InvalidStatus.ValueNotSupported', + 'errorMessage' => 'The specified Status is not supported.', + ], + [ + 'errorCode' => 'DomainNameOverLimit', + 'errorMessage' => 'A maximum of 500 domains are supported for each request.', + ], + [ + 'errorCode' => 'InvalidTime', + 'errorMessage' => 'The query time cannot exceed the last 3 days.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"174F6032-AA26-470D-****-36F0EB205BEE\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"Tasks\\": {\\n \\"Task\\": [\\n {\\n \\"Status\\": \\"Complete\\",\\n \\"CreationTime\\": \\"2014-11-27T08:23:22Z\\",\\n \\"ObjectType\\": \\"file\\",\\n \\"Process\\": \\"100%\\",\\n \\"Description\\": \\"Internal Error\\",\\n \\"ObjectPath\\": \\"http://example.com/****.txt\\",\\n \\"TaskId\\": \\"704225667\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"utf-8\\"?>\\r\\n<DescribeVodRefreshTasksResponse>\\r\\n <Tasks>\\r\\n <Task>\\r\\n <CreationTime>2014-11-27T08:23:22Z</CreationTime>\\r\\n <ObjectPath>http://example.com/****.txt</ObjectPath>\\r\\n <Status>Complete</Status>\\r\\n <TaskId>704225667</TaskId>\\r\\n <ObjectType>file</ObjectType>\\r\\n <Process>100%</Process>\\r\\n </Task>\\r\\n <Task>\\r\\n <CreationTime>2014-11-27T08:18:38Z</CreationTime>\\r\\n <ObjectPath>http://example.com/****.txt</ObjectPath>\\r\\n <Status>Complete</Status>\\r\\n <TaskId>704222904</TaskId>\\r\\n <ObjectType>file</ObjectType>\\r\\n <Process>100%</Process>\\r\\n </Task>\\r\\n </Tasks>\\r\\n <PageNumber>1</PageNumber>\\r\\n <PageSize>10</PageSize>\\r\\n <TotalCount>2</TotalCount>\\r\\n <RequestId>13DF2E2F-FBF8-4E1C-****-98141795443D</RequestId>\\r\\n</DescribeVodRefreshTasksResponse>","errorExample":""}]', + 'title' => '查询刷新和预热状态', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 若Taskid与Objectpath都不指定，则默认查询3天内，第一页的数据（20条）。Taskid与Objectpath可以同时指定。'."\n" + .'- 当指定DomainName或Status时，ObjectType该项为必填。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| Throttling | Request was denied due to request throttling. | 503 | 请求被流量控制限制。|'."\n" + .'| OperationDenied | Your account does not open VOD service yet. | 403 | 账号未开通视频点播服务。|'."\n" + .'| OperationDenied.Suspended | Your VOD service is suspended. | 403 | 账号已欠费，请充值。|'."\n" + .'| InvalidTaskId.Malformed | Specified TaskId is malformed. | 400 | TaskId格式错误。|', + ], + 'DescribeVodRefreshQuota' => [ + 'summary' => '调用本接口查询刷新预热URL及目录的最大限制数量和当日剩余数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39908', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BlockQuota' => [ + 'description' => '当日存储刷新数量上限。', + 'type' => 'string', + 'example' => '500', + ], + 'PreloadRemain' => [ + 'description' => '当天剩余预热数量。', + 'type' => 'string', + 'example' => '500', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '42E0554B-80F4-4921-****-ACFB22CAAAD0', + ], + 'blockRemain' => [ + 'description' => '当日剩余存储刷新数量。', + 'type' => 'string', + 'example' => '500', + ], + 'DirRemain' => [ + 'description' => '当日剩余目录刷新数量。', + 'type' => 'string', + 'example' => '99', + ], + 'UrlRemain' => [ + 'description' => '当日剩余URL刷新数量。', + 'type' => 'string', + 'example' => '1996', + ], + 'DirQuota' => [ + 'description' => '当日路径刷新数量上限。', + 'type' => 'string', + 'example' => '100', + ], + 'UrlQuota' => [ + 'description' => '当日URL刷新数量上限。', + 'type' => 'string', + 'example' => '2000', + ], + 'PreloadQuota' => [ + 'description' => '当天预热数量上限。', + 'type' => 'string', + 'example' => '500', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"BlockQuota\\": \\"500\\",\\n \\"PreloadRemain\\": \\"500\\",\\n \\"RequestId\\": \\"42E0554B-80F4-4921-****-ACFB22CAAAD0\\",\\n \\"blockRemain\\": \\"500\\",\\n \\"DirRemain\\": \\"99\\",\\n \\"UrlRemain\\": \\"1996\\",\\n \\"DirQuota\\": \\"100\\",\\n \\"UrlQuota\\": \\"2000\\",\\n \\"PreloadQuota\\": \\"500\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeVodRefreshQuotaResponse>\\r\\n <DirQuota>100</DirQuota>\\r\\n <DirRemain>99</DirRemain>\\r\\n <RequestId>A56FC7F8-CA97-482E-****-F77C2135BD22</RequestId>\\r\\n <UrlQuota>2000</UrlQuota>\\r\\n <UrlRemain>1996</UrlRemain>\\r\\n <PreloadQuota>500</PreloadQuota>\\r\\n <PreloadRemain>500</PreloadRemain>\\r\\n</DescribeVodRefreshQuotaResponse>","errorExample":""}]', + 'title' => '查询刷新预热次数限制和余量', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 刷新预热类接口包含[RefreshVodObjectCaches](~~69215~~)刷新接口和[PreloadVodObjectCaches](~~69211~~)预热接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| Throttling | Request was denied due to request throttling. | 503 | 请求被流量控制限制。|'."\n" + .'| OperationDenied | Your account does not open VOD service yet. | 403 | 账号未开通视频点播服务。|'."\n" + .'| OperationDenied.Suspended | Your VOD service is suspended. | 403 | 账号已欠费，请充值。|', + ], + 'PreloadVodObjectCaches' => [ + 'summary' => '调用本接口将源站的内容主动预热到L2 Cache节点上，首次访问可直接命中缓存，缓解源站压力。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40098', + 'abilityTreeNodes' => [ + 'FEATUREvod59E0PR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ObjectPath', + 'in' => 'query', + 'schema' => [ + 'description' => '预热文件URL。多个URL使用换行符（\\n或\\r\\n）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'vod.test.com/test.txt', + ], + ], + [ + 'name' => 'Area', + 'in' => 'query', + 'schema' => [ + 'description' => '预热区域，取值：**domestic**, **overseas**。', + 'type' => 'string', + 'required' => false, + 'example' => 'domestic', + 'enum' => [ + 'domestic', + 'overseas', + ], + ], + ], + [ + 'name' => 'L2Preload', + 'in' => 'query', + 'schema' => [ + 'description' => '是否直接预热到L2节点。取值：'."\n" + ."\n" + .'- **true**：代表预热的节点层级必须包含L2节点。'."\n" + ."\n" + .'- **false**：代表仅预热回源层节点（false为**默认值**，回源层节点可能是L2节点，也可能是L3节点）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'WithHeader', + 'in' => 'query', + 'schema' => [ + 'description' => '预热请求默认携带的header是Accept-Encoding:gzip，如果您需要预热请求携带其他header，或者实现多副本预热，那么可以使用该参数来实现自定义预热header。用JSON串格式提交。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "Accept-Encoding": ['."\n" + .' "gzip, deflate, br"'."\n" + .' ]'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'PreloadTaskId' => [ + 'description' => '预热返回的任务ID。多个任务ID用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => '9524****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E5BD4B50-7A02-493A-*****-97B9024B4135', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SingleRequest.OverLimit', + 'errorMessage' => 'A maximum of 1000 URLs are supported for each request.', + ], + [ + 'errorCode' => 'QuotaExceeded.Preload', + 'errorMessage' => 'Your refresh attempts have exceeded the daily limit.', + ], + [ + 'errorCode' => 'InvalidObjectPath.Malformed', + 'errorMessage' => 'The specified ObjectPath is invalid.', + ], + [ + 'errorCode' => 'InvalidExtensiveDomain.ValueNotSupported', + 'errorMessage' => 'The specified ExtensiveDomain is not supported.', + ], + [ + 'errorCode' => 'PreloadQueueFull', + 'errorMessage' => 'The warming queue is full; please try again later.', + ], + [ + 'errorCode' => 'InvalidCustomHeader', + 'errorMessage' => 'Parse preload header failed.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomain.Offline', + 'errorMessage' => 'The domain provided is offline.', + ], + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not belong to you.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PreloadTaskId\\": \\"9524****\\",\\n \\"RequestId\\": \\"E5BD4B50-7A02-493A-*****-97B9024B4135\\"\\n}","errorExample":""},{"type":"xml","example":"<PreloadVodObjectCachesResponse>\\r\\n <PreloadTaskId>9525****</PreloadTaskId>\\r\\n <RequestId>5FF9B16E-FBAC-48E5-****-65B5F0184DB3</RequestId>\\r\\n</PreloadVodObjectCachesResponse>","errorExample":""}]', + 'title' => '预热缓存', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 同一账号每天最多可提交预热URL请求共500条，目前不支持目录级别的预热。'."\n" + .'- 刷新预热类接口包含[RefreshVodObjectCaches](~~RefreshVodObjectCaches~~)刷新接口和[PreloadVodObjectCaches](~~PreloadVodObjectCaches~~)预热接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| Throttling | Request was denied due to request throttling. | 503 | 请求被流量控制限制。|'."\n" + .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 非法域名, 无法操作。|'."\n" + .'| OperationDenied | Your account does not open VOD service yet. | 403 | 账号未开通视频点播服务。|'."\n" + .'| OperationDenied.Suspended | Your VOD service is suspended. | 403 | 账号已欠费，请充值。如果您欠费超过15天，续费后需要重新开通点播服务。|'."\n" + .'| InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不属于当前用户。|'."\n" + .'| InvalidDomain.Offline | The domain provided is offline. | 404 | 域名已下线。|'."\n" + .'| QuotaExceeded.Refresh | You’ve exceeded the prescribed refresh limits. | 400 | 超出当日刷新限制。|'."\n" + .'| PreloadQueueFull | Preload queue is full, please try again later! | 403 | 预热队列已满（域名正在预热的URL个数已经达到上限），请稍后再试。|'."\n" + .'| InvalidDomain.Configure_failed | Failed to configure the provided domain. | 500 | 域名配置失败, 无法刷新。|'."\n" + .'| MissingParameter | The input parameter “ObjectPath” that is mandatory for processing this request is not supplied. | 400 | 缺少ObjectPath参数。|'."\n" + .'| InvalidObjectPath.Malformed | The specific value of parameter ObjectPath is malformed. | 400 | ObjectPath值格式错误。|'."\n" + .'| InvalidExtensiveDomain.ValueNotSupported | Extensive domain not supported. | 400 | 不支持泛域名。|'."\n" + .'| InvalidObjectPath.Size.Malformed | The size of ObjectPath is bigger than 1000. | 400 | 预热URL个数一次不能超过1000。|', + ], + 'RefreshVodObjectCaches' => [ + 'summary' => '调用本接口刷新节点上的文件内容。指定URL内容刷新至Cache节点，支持URL批量刷新。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40109', + 'abilityTreeNodes' => [ + 'FEATUREvod59E0PR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ObjectPath', + 'in' => 'query', + 'schema' => [ + 'description' => '预热文件URL。多个URL使用换行符（\\n或\\r\\n）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'abc.com/image/1.png', + ], + ], + [ + 'name' => 'ObjectType', + 'in' => 'query', + 'schema' => [ + 'description' => '刷新的类型。取值：'."\n" + ."\n" + .'- **File**（默认值）：文件刷新。'."\n" + .'- **Directory**：目录刷新。'."\n" + .'- **Regex**：正则刷新。'."\n" + .'- **IgnoreParams**：去参数刷新。去参数指的是去除请求 URL 中?及?之后的参数，去参数刷新指的是用户先通过接口提交去参数后的 URL，然后用户提交的待刷新 URL 将会与已缓存资源的 URL 进行去参数匹配，如果已缓存资源的 URL 去参数以后与待刷新 URL 匹配，那么 CDN 节点将对缓存资源执行刷新处理。', + 'type' => 'string', + 'required' => false, + 'example' => 'File', + 'default' => 'File', + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'description' => '当回源内容和源站资源对比后不一致时，是否刷新对应目录下的资源。默认为 false。'."\n" + ."\n" + .'- **true**：刷新对应目录下的全部资源。选择'."\n" + .'“刷新全部资源” 时，如果用户请求的内容匹配到了目录下的资源，CDN 节点将会直接回源拉取新资源返回给用户，并重新缓存该资源。'."\n" + .'- **false**：刷新对应目录下发生变更的资源。选择 “刷新变更资源” 时，如果用户请求的内容匹配到了目录下的资源，CDN 节点将会回源获取资源的 Last-Modified 信息，若与当前缓存资源一致，则直接返回已缓存资源，若不一致，则回源拉取新资源返回给用户，并重新缓存该资源。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RefreshTaskId' => [ + 'description' => '刷新返回的任务ID。多个任务ID用半角逗号（,）分隔。'."\n" + .'刷新返回的任务 ID 会按照以下两条规则对刷新任务做合并：'."\n" + ."\n" + .'同一个域名、同一秒钟提交的刷新任务（URL 颗粒度）会被合并为同一个 RefreshTaskId。'."\n" + .'同一个域名、同一秒钟提交的刷新任务（URL 颗粒度）如果超过 2000 条，那么会按照每 2000 条合并为一个 RefreshTaskId 的方式处理。', + 'type' => 'string', + 'example' => '70422*****2904', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D61E4801-EAFF-4A63-****-FBF6CE1CFD1C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SingleRequest.OverLimit', + 'errorMessage' => 'A maximum of 1000 URLs are supported for each request.', + ], + [ + 'errorCode' => 'InvalidObjectType.Malformed', + 'errorMessage' => 'The specified ObjectType is invalid.', + ], + [ + 'errorCode' => 'QuotaExceeded.Refresh', + 'errorMessage' => 'Your refresh attempts have exceeded the daily limit.', + ], + [ + 'errorCode' => 'InvalidObjectPath.Malformed', + 'errorMessage' => 'The specified ObjectPath is invalid.', + ], + [ + 'errorCode' => 'InvalidExtensiveDomain.ValueNotSupported', + 'errorMessage' => 'The specified ExtensiveDomain is not supported.', + ], + [ + 'errorCode' => 'QuotaPerMinuteExceeded.Refresh', + 'errorMessage' => 'You tried to refresh too frequently; please try again later.', + ], + [ + 'errorCode' => 'TooMany.Refresh', + 'errorMessage' => 'The refresh queue is full; please try again later.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not belong to you.', + ], + [ + 'errorCode' => 'InvalidDomain.Offline', + 'errorMessage' => 'The domain provided is offline.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RefreshTaskId\\": \\"70422*****2904\\",\\n \\"RequestId\\": \\"D61E4801-EAFF-4A63-****-FBF6CE1CFD1C\\"\\n}","errorExample":""},{"type":"xml","example":"<RefreshVodObjectCachesResponse>\\n <RefreshTaskId>70422*****2904</RefreshTaskId>\\n <RequestId>D61E4801-EAFF-4A63-****-FBF6CE1CFD1C</RequestId>\\n</RefreshVodObjectCachesResponse>","errorExample":""}]', + 'title' => '刷新缓存', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 同一账号每天最多可提交刷新URL请求共2000条，刷新目录共100个。'."\n" + .'- 刷新预热类接口包含[RefreshVodObjectCaches](~~69215~~)刷新接口和[PreloadVodObjectCaches](~~69211~~)预热接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| Throttling | Request was denied due to request throttling. | 503 | 请求被流量控制限制。|'."\n" + .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 非法域名, 无法操作|'."\n" + .'| OperationDenied | Your account does not open VOD service yet. | 403 | 账号未开通视频点播服务。|'."\n" + .'| OperationDenied.Suspended | Your VOD service is suspended. | 403 | 账号已欠费，请充值。|'."\n" + .'| InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不属于当前用户。|'."\n" + .'| InvalidDomain.Offline | The domain provided is offline. | 404 | 域名已下线。|'."\n" + .'| QuotaExceeded.Refresh | You’ve exceeded the prescribed refresh limits. | 400 | 超出当日刷新限制。|'."\n" + .'| ServiceBusy | The specified Domain is configuring, please retry later. | 403 | 域名正在配置中, 请稍后再试。|'."\n" + .'| InvalidDomain.Configure_failed | Failed to configure the provided domain. | 500 | 域名配置失败, 无法刷新。|'."\n" + .'| MissingParameter | The input parameter “ObjectPath” that is mandatory for processing this request is not supplied. | 400 | 缺少ObjectPath参数。|'."\n" + .'| InvalidObjectType.ValueNotSupported | The specified value of "<ObjectType>" is not supported. | 400 | 不支持指定的ObjectType值。|'."\n" + .'| InvalidObjectPath.Malformed | The specific value of parameter ObjectPath is malformed. | 400 | ObjectPath值格式错误。|'."\n" + .'| InvalidExtensiveDomain.ValueNotSupported | Extensive domain not supported. | 400 | 不支持泛域名。|'."\n" + .'| QuotaPerMinuteExceeded.Refresh | You’ve exceeded the prescribed refresh limits per minute. | 400 | 超出每分钟刷新限制。|', + ], + 'RefreshMediaPlayUrls' => [ + 'summary' => '调用本接口通过音视频ID发起音视频刷新或预热任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'MediaIds', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资ID列表', + 'description' => '需要刷新或预热的音/视频ID。支持设置一个或多个，多个ID之前使用半角逗号（,）分隔，最多支持20个。'."\n" + .'音/视频ID可通过以下方式获取：'."\n" + .'- 通过控制台上传的音/视频，可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看音/视频ID。'."\n" + .'- 通过[获取音视频上传地址和凭证](~~55407~~)接口获取上传地址和凭证时，音/视频ID为返回参数VideoId的值。'."\n" + .'- 音/视频上传后，可通过[搜索媒体信息](~~86044~~)接口查询音/视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'ca3a8f6e4957b658067095869****, a6e49sfgd23p5g9ja7095863****', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => 'Refresh: 刷新。Preload: 预热', + 'description' => '提交的任务类型。取值：'."\n" + .'- **Refresh**：刷新'."\n" + .'- **Preload**：预热', + 'type' => 'string', + 'required' => true, + 'example' => 'Preload', + ], + ], + [ + 'name' => 'Formats', + 'in' => 'query', + 'schema' => [ + 'title' => '播放流格式', + 'description' => '设置需要刷新或预热的播放流格式。支持设置多个格式，多个格式之间使用半角逗号（,）分隔。若不设置，则**默认刷新或预热所有格式的播放流**。支持的格式如下：'."\n" + .'- **mp4**'."\n" + .'- **m3u8**'."\n" + .'- **mp3**'."\n" + .'- **flv**'."\n" + .'- **webm**'."\n" + .'- **ts**', + 'type' => 'string', + 'required' => false, + 'example' => 'mp4,m3u8', + ], + ], + [ + 'name' => 'Definitions', + 'in' => 'query', + 'schema' => [ + 'title' => '播放流清晰度', + 'description' => '设置需要刷新或预热的播放流清晰度。支持设置多个清晰度，多个清晰度之间使用半角逗号（,）分隔。若不设置，则**默认刷新或预热所有清晰度的播放流**。'."\n" + .'> 取值必须为[媒资参数说明](~~124671~~)中**清晰度：Definition**所定义的取值。', + 'type' => 'string', + 'required' => false, + 'example' => 'HD, SD', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'title' => '播放流类型：视频或音频', + 'description' => '设置需要刷新或预热的播放流类型。支持设置多个播放流类型，多个播放流类型之间使用半角逗号（,）分隔。若不设置，则**默认刷新或预热所有的播放流类型**。取值：'."\n" + .'- **video**：视频'."\n" + .'- **audio**：音频', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + ], + ], + [ + 'name' => 'ResultType', + 'in' => 'query', + 'schema' => [ + 'title' => '结果类型：Single或Multiple', + 'description' => '设置刷新或预热的结果类型。取值：'."\n" + .'- **Single**（默认）：每种清晰度和格式只刷新或预热一路最新转码完成的流。'."\n" + .'- **Multiple**：每种清晰度和格式刷新或预热所有转码完成的流。', + 'type' => 'string', + 'required' => false, + 'example' => 'Single', + ], + ], + [ + 'name' => 'SliceFlag', + 'in' => 'query', + 'schema' => [ + 'title' => 'M3U8文件是否获取ts链接', + 'description' => '设置是否刷新或预热M3U8播放流的TS文件的播放链接。取值：'."\n" + .'- **false**（默认）：否'."\n" + .'- **true**：是', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'SliceCount', + 'in' => 'query', + 'schema' => [ + 'title' => 'M3U8文件的ts链接数量', + 'description' => '设置刷新或预热M3U8播放流的TS文件播放链接的个数。每个M3U8播放流仅会刷新前N个TS文件的播放链接。取值范围为1~20，**默认值为5**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '回调设置', + 'description' => '自定义设置。为JSON字符串，支持消息回调、上传加速等设置。更多信息，请参见[UserData](~~86952~~)。'."\n" + .'> - 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用，否则回调设置不生效。控制台配置HTTP回调的操作，请参见[回调设置](~~86071~~)。'."\n" + .'> - 如需使用上传加速功能，请提交工单申请开通，更多信息，请参见[上传相关说明](~~55396~~)。关于如何提交工单，请参见[联系我们](~~464625~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'MediaRefreshJobId' => [ + 'title' => '刷新预热任务ID', + 'description' => '刷新或预热的任务ID', + 'type' => 'string', + 'example' => '41d465e31957****', + ], + 'NonExistMediaIds' => [ + 'title' => '不存在的媒资ID', + 'description' => '不存在的音/视频ID列表。', + 'type' => 'string', + 'example' => 'ca3a8f6e4957b658067095869****', + ], + 'ForbiddenMediaIds' => [ + 'title' => '没有多应用权限的视频ID', + 'description' => '被禁止操作的音/视频ID列表，通常是由于没有多应用的权限而导致被禁止操作，更多信息，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'example' => 'a6e49sfgd23p5g9ja7095863****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-04D5-D7393642****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MediaRefreshJobId\\": \\"41d465e31957****\\",\\n \\"NonExistMediaIds\\": \\"ca3a8f6e4957b658067095869****\\",\\n \\"ForbiddenMediaIds\\": \\"a6e49sfgd23p5g9ja7095863****\\",\\n \\"RequestId\\": \\"25818875-5F78-4AF6-04D5-D7393642****\\"\\n}","errorExample":""},{"type":"xml","example":"<RefreshMediaPlayUrlsResponse>\\n <MediaRefreshJobId>41d465e31957****</MediaRefreshJobId>\\n <NonExistMediaIds>ca3a8f6e4957b658067095869****</NonExistMediaIds>\\n <ForbiddenMediaIds>a6e49sfgd23p5g9ja7095863****</ForbiddenMediaIds>\\n <RequestId>25818875-5F78-4AF6-04D5-D7393642****</RequestId>\\n</RefreshMediaPlayUrlsResponse>","errorExample":""}]', + 'title' => '提交音视频刷新或预热任务', + 'description' => '- 视频点播提供资源的刷新和预热功能，通过刷新功能，您可以删除CDN节点上已经缓存的资源，并强制CDN节点回源站获取最新资源；通过预热功能，您可以在业务高峰前预热热门资源，提前将热门资源下载并缓存到CDN节点，提高资源的访问效率。'."\n" + .'- 本接口直接通过音/视频ID发起刷新或预热任务，且支持筛选播放流格式及清晰度等，满足用户按需选择合适的播放流进行刷新预热的需求。'."\n" + .'- 最多支持一次发起20个音/视频的刷新或预热任务。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + ], + 'GetMediaRefreshJobs' => [ + 'summary' => '调用本接口查询视频刷新或预热任务的任务状态、筛选策略等任务信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'MediaRefreshJobId', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资刷新预热任务ID', + 'description' => '音/视频刷新或预热的任务ID，为[提交音视频刷新或预热任务](~~431095~~)接口返回参数MediaRefreshJobId的值。', + 'type' => 'string', + 'required' => true, + 'example' => '41d465e31957****', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资ID', + 'description' => '音/视频ID，为[提交音视频刷新或预热任务](~~431095~~)时传入的`MediaIds`，只能设置一个音/视频ID。'."\n" + ."\n" + .'若不传入本参数，则查询`MediaRefreshJobId`下所有音/视频的任务信息；若传入本参数，则只查询`MediaRefreshJobId`下该音/视频ID所对应的任务信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'ca3a8f6e4957b658067095869****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'MediaRefreshJobs' => [ + 'description' => '音/视频刷新或预热任务信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '音/视频刷新或预热任务详情。', + 'type' => 'object', + 'properties' => [ + 'MediaRefreshJobId' => [ + 'description' => '音/视频刷新或预热的任务ID。', + 'type' => 'string', + 'example' => '41d465e31957****', + ], + 'MediaId' => [ + 'description' => '音/视频ID。', + 'type' => 'string', + 'example' => 'ca3a8f6e4957b658067095869****', + ], + 'TaskType' => [ + 'description' => '任务类型。取值：'."\n" + .'- **Refresh**：刷新'."\n" + .'- **Preload**：预热', + 'type' => 'string', + 'example' => 'Preload', + ], + 'FilterPolicy' => [ + 'description' => '播放流的筛选策略。JSON格式，内容为[提交音视频刷新或预热任务](~~431095~~)接口的请求参数。', + 'type' => 'string', + 'example' => '{"Formats":"mp4,m3u8", "Definitions":"HD,SD", " StreamType":"video", "ResultType":"Single", " SliceFlag":false, "SliceCount": 3}', + ], + 'Status' => [ + 'description' => '任务状态。取值：'."\n" + .'- **success**：成功'."\n" + .'- **fail**：失败', + 'type' => 'string', + 'example' => 'success', + ], + 'SuccessPlayUrls' => [ + 'description' => '成功被刷新或预热的播放URL。', + 'type' => 'string', + 'example' => 'https://shenzhen.****.aliyuncdn.com/74401a4f546007bf845cd8840****.m3u8,https://shenzhen.****.aliyuncdn.com/24041e7d13582d86604d8****.m3u8', + ], + 'TaskIds' => [ + 'description' => '播放URL的刷新或预热的任务ID，一个URL对应一个任务ID。该任务ID用于[DescribeVodRefreshTasks](~~69214~~)接口查询每个播放URL的刷新或预热状态。', + 'type' => 'string', + 'example' => '70422****,9524****', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n" + .'当提交刷新或预热任务失败时会有该字段。', + 'type' => 'string', + 'example' => 'PreloadQueueFull', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n" + .'当提交刷新或预热任务失败时会有该字段。', + 'type' => 'string', + 'example' => 'Preload queue is full, please try again later!', + ], + 'UserData' => [ + 'description' => '提交刷新或预热任务时传入的UserData信息。', + 'type' => 'string', + 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}}', + ], + 'GmtCreate' => [ + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2022-05-20 08:23:22', + ], + 'GmtModified' => [ + 'description' => '任务修改时间。', + 'type' => 'string', + 'example' => '2022-05-21 08:23:22', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"MediaRefreshJobs\\": [\\n {\\n \\"MediaRefreshJobId\\": \\"41d465e31957****\\",\\n \\"MediaId\\": \\"ca3a8f6e4957b658067095869****\\",\\n \\"TaskType\\": \\"Preload\\",\\n \\"FilterPolicy\\": \\"{\\\\\\"Formats\\\\\\":\\\\\\"mp4,m3u8\\\\\\", \\\\\\"Definitions\\\\\\":\\\\\\"HD,SD\\\\\\", \\\\\\" StreamType\\\\\\":\\\\\\"video\\\\\\", \\\\\\"ResultType\\\\\\":\\\\\\"Single\\\\\\", \\\\\\" SliceFlag\\\\\\":false, \\\\\\"SliceCount\\\\\\": 3}\\",\\n \\"Status\\": \\"success\\",\\n \\"SuccessPlayUrls\\": \\"https://shenzhen.****.aliyuncdn.com/74401a4f546007bf845cd8840****.m3u8,https://shenzhen.****.aliyuncdn.com/24041e7d13582d86604d8****.m3u8\\",\\n \\"TaskIds\\": \\"70422****,9524****\\",\\n \\"ErrorCode\\": \\"PreloadQueueFull\\",\\n \\"ErrorMessage\\": \\"Preload queue is full, please try again later!\\",\\n \\"UserData\\": \\"{\\\\\\"MessageCallback\\\\\\":{\\\\\\"CallbackURL\\\\\\":\\\\\\"http://example.aliyundoc.com\\\\\\"}, \\\\\\"Extend\\\\\\":{\\\\\\"localId\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"test\\\\\\":\\\\\\"www\\\\\\"}}\\",\\n \\"GmtCreate\\": \\"2022-05-20 08:23:22\\",\\n \\"GmtModified\\": \\"2022-05-21 08:23:22\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetMediaRefreshJobsResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <MediaRefreshJobs>\\n <MediaRefreshJobId>41d465e31957****</MediaRefreshJobId>\\n <MediaId>ca3a8f6e4957b658067095869****</MediaId>\\n <TaskType>Preload</TaskType>\\n <FilterPolicy>{\\"Formats\\":\\"mp4,m3u8\\", \\"Definitions\\":\\"HD,SD\\", \\" StreamType\\":\\"video\\", \\"ResultType\\":\\"Single\\", \\" SliceFlag\\":false, \\"SliceCount\\": 3}</FilterPolicy>\\n <Status>success</Status>\\n <SuccessPlayUrls>https://shenzhen.****.aliyuncdn.com/74401a4f546007bf845cd8840****.m3u8,https://shenzhen.****.aliyuncdn.com/24041e7d13582d86604d8****.m3u8</SuccessPlayUrls>\\n <TaskIds>70422****,9524****</TaskIds>\\n <UserData>{\\"MessageCallback\\":{\\"CallbackURL\\":\\"http://example.aliyundoc.com\\"}, \\"Extend\\":{\\"localId\\":\\"xxx\\",\\"test\\":\\"www\\"}}</UserData>\\n <GmtCreate>2022-05-20T08:23:22Z</GmtCreate>\\n <GmtModified>2022-05-21T08:23:22Z</GmtModified>\\n </MediaRefreshJobs>\\n</GetMediaRefreshJobsResponse>","errorExample":""}]', + 'title' => '查询视频刷新或预热任务信息', + 'description' => '### 使用说明'."\n" + .'支持查询刷新或预热任务下所有音/视频的任务信息或指定查某一个音/视频的任务信息。'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + ], + 'DescribeVodDomainLog' => [ + 'summary' => '调用本接口获取指定域名的CDN原始访问日志下载地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39884', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '点播加速域名。'."\n" + .'> 仅支持单个查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。'."\n" + .'- 默认值：**300**'."\n" + .'- 最大值：**1000**', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '300', + 'default' => '300', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取日志起始时间点。格式为：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-10-20T04:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，需晚于起始时间。起止时间和结束时间，间隔不超过一年。格式为：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-10-20T05:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '077D0284-F041-4A41-4D3C-B48377FD****', + ], + 'DomainLogDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DomainLogDetail' => [ + 'description' => 'CDN日志详细数据。', + 'type' => 'array', + 'items' => [ + 'description' => 'CDN日志详情。', + 'type' => 'object', + 'properties' => [ + 'LogCount' => [ + 'description' => '本页返回的总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'DomainName' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'LogInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogInfoDetail' => [ + 'description' => 'CDN日志详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'CDN日志详情。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。格式为：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2018-05-31T05:00:00Z', + ], + 'LogSize' => [ + 'description' => '日志大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2645401', + ], + 'StartTime' => [ + 'description' => '开始时间。格式为：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2018-05-31T04:00:00Z', + ], + 'LogName' => [ + 'description' => '日志名称。', + 'type' => 'string', + 'example' => 'example.com_2018_03_25_180000_19****.gz', + ], + 'LogPath' => [ + 'description' => '日志路径。', + 'type' => 'string', + 'example' => 'example.com/2018_03_25/example.com_2018_03_25_180000_19****.gz?Expires=1522659931&OSSAccessKeyId=****&Signature=****', + ], + ], + ], + ], + ], + ], + 'PageInfos' => [ + 'description' => 'CDN日志翻页信息。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '返回数据的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '整页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + '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' => 'StartTime or EndTime is miss match.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter \\ is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"077D0284-F041-4A41-4D3C-B48377FD****\\",\\n \\"DomainLogDetails\\": {\\n \\"DomainLogDetail\\": [\\n {\\n \\"LogCount\\": 2,\\n \\"DomainName\\": \\"example.com\\",\\n \\"LogInfos\\": {\\n \\"LogInfoDetail\\": [\\n {\\n \\"EndTime\\": \\"2018-05-31T05:00:00Z\\",\\n \\"LogSize\\": 2645401,\\n \\"StartTime\\": \\"2018-05-31T04:00:00Z\\",\\n \\"LogName\\": \\"example.com_2018_03_25_180000_19****.gz\\",\\n \\"LogPath\\": \\"example.com/2018_03_25/example.com_2018_03_25_180000_19****.gz?Expires=1522659931&OSSAccessKeyId=****&Signature=****\\"\\n }\\n ]\\n },\\n \\"PageInfos\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 300,\\n \\"Total\\": 2\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVodDomainLogResponse>\\n <RequestId>077D0284-F041-4A41-4D3C-B48377FD****</RequestId>\\n <DomainLogDetails>\\n <LogCount>2</LogCount>\\n <DomainName>example.com</DomainName>\\n <LogInfos>\\n <EndTime>2018-05-31T05:00:00Z</EndTime>\\n <LogSize>2645401</LogSize>\\n <StartTime>2018-05-31T04:00:00Z</StartTime>\\n <LogName>example.com_2018_03_25_180000_19****.gz</LogName>\\n <LogPath>example.com/2018_03_25/example.com_2018_03_25_180000_19****.gz?Expires=1522659931&OSSAccessKeyId=****&Signature=****</LogPath>\\n </LogInfos>\\n <PageInfos>\\n <PageNumber>1</PageNumber>\\n <PageSize>300</PageSize>\\n <Total>2</Total>\\n </PageInfos>\\n </DomainLogDetails>\\n</DescribeVodDomainLogResponse>","errorExample":""}]', + 'title' => '查询域名日志', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 日志格式、延迟时间等详细说明，请参见[日志管理](~~86099~~)。'."\n" + .'- 不指定StartTime和EndTime时，默认读取过去24小时的日志数据。'."\n" + .'- StartTime和EndTime需要同时指定。按指定的起止时间查询日志。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GenerateKMSDataKey' => [ + 'summary' => '通过调用本接口生成一个随机的KMS数据密钥，用于视频点播标准加密。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '144169', + 'abilityTreeNodes' => [ + 'FEATUREvodMVRCEC', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'KeyId' => [ + 'description' => '主密钥的全局唯一标识符。', + 'type' => 'string', + 'example' => '7906979c-8e06-46a2-be2d-68e3ccbc****', + ], + 'CiphertextBlob' => [ + 'description' => '数据密钥被加密后的密文。用于在发起转码时填入CipherText参数。', + 'type' => 'string', + 'example' => 'ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****', + ], + 'Plaintext' => [ + 'description' => '数据密钥的明文经过Base64编码后的值。', + 'type' => 'string', + 'example' => 'QmFzZTY0IGVuY29kZWQgcGxhaW50****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'EntityNotExist.Role', + 'errorMessage' => 'AliyunVODDefaultRole is not authorized by your account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"KeyId\\": \\"7906979c-8e06-46a2-be2d-68e3ccbc****\\",\\n \\"CiphertextBlob\\": \\"ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****\\",\\n \\"Plaintext\\": \\"QmFzZTY0IGVuY29kZWQgcGxhaW50****\\"\\n}","type":"json"}]', + 'title' => '创建KMS数据密钥', + ], + 'DecryptKMSDataKey' => [ + 'summary' => '通过调用本接口解密KMS数据密钥中的CiphertextBlob密文。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '146055', + 'abilityTreeNodes' => [ + 'FEATUREvodMVRCEC', + ], + ], + 'parameters' => [ + [ + 'name' => 'CipherText', + 'in' => 'query', + 'schema' => [ + 'title' => '待解密的密文。', + 'description' => '待解密的密文。', + 'type' => 'string', + 'required' => true, + 'example' => 'DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'KeyId' => [ + 'description' => '解密密文使用的主密钥ID。', + 'type' => 'string', + 'example' => '202b9877-5a25-46e3-a763-e20791b5****', + ], + 'Plaintext' => [ + 'description' => '解密后的明文。', + 'type' => 'string', + 'example' => 'tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'EntityNotExist.Role', + 'errorMessage' => 'AliyunVODDefaultRole is not authorized by your account.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"KeyId\\": \\"202b9877-5a25-46e3-a763-e20791b5****\\",\\n \\"Plaintext\\": \\"tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****\\"\\n}","type":"json"}]', + 'title' => '解密KMS数据密钥密文', + ], + 'SubmitDigitalWatermarkExtractJob' => [ + 'summary' => '通过调用本接口提交数字水印（版权水印或溯源水印）提取作业，开始异步提取版权水印或溯源水印。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '待提取水印的视频的视频ID，仅支持传入单个视频ID。可通过以下方式获取：'."\n" + .'- 登录[视频点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[SearchMedia](~~436559~~)接口请求后会返回视频ID（VideoId）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0222e203cf80f9c22870a4d2c****', + ], + ], + [ + 'name' => 'ExtractType', + 'in' => 'query', + 'schema' => [ + 'description' => '水印提取类型。取值：'."\n" + ."\n" + .'- **TraceMark**：溯源水印。'."\n" + .'- **CopyrightMark**：版权水印。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TraceMark', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '水印提取作业ID。可作为[GetDigitalWatermarkExtractResult](~~2587769~~)接口的请求参数。', + 'type' => 'string', + 'example' => 'ad90a501b1b9472374ad005046****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-****-6C044FE73368', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobId\\": \\"ad90a501b1b9472374ad005046****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-****-6C044FE73368\\"\\n}","type":"json"}]', + 'title' => '提交数字水印提取作业', + 'description' => '- **请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。数字水印为付费功能，数字水印的生成和提取都涉及计费，计费详情请参见[数字水印计费](~~188310#62b9c940403se~~)。**'."\n" + .'- 目前本接口服务地址仅支持：**华东2（上海）**、**华北2（北京）**。'."\n" + .'- <props="china">有关数字水印的生成和提取等更多信息，请参见[数字水印](~~2527021~~)。</props>提交数字水印提取作业前，请确保已满足下述条件：'."\n" + .' - 待提取水印的视频已经上传到视频点播中。'."\n" + .' - 待提取水印的视频时长需要超过6分钟。'."\n" + .'- 数字水印提取作业提交后，请调用[GetDigitalWatermarkExtractResult](~~2587769~~)接口查询作业结果。', + ], + 'GetDigitalWatermarkExtractResult' => [ + 'summary' => '通过调用本接口查询数字水印（版权水印或溯源水印）的提取作业结果，包括数字水印提取作业的状态、成功提取出的水印文字等信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的视频ID，仅支持传入单个视频ID。可通过以下方式获取：'."\n" + .'- 登录[视频点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看视频ID。'."\n" + .'- 通过[SearchMedia](~~SearchMedia~~)接口请求后会返回视频ID（VideoId）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '93ab850b4f6f54b6e91d24d81d4****', + ], + ], + [ + 'name' => 'ExtractType', + 'in' => 'query', + 'schema' => [ + 'description' => '水印提取类型。取值：'."\n" + ."\n" + .'- **TraceMark**：溯源水印'."\n" + .'- **CopyrightMark**：版权水印', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TraceMark', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '水印提取作业ID。'."\n" + .'- 调用[SubmitDigitalWatermarkExtractJob](~~SubmitDigitalWatermarkExtractJob~~)接口后会返回。'."\n" + .'- 传入该参数，则可查询指定水印提取作业ID的结果；不传，则默认返回该视频下所有历史水印提取作业的结果。', + 'type' => 'string', + 'required' => false, + 'example' => '2bf4390af9e5491c09cc720ad****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '42E0554B-80F4-4921-****-ACFB22CAAAD0', + ], + 'AiExtractResultList' => [ + 'description' => '水印提取作业详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '水印提取作业ID。', + 'type' => 'string', + 'example' => '3af004763bcf459698860f4ede20****', + ], + 'CreateTime' => [ + 'description' => '水印提取作业的创建时间。', + 'type' => 'string', + 'example' => '2023-09-16T02:49:04Z', + ], + 'ModifyTime' => [ + 'description' => '水印提取作业的最后更新时间。', + 'type' => 'string', + 'example' => '2023-09-17T06:20:45Z', + ], + 'Status' => [ + 'description' => '水印提取作业的状态。取值：'."\n" + ."\n" + .'- **Success**：成功 '."\n" + .'- **Failed**：失败'."\n" + .'- **Processing**：处理中', + 'type' => 'string', + 'example' => 'Failed', + ], + 'ErrorMessage' => [ + 'description' => '报错提示信息。当水印提取作业处理失败（即`Status`为`Failed`）时，才会返回本参数。', + 'type' => 'string', + 'example' => 'query copyright info err', + ], + 'WaterMarkText' => [ + 'description' => '提取出的水印文字。', + 'type' => 'string', + 'example' => 'test mark', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42E0554B-80F4-4921-****-ACFB22CAAAD0\\",\\n \\"AiExtractResultList\\": [\\n {\\n \\"JobId\\": \\"3af004763bcf459698860f4ede20****\\",\\n \\"CreateTime\\": \\"2023-09-16T02:49:04Z\\",\\n \\"ModifyTime\\": \\"2023-09-17T06:20:45Z\\",\\n \\"Status\\": \\"Failed\\",\\n \\"ErrorMessage\\": \\"query copyright info err\\",\\n \\"WaterMarkText\\": \\"test mark\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询数字水印提取作业', + 'description' => '- 目前本接口服务地址仅支持：华东 2（上海）、华北 2（北京）。'."\n" + .'- 调用[SubmitDigitalWatermarkExtractJob](~~SubmitDigitalWatermarkExtractJob~~)接口提取视频的版权水印或溯源水印后，调用本接口查询提取出来的水印文字信息。'."\n" + .'- 目前仅支持查询最近2年内的水印提取作业。', + ], + 'GenerateDownloadSecretKey' => [ + 'summary' => '阿里云播放器SDK的安全下载功能，可使视频下载到本地时经密钥文件进行加密，让其仅能通过预先绑定的唯一App生成的密钥文件进行解密播放，可有效保护视频内容，防止下载到本地的视频被恶意播放或传播。调用本接口可生成用于安全下载的密钥。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39929', + 'abilityTreeNodes' => [ + 'FEATUREvodU0GZW5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppIdentification', + 'in' => 'query', + 'schema' => [ + 'description' => 'APP唯一标识'."\n" + ."\n" + .'- Android：keystore文件的SHA-1值，获取到的SHA-1应为带冒号的字符串。'."\n" + .'- iOS：App Bundle ID值。'."\n" + .'- Windows：数字签名证书的序列号。'."\n" + ."\n" + .'APP唯一标识的获取方式，请参见[获取APP唯一标识](~~86107#section-wtj-9d7-lg2~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'BB:0D:AC:74:D3:21:09:EF:9C:71:1A:5E:77:2C:8E:BF:03:FD:FA:5A'."\n", + ], + ], + [ + 'name' => 'AppDecryptKey', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义加密私钥字符串，长度为16~32个字符，由英文字符和数字自由组合，且必须同时包含大写字母、小写字母和数字。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'AppDecryptKeyAndroid20230101', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AppEncryptKey' => [ + 'description' => '生成的安全下载密钥。', + 'type' => 'string', + 'example' => '***', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E99B9BAD-7F9D-552B-A689-B72E92EA040E', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppEncryptKey\\": \\"***\\",\\n \\"RequestId\\": \\"E99B9BAD-7F9D-552B-A689-B72E92EA040E\\"\\n}","type":"json"}]', + 'title' => '生成安全下载密钥', + 'description' => '- 使用安全下载功能，需先在视频点播控制台开启下载功能并配置下载方式为安全下载，详细操作，请参见[下载设置](~~86107~~)。'."\n" + .'- 生成用于安全下载的密钥后，还需将密钥配置到阿里云播放器SDK中。详细操作，请参见[安全下载](~~124735~~)。', + ], + 'DescribeVodDomainUsageData' => [ + 'summary' => '调用本接口查询加速流量或带宽用量数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39904', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。若参数为空，默认返回所有加速域名合并后数据。支持批量查询，多个用半角逗号（,）分隔。', + '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-10T10:20: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' => '2015-12-10T12:20:00Z', + ], + ], + [ + 'name' => 'Field', + 'in' => 'query', + 'schema' => [ + 'description' => '数据类型。取值：'."\n" + .'- **bps**：带宽。'."\n" + .'- **traf**：流量。', + 'type' => 'string', + 'required' => true, + 'example' => 'bps', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '需要获取的用量类型。取值：'."\n" + ."\n" + .' - **static**：静态。'."\n" + .'- **dynamic**：动态。'."\n" + .'- **all**：全部。', + 'type' => 'string', + 'required' => false, + 'example' => 'static', + ], + ], + [ + 'name' => 'Area', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '地域代号。默认为CN中国大陆。取值：'."\n" + .'- **CN**：中国大陆。'."\n" + .'- **OverSeas**：海外区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'CN', + 'default' => 'CN', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '强制指定获取指定时间粒度的数据，单位为秒。支持**300**（5分钟）、**3600**（1小时）和**86400**（1天）。'."\n" + .'- **Interval**=**300**：最长可查询最近半年的数据，单次查询的时间跨度最长为3天。'."\n" + .'- **Interval**=**3600**或**86400**：最长可查询最近1年的数据。'."\n" + .'- 不指定**Interval**：单次查询跨度最长为1个月。当查询时间为1~3天时，数据按小时粒度返回；当查询时间为4天及以上时，数据按天粒度返回。', + '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-10T12:20:00Z', + ], + 'Type' => [ + 'description' => '数据类型。取值：'."\n" + .'- **bps**：带宽。'."\n" + .' - **traf**：流量。', + 'type' => 'string', + 'example' => 'bps', + ], + 'StartTime' => [ + 'description' => '开始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-10T10:20:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B955107D-E658-4E77-****-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' => '流量或带宽用量。单位：bit/second。', + 'type' => 'string', + 'example' => '2592.3920000000003', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-10T10:00:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is not valid.', + ], + [ + 'errorCode' => 'InvalidParameterProduct', + 'errorMessage' => 'The specified parameter Product is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterArea', + 'errorMessage' => 'The specified parameter Area is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterField', + 'errorMessage' => 'The specified parameter Field is invalid.', + ], + [ + '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' => 'InvalidParameterInterval', + 'errorMessage' => 'The specified Interval is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2015-12-10T12:20:00Z\\",\\n \\"Type\\": \\"bps\\",\\n \\"StartTime\\": \\"2015-12-10T10:20:00Z\\",\\n \\"RequestId\\": \\"B955107D-E658-4E77-****-E0AC3D31693E\\",\\n \\"Area\\": \\"CN\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DataInterval\\": \\"300\\",\\n \\"UsageDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"Value\\": \\"2592.3920000000003\\",\\n \\"TimeStamp\\": \\"2015-12-10T10:00:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVodDomainUsageDataResponse>\\n <RequestId>B955107D-E658-4E77-****-E0AC3D31693E</RequestId>\\n <StartTime>2015-12-10T10:20:00Z</StartTime>\\n <EndTime>2015-12-10T12:21:00Z</EndTime>\\n <Area>CN</Area>\\n <Type>static</Type>\\n <DomainName>example.com</DomainName>\\n <DataInterval>300</DataInterval>\\n <UsageDataPerInterval>\\n <UsageData>\\n <TimeStamp>2015-12-10T11:00:00Z</TimeStamp>\\n <Value>2592.3920000000003</Value>\\n </UsageData>\\n <UsageData>\\n <TimeStamp>2015-12-10T11:05:00Z</TimeStamp>\\n <Value>2592.3920000000003</Value>\\n </UsageData>\\n </UsageDataPerInterval>\\n</DescribeVodDomainUsageDataResponse>","errorExample":""}]', + 'title' => '查询流量带宽用量', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 支持批量域名查询，多个域名用逗号半角（,）分隔,最多可以一次查询100个域名。如果为空则返回账号下所有域名的数据。'."\n" + .'- 最长可查询近1年的数据，单次查询跨度最长为3个月，查询时间为1-3天时，数据按小时粒度返回，查询时间大于4天，数据按天粒度返回。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\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 CDN service yet. | 403 | 未开通CDN服务。|'."\n" + .'| OperationDenied | Your CDN service is suspended. | 403 | CDN服务已被停止。|'."\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参数错误。|.', + ], + 'DescribeVodStorageData' => [ + 'summary' => '调用本接口查询媒资管理（存储空间、存储流出流量）的用量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39912', + 'abilityTreeNodes' => [ + 'FEATUREvodUOYFRF', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-02-01T14: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' => '2019-02-01T15:00:00Z', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '存储地域。默认返回所有地域。支持批量查询，多个区域用半角逗号（,）分隔。取值：'."\n" + .'- **cn-shanghai**：上海。'."\n" + .'- **cn-beijing**：北京。'."\n" + .'- **eu-central-1**：德国。'."\n" + .'- **ap-southeast-1**：新加坡。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '存储类型。固定取值：**OSS**。', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + 'default' => 'OSS', + ], + ], + [ + 'name' => 'Storage', + 'in' => 'query', + 'schema' => [ + 'description' => '存储名称（阿里云OSS存储Bucket名称），默认返回所有存储。支持批量查询，多个用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'bucket', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。若已开通多应用，传入此参数，可以查询指定应用下的存储用量。不传，则默认返回所有应用的转码用量总数据。本参数值可以从[CreateAppInfo](~~CreateAppInfo~~)接口的返回参数`AppId`获取。更多信息，请参见[多应用体系](~~113601~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-1000000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DataInterval' => [ + 'description' => '返回数据的时间颗粒度。取值：'."\n" + .'- **hour**：小时数据。'."\n" + .'- **day**：天数据。', + 'type' => 'string', + 'example' => 'day', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C370DAF1-C838-4288-****-9A87633D248E', + ], + 'StorageData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StorageDataItem' => [ + 'description' => '存储用量数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-02-01T15:00:00Z', + ], + 'StorageUtilization' => [ + 'description' => '存储用量数据。单位：byte。', + 'type' => 'string', + 'example' => '111111', + ], + 'NetworkOut' => [ + 'description' => '存储流出流量。单位：byte。此流量指直接访问存储地址产生的流量，未经CDN加速。', + 'type' => 'string', + 'example' => '111111', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidParameterType', + 'errorMessage' => 'The specified Type is invalid.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid input parameter.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'The specified Time is malformed.', + ], + [ + 'errorCode' => 'InvalidParameterInterval', + 'errorMessage' => 'The specified Interval is invalid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DataInterval\\": \\"day\\",\\n \\"RequestId\\": \\"C370DAF1-C838-4288-****-9A87633D248E\\",\\n \\"StorageData\\": {\\n \\"StorageDataItem\\": [\\n {\\n \\"TimeStamp\\": \\"2019-02-01T15:00:00Z\\",\\n \\"StorageUtilization\\": \\"111111\\",\\n \\"NetworkOut\\": \\"111111\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVodStorageDataResponse>\\r\\n\\t<RequestId>C370DAF1-C838-4288-****-9A87633D248E</RequestId>\\r\\n\\t<DataInterval>day</DataInterval>\\r\\n\\t<StorageData>\\r\\n\\t\\t<StorageDataItem>\\r\\n\\t\\t\\t<StorageUtilization>111111</StorageUtilization>\\r\\n\\t\\t\\t<NetworkOut>111111</NetworkOut>\\r\\n\\t\\t\\t<TimeStamp>2019-02-01T15:00:00Z</TimeStamp>\\r\\n\\t\\t</StorageDataItem>\\r\\n\\t\\t<StorageDataItem>\\r\\n\\t\\t\\t<StorageUtilization>111111</StorageUtilization>\\r\\n\\t\\t\\t<NetworkOut>111111</NetworkOut>\\r\\n\\t\\t\\t<TimeStamp>2019-02-02T15:00:00Z</TimeStamp>\\r\\n\\t\\t</StorageDataItem>\\r\\n\\t</StorageData>\\r\\n</DescribeVodStorageDataResponse>","errorExample":""}]', + 'title' => '查询存储用量', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 当结束时间间隔在7天以内时，返回小时粒度的数据。当结束时间间隔大于7天时，返回天粒度的数据，最大间隔为31天。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| Throttling | Request was denied due to request throttling. | 503 | 请求被流量控制限制。|'."\n" + .'| OperationDenied | Your account does not open VOD service yet. | 403 | 未开通VOD服务。|'."\n" + .'| OperationDenied | Your VOD service is suspended. | 403 | VOD服务已被停止。|'."\n" + .'| InvalidParameter | Invalid Parameter. | 400 | 参数错误。|'."\n" + .'| InvalidParameterAliUid | Invalid Parameter AliUid. | 400 | AliUid参数错误。|'."\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" + .'| InvalidParameterRegion | Invalid Parameter Region. | 400 | Region参数错误。|', + ], + 'DescribeVodTranscodeData' => [ + 'summary' => '调用本接口查询转码用量数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39915', + 'abilityTreeNodes' => [ + 'FEATUREvodJALMOJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-02-01T15: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' => '2019-02-01T15:59:00Z', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '存储地域。默认返回所有区域。支持批量查询，多个地域使用半角逗号（,）分隔。取值：'."\n" + .'- **cn-shanghai**：上海。'."\n" + .'- **cn-beijing**：北京。'."\n" + .'- **eu-central-1**：德国。'."\n" + .'- **ap-southeast-1**：新加坡。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '时间粒度。取值：'."\n" + ."\n" + .'- **day**：天。'."\n" + .'- **hour**：小时。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'day', + ], + ], + [ + 'name' => 'Storage', + 'in' => 'query', + 'schema' => [ + 'description' => '存储名称（阿里云OSS存储Bucket名称）。默认返回所有存储。支持批量查询，多个用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'bucket01', + ], + ], + [ + 'name' => 'Specification', + 'in' => 'query', + 'schema' => [ + 'description' => '转码规格，默认返回所有转码规格。支持批量查询，多个用半角逗号（,）分隔。取值：'."\n" + .'- **Audio**：音频。'."\n" + .'- **Segmentation**：转封装。'."\n" + .'- **H264.LD**、**H264.SD**、**H264.HD**、**H264.2K**、**H264.4K**等。', + 'type' => 'string', + 'required' => false, + 'example' => 'Audio', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。传入此参数，可以查询指定应用下的转码用量。默认返回所有应用的转码用量数据。本参数值可以从[CreateAppInfo](~~CreateAppInfo~~)接口的返回参数`AppId`获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-1000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DataInterval' => [ + 'description' => '返回数据的时间颗粒度。取值：'."\n" + .'- **hour**：小时数据。'."\n" + .'- **day**：天数据。', + 'type' => 'string', + 'example' => 'day', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C370DAF1-C838-4288-****-9A87633D248E', + ], + 'TranscodeData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TranscodeDataItem' => [ + 'description' => '转码用量数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '数据时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-02-01T16:00:00Z', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataItem' => [ + 'description' => '转码用量详细数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '转码规格。取值：'."\n" + .'- **Audio**：音频。'."\n" + .'- **Segmentation**：转封装。'."\n" + .'- **H264.LD、H264.SD、H264.HD、H264.2K、H264.4K**等。', + 'type' => 'string', + 'example' => 'H264.SD', + ], + 'Value' => [ + 'description' => '转码时长。单位：秒。', + 'type' => 'string', + 'example' => '111', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidParameterType', + 'errorMessage' => 'The specified Type is invalid.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid input parameter.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'The specified Time is malformed.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DataInterval\\": \\"day\\",\\n \\"RequestId\\": \\"C370DAF1-C838-4288-****-9A87633D248E\\",\\n \\"TranscodeData\\": {\\n \\"TranscodeDataItem\\": [\\n {\\n \\"TimeStamp\\": \\"2019-02-01T16:00:00Z\\",\\n \\"Data\\": {\\n \\"DataItem\\": [\\n {\\n \\"Name\\": \\"H264.SD\\",\\n \\"Value\\": \\"111\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVodTranscodeDataResponse>\\r\\n <RequestId>C370DAF1-C838-4288-****-9A87633D248E</RequestId>\\r\\n\\t<DataInterval>day</DataInterval>\\r\\n\\t<TranscodeData>\\r\\n\\t\\t<TranscodeDataItem>\\r\\n\\t\\t\\t<TimeStamp>2019-02-01T16:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Data>\\r\\n\\t\\t\\t\\t<DataItem>\\r\\n\\t\\t\\t\\t\\t<Name>H264.SD</Name>\\r\\n\\t\\t\\t\\t\\t<Value>111</Value>\\r\\n\\t\\t\\t\\t</DataItem>\\r\\n\\t\\t\\t\\t<DataItem>\\r\\n\\t\\t\\t\\t\\t<Name>All</Name>\\r\\n\\t\\t\\t\\t\\t<Value>111</Value>\\r\\n\\t\\t\\t\\t</DataItem>\\r\\n\\t\\t\\t</Data>\\r\\n\\t\\t</TranscodeDataItem>\\r\\n\\t\\t<TranscodeDataItem>\\r\\n\\t\\t\\t<TimeStamp>2019-02-02T16:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Data>\\r\\n\\t\\t\\t\\t<DataItem>\\r\\n\\t\\t\\t\\t\\t<Name>Audio</Name>\\r\\n\\t\\t\\t\\t\\t<Value>111</Value>\\r\\n\\t\\t\\t\\t</DataItem>\\r\\n\\t\\t\\t\\t<DataItem>\\r\\n\\t\\t\\t\\t\\t<Name>H264.SD</Name>\\r\\n\\t\\t\\t\\t\\t<Value>222</Value>\\r\\n\\t\\t\\t\\t</DataItem>\\r\\n\\t\\t\\t\\t<DataItem>\\r\\n\\t\\t\\t\\t\\t<Name>All</Name>\\r\\n\\t\\t\\t\\t\\t<Value>333</Value>\\r\\n\\t\\t\\t\\t</DataItem>\\r\\n\\t\\t\\t</Data>\\r\\n\\t\\t</TranscodeDataItem>\\r\\n\\t</TranscodeData>\\r\\n</DescribeVodTranscodeDataResponse>","errorExample":""}]', + 'title' => '查询转码用量数据', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 当起始结束时间间隔在7天以内时，返回小时粒度的数据。当起始结束时间间隔大于7天时，返回天粒度的数据，最大间隔为31天。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| Throttling | Request was denied due to request throttling. | 503 | 请求被流量控制限制。|'."\n" + .'| OperationDenied | Your account does not open VOD service yet. | 403 | 未开通VOD服务。|'."\n" + .'| OperationDenied | Your VOD service is suspended. | 403 | VOD服务已被停止。|'."\n" + .'| InvalidParameter | Invalid Parameter. | 400 | 参数错误。|'."\n" + .'| InvalidParameterAliUid | Invalid Parameter AliUid. | 400 | AliUid参数错误。|'."\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" + .'| InvalidParameterRegion | Invalid Parameter Region. | 400 | Region参数错误。|', + ], + 'DescribeVodAIData' => [ + 'summary' => '调用本接口查询AI处理（智能审核、视频DNA等）的用量数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39873', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。格式为：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-02-01T13:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点，需晚于起始时间。格式为：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2019-02-01T15:00:00Z', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '存储地域。默认返回所有区域。支持批量查询，多个地域使用半角逗号（,）分隔。取值：'."\n" + .'- **cn-shanghai**：上海。'."\n" + .'- **cn-beijing**：北京。'."\n" + .'- **eu-central-1**：德国。'."\n" + .'- **ap-southeast-1**：新加坡。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'AIType', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI类型。默认返回类型。支持批量查询，多个区域使用半角逗号（,）分隔。取值：'."\n" + .'- **AIVideoCensor**：智能审核。'."\n" + .'- **AIVideoFPShot**：视频DNA。'."\n" + .'- **AIVideoTag**：智能标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'AIVideoCensor', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DataInterval' => [ + 'description' => '返回数据的时间颗粒度。取值：'."\n" + .'- **hour**：小时数据。'."\n" + .'- **day**：天数据。', + 'type' => 'string', + 'example' => 'day', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C370DAF1-C838-4288-****-9A87633D248E', + ], + 'AIData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AIDataItem' => [ + 'description' => 'AI处理用量数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻。格式为：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2019-02-01T13:00:00Z', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataItem' => [ + 'description' => 'AI处理用量详细数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'AI类型。 取值：'."\n" + .'- **AIVideoCensor**：智能审核。'."\n" + .'- **AIVideoFPShot**：视频DNA。'."\n" + .'- **AIVideoTag**：智能标签。', + 'type' => 'string', + 'example' => 'AIVideoCensor', + ], + 'Value' => [ + 'description' => '处理时长。单位：秒。', + 'type' => 'string', + 'example' => '111', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'InvalidParameter.', + ], + [ + 'errorCode' => 'InvalidParameterStartTime', + 'errorMessage' => 'Invalid Parameter StartTime.', + ], + [ + 'errorCode' => 'InvalidParameterEndTime', + 'errorMessage' => 'Invalid Parameter EndTime.', + ], + [ + 'errorCode' => 'InvalidTimeRange', + 'errorMessage' => 'Invalid StartTime and EndTime range.', + ], + [ + 'errorCode' => 'InvalidParameterInterval', + 'errorMessage' => 'Invalid Parameter interval.', + ], + [ + 'errorCode' => 'InvalidParameterRegion', + 'errorMessage' => 'Invalid Parameter Region.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DataInterval\\": \\"day\\",\\n \\"RequestId\\": \\"C370DAF1-C838-4288-****-9A87633D248E\\",\\n \\"AIData\\": {\\n \\"AIDataItem\\": [\\n {\\n \\"TimeStamp\\": \\"2019-02-01T13:00:00Z\\",\\n \\"Data\\": {\\n \\"DataItem\\": [\\n {\\n \\"Name\\": \\"AIVideoCensor\\",\\n \\"Value\\": \\"111\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVodAIDataResponse>\\r\\n\\t<RequestId>C370DAF1-C838-4288-****-9A87633D248E</RequestId>\\r\\n\\t<DataInterval>day</DataInterval>\\r\\n\\t<AIData>\\r\\n\\t\\t<AIDataItem>\\r\\n\\t\\t\\t<TimeStamp>2019-02-01T16:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Data>\\r\\n\\t\\t\\t\\t<DataItem>\\r\\n\\t\\t\\t\\t\\t<Name>AIVideoCensor</Name>\\r\\n\\t\\t\\t\\t\\t<Value>111</Value>\\r\\n\\t\\t\\t\\t</DataItem>\\r\\n\\t\\t\\t</Data>\\r\\n\\t\\t</AIDataItem>\\r\\n\\t\\t<AIDataItem>\\r\\n\\t\\t\\t<TimeStamp>2019-02-02T16:00:00Z</TimeStamp>\\r\\n\\t\\t\\t<Data>\\r\\n\\t\\t\\t\\t<DataItem>\\r\\n\\t\\t\\t\\t\\t<Name>AIVideoCensor</Name>\\r\\n\\t\\t\\t\\t\\t<Value>111</Value>\\r\\n\\t\\t\\t\\t</DataItem>\\r\\n\\t\\t\\t\\t<DataItem>\\r\\n\\t\\t\\t\\t\\t<Name>AIVideoFPShot</Name>\\r\\n\\t\\t\\t\\t\\t<Value>222</Value>\\r\\n\\t\\t\\t\\t</DataItem>\\r\\n\\t\\t\\t</Data>\\r\\n\\t\\t</AIDataItem>\\r\\n\\t</AIData>\\r\\n</DescribeVodAIDataResponse>","errorExample":""}]', + 'title' => '查询AI处理用量数据', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 当起始结束时间间隔在7天以内时，返回小时粒度的数据。当起始结束时间间隔大于7天时，返回天粒度的数据，最大间隔为31天。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| Throttling | Request was denied due to request throttling. | 503 | 请求被流量控制限制。|'."\n" + .'| OperationDenied | Your account does not open VOD service yet. | 403 | 未开通VOD服务。|'."\n" + .'| OperationDenied | Your VOD service is suspended. | 403 | VOD服务已被停止。|'."\n" + .'| InvalidParameter | Invalid Parameter. | 400 | 参数错误。|'."\n" + .'| InvalidParameterAliUid | Invalid Parameter AliUid. | 400 | AliUid参数错误。|'."\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" + .'| InvalidParameterRegion | Invalid Parameter Region. | 400 | Region参数错误。|', + ], + 'DescribeVodTieringStorageData' => [ + 'summary' => '查询媒资管理分级存储的用量。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216951', + 'abilityTreeNodes' => [ + 'FEATUREvodUOYFRF', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。日期格式按照ISO8601表示法，使用UTC时间。格式为：YYYY-MM-DDThh:mmZ。若为空，则默认读取最近24小时的数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-05-29T01:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点，需晚于起始时间，不能相差超过31天。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-05-29T02:00:00Z', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '存储地域。默认返回所有地域。支持批量查询，多个区域用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'StorageClass', + 'in' => 'query', + 'schema' => [ + 'description' => '存储类型，默认返回所有类型。取值：'."\n" + .'- **IA**：低频'."\n" + .'- **Archive**：归档'."\n" + .'- **ColdArchive**：冷归档', + 'type' => 'string', + 'required' => false, + 'example' => 'IA', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-1000000', + ], + ], + ], + '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' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'StorageData' => [ + 'description' => '存储用量数据。', + 'type' => 'array', + 'items' => [ + 'description' => '存储用量数据。', + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => '2023-05-29T01:00:00Z', + ], + 'Region' => [ + 'description' => '存储地域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'StorageClass' => [ + 'description' => '存储类型。', + 'type' => 'string', + 'example' => 'IA', + ], + 'StorageUtilization' => [ + 'description' => '存储用量数据。单位：byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'LessthanMonthDatasize' => [ + 'description' => '不足一月存储数据。单位：byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidParameterType', + 'errorMessage' => 'The specified Type is invalid.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid input parameter.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'The specified Time is malformed.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"StorageData\\": [\\n {\\n \\"TimeStamp\\": \\"2023-05-29T01:00:00Z\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"StorageClass\\": \\"IA\\",\\n \\"StorageUtilization\\": 1234,\\n \\"LessthanMonthDatasize\\": 123\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询分级存储的用量', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 当查询时间的间隔在7天以内时，返回小时粒度的数据。当查询时间的间隔大于7天时，返回天粒度的数据，最大间隔为31天。', + ], + 'DescribeVodTieringStorageRetrievalData' => [ + 'summary' => '查询媒资管理分级存储的取回数据用量。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216979', + 'abilityTreeNodes' => [ + 'FEATUREvodUOYFRF', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。日期格式按照ISO8601表示法，使用UTC时间。格式为：YYYY-MM-DDThh:mmZ。最小数据粒度为5分钟，若为空，则默认读取最近24小时的数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-06-02T10:20:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点，需晚于起始时间，不能相差超过31天。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-06-02T11:20:00Z'."\n", + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '存储地域。默认返回所有地域。支持批量查询，多个区域用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'StorageClass', + 'in' => 'query', + 'schema' => [ + 'description' => '存储类型。取值：'."\n" + .'- **IA**：低频'."\n" + .'- **Archive**：归档'."\n" + .'- **ColdArchive**：冷归档', + 'type' => 'string', + 'required' => false, + 'example' => 'IA', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-1000000', + ], + ], + ], + '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' => '25818875-5F78-4A13-BEF6-D73936****', + ], + 'RetrievalData' => [ + 'description' => '取回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '取回数据。', + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2023-06-02T10:20:00Z'."\n", + ], + 'Region' => [ + 'description' => '存储地域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'StorageClass' => [ + 'description' => '媒资存储类型。', + 'type' => 'string', + 'example' => 'IA', + ], + 'RetrievalData' => [ + 'description' => '取回数据。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'CAStdRetrievalData' => [ + 'description' => '冷归档标准取回数据。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'CABulkRetrievalData' => [ + 'description' => '冷归档批量取回数据。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'CAHighPriorRetrievalData' => [ + 'description' => '冷归档高优取回数据。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidParameterType', + 'errorMessage' => 'The specified Type is invalid.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid input parameter.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'The specified Time is malformed.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D73936****\\",\\n \\"RetrievalData\\": [\\n {\\n \\"TimeStamp\\": \\"2023-06-02T10:20:00Z\\\\n\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"StorageClass\\": \\"IA\\",\\n \\"RetrievalData\\": 1234,\\n \\"CAStdRetrievalData\\": 123,\\n \\"CABulkRetrievalData\\": 123,\\n \\"CAHighPriorRetrievalData\\": 123\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询分级存储取回数据', + 'description' => '> - 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'> - 当查询时间的间隔在7天以内时，返回小时粒度的数据。当查询时间的间隔大于7天时，返回天粒度的数据，最大间隔为31天。', + 'responseParamsDescription' => 'CAStdRetrievalData，CABulkRetrievalData，CAHighPriorRetrievalData 字段仅存储类型为冷归档且用量不为零时存在。', + ], + 'DescribeVodPlayerMetricData' => [ + 'summary' => '查询播放器指标数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '273926', + 'abilityTreeNodes' => [ + 'FEATUREvod2L0PVC', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-1000000', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的开始时间。格式为：<i>yyyy-mm-dd</i>t<i>hh:mm:ss</i>z（utc时间）。'."\n" + .'> '."\n" + .'> - 支持近一年播放数据历史查询。'."\n" + .'> - 单次查询时间范围不超过31天。'."\n" + .'> - 时间区间为左闭右开[StartTime, EndTime)。', + 'type' => 'string', + 'required' => true, + 'example' => '2025-06-24T00:55:06Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的结束时间。格式为：yyyy-mm-ddthh:mm:ssz（utc时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2025-06-05T15:59:59Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询数据的时间粒度。取值：**5m**、**1h**和**1d**。根据您指定的`StartTime`和`EndTime`的时间跨度，支持设置的时间粒度如下：'."\n" + ."\n" + .'- 3天以内支持：**5m**、**1h**和**1d**。'."\n" + .'- 4-7天内支持：**1h**和**1d**。'."\n" + .'- 7天以上支持：**1d**。', + 'type' => 'string', + 'required' => true, + 'example' => '1d', + ], + ], + [ + 'name' => 'TerminalType', + 'in' => 'query', + 'schema' => [ + 'description' => '终端类型。取值：'."\n" + .'- **web**：web端。'."\n" + .'- **mobile**：native端。', + 'type' => 'string', + 'required' => true, + 'example' => 'web', + ], + ], + [ + 'name' => 'Filters', + 'in' => 'query', + 'schema' => [ + 'description' => '指标维度筛选器，维度由维度类型（Field）、操作符号（Op）、维度值组成。'."\n" + ."\n" + .'> - 最多指定三个维度。'."\n" + .'> - 当Metrics参数包含以下四种指标时，Filters筛选不生效：Uv（播放用户数）、'."\n" + .'AvgPerVv（人均播放次数）、AvgPerPlayDuration（人均播放时长）、AvgPerCompletionVv（人均完播次数）。'."\n" + .'> - 省份和国家传递用regionCode即可。'."\n" + .'> - 多个value在传参时采取用#_#分隔。'."\n" + ."\n" + .'维度类型（Field）取值如下：'."\n" + .'- SdkVersion：SDK版本。'."\n" + .'- AppVersion：APP版本。'."\n" + .'- Codec：编码格式。'."\n" + .'- VideoType：视频格式。'."\n" + .'- Network：网络类型。'."\n" + .'- Country：国家。'."\n" + .'- Isp：运营商。'."\n" + .'- VideoDefinition：分辨率。'."\n" + .'- Domain：域名。'."\n" + .'- Province：省份。'."\n" + .'- IsHw：是否硬解。'."\n" + .'- ErrorCode：错误码。'."\n" + ."\n" + .'操作符号（Op）取值为：=（等于）、>（大于）、<（小于）和!=（不等于）。'."\n" + .'> '."\n" + .'> - 操作符可选情况为：SdkVersion、VideoDefinition指标支持所有四种操作符，其他指标只支持=（等于）和!=（不等于）。'."\n" + ."\n" + .'维度值请通过DescribeVodPlayerDimensionData 获取。', + 'type' => 'string', + 'required' => false, + 'example' => '['."\n" + .' {'."\n" + .' "Field": "codec",'."\n" + .' "Op": "=",'."\n" + .' "Value": "h265#_#h264"'."\n" + .' },'."\n" + .' {'."\n" + .' "Field": "os",'."\n" + .' "Op": "=",'."\n" + .' "Value": "Android#_#iOS"'."\n" + .' }'."\n" + .']', + ], + ], + [ + 'name' => 'Metrics', + 'in' => 'query', + 'schema' => [ + 'description' => '指标类型，支持多选（最多支持3个指标）。'."\n" + ."\n" + .'> '."\n" + .'> - 百分比数据返回值为小数形式。'."\n" + ."\n" + .'播放质量QoS指标：'."\n" + .'- Vv：播放次数 。'."\n" + .'- RealVv：实际播放量。'."\n" + .'- FirstFrame：首帧时间。'."\n" + .'- SecondPlayRate：秒开率。'."\n" + .'- SlowPlayRate：慢开率。'."\n" + .'- StuckCountRate：次数卡顿率。'."\n" + .'- SeekDuration：seek耗时。'."\n" + .'- StuckDuration100s：百秒卡顿耗时。'."\n" + .'- StuckCount100s：百秒卡顿次数 。'."\n" + .'- PlayFailRate:播放失败率。'."\n" + .'- SeedFailRate：未起播率。'."\n" + .'- AvgPlayBitrate：平均播放码率。'."\n" + .'- AvgStartBitrate：平均起播码率。'."\n" + .'- ErrorCount100s：百秒错误次数。'."\n" + ."\n" + .'播放体验QoE指标：'."\n" + .'- Uv：播放用户数。'."\n" + .'- AvgPerVv：人均播放次数。'."\n" + .'- AvgVideoDuration：平均视频时长。'."\n" + .'- AvgPerPlayDuration：人均播放时长。'."\n" + .'- AvgPerCompletionVv：人均完播次数。'."\n" + .'- CompletionVv：完播量。'."\n" + .'- CompletionRate：完播率。'."\n" + .'- AvgPlayDuration：平均播放时长。'."\n" + .'- JumpRate5s：5秒跳出率。', + 'type' => 'string', + 'required' => true, + 'example' => 'Vv,Uv,AvgPerVv', + ], + ], + [ + 'name' => 'Top', + 'in' => 'query', + 'schema' => [ + 'description' => '取播放量排名前top的数据展示，不传值时返回全量维度数据。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示的条目数。默认值：**5000**。最大值：**5000**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5000', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '请求返回的语言。取值：'."\n" + ."\n" + .'- **zh**（**默认**）：表示简体中文。'."\n" + ."\n" + .'- **en**：表示英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Os', + 'in' => 'query', + 'schema' => [ + 'description' => '播放端的操作系统。传入此参数，可筛选查询指定操作系统的播放数据。取值包含：**Android** 、**iOS**、**Harmony**、**Windows**、**MacOS**和**Linux**。'."\n" + .'不同端类型可选取值不同，对应关系如下：'."\n" + ."\n" + .'- **native**：Android、iOS、Harmony。'."\n" + .'- **web**：Android、iOS、Harmony、Windows、MacOs、Linux。'."\n" + ."\n" + .'多个os以 #_#进行分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'Android、iOS、Windows', + ], + ], + ], + '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' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5000', + ], + 'TotalCnt' => [ + 'description' => '数据点总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'DataList' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '数据返回时间戳。格式为：yyyy-mm-ddthh:mm:ssz（utc时间）。', + 'type' => 'string', + 'example' => '2025-06-24T00:55:06Z'."\n", + ], + 'Dimension' => [ + 'description' => '维度。', + 'type' => 'string', + 'example' => 'H265_MP4_WIFI', + ], + 'Uv' => [ + 'description' => '播放用户数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '500', + ], + 'Vv' => [ + 'description' => '播放次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '800', + ], + 'RealVv' => [ + 'description' => '实际播放量。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1000', + ], + 'FirstFrame' => [ + 'description' => '首帧时间，单位毫秒（ms）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'SecondPlayRate' => [ + 'description' => '秒开率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.8', + ], + 'SlowPlayRate' => [ + 'description' => '慢开率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.2', + ], + 'StuckCountRate' => [ + 'description' => '次数卡顿率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.1', + ], + 'SeekDuration' => [ + 'description' => 'seek耗时，单位毫秒（ms）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'StuckDuration100s' => [ + 'description' => '百秒卡顿耗时，单位毫秒（ms）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '200', + ], + 'PlayFailRate' => [ + 'description' => '播放失败率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.2', + ], + 'SeedFailRate' => [ + 'description' => '未起播率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.01', + ], + 'AvgPlayBitrate' => [ + 'description' => '平均播放码率，单位为bps。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'AvgStartBitrate' => [ + 'description' => '平均起播码率，单位为bps。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'ErrorCount100s' => [ + 'description' => '百秒错误次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1', + ], + 'AvgPerVv' => [ + 'description' => '人均播放次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + 'AvgVideoDuration' => [ + 'description' => '平均视频时长，单位毫秒（ms）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100000', + ], + 'AvgPerPlayDuration' => [ + 'description' => '人均播放时长，单位毫秒（ms）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100000', + ], + 'AvgPerCompletionVv' => [ + 'description' => '人均完播次数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2', + ], + 'CompletionVv' => [ + 'description' => '完播量。', + 'type' => 'number', + 'format' => 'double', + 'example' => '500', + ], + 'CompletionRate' => [ + 'description' => '完播率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.8', + ], + 'AvgPlayDuration' => [ + 'description' => '平均播放时长，单位毫秒（ms）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100000'."\n", + ], + 'JumpRate5s' => [ + 'description' => '5秒跳出率。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.1', + ], + 'TotalPlayDuration' => [ + 'description' => '累计播放时长，单位毫秒（ms）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100000', + ], + 'StuckCount100s' => [ + 'description' => '百秒卡顿次数 。', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + 'Extend' => [ + 'description' => '扩展信息', + 'type' => 'object', + 'properties' => [ + 'ActualStartTime' => [ + 'description' => '指定时间范围内有数据点的最早时间，格式为：yyyy-mm-ddthh:mm:ssz（utc时间）。', + 'type' => 'string', + 'example' => '2025-06-24T00:55:06Z', + ], + 'ActualEndTime' => [ + 'description' => '指定时间范围内有数据点的最晚时间，格式为：yyyy-mm-ddthh:mm:ssz（utc时间）。', + 'type' => 'string', + 'example' => '2025-06-05T15:59:59Z', + ], + 'IntervalSeconds' => [ + 'description' => '查询数据的时间粒度，单位为秒（s）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Meter.ParamError', + 'errorMessage' => 'Param Error:%s,Please Check Again.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Meter.AuthError', + 'errorMessage' => 'Authentication Failed,Please Try Again.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Meter.ServerInternalError', + 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', + ], + [ + 'errorCode' => 'Meter.DataSourceQueryError', + 'errorMessage' => 'Data Source Error:%s,Please Try Again.', + ], + ], + 502 => [ + [ + 'errorCode' => 'Meter.ReadyTsError', + 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 5000,\\n \\"TotalCnt\\": 500,\\n \\"DataList\\": [\\n {\\n \\"TimeStamp\\": \\"2025-06-24T00:55:06Z\\\\n\\",\\n \\"Dimension\\": \\"H265_MP4_WIFI\\",\\n \\"Uv\\": 500,\\n \\"Vv\\": 800,\\n \\"RealVv\\": 1000,\\n \\"FirstFrame\\": 100,\\n \\"SecondPlayRate\\": 0.8,\\n \\"SlowPlayRate\\": 0.2,\\n \\"StuckCountRate\\": 0.1,\\n \\"SeekDuration\\": 100,\\n \\"StuckDuration100s\\": 200,\\n \\"PlayFailRate\\": 0.2,\\n \\"SeedFailRate\\": 0.01,\\n \\"AvgPlayBitrate\\": 100,\\n \\"AvgStartBitrate\\": 100,\\n \\"ErrorCount100s\\": 1,\\n \\"AvgPerVv\\": 10,\\n \\"AvgVideoDuration\\": 100000,\\n \\"AvgPerPlayDuration\\": 100000,\\n \\"AvgPerCompletionVv\\": 2,\\n \\"CompletionVv\\": 500,\\n \\"CompletionRate\\": 0.8,\\n \\"AvgPlayDuration\\": 100000,\\n \\"JumpRate5s\\": 0.1,\\n \\"TotalPlayDuration\\": 100000,\\n \\"StuckCount100s\\": \\"2\\"\\n }\\n ],\\n \\"Extend\\": {\\n \\"ActualStartTime\\": \\"2025-06-24T00:55:06Z\\",\\n \\"ActualEndTime\\": \\"2025-06-05T15:59:59Z\\",\\n \\"IntervalSeconds\\": 3600\\n }\\n}","type":"json"}]', + 'title' => '播放器播放数据查询', + ], + 'DescribeVodPlayerCollectData' => [ + 'summary' => '查询播放器播放汇总的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '274030', + 'abilityTreeNodes' => [ + 'FEATUREvod2L0PVC', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-1000000', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的开始时间。格式为：<i>yyyy-mm-dd</i>t<i>hh:mm:ss</i>z（utc时间）。'."\n" + .'> '."\n" + .'> - 支持近一年播放数据历史查询。'."\n" + .'> - 单次查询时间范围不超过31天。'."\n" + .'> - 时间区间为左闭右开[StartTime, EndTime)。', + 'type' => 'string', + 'required' => true, + 'example' => '2025-06-24T00:55:06Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的结束时间。格式为：yyyy-mm-ddthh:mm:ssz（utc时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2025-06-05T15:59:59Z', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询数据的时间粒度。取值：**5m**、**1h**和**1d**。根据您指定的`StartTime`和`EndTime`的时间跨度，支持设置的时间粒度如下：'."\n" + ."\n" + .'- 3天以内支持：**5m**、**1h**和**1d**。'."\n" + .'- 4-7天内支持：**1h**和**1d**。'."\n" + .'- 7天以上支持：**1d**。', + 'type' => 'string', + 'required' => true, + 'example' => '1d', + ], + ], + [ + 'name' => 'TerminalType', + 'in' => 'query', + 'schema' => [ + 'description' => '终端类型。取值：'."\n" + .'- **web**：web端。'."\n" + .'- **mobile**：native端。', + 'type' => 'string', + 'required' => true, + 'example' => 'web', + ], + ], + [ + 'name' => 'Os', + 'in' => 'query', + 'schema' => [ + 'description' => '播放端的操作系统。传入此参数，可筛选查询指定操作系统的播放数据。取值包含：**Android** 、**iOS**、**Harmony**、**Windows**、**MacOS**和**Linux**。'."\n" + .'不同端类型可选取值不同，对应关系如下：'."\n" + ."\n" + .'- **native**：Android、iOS、Harmony。'."\n" + .'- **web**：Android、iOS、Harmony、Windows、MacOs、Linux。'."\n" + ."\n" + .'多个os以 #_#进行分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'Android、iOS、Windows', + ], + ], + [ + 'name' => 'Metrics', + 'in' => 'query', + 'schema' => [ + 'description' => '指标类型，支持多选（最多支持3个指标）。'."\n" + ."\n" + .'> '."\n" + .'> - 百分比数据返回值为小数形式。'."\n" + ."\n" + .'播放质量QoS指标：'."\n" + .'- Vv：播放次数 。'."\n" + .'- RealVv：实际播放量。'."\n" + .'- FirstFrame：首帧时间。'."\n" + .'- SecondPlayRate：秒开率。'."\n" + .'- SlowPlayRate：慢开率。'."\n" + .'- StuckCountRate：次数卡顿率。'."\n" + .'- SeekDuration：seek耗时。'."\n" + .'- StuckDuration100s：百秒卡顿耗时。'."\n" + .'- StuckCount100s：百秒卡顿次数 。'."\n" + .'- PlayFailRate:播放失败率。'."\n" + .'- SeedFailRate：未起播率。'."\n" + .'- AvgPlayBitrate：平均播放码率。'."\n" + .'- AvgStartBitrate：平均起播码率。'."\n" + .'- ErrorCount100s：百秒错误次数。'."\n" + ."\n" + .'播放体验QoE指标：'."\n" + .'- Uv：播放用户数。'."\n" + .'- AvgPerVv：人均播放次数。'."\n" + .'- AvgVideoDuration：平均视频时长。'."\n" + .'- AvgPerPlayDuration：人均播放时长。'."\n" + .'- AvgPerCompletionVv：人均完播次数。'."\n" + .'- CompletionVv：完播量。'."\n" + .'- CompletionRate：完播率。'."\n" + .'- AvgPlayDuration：平均播放时长。'."\n" + .'- JumpRate5s：5秒跳出率。', + 'type' => 'string', + 'required' => true, + 'example' => 'Vv,Uv,AvgPerVv', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '用于确认环比分析的时间范围，单位天（d）。'."\n" + ."\n" + .'例如当传值1d（1天）时，会取环比时间为StartTime-1d ～EndTime-1d作为环比数据的时间范围。', + 'type' => 'string', + 'required' => false, + 'example' => '1d', + ], + ], + ], + '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' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'DataList' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'description' => '返回的数据指标。', + 'type' => 'string', + 'example' => 'Vv', + ], + 'Value' => [ + 'description' => '返回的数据指标数值。', + 'type' => 'number', + 'format' => 'double', + 'example' => '100.0', + ], + 'ValueRefer' => [ + 'description' => '返回的数据指标环比数值。', + 'type' => 'number', + 'format' => 'double', + 'example' => '200.0', + ], + 'ValueRatio' => [ + 'description' => '环比百分比。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.5', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Meter.ParamError', + 'errorMessage' => 'Param Error:%s,Please Check Again.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Meter.AuthError', + 'errorMessage' => 'Authentication Failed,Please Try Again.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Meter.ServerInternalError', + 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', + ], + [ + 'errorCode' => 'Meter.DataSourceQueryError', + 'errorMessage' => 'Data Source Error:%s,Please Try Again.', + ], + ], + 502 => [ + [ + 'errorCode' => 'Meter.ReadyTsError', + 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"DataList\\": [\\n {\\n \\"Metric\\": \\"Vv\\",\\n \\"Value\\": 100,\\n \\"ValueRefer\\": 200,\\n \\"ValueRatio\\": 0.5\\n }\\n ]\\n}","type":"json"}]', + 'title' => '播放器播放汇总数据查询', + ], + 'DescribeVodPlayerDimensionData' => [ + 'summary' => '查询播放器维度元信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '273845', + 'abilityTreeNodes' => [ + 'FEATUREvod2L0PVC', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-1000000', + ], + ], + [ + 'name' => 'Dimension', + 'in' => 'query', + 'schema' => [ + 'description' => '维度类型。包含以下13种维度：'."\n" + ."\n" + .'- Os：操作系统。'."\n" + .'- AppVersion：APP版本。'."\n" + .'- SdkVersion：SDK版本。'."\n" + .'- Codec：编码格式。'."\n" + .'- VideoType：视频格式。'."\n" + .'- Network：网络类型。'."\n" + .'- Isp:运营商。'."\n" + .'- VideoDefinition：分辨率。'."\n" + .'- Domain：域名。'."\n" + .'- Country：国家。'."\n" + .'- Province：省份。'."\n" + .'- ErrorCode：错误码。'."\n" + .'- IsHw：是否硬解。', + 'type' => 'string', + 'required' => true, + 'example' => 'Os', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的开始时间。格式为：<i>yyyy-mm-dd</i>t<i>hh:mm:ss</i>z（utc时间）。'."\n" + .'> '."\n" + .'> - 支持近一年播放数据历史查询。'."\n" + .'> - 单次查询时间范围不超过31天。'."\n" + .'> - 时间区间为左闭右开[StartTime, EndTime)。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-06-24T00:55:06Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的结束时间。格式为：yyyy-mm-ddthh:mm:ssz（utc时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-06-05T15:59:59Z', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '在查询Province（省份）和Isp（运营商）维度元信息时限制查询区域，包含以下3种区域：'."\n" + ."\n" + .'- ALL（默认）：全部。'."\n" + .'- CN：中国。'."\n" + .'- OVERSEAS：海外。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + ], + ], + ], + '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' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'DataList' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '维度元信息。', + 'type' => 'string', + 'example' => 'Android', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Meter.ParamError', + 'errorMessage' => 'Param Error:%s,Please Check Again.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Meter.AuthError', + 'errorMessage' => 'Authentication Failed,Please Try Again.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Meter.ServerInternalError', + 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', + ], + [ + 'errorCode' => 'Meter.DataSourceQueryError', + 'errorMessage' => 'Data Source Error:%s,Please Try Again.', + ], + ], + 502 => [ + [ + 'errorCode' => 'Meter.ReadyTsError', + 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"DataList\\": [\\n \\"Android\\"\\n ]\\n}","type":"json"}]', + 'title' => '播放器维度元信息查询', + ], + 'GetDailyPlayRegionStatis' => [ + 'summary' => '获取指定日期和区域的全量媒资流量数据。该数据基于CDN流量日志生成，主要反映视频的流量消耗情况。生成的CSV文件中包含以下信息：日期、视频ID、域名、流量、应用ID、分类ID等。您可以将文件下载到本地，用于运营数据分析等场景。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '267530', + 'abilityTreeNodes' => [ + 'FEATUREvodKNCWCD', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Date', + 'in' => 'query', + 'schema' => [ + 'description' => '播放日期，单位：天。格式为：yyyy-MM-dd。'."\n" + ."\n" + .'> '."\n" + .'> - 仅支持按天查询'."\n" + .'> - 仅支持查询过去1年内的数据。', + 'type' => 'string', + 'required' => true, + 'example' => '2025-03-20', + ], + ], + [ + 'name' => 'MediaRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资区域ID。传入此参数，可筛选查询指定服务地域下的所有音视频的播放数据。取值：'."\n" + ."\n" + .'- cn-beijing：华北2（北京）'."\n" + .'- cn-shanghai：华东2（上海）'."\n" + .'- cn-shenzhen：华南1（深圳）'."\n" + .'- ap-northeast-1：日本（东京）'."\n" + .'- ap-southeast-1：新加坡'."\n" + .'- ap-southeast-5：印度尼西亚（雅加达）'."\n" + .'- eu-central-1：德国（法兰克福）', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '67720502-CDDB-3F1C-8A91-12258*******', + ], + 'DailyPlayRegionStatisList' => [ + 'description' => '返回的CSV文件信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => '播放日期，单位：天。格式为：yyyy-MM-dd。', + 'type' => 'string', + 'example' => '2025-03-20', + ], + 'FileUrl' => [ + 'description' => 'CSV文件下载地址。', + 'type' => 'string', + 'example' => 'https://outin-e70266d4ed*******0163e1403e7.oss-cn-shanghai.aliyuncs.com/dataexport/play/cn_hangzhou_20250320_video_traffic.csv?*******', + ], + ], + ], + ], + 'FailDates' => [ + 'description' => '若当日播放数据导出失败，日期会在本条显示。', + 'type' => 'array', + 'items' => [ + 'description' => '导出失败日期。', + 'type' => 'string', + 'example' => '[]', + ], + ], + 'EmptyDates' => [ + 'description' => '若当日不存在播放数据，日期会在本条显示。', + 'type' => 'array', + 'items' => [ + 'description' => '数据为空日期。', + 'type' => 'string', + 'example' => '[]', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"67720502-CDDB-3F1C-8A91-12258*******\\",\\n \\"DailyPlayRegionStatisList\\": [\\n {\\n \\"Date\\": \\"2025-03-20\\",\\n \\"FileUrl\\": \\"https://outin-e70266d4ed*******0163e1403e7.oss-cn-shanghai.aliyuncs.com/dataexport/play/cn_hangzhou_20250320_video_traffic.csv?*******\\"\\n }\\n ],\\n \\"FailDates\\": [\\n \\"[]\\"\\n ],\\n \\"EmptyDates\\": [\\n \\"[]\\"\\n ]\\n}","type":"json"}]', + 'title' => '音视频ID流量数据统计', + 'description' => '- 目前本接口的服务地址仅支持：**华东2（上海）**。'."\n" + .'- 仅支持查询过去90天以内的数据（数据起始日期为2025年4月29日）。'."\n" + .'- 本接口提供的流量数据为原始流量数据。若需与计费流量一致，请将数据乘以1.1的TCP系数。', + ], + 'DescribeVodMediaPlayData' => [ + 'summary' => '通过媒体ID（即音视频ID）获取音视频在指定日期的播放数据，包括访问用户数、人均播放次数、播放总次数、人均播放时长、累计播放时长等数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '207593', + 'abilityTreeNodes' => [ + 'FEATUREvodKNCWCD', + ], + ], + 'parameters' => [ + [ + 'name' => 'PlayDate', + 'in' => 'query', + 'schema' => [ + 'description' => '播放日期，单位：天。格式为：yyyyMMdd。'."\n" + .'>- 仅支持按天查询。'."\n" + .'>- 仅支持查询过去30天以内的数据。', + 'type' => 'string', + 'required' => false, + 'example' => '20240322', + ], + ], + [ + 'name' => 'TerminalType', + 'in' => 'query', + 'schema' => [ + 'description' => '播放器SDK的终端类型。传入此参数，可筛选查询指定终端类型的所有音视频的播放数据。取值：'."\n" + .'- **Native**：Android播放器SDK或iOS播放器SDK。'."\n" + .'- **Web**：Web播放器SDK。', + 'type' => 'string', + 'required' => false, + 'example' => 'Native', + ], + ], + [ + 'name' => 'Os', + 'in' => 'query', + 'schema' => [ + 'description' => '播放端的操作系统。传入此参数，可筛选查询指定操作系统的所有音视频的播放数据。取值：'."\n" + .'- **Android**'."\n" + .'- **iOS**'."\n" + .'- **Windows**'."\n" + .'- **macOS**'."\n" + .'- **Linux**', + 'type' => 'string', + 'required' => false, + 'example' => 'Android', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '服务地域。传入此参数，可筛选查询指定服务地域下的所有音视频的播放数据。取值：'."\n" + .'- **cn-beijing**：华北2（北京）'."\n" + .'- **cn-shanghai**：华东2（上海）'."\n" + .'- **cn-shenzhen**：华南1（深圳）'."\n" + .'- **ap-northeast-1**：日本（东京）'."\n" + .'- **ap-southeast-1**：新加坡'."\n" + .'- **ap-southeast-5**：印度尼西亚（雅加达）'."\n" + .'- **eu-central-1**：德国（法兰克福）', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体ID，即音/视频ID（VideoId）。传入此参数，可筛选查询指定媒体ID的音视频播放数据，仅支持设置一个媒体ID。可通过以下方式获取：'."\n" + .'- 通过控制台上传的音/视频，可登录[视频点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看音/视频ID。'."\n" + .'- 通过[CreateUploadVideo](~~CreateUploadVideo~~)接口上传音/视频时，音/视频ID为返回参数VideoId的值。'."\n" + .'- 音/视频上传后，可通过[SearchMedia](~~SearchMedia~~)接口查询音/视频ID，为请求后返回参数VideoId的值。', + 'type' => 'string', + 'required' => false, + 'example' => '9ae2af636ca6c10412f44891fc****', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的当前页码。传入此参数，可指定查询数据从第几页开始返回。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的数据条数。传入此参数，可设置返回数据每页显示的条数。最大值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '排序类型，与`OrderName`参数搭配使用。传入此参数，可设置返回数据按指定指标的升序或降序进行排列。取值：'."\n" + .'- **ASC**：升序，返回的数据按从小到大向下排列。'."\n" + .'- **DESC**：降序，返回的数据按从大到小向下排列。', + 'type' => 'string', + 'required' => false, + 'example' => 'ASC', + ], + ], + [ + 'name' => 'OrderName', + 'in' => 'query', + 'schema' => [ + 'description' => '指标名称，与`OrderType`参数搭配使用。传入此参数，可设置返回数据按指定指标的升序或降序进行排列。取值：'."\n" + .'- **PlaySuccessVv**：播放总次数。'."\n" + .'- **PlayPerVv**：人均播放次数:。'."\n" + .'- **PlayDuration**：累计播放时长。'."\n" + .'- **PlayDurationPerUv**：人均播放时长。', + 'type' => 'string', + 'required' => false, + 'example' => 'PlaySuccessVv', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + 'TotalCount' => [ + 'description' => '返回数据的总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageNo' => [ + 'description' => '返回数据的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'QoeInfoList' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据详情。', + 'type' => 'object', + 'properties' => [ + 'VideoTitle' => [ + 'description' => '音视频的名称。', + 'type' => 'string', + 'example' => '阿里云VOD视频标题', + ], + 'VideoDuration' => [ + 'description' => '音视频的时长，单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '246', + ], + 'MediaId' => [ + 'description' => '媒体ID，即音/视频ID（VideoId）。', + 'type' => 'string', + 'example' => '9ae2af636ca6c10412f44891fc****', + ], + 'DAU' => [ + 'description' => '音视频的访问用户数，单位：个。', + 'type' => 'number', + 'format' => 'float', + 'example' => '5', + ], + 'PlaySuccessVv' => [ + 'description' => '音视频的播放总次数，单位：次。', + 'type' => 'number', + 'format' => 'float', + 'example' => '20', + ], + 'PlayDurationPerUv' => [ + 'description' => '音视频的人均播放时长，单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '120', + ], + 'PlayDuration' => [ + 'description' => '音视频的累计播放时长，单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '2400', + ], + 'PlayPerVv' => [ + 'description' => '音视频的人均播放次数，单位：次。', + 'type' => 'number', + 'format' => 'float', + 'example' => '4', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Meter.ParamError', + 'errorMessage' => 'Param Error:%s,Please Check Again.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Meter.AuthError', + 'errorMessage' => 'Authentication Failed,Please Try Again.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Meter.ServerInternalError', + 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', + ], + [ + 'errorCode' => 'Meter.DataSourceQueryError', + 'errorMessage' => 'Data Source Error:%s,Please Try Again.', + ], + ], + 502 => [ + [ + 'errorCode' => 'Meter.ReadyTsError', + 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"TotalCount\\": 1,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"QoeInfoList\\": [\\n {\\n \\"VideoTitle\\": \\"阿里云VOD视频标题\\",\\n \\"VideoDuration\\": 246,\\n \\"MediaId\\": \\"9ae2af636ca6c10412f44891fc****\\",\\n \\"DAU\\": 5,\\n \\"PlaySuccessVv\\": 20,\\n \\"PlayDurationPerUv\\": 120,\\n \\"PlayDuration\\": 2400,\\n \\"PlayPerVv\\": 4\\n }\\n ]\\n}","type":"json"}]', + 'title' => '音视频播放数据统计', + 'description' => '- 目前本接口的服务地址仅支持：**华东2（上海）**。'."\n" + .'- 仅支持统计使用了阿里云播放器SDK的播放数据，且不支持纯音频的流量统计。'."\n" + .'- 仅支持查询过去30天以内的数据。'."\n" + ."\n" + .'><notice>- 调用本接口之前，需确保阿里云播放器SDK满足以下条件：></notice>'."\n" + .' - Android播放器SDK或iOS播放器SDK'."\n" + .' - 播放器SDK版本为5.4.9.2及以上。'."\n" + .' - 已获取播放器SDK的License授权并接入License，详情参见[License管理](~~469166~~)。'."\n" + .' - 已开启播放器SDK的埋点日志上报功能，正常情况下，阿里云播放器SDK的埋点日志上报功能为默认开启的。更多信息，请参见[Android端创建播放器](~~311525#section-dc4-gp6-xk2~~)、[iOS端创建播放器](~~313855#section-cmf-k7d-jg5~~)。'."\n" + .' - Web播放器SDK'."\n" + .' - 播放器SDK版本为2.16.0及以上。'."\n" + .' - 已申请开通**播放质量监控**的License授权并接入License，可填写[Web播放器SDK增值服务申请表单](https://yida.alibaba-inc.com/o/webplayer#/)申请开通，License接入方法，请参见[Web端接口说明](~~125572#section-3ty-gwp-6pa~~)中的`license`属性。'."\n" + .' - 已开启播放器SDK的埋点日志上报功能，正常情况下，阿里云播放器SDK的埋点日志上报功能为默认开启的。', + ], + 'DescribePlayTopVideos' => [ + 'summary' => '调用本接口获取每日TOP视频的播放数据统计，统计指标包括播放次数、播放用户数和播放总时长。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39858', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BizDate', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询的日期。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2016-06-29T13:00:00Z', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小，每页显示的条数。默认值为**100**，最大值为**1000**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '10', + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'description' => '分页的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4B0BCF9F-2FD5-4817-****-7BEBBE3AF90B"', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'TotalNum' => [ + 'description' => 'TOP视频的总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TopPlayVideos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TopPlayVideoStatis' => [ + 'description' => 'TOP视频的当日播放数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'description' => '视频名称。', + 'type' => 'string', + 'example' => '阿里云视频', + ], + 'VV' => [ + 'description' => '播放次数。', + 'type' => 'string', + 'example' => '107', + ], + 'PlayDuration' => [ + 'description' => '播放总时长。单位：毫秒。', + 'type' => 'string', + 'example' => '4640369', + ], + 'VideoId' => [ + 'description' => '视频ID。', + 'type' => 'string', + 'example' => '2a8d4cb9ecbb487681473a15****8fda', + ], + 'UV' => [ + 'description' => '播放用户数。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidBizDate.Malformed', + 'errorMessage' => 'Specified BizDate is malformed.', + ], + [ + 'errorCode' => 'InvalidBizDate.BeyondCurrent', + 'errorMessage' => 'BizDate beyond current time.', + ], + [ + 'errorCode' => 'InvalidParamter', + 'errorMessage' => '%s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNo\\": 1,\\n \\"RequestId\\": \\"4B0BCF9F-2FD5-4817-****-7BEBBE3AF90B\\\\\\"\\",\\n \\"PageSize\\": 100,\\n \\"TotalNum\\": 2,\\n \\"TopPlayVideos\\": {\\n \\"TopPlayVideoStatis\\": [\\n {\\n \\"Title\\": \\"阿里云视频\\",\\n \\"VV\\": \\"107\\",\\n \\"PlayDuration\\": \\"4640369\\",\\n \\"VideoId\\": \\"2a8d4cb9ecbb487681473a15****8fda\\",\\n \\"UV\\": \\"1\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\":\\"1FAFB884-D5A7-47D1-82B5-8928AA9C8720\\",\\n \\"HostId\\":\\"vod.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\":\\"InvalidStartTime.Malformed\\",\\n \\"Message\\":\\"Specified StartTime is malformed.\\"\\n} "},{"type":"xml","example":"<DescribePlayTopVideosResponse>\\n <TopPlayVideos>\\n <TopPlayVideoStatis>\\n <VideoId>2a8d4cb9ecbb487681473**53aba8fda</VideoId>\\n <VV>107</VV>\\n <Title>4路（2路加密）：流畅-HLS-加密+标清-MP4+高清-H</Title>\\n <UV>1</UV>\\n <PlayDuration>4640369</PlayDuration>\\n </TopPlayVideoStatis>\\n <TopPlayVideoStatis>\\n <VideoId>cca9dbd11b7045808cc9b**c56f5bad2</VideoId>\\n <VV>33</VV>\\n <Title>2路（全加密）：标清-HLS-加密+超清-HLS-加密</Title>\\n <UV>1</UV>\\n <PlayDuration>4689369</PlayDuration>\\n </TopPlayVideoStatis>\\n </TopPlayVideos>\\n <PageSize>1000</PageSize>\\n <PageNo>1</PageNo>\\n <Total>150</Total>\\n <RequestId>4B0BCF9F-2FD5-4817-****-7BEBBE3AF90B</RequestId>\\n</DescribePlayTopVideosResponse>","errorExample":""}]', + 'title' => 'TOP视频播放数据统计', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 最多可查询当日Top1000的视频播放统计数据，Top视频列表默认基于播放次数进行倒序排序。'."\n" + .'- 仅支持统计使用了阿里云播放器SDK的播放数据。'."\n" + .'- 以北京时间（UTC+8）为基准，每天上午9点生成前一天的播放数据统计。'."\n" + .'- 支持查询2018-01-01之后的数据，数据查询的起止时间跨度最大为180天。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。|'."\n" + .'| InvalidBizDate.Malformed | Specified BizDate is malformed. |400 | BizDate格式错误。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。|'."\n" + .'| InvalidBizDate.BeyondCurrent |EndTime beyond current time. | 400 | BizDate不能超过当前时间。|', + ], + 'DescribePlayUserAvg' => [ + 'summary' => '调用本接口获取指定时间范围内的每日播放数据均量统计，统计指标包括平均播放时长、平均播放次数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39859', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询的起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2016-06-29T13:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询的结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'> 结束时间需大于起始时间，且与起始时间的最大跨度为180天。', + 'type' => 'string', + 'required' => true, + 'example' => '2016-06-30T13:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6C7F90B2-BDA4-4FAC-****-A38A121DFE19', + ], + 'UserPlayStatisAvgs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UserPlayStatisAvg' => [ + 'description' => ' 用户每天平均播放均值统计数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => '播放日期，格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2016-06-30T13:00:00Z', + ], + 'AvgPlayDuration' => [ + 'description' => ' 平均播放时长。单位：毫秒。', + 'type' => 'string', + 'example' => '1035902.8', + ], + 'AvgPlayCount' => [ + 'description' => '平均播放次数。', + 'type' => 'string', + 'example' => '2.0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.BeyondCurrent', + 'errorMessage' => 'EndTime beyond current time.', + ], + [ + 'errorCode' => 'InvalidParamter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'StartTime or EndTime is mismatch.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6C7F90B2-BDA4-4FAC-****-A38A121DFE19\\",\\n \\"UserPlayStatisAvgs\\": {\\n \\"UserPlayStatisAvg\\": [\\n {\\n \\"Date\\": \\"2016-06-30T13:00:00Z\\",\\n \\"AvgPlayDuration\\": \\"1035902.8\\",\\n \\"AvgPlayCount\\": \\"2.0\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\":\\"1FAFB884-D5A7-47D1-82B5-8928AA9C8720\\",\\n \\"HostId\\":\\"vod.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\":\\"InvalidStartTime.Malformed\\",\\n \\"Message\\":\\"Specified StartTime is malformed.\\"\\n}"},{"type":"xml","example":"<DescribePlayUserAvgResponse>\\r\\n\\t<UserPlayStatisAvgs>\\r\\n\\t\\t<UserPlayStatisAvg>\\r\\n\\t\\t\\t<AvgPlayDuration>1035902.8</AvgPlayDuration>\\r\\n\\t\\t\\t<Date>20171127</Date>\\r\\n\\t\\t\\t<AvgPlayCount>17.0</AvgPlayCount>\\r\\n\\t\\t</UserPlayStatisAvg>\\r\\n\\t\\t<UserPlayStatisAvg>\\r\\n\\t\\t\\t<AvgPlayDuration>3113356.7</AvgPlayDuration>\\r\\n\\t\\t\\t<Date>20171128</Date>\\r\\n\\t\\t\\t<AvgPlayCount>41.0</AvgPlayCount>\\r\\n\\t\\t</UserPlayStatisAvg>\\r\\n\\t\\t<UserPlayStatisAvg>\\r\\n\\t\\t\\t<AvgPlayDuration>4290368.0</AvgPlayDuration>\\r\\n\\t\\t\\t<Date>20171129</Date>\\r\\n\\t\\t\\t<AvgPlayCount>59.8</AvgPlayCount>\\r\\n\\t\\t</UserPlayStatisAvg>\\r\\n\\t</UserPlayStatisAvgs>\\r\\n\\t<RequestId>6C7F90B2-BDA4-4FAC-****-A38A121DFE19</RequestId>\\r\\n</DescribePlayUserAvgResponse>","errorExample":""}]', + 'title' => '播放数据均量统计', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 仅支持使用了阿里云播放器SDK的播放数据统计。'."\n" + .'- 以北京时间（UTC+8）为基准，每天上午9点生成前一天的播放数据统计。'."\n" + .'- 支持查询2018-01-01之后的数据，数据查询的起止时间跨度最大为180天。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。|'."\n" + .'| InvalidStartTime.Malformed | Specified StartTime is malformed. | 400 | StartTime格式错误。使格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。|'."\n" + .'| InvalidEndTime.Malformed | Specified EndTime is malformed. | 400 | EndTime格式错误。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。|'."\n" + .'| InvalidEndTime.BeyondCurrent | EndTime beyond current time. | 400 | EndTime不能超过当前时间。|'."\n" + .'| InvalidEndTime.Mismatch | StartTime or EndTime is mismatch. | 400 | StartTime和EndTime不匹配。|', + ], + 'DescribePlayUserTotal' => [ + 'summary' => '调用本接口获取指定时间范围内的每日播放数据总量统计，统计指标包括总播放次数、总播放用户数、总播放时长、播放时长分布。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39860', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询的起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2016-06-29T13:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询的结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'> 结束时间需大于起始时间，且与起始时间的最大跨度为180天。', + 'type' => 'string', + 'required' => true, + 'example' => '2016-06-30T13:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1FAFB884-D5A7-47D1-****-8928AA9C8720', + ], + 'UserPlayStatisTotals' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UserPlayStatisTotal' => [ + 'description' => '用户每天播放总量统计数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => '播放日期，格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2016-06-30T13:00:00Z', + ], + 'PlayDuration' => [ + 'description' => '播放总时长。单位：毫秒。', + 'type' => 'string', + 'example' => '9340070', + ], + 'PlayRange' => [ + 'description' => '播放时长分布。', + 'type' => 'string', + 'example' => '"<=1m:74.3%;>1<=5m:22.8%;>5<=10m:1.0%;>10<=15m:1.0%;>15<=30m:1.0%"', + ], + 'VV' => [ + 'description' => '播放次数总量统计。', + 'type' => 'object', + 'properties' => [ + 'Flash' => [ + 'description' => 'Flash播放器播放总次数。', + 'type' => 'string', + 'example' => '2', + ], + 'iOS' => [ + 'description' => 'iOS播放器播放总次数。', + 'type' => 'string', + 'example' => '0', + ], + 'HTML5' => [ + 'description' => 'HTML5播放器播放总次数。', + 'type' => 'string', + 'example' => '2', + ], + 'Android' => [ + 'description' => 'Android播放器播放总次数。', + 'type' => 'string', + 'example' => '161', + ], + ], + ], + 'UV' => [ + 'description' => '播放用户数总量统计。', + 'type' => 'object', + 'properties' => [ + 'Flash' => [ + 'description' => 'Flash播放器播放总用户数。', + 'type' => 'string', + 'example' => '1', + ], + 'iOS' => [ + 'description' => 'iOS播放器播放总用户数。', + 'type' => 'string', + 'example' => '0', + ], + 'HTML5' => [ + 'description' => 'HTML5播放器播放总用户数。', + 'type' => 'string', + 'example' => '1', + ], + 'Android' => [ + 'description' => 'Android播放器播放总用户数。', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.BeyondCurrent', + 'errorMessage' => 'EndTime beyond current time.', + ], + [ + 'errorCode' => 'InvalidParamter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'StartTime or EndTime is mismatch.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1FAFB884-D5A7-47D1-****-8928AA9C8720\\",\\n \\"UserPlayStatisTotals\\": {\\n \\"UserPlayStatisTotal\\": [\\n {\\n \\"Date\\": \\"2016-06-30T13:00:00Z\\",\\n \\"PlayDuration\\": \\"9340070\\",\\n \\"PlayRange\\": \\"\\\\\\"<=1m:74.3%;>1<=5m:22.8%;>5<=10m:1.0%;>10<=15m:1.0%;>15<=30m:1.0%\\\\\\"\\",\\n \\"VV\\": {\\n \\"Flash\\": \\"2\\",\\n \\"iOS\\": \\"0\\",\\n \\"HTML5\\": \\"2\\",\\n \\"Android\\": \\"161\\"\\n },\\n \\"UV\\": {\\n \\"Flash\\": \\"1\\",\\n \\"iOS\\": \\"0\\",\\n \\"HTML5\\": \\"1\\",\\n \\"Android\\": \\"2\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\":\\"1FAFB884-D5A7-47D1-82B5-8928AA9C8720\\",\\n \\"HostId\\":\\"vod.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\":\\"InvalidStartTime.Malformed\\",\\n \\"Message\\":\\"Specified StartTime is malformed.\\"\\n}"},{"type":"xml","example":"<DescribePlayUserTotalResponse>\\r\\n <UserPlayStatisTotals>\\r\\n\\t\\t<UserPlayStatisTotal>\\r\\n\\t\\t\\t<PlayRange><=1m:74.3%;>1<=5m:22.8%;>5<=10m:1.0%;>10<=15m:1.0%;>15<=30m:1.0%</PlayRange>\\r\\n\\t\\t\\t<Date>20180101</Date>\\r\\n\\t\\t\\t<VV>\\r\\n\\t\\t\\t\\t<Android>101</Android>\\r\\n\\t\\t\\t\\t<iOS>1</iOS>\\r\\n\\t\\t\\t</VV>\\r\\n\\t\\t\\t<PlayDuration>6215417</PlayDuration>\\r\\n\\t\\t\\t<UV>\\r\\n\\t\\t\\t\\t<Android>5</Android>\\r\\n\\t\\t\\t\\t<iOS>1</iOS>\\r\\n\\t\\t\\t</UV>\\r\\n\\t\\t</UserPlayStatisTotal>\\r\\n\\t\\t<UserPlayStatisTotal>\\r\\n\\t\\t\\t<PlayRange><=1m:73.6%;>1<=5m:23.9%;>5<=10m:2.5%</PlayRange>\\r\\n\\t\\t\\t<Date>20180102</Date>\\r\\n\\t\\t\\t<VV>\\r\\n\\t\\t\\t\\t<Android>161</Android>\\r\\n\\t\\t\\t\\t<Flash>2</Flash>\\r\\n\\t\\t\\t\\t<HTML5>1</HTML5>\\r\\n\\t\\t\\t</VV>\\r\\n\\t\\t\\t<PlayDuration>9340070</PlayDuration>\\r\\n\\t\\t\\t<UV>\\r\\n\\t\\t\\t\\t<Android>1</Android>\\r\\n\\t\\t\\t\\t<Flash>2</Flash>\\r\\n\\t\\t\\t\\t<HTML5>1</HTML5>\\r\\n\\t\\t\\t</UV>\\r\\n\\t\\t</UserPlayStatisTotal>\\r\\n\\t</UserPlayStatisTotals>\\r\\n\\t<RequestId>0B9BA42C-8BDE-4611-****-C856BBE20898</RequestId>\\r\\n</DescribePlayUserTotalResponse>","errorExample":""}]', + 'title' => '播放数据总量统计', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 仅支持统计使用了阿里云播放器SDK的播放数据。'."\n" + .'- 以北京时间（UTC+8）为基准，每天上午9点生成前一天的播放数据统计。'."\n" + .'- 支持查询2018-01-01之后的数据，数据查询的起止时间跨度最大为180天。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |'."\n" + .'| InvalidStartTime.Malformed | Specified StartTime is malformed. |400 | StartTime格式错误，应为UTC时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。 |'."\n" + .'| InvalidEndTime.Malformed | Specified EndTime is malformed. | 400 | EndTime格式错误，应为UTC时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。 |'."\n" + .'| InvalidEndTime.BeyondCurrent | EndTime beyond current time. | 400 | EndTime不能超过当前时间。 |'."\n" + .'| InvalidEndTime.Mismatch | StartTime or EndTime is mismatch. | 400 | StartTime和EndTime 不匹配。 |', + ], + 'DescribePlayVideoStatis' => [ + 'summary' => '调用本接口查询指定视频在指定时间范围内的每日播放统计数据，统计指标包括播放总时长、播放次数、播放用户数和播放时长分布。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39861', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询的起始时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'example' => '2016-06-29T13:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询的结束时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n" + .'> 结束时间需大于起始时间，且与起始时间的最大跨度为180天。', + 'type' => 'string', + 'required' => true, + 'example' => '2016-06-30T13:00:00Z', + ], + ], + [ + 'name' => 'VideoId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的视频的视频ID，仅支持传入一个视频ID。可通过以下方式获取：'."\n" + .'- 可登录[点播控制台](https://vod.console.aliyun.com)，选择**媒资库** > **音/视频**查看。'."\n" + .'- 调用[CreateUploadVideo](~~CreateUploadVideo~~)接口获取上传地址和凭证时会返回。'."\n" + .'- 音视频上传后，调用[SearchMedia ](~~SearchMedia~~)接口查询视频时会返回。', + 'type' => 'string', + 'required' => true, + 'example' => '2a8d4cb9ecbb487681473****aba8fda', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A92D3600-A3E7-43D6-****-B6E3B4A1FE6B', + ], + 'VideoPlayStatisDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoPlayStatisDetail' => [ + 'description' => '视频在指定时间段内每日的播放统计数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PlayDuration' => [ + 'description' => '播放总时长。单位：毫秒。', + 'type' => 'string', + 'example' => '967277', + ], + 'Date' => [ + 'description' => '播放日期，格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2024-06-12T16:00:00Z', + ], + 'VV' => [ + 'description' => '播放次数。', + 'type' => 'string', + 'example' => '24', + ], + 'Title' => [ + 'description' => '视频名称。', + 'type' => 'string', + 'example' => '阿里云视频', + ], + 'UV' => [ + 'description' => '播放用户数。', + 'type' => 'string', + 'example' => '1', + ], + 'PlayRange' => [ + 'description' => '播放时长分布。', + 'type' => 'string', + 'example' => '<=1m:79.2%;>1<=5m:16.7%;>5<=10m:4.2%', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidParamter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'StartTime or EndTime is mismatch.', + ], + [ + 'errorCode' => 'InvalidEndTime.BeyondCurrent', + 'errorMessage' => 'EndTime beyond current time.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A92D3600-A3E7-43D6-****-B6E3B4A1FE6B\\",\\n \\"VideoPlayStatisDetails\\": {\\n \\"VideoPlayStatisDetail\\": [\\n {\\n \\"PlayDuration\\": \\"967277\\",\\n \\"Date\\": \\"2024-06-12T16:00:00Z\\",\\n \\"VV\\": \\"24\\",\\n \\"Title\\": \\"阿里云视频\\",\\n \\"UV\\": \\"1\\",\\n \\"PlayRange\\": \\"<=1m:79.2%;>1<=5m:16.7%;>5<=10m:4.2%\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribePlayVideoStatisResponse>\\r\\n\\t<RequestId>A92D3600-A3E7-43D6-****-B6E3B4A1FE6B</RequestId>\\r\\n\\t<VideoPlayStatisDetails>\\r\\n\\t\\t<VideoPlayStatisDetail>\\r\\n\\t\\t\\t<Date>20180101</Date>\\r\\n\\t\\t\\t<PlayDuration>3288</PlayDuration>\\r\\n\\t\\t\\t<PlayRange><=1m:79.2%;>1<=5m:16.7%;>5<=10m:4.2%</PlayRange>\\r\\n\\t\\t\\t<Title>4路（1路加密）：流畅-HLS+标清-MP4+高清-HLS-加密+超清-MP4</Title>\\r\\n\\t\\t\\t<UV>1</UV>\\r\\n\\t\\t\\t<VV>1</VV>\\r\\n\\t\\t</VideoPlayStatisDetail>\\r\\n\\t\\t<VideoPlayStatisDetail>\\r\\n\\t\\t\\t<Date>20180102</Date>\\r\\n\\t\\t\\t<PlayDuration>967277</PlayDuration>\\r\\n\\t\\t\\t<PlayRange><=1m:79.2%;>1<=5m:16.7%;>5<=10m:4.2%</PlayRange>\\r\\n\\t\\t\\t<Title>4路（1路加密）：流畅-HLS+标清-MP4+高清-HLS-加密+超清-MP4</Title>\\r\\n\\t\\t\\t<UV>1</UV>\\r\\n\\t\\t\\t<VV>24</VV>\\r\\n\\t\\t</VideoPlayStatisDetail>\\r\\n\\t</VideoPlayStatisDetails>\\r\\n</DescribePlayVideoStatisResponse>","errorExample":""}]', + 'title' => '单视频播放数据统计', + 'description' => '- 目前服务地址仅支持：**华东2（上海）**。'."\n" + .'- 仅支持统计使用了阿里云播放器SDK且单日播放次数排名前1000的视频播放数据。'."\n" + .'- 以北京时间（UTC+8）为基准，每天上午9点生成前一天的播放数据统计。'."\n" + .' - 仅支持最近2年内（730天）的数据查询，且数据查询的起止时间跨度最大为180天。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。|'."\n" + .'| InvalidStartTime.Malformed | Specified StartTime is malformed. | 400 | StartTime格式错误，应为UTC时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。|'."\n" + .'| InvalidEndTime.Malformed | Specified EndTime is malformed. | 400 | EndTime格式错误，应为UTC时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。|'."\n" + .'| InvalidEndTime.BeyondCurrent | EndTime beyond current time. | 400 | EndTime不能超过当前时间。|'."\n" + .'| InvalidEndTime.Mismatch | StartTime or EndTime is mismatch. | 400 | StartTime和EndTime不匹配。|', + ], + 'CreateAppInfo' => [ + 'summary' => '调用本接口创建新的应用。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39806', + 'abilityTreeNodes' => [ + 'FEATUREvodHJ3KAX', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。不能重复。'."\n" + .'- 最多支持128个字符，仅支持中文、大小写英文字母、数字、半角句号（.）、短划线（-）和at字符（@）。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '应用描述。'."\n" + .'- 最多支持512个字符。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'myfirstapp', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzko7fsuj****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-34D5-D7393642****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AppId\\": \\"app-****\\",\\n \\"RequestId\\": \\"25818875-5F78-4A13-34D5-D7393642****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAppInfoResponse>\\n <AppId>app-****</AppId>\\n <RequestId>25818875-5F78-4A13-34D5-D7393642****</RequestId>\\n</CreateAppInfoResponse>","errorExample":""}]', + 'title' => '创建应用', + 'description' => '每个账号最多能创建10个应用，更多详情，请参见[多应用开发指南](~~113600~~)。'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + ], + 'DeleteAppInfo' => [ + 'summary' => '调用本接口删除应用信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '39824', + 'abilityTreeNodes' => [ + 'FEATUREvodHJ3KAX', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。为调用[创建应用](~~113266~~)接口或[获取应用信息列表](~~114000~~)接口返回参数AppId的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAppInfoResponse>\\n <RequestId>25818875-5F78-4A13-BEF6-****</RequestId>\\n</DeleteAppInfoResponse>","errorExample":""}]', + 'title' => '删除应用', + 'description' => '应用下存在资源时，将无法被删除。'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'|OperationDenied.NotOpenAppService | The app service is not open. | 403 | 多应用服务未开通。 |'."\n" + .'|Forbidden.OperateApp | User not authorized to operate app. | 403 | 未授予操作该应用的权限。 |'."\n" + .'|Forbidden.ResourceNotEmpty | The App: app-**** has **** resource, can not be deleted. | 403 | 应用下存在资源, 不能被删除。 |', + ], + 'UpdateAppInfo' => [ + 'summary' => '调用本接口更新应用信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '40207', + 'abilityTreeNodes' => [ + 'FEATUREvodHJ3KAX', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。为调用[创建应用](~~113266~~)接口或[获取应用信息列表](~~114000~~)接口返回参数AppId的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-****', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '期望修改的应用名称。'."\n" + .'- 最多支持128个字符，仅支持中文、大小写英文字母、数字、半角句号（.）、短划线（-）和at字符（@）。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '期望修改的应用描述。'."\n" + .'- 最多支持512个字符。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'my first app.', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '期望修改的应用状态。可选值：'."\n" + .'- **Normal**（正常启用）'."\n" + .'- **Disable**（停用）'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Disable', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-DF45-D7393642****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-DF45-D7393642****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAppInfoResponse>\\n <RequestId>25818875-5F78-4A13-DF45-D7393642****</RequestId>\\n</UpdateAppInfoResponse>","errorExample":""}]', + 'title' => '更新应用信息', + 'description' => '创建应用后，可调用本接口通过应用ID来定位到某个应用并修改该应用的名称、描述及状态信息。'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '### 接口错误码'."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| OperationDenied.NotOpenAppService | The app service is not open. |403 |多应用服务未开通。|'."\n" + .'|Forbidden.OperateApp | User not authorized to operate app. | 403 | 未授予修改应用的权限。|', + ], + 'GetAppInfos' => [ + 'summary' => '调用本接口通过应用ID查询应用信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39937', + 'abilityTreeNodes' => [ + 'FEATUREvodHJ3KAX', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppIds', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID列表。由一个或多个应用ID组成，应用ID为调用[创建应用](~~113266~~)接口或[获取应用信息列表](~~114000~~)接口返回参数AppId的值。'."\n" + .'- 最多支持10个ID。'."\n" + .'- 多个ID之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'app-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-4DC4-D7393642****', + ], + 'NonExistAppIds' => [ + 'description' => '不存在的应用ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的应用ID列表。', + 'type' => 'string', + 'example' => 'app-12****', + ], + ], + 'AppInfoList' => [ + 'description' => '应用信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用信息详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '应用类型。取值范围：'."\n" + .'- **System**（系统默认）'."\n" + .'- **Custom**（用户创建）', + 'type' => 'string', + 'example' => 'System', + ], + 'Status' => [ + 'description' => '应用状态。取值范围：'."\n" + .'- **Normal**（正常）'."\n" + .'- **Disable**（停用）', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CreationTime' => [ + 'description' => 'UTC创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-03-01T08:00:00Z', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Description' => [ + 'description' => '应用描述。', + 'type' => 'string', + 'example' => 'my first app.', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'ModificationTime' => [ + 'description' => 'UTC更新时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-03-01T09:00:00Z', + ], + 'ResourceGroupId' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'example' => 'rg-aekzko7fsuj****', + ], + ], + ], + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-4DC4-D7393642****\\",\\n \\"NonExistAppIds\\": [\\n \\"app-12****\\"\\n ],\\n \\"AppInfoList\\": [\\n {\\n \\"Type\\": \\"System\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreationTime\\": \\"2019-03-01T08:00:00Z\\",\\n \\"AppName\\": \\"test\\",\\n \\"Description\\": \\"my first app.\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"ModificationTime\\": \\"2019-03-01T09:00:00Z\\",\\n \\"ResourceGroupId\\": \\"rg-aekzko7fsuj****\\"\\n }\\n ],\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAppInfosResponse>\\n <RequestId>25818875-5F78-4A13-4DC4-D7393642****</RequestId>\\n <NonExistAppIds>1</NonExistAppIds>\\n <AppInfoList>\\n <Type>System</Type>\\n <Status>Normal</Status>\\n <CreationTime>2019-03-01T08:00:00Z</CreationTime>\\n <AppName>test</AppName>\\n <Description>my first app.</Description>\\n <AppId>app-****</AppId>\\n <ModificationTime>2019-03-01T09:00:00Z</ModificationTime>\\n </AppInfoList>\\n</GetAppInfosResponse>","errorExample":""}]', + 'title' => '查询应用信息', + 'description' => '- 支持批量查询。'."\n" + .'- AppIds最多支持10个ID。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| OperationDenied.NotOpenAppService | The app service is not open. | 403 | 多应用服务未开通。 |', + ], + 'ListAppInfo' => [ + 'summary' => '调用本接口根据查询条件获取有权限的应用信息列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40042', + 'abilityTreeNodes' => [ + 'FEATUREvodHJ3KAX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '应用状态，可查询指定状态的应用。应用创建后默认为**Normal**，取值范围：'."\n" + .'- **Normal**（正常）'."\n" + .'- **Disable**（停用）', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + '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' => '10', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzko7fsuj****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '总条目。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-4D5C-D7393642****', + ], + 'AppInfoList' => [ + 'description' => '应用信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用信息详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '应用类型。取值范围：'."\n" + .'- **System**（系统默认）'."\n" + .'- **Custom**（用户创建）', + 'type' => 'string', + 'example' => 'System', + ], + 'Status' => [ + 'description' => '应用状态。取值范围：'."\n" + .'- **Normal**（正常）'."\n" + .'- **Disable**（停用）', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CreationTime' => [ + 'description' => 'UTC创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-03-01T08:00:00Z', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Description' => [ + 'description' => '应用描述。', + 'type' => 'string', + 'example' => 'my first app.', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'ModificationTime' => [ + 'description' => 'UTC更新时间。格式为：`yyyy-MM-ddTHH:mm:ssZ`（UTC时间）。', + 'type' => 'string', + 'example' => '2019-03-01T09:00:00Z', + ], + 'RegionId' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'ResourceGroupId' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'example' => 'rg-aekzko7fsuj****', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Total\\": 10,\\n \\"RequestId\\": \\"25818875-5F78-4A13-4D5C-D7393642****\\",\\n \\"AppInfoList\\": [\\n {\\n \\"Type\\": \\"System\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreationTime\\": \\"2019-03-01T08:00:00Z\\",\\n \\"AppName\\": \\"test\\",\\n \\"Description\\": \\"my first app.\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"ModificationTime\\": \\"2019-03-01T09:00:00Z\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"ResourceGroupId\\": \\"rg-aekzko7fsuj****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListAppInfoResponse>\\n <Total>10</Total>\\n <RequestId>25818875-5F78-4A13-4D5C-D7393642****</RequestId>\\n <AppInfoList>\\n <Type>System</Type>\\n <Status>Normal</Status>\\n <CreationTime>2019-03-01T08:00:00Z</CreationTime>\\n <AppName>test</AppName>\\n <Description>my first app.</Description>\\n <AppId>app-****</AppId>\\n <ModificationTime>2019-03-01T09:00:00Z</ModificationTime>\\n </AppInfoList>\\n</ListAppInfoResponse>","errorExample":""}]', + 'title' => '获取应用信息列表', + 'description' => '### 使用说明'."\n" + .'支持按应用状态过滤查询。'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| OperationDenied.NotOpenAppService | The app service is not open. | 403 | 多应用服务未开通。 |', + ], + 'AddVodStorageForApp' => [ + 'summary' => '为视频点播的子应用绑定存储Bucket。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '200259', + 'abilityTreeNodes' => [ + 'FEATUREvod3O95DN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID列表。应用ID为调用[CreateAppInfo](~~CreateAppInfo~~)接口或[ListAppInfo](~~ListAppInfo~~)接口返回参数`AppId`的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-****', + ], + ], + [ + 'name' => 'StorageLocation', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS bucket地址。当StorageType为user_oss_bucket时，该字段必填。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'example-bucket.oss-cn-shanghai.aliyuncs.com', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '存储类型。可选择vod_oss_bucket，user_oss_bucket。默认为**vod_oss_bucket**。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'vod_oss_bucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'StorageLocation' => [ + 'description' => '创建的点播系统bucket存储地址。', + 'type' => 'string', + 'example' => 'out-****.oss-cn-shanghai.aliyuncs.com', + ], + ], + ], + ], + [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"StorageLocation\\": \\"out-****.oss-cn-shanghai.aliyuncs.com\\"\\n}","type":"json"}]', + 'title' => '为子应用绑定存储', + 'description' => '调用AddVodStorageForApp为视频点播子应用启用点播系统bucket。'."\n" + .' <notice>每个子应用最多启用一个点播系统bucket。传入不存在AppId或AppId已启用点播系统bucket会返回失败。</notice>'."\n" + .'<notice>调用该接口需要调用者有应用管理员权限（VODAppAdministratorAccess），主账号默认有应用管理员权限，应用管理员可以调用AttachAppPolicyToIdentity为子账号或角色授权应用权限。</notice>', + ], + 'AttachAppPolicyToIdentity' => [ + 'summary' => '调用本接口为指定身份（RAM用户或RAM角色）附加点播应用的访问权限。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39798', + 'abilityTreeNodes' => [ + 'FEATUREvodHJ3KAX', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'IdentityType', + 'in' => 'query', + 'schema' => [ + 'description' => '身份类型。取值：'."\n" + .'- **RamUser**：RAM用户。'."\n" + .'- **RamRole**：RAM角色。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RamRole', + ], + ], + [ + 'name' => 'IdentityName', + 'in' => 'query', + 'schema' => [ + 'description' => '身份名称。'."\n" + ."\n" + .'- 类型为RamUser时，传入RAM用户ID。'."\n" + .'- 类型为RamRole时，传入角色名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '****', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。默认取值：**app-1000000**。使用说明，请参见[多应用](~~113600~~)。'."\n" + ."\n" + .'> 当策略名称为VODAppAdministratorAccess时，该字段非必选。其他策略时，该字段必填。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'app-****', + ], + ], + [ + 'name' => 'PolicyNames', + 'in' => 'query', + 'schema' => [ + 'description' => '策略名称。多个名称使用英文逗号（,）分隔，暂时只支持设置为系统策略，可选值：'."\n" + .'- **VODAppFullAccess**：管理和操作应用下所有资源的权限。'."\n" + .'- **VODAppReadOnlyAccess**：只读访问应用下所有资源的权限。'."\n" + .'- **VODAppAdministratorAccess**：应用管理员权限。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'VODAppFullAccess', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-****-D7393642CA58', + ], + 'NonExistPolicyNames' => [ + 'description' => '不存在的策略名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的策略名称列表。', + 'type' => 'string', + 'example' => 'test****1', + ], + ], + 'FailedPolicyNames' => [ + 'description' => '失败的策略名称。', + 'type' => 'array', + 'items' => [ + 'description' => '失败的策略名称。', + 'type' => 'string', + 'example' => 'test****2', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-****-D7393642CA58\\",\\n \\"NonExistPolicyNames\\": [\\n \\"test****1\\"\\n ],\\n \\"FailedPolicyNames\\": [\\n \\"test****2\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<AttachAppPolicyToIdentityResponse>\\n <RequestId>25818875-5F78-4A13-****-D7393642CA58</RequestId>\\n <NonExistPolicyNames>test****1</NonExistPolicyNames>\\n <FailedPolicyNames>test****2</FailedPolicyNames>\\n</AttachAppPolicyToIdentityResponse>","errorExample":""}]', + 'title' => '为身份实体附加应用授权', + 'description' => '><notice> 每个RAM用户或RAM角色最多授予10个应用权限。></notice>'."\n" + .'><notice>调用该接口需要有应用管理员权限，首次调用建议使用主账号调用。></notice>'."\n" + .'- 当策略名称为VODAppAdministratorAccess时，AppId非必选。其他策略时，AppId必填。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'|OperationDenied.NotOpenAppService | The app service is not open. | 403 | 多应用服务未开通。 |'."\n" + .'|Forbidden.OperateApp | User not authorized to operate app. | 403 | 未授予操作该应用的权限。 |', + ], + 'DetachAppPolicyFromIdentity' => [ + 'summary' => '调用本接口为指定账号身份（RAM用户或RAM角色）撤销指定的应用授权。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39923', + 'abilityTreeNodes' => [ + 'FEATUREvodHJ3KAX', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'IdentityType', + 'in' => 'query', + 'schema' => [ + 'description' => '身份类型，取值：'."\n" + .'- **RamUser**：RAM用户。'."\n" + .'- **RamRole**：RAM角色。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RamUser', + ], + ], + [ + 'name' => 'IdentityName', + 'in' => 'query', + 'schema' => [ + 'description' => '身份名称。'."\n" + ."\n" + .'- 当类型为RamUser时，传入RAM用户ID。'."\n" + .'- 当类型为RamRole时，传入角色名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test****name', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。当策略名称为VODAppAdministratorAccess时，该字段非必选。其他策略时，该字段必填。'."\n" + .'- 取值（默认）：**app-1000000**。'."\n" + .'- 使用说明，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'app-****', + ], + ], + [ + 'name' => 'PolicyNames', + 'in' => 'query', + 'schema' => [ + 'description' => '策略名称。多个名称使用英文逗号（,）分隔。暂时只支持设置为系统策略，取值：'."\n" + .'- **VODAppFullAccess**：管理和操作应用下所有资源的权限。'."\n" + .'- **VODAppReadOnlyAccess**：只读访问应用下所有资源的权限。'."\n" + .'- **VODAppAdministratorAccess**：应用管理员权限。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'VODAppFullAccess', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-****-D7393642C', + ], + 'NonExistPolicyNames' => [ + 'description' => '不存在的策略名称。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的策略名称。', + 'type' => 'string', + 'example' => 'test****1', + ], + ], + 'FailedPolicyNames' => [ + 'description' => '失败的策略名称。', + 'type' => 'array', + 'items' => [ + 'description' => '失败的策略名称。', + 'type' => 'string', + 'example' => 'test****2', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-****-D7393642C\\",\\n \\"NonExistPolicyNames\\": [\\n \\"test****1\\"\\n ],\\n \\"FailedPolicyNames\\": [\\n \\"test****2\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DetachAppPolicyFromIdentityResponse>\\n <RequestId>25818875-5F78-4A13-****-D7393642C</RequestId>\\n <FailedPolicyNames>test****1</FailedPolicyNames>\\n <NonExistPolicyNames>test****2</NonExistPolicyNames>\\n</DetachAppPolicyFromIdentityResponse>","errorExample":""}]', + 'title' => '为身份实体撤销应用授权', + 'description' => '><notice>每个RAM用户或RAM角色最多授予10个应用权限。></notice>'."\n" + .'- 当策略名称为**VODAppAdministratorAccess**时，**AppId**非必选。其他策略时，**AppId**必填。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| OperationDenied.NotOpenAppService | The app service is not open. |403 | 多应用服务未开通。|'."\n" + .'| Forbidden.OperateApp | User not authorized to operate app. | 403 | 未授予操作该应用的权限。|', + ], + 'ListAppPoliciesForIdentity' => [ + 'summary' => '调用本接口列出指定账号身份（RAM用户或RAM角色）被授予的应用权限的列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40044', + 'abilityTreeNodes' => [ + 'FEATUREvodHJ3KAX', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'IdentityType', + 'in' => 'query', + 'schema' => [ + 'description' => '身份类型。取值：'."\n" + .'- **RamUser**（RAM用户）'."\n" + .'- **RamRole**（RAM角色）', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'RamUser', + ], + ], + [ + 'name' => 'IdentityName', + 'in' => 'query', + 'schema' => [ + 'description' => '身份名称。'."\n" + ."\n" + .'- 类型为RamUser时，传入RAM用户ID'."\n" + .'- 类型为RamRole时，传入角色名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'test****name', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。 默认取值：**app-1000000**。使用说明，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C9F3E715-B3B8-4D*****27-3A70346F0E04', + ], + 'AppPolicyList' => [ + 'description' => '权限策略名称列表。'."\n" + ."\n" + .'> 最多返回前100条数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '角色授权应用策略的创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2019-01-01T01:01:01Z', + ], + 'Description' => [ + 'description' => '策略描述。', + 'type' => 'string', + 'example' => 'App full access permission', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-****', + ], + 'PolicyValue' => [ + 'description' => '策略值。', + 'type' => 'string', + 'example' => '****', + ], + 'PolicyName' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'VODAppFullAccess', + ], + 'ModificationTime' => [ + 'description' => '角色授权应用策略的修改时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2019-01-01T01:08:01Z', + ], + 'PolicyType' => [ + 'description' => '策略类型。'."\n" + .'- **System**（系统策略）'."\n" + .'- **Custom**（用户自定义）', + 'type' => 'string', + 'example' => 'System', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C9F3E715-B3B8-4D*****27-3A70346F0E04\\",\\n \\"AppPolicyList\\": [\\n {\\n \\"CreationTime\\": \\"2019-01-01T01:01:01Z\\",\\n \\"Description\\": \\"App full access permission\\",\\n \\"AppId\\": \\"app-****\\",\\n \\"PolicyValue\\": \\"****\\",\\n \\"PolicyName\\": \\"VODAppFullAccess\\",\\n \\"ModificationTime\\": \\"2019-01-01T01:08:01Z\\",\\n \\"PolicyType\\": \\"System\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListAppPoliciesForIdentityResponse>\\n<RequestId>C9F3E715-B3B8-4D*****27-3A70346F0E04</RequestId>\\n<AppPolicyList>\\n <PolicyType>System</PolicyType>\\n <Description>App full access permission</Description>\\n <AppId>app-****</AppId>\\n <PolicyName>VODAppFullAccess</PolicyName>\\n <PolicyValue>****</PolicyValue>\\n <CreationTime>2019-01-01T01:01:01Z</CreationTime>\\n <ModificationTime>2019-01-01T01:08:01Z</ModificationTime>\\n</AppPolicyList>\\n</ListAppPoliciesForIdentityResponse>","errorExample":""}]', + 'title' => '查询身份实体被授予的应用权限列表', + 'description' => '- 只有拥有管理员权限的账号身份调用该接口时，**IdentityType**和**IdentityName**有效；否则只返回当前账号身份被授予的应用权限策略。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| OperationDenied.NotOpenAppService | The app service is not open. | 403 | 多应用服务未开通。|', + ], + 'MoveAppResource' => [ + 'summary' => '调用本接口将媒资等资源从一个应用迁移到另外一个应用。应用管理员可以直接转移，RAM用户或RAM角色需要对资源转移前后的两个应用拥有写权限，支持批量迁移。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40094', + 'abilityTreeNodes' => [ + 'FEATUREvodHJ3KAX', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TargetAppId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标应用ID。默认取值：**app-1000000**。使用说明，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'app-****', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。取值：'."\n" + .'- **video**：视频。'."\n" + .'- **image**：图片。'."\n" + .'- **attached**：辅助媒资。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'video', + ], + ], + [ + 'name' => 'ResourceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID。多个ID使用英文逗号（,）分隔，一次最多20条。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '9afb4****06de180880e,f7bba****caa546cfe2ba', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-****', + ], + 'NonExistResourceIds' => [ + 'description' => '不存在的资源ID。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的资源ID。', + 'type' => 'string', + 'example' => '9afb4****06de180880e', + ], + ], + 'FailedResourceIds' => [ + 'description' => '失败的资源ID。', + 'type' => 'array', + 'items' => [ + 'description' => '失败的资源ID。', + 'type' => 'string', + 'example' => 'f7bba****caa546cfe2ba', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-****\\",\\n \\"NonExistResourceIds\\": [\\n \\"9afb4****06de180880e\\"\\n ],\\n \\"FailedResourceIds\\": [\\n \\"f7bba****caa546cfe2ba\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<MoveAppResourceResponse>\\n <RequestId>25818875-5F78-4A13-BEF6-****</RequestId>\\n <FailedResourceIds>9afb4****06de180880e</FailedResourceIds>\\n <NonExistResourceIds>f7bba****caa546cfe2ba</NonExistResourceIds>\\n</MoveAppResourceResponse>","errorExample":""}]', + 'title' => '迁移资源到新应用', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '## 接口错误码'."\n" + ."\n" + .'下表列举了本接口特有的错误码。'."\n" + .'| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| OperationDenied.NotOpenAppService | The app service is not open. | 403 |多应用服务未开通。|'."\n" + .'| Forbidden.OperateAppResource | Invalid app permission to operate on the specified resource. | 403 |未授予管理目标应用下资源的权限。|', + ], + 'GetAppPlayKey' => [ + 'summary' => '获取应用播放密钥。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39805', + 'abilityTreeNodes' => [ + 'FEATUREvodHJ3KAX', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。 默认取值：**app-1000000**。使用说明，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-1000000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'AppPlayKey' => [ + 'description' => '应用播放密钥信息。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-1000000', + ], + 'PlayKey' => [ + 'description' => '播放密钥。'."\n" + .'- 仅支持大小写字母和数字，长度在8 ~ 20个字符之间。'."\n" + .'- UTF-8 编码。', + 'type' => 'string', + 'example' => 'yzNgTUtAl6HAuosIA', + ], + 'CreationTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。'."\n", + 'type' => 'string', + 'example' => '2025-03-18T03:59:01Z', + ], + 'ModificationTime' => [ + 'description' => '更新时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2025-03-18T03:59:01Z', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"AppPlayKey\\": {\\n \\"AppId\\": \\"app-1000000\\",\\n \\"PlayKey\\": \\"yzNgTUtAl6HAuosIA\\",\\n \\"CreationTime\\": \\"2025-03-18T03:59:01Z\\",\\n \\"ModificationTime\\": \\"2025-03-18T03:59:01Z\\"\\n }\\n}","type":"json"}]', + 'title' => '获取应用播放密钥', + ], + 'SetAppPlayKey' => [ + 'summary' => '设置应用播放密钥。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39805', + 'abilityTreeNodes' => [ + 'FEATUREvodHJ3KAX', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。 默认取值：**app-1000000**。使用说明，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-1000231', + ], + ], + [ + 'name' => 'PlayKey', + 'in' => 'query', + 'schema' => [ + 'description' => '播放密钥。'."\n" + .'- 仅支持大小写字母和数字，长度在8 ~ 20个字符之间。'."\n" + .'- UTF-8 编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'yzNgTUtAl6HAuosIA', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\"\\n}","type":"json"}]', + 'title' => '设置应用播放密钥', + ], + 'SetCrossdomainContent' => [ + 'summary' => '调用本接口更新点播跨域文件crossdomain.xml的内容。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40126', + 'abilityTreeNodes' => [ + 'FEATUREvodHI57GB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '跨域文件内容。XML格式，不超过2048个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '<cross-domain-policy><allow-access-from domain="*"/><allow-http-request-headers-from domain="*" headers="*" secure="false"/></cross-domain-policy>', + ], + ], + [ + 'name' => 'StorageLocation', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储地址。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'outin-67870fd5b****1e98a3900163e1c35d5.oss-cn-shanghai.aliyuncs.com', + ], + ], + [ + 'name' => 'ResourceRealOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源所有者ID。', + 'type' => 'string', + 'required' => false, + 'example' => '3461111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-****-D7393642CA58', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-****-D7393642CA58\\"\\n}","errorExample":""},{"type":"xml","example":"<SetCrossdomainContentResponse>\\r\\n <RequestId>25818875-5F78-4A13-****-D7393642CA58</RequestId>\\r\\n</SetCrossdomainContentResponse>","errorExample":""}]', + 'title' => '更新跨域文件', + 'description' => '><notice>如果通过域名跨域文件访问，需要刷新CDN缓存来立即生效，可以登录控制台[刷新文件](~~86098~~)或者调用[刷新缓存接口](~~69215~~)。></notice>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteMessageCallback' => [ + 'summary' => '调用本接口删除事件通知的回调方式、回调地址、事件类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39838', + 'abilityTreeNodes' => [ + 'FEATUREvod9NUA3V', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。不传时为系统默认应用的ID，取固定值：**app-1000000**。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'app-1000000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-****-D7393642CA58', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-****-D7393642CA58\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteMessageCallbackResponse>\\r\\n <RequestId>25818875-5F78-4A13-****-D7393642CA58</RequestId>\\r\\n</DeleteMessageCallbackResponse>","errorExample":""}]', + 'title' => '删除事件通知配置', + 'description' => '> 详细使用说明，请参见[事件通知开发指南](~~55627~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetMessageCallback' => [ + 'summary' => '调用本接口设置事件通知的回调方式、回调地址、事件类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '40150', + 'abilityTreeNodes' => [ + 'FEATUREvod9NUA3V', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CallbackType', + 'in' => 'query', + 'schema' => [ + 'description' => '回调方式，取值：'."\n" + .'- **HTTP**'."\n" + .'- **轻量消息队列（原MNS）**', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'CallbackURL', + 'in' => 'query', + 'schema' => [ + 'description' => '回调地址。回调方式为**HTTP**时，需设置此参数。'."\n" + .'回调地址URL的长度不能超过256个字节，不支持设置多个回调地址。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'http://developer.aliyundoc.com', + ], + ], + [ + 'name' => 'EventTypeList', + 'in' => 'query', + 'schema' => [ + 'description' => '回调事件类型，取值为空时关闭所有消息通知，取值为**ALL**时开启全部消息通知。也可指定开启某些消息通知，多个事件类型之间使用半角逗号（,）分隔。可设置的事件类型取值范围请参见：[事件类型](~~55627~~)。'."\n" + ."\n" + .'<props="china">'."\n" + .'> 所有AI相关事件即AIMediaAuditComplete、AIMediaDNAComplete等取值都为**AIComplete**。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'FileUploadComplete', + ], + ], + [ + 'name' => 'AuthSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP回调的鉴权开关，回调方式设置为**HTTP**时，此参数有效。取值：'."\n" + .'- **on**（启用）'."\n" + .'- **off**（不启用）', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'AuthKey', + 'in' => 'query', + 'schema' => [ + 'description' => '鉴权Key，最长32位，必须同时包含大小写字母和数字。回调方式为**HTTP**时，可设置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'Dsf346dvet', + ], + ], + [ + 'name' => 'MnsEndpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '消息队列公网Endpoint，回调方式为**轻量消息队列（原MNS）**时，需设置此参数。可登录[消息服务控制台](https://account.aliyun.com/login/login.html)，单击右上角的**获取Endpoint**按钮获取。更多信息，请参见[Endpoint](~~27480~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://****.mns.cn-shanghai.aliyuncs.com/', + ], + ], + [ + 'name' => 'MnsQueueName', + 'in' => 'query', + 'schema' => [ + 'description' => '消息队列名称，可登录[消息服务控制台](https://account.aliyun.com/login/login.html)，在**队列列表**中查看。回调方式为**轻量消息队列（原MNS）**时，需设置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'quene_name', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。不传时为系统默认应用的ID，取固定值：**app-1000000**。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-1000000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetMessageCallbackResponse>\\n <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n</SetMessageCallbackResponse>","errorExample":""}]', + 'title' => '设置事件通知配置', + 'description' => '支持HTTP回调和MNS回调。详细使用说明，请参见[事件通知](~~55627~~)。'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见[QPS限制](~~342790~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetMessageCallback' => [ + 'summary' => '调用本接口查询事件通知的回调方式、回调地址、事件类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '39965', + 'abilityTreeNodes' => [ + 'FEATUREvod9NUA3V', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。不传时为系统默认应用的ID，取固定值：**app-1000000**。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-1000000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '272A222A-F7F7-4A3E-****-F531574F1234', + ], + 'MessageCallback' => [ + 'description' => '事件通知配置。', + 'type' => 'object', + 'properties' => [ + 'CallbackType' => [ + 'description' => '回调方式，取值：'."\n" + .'- **HTTP**'."\n" + .'- **MNS**', + 'type' => 'string', + 'example' => 'HTTP', + ], + 'CallbackURL' => [ + 'description' => '回调方式选择HTTP时，回调地址。', + 'type' => 'string', + 'example' => 'http://test.com/test', + ], + 'EventTypeList' => [ + 'description' => '回调事件类型。', + 'type' => 'string', + 'example' => 'FileUploadComplete,StreamTranscodeComplete,TranscodeComplete,SnapshotComplete,AIComplete,AddLiveRecordVideoComplete,CreateAuditComplete,UploadByURLComplete,ProduceMediaComplete,LiveRecordVideoComposeStart,ImageUploadComplete,VideoAnalysisComplete', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'app-1000000', + ], + 'MnsQueueName' => [ + 'description' => '回调方式选择MNS时，消息队列名称。', + 'type' => 'string', + 'example' => 'vodcallback', + ], + 'AuthKey' => [ + 'description' => '回调方式选择HTTP时，鉴权Key。', + 'type' => 'string', + 'example' => '12345678abc', + ], + 'AuthSwitch' => [ + 'description' => '回调方式选择HTTP时，回调鉴权开关，取值：'."\n" + .'- **on**（启用）'."\n" + .'- **off**（不启用）', + 'type' => 'string', + 'example' => 'on', + ], + 'MnsEndpoint' => [ + 'description' => '回调方式选择MNS时，消息队列公网Endpoint。', + 'type' => 'string', + 'example' => 'http://1234567.mns.cn-shanghai-internal.aliyuncs.com/', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"272A222A-F7F7-4A3E-****-F531574F1234\\",\\n \\"MessageCallback\\": {\\n \\"CallbackType\\": \\"HTTP\\",\\n \\"CallbackURL\\": \\"http://test.com/test\\",\\n \\"EventTypeList\\": \\"FileUploadComplete,StreamTranscodeComplete,TranscodeComplete,SnapshotComplete,AIComplete,AddLiveRecordVideoComplete,CreateAuditComplete,UploadByURLComplete,ProduceMediaComplete,LiveRecordVideoComposeStart,ImageUploadComplete,VideoAnalysisComplete\\",\\n \\"AppId\\": \\"app-1000000\\",\\n \\"MnsQueueName\\": \\"vodcallback\\",\\n \\"AuthKey\\": \\"12345678abc\\",\\n \\"AuthSwitch\\": \\"on\\",\\n \\"MnsEndpoint\\": \\"http://1234567.mns.cn-shanghai-internal.aliyuncs.com/\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMessageCallbackResponse>\\r\\n\\t<MessageCallback>\\r\\n\\t\\t<CallbackType>HTTP</CallbackType>\\r\\n\\t\\t<EventTypeList>FileUploadComplete,StreamTranscodeComplete,TranscodeComplete,SnapshotComplete,AIComplete,AddLiveRecordVideoComplete,CreateAuditComplete,UploadByURLComplete,ProduceMediaComplete,LiveRecordVideoComposeStart,ImageUploadComplete,VideoAnalysisComplete</EventTypeList>\\r\\n\\t\\t<AuthKey>12345678abc</AuthKey>\\r\\n\\t\\t<AppId>app-1000000</AppId>\\r\\n\\t\\t<MnsQueueName>vodcallback</MnsQueueName>\\r\\n\\t\\t<CallbackURL>http://test.com/test</CallbackURL>\\r\\n\\t\\t<MnsEndpoint>http://1234567.mns.cn-shanghai-internal.aliyuncs.com/</MnsEndpoint>\\r\\n\\t\\t<AuthSwitch>off</AuthSwitch>\\r\\n\\t</MessageCallback>\\r\\n\\t<RequestId>272A222A-F7F7-4A3E-****-F531574F1234</RequestId>\\r\\n</GetMessageCallbackResponse>","errorExample":""}]', + 'title' => '查询事件通知配置', + 'description' => '> 详细使用说明，请参见[事件通知开发指南](~~55627~~)。', + ], + 'ChangeResourceGroup' => [ + 'summary' => '调用本接口将资源进行转组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '161156', + 'abilityTreeNodes' => [ + 'FEATUREvod7FWSSO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'required' => false, + 'example' => 'AppInfo', + 'default' => 'Storage', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源Id', + 'description' => '资源Id', + 'type' => 'string', + 'required' => true, + 'example' => 'app-xxxxxxx', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域Id', + 'description' => '地域Id', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '目标资源组', + 'description' => '目标资源组', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-aekzko7fsuj****', + ], + ], + ], + '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' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.ChangeResourceGroup', + 'errorMessage' => 'You are not authorized to change resourcegroup', + ], + [ + 'errorCode' => 'MissingParameter.ResourceRegionId', + 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceId', + 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceGroupId', + 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'InvalidResourceGroup', + 'errorMessage' => 'The specified ResourceGroupId is invalid', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred while processing your request', + ], + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => ' The specified resource is not found', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\"\\n}","type":"json"}]', + 'title' => '资源转组', + 'description' => '调用该接口将资源转移至另一个资源组下。', + ], + 'DescribeVodDomainMax95BpsData' => [ + 'summary' => '调用本接口查询加速域名95带宽峰值监控数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235311', + 'abilityTreeNodes' => [ + 'FEATUREvodB8HTWV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的加速域名。若参数为空，默认返回所有加速域名合并后的数据。'."\n" + ."\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' => '2017-01-11T12:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取结束时间点。日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。'."\n" + ."\n\n" + .'> 结束时间需大于起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-01-12T13:00:00Z', + ], + ], + [ + 'name' => 'TimePoint', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-21T10:00:00Z', + ], + ], + [ + 'name' => 'Cycle', + 'in' => 'query', + 'schema' => [ + 'description' => '95 带宽峰值周期，默认值为 day。取值：'."\n" + ."\n" + .'- day：按日查询95 峰值。'."\n" + ."\n" + .'- month：按月查询95 峰值。', + 'type' => 'string', + 'required' => false, + 'example' => 'month', + 'enum' => [ + 'day', + 'month', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A*****F6-D7393642CA58', + ], + 'DomainName' => [ + 'description' => '加速域名信息', + 'type' => 'string', + 'example' => 'example.com', + ], + 'EndTime' => [ + 'description' => '数据的结束时间点。', + 'type' => 'string', + 'example' => '2017-01-11T13:00:00Z', + ], + 'StartTime' => [ + 'description' => '数据的起始时间点。', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'DomesticMax95Bps' => [ + 'description' => '中国内地95带宽峰值。', + 'type' => 'string', + 'example' => '16777590.28'."\n", + ], + 'OverseasMax95Bps' => [ + 'description' => '全球（不含中国内地）95带宽峰值。', + 'type' => 'string', + 'example' => '0', + ], + 'Max95Bps' => [ + 'description' => '95带宽峰值。', + 'type' => 'string', + 'example' => '16777590.28'."\n", + ], + 'DetailData' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Max95Detail' => [ + 'description' => '95带宽明细数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => [ + 'description' => '时间片起始时刻。', + 'type' => 'string', + 'example' => '2024-01-18 10:11:32', + ], + 'Area' => [ + 'description' => '95带宽对应的区域。', + 'type' => 'string', + 'example' => 'CN', + ], + 'Max95BpsPeakTime' => [ + 'description' => '95 带宽峰值时间。', + 'type' => 'string', + 'example' => '2015-12-11T21:05:00Z'."\n", + ], + 'Max95Bps' => [ + 'description' => '95带宽峰值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '16777590.28'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'The specified value of parameter StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'The specified value of parameter EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidStartTime.ValueNotSupported', + 'errorMessage' => 'The specified value of parameter StartTime is not supported.', + ], + [ + 'errorCode' => 'InvalidEndTime.Mismatch', + 'errorMessage' => 'Specified EndTime does not match the specified StartTime.', + ], + [ + 'errorCode' => 'InvalidTimePoint.Malformed', + 'errorMessage' => 'Specified TimePoint is malformed.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidTime.Malformed', + 'errorMessage' => 'Specified StartTime or EndTime is malformed.', + ], + ], + 404 => [ + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A*****F6-D7393642CA58\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"EndTime\\": \\"2017-01-11T13:00:00Z\\",\\n \\"StartTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"DomesticMax95Bps\\": \\"16777590.28\\\\n\\",\\n \\"OverseasMax95Bps\\": \\"0\\",\\n \\"Max95Bps\\": \\"16777590.28\\\\n\\",\\n \\"DetailData\\": {\\n \\"Max95Detail\\": [\\n {\\n \\"TimeStamp\\": \\"2024-01-18 10:11:32\\",\\n \\"Area\\": \\"CN\\",\\n \\"Max95BpsPeakTime\\": \\"2015-12-11T21:05:00Z\\\\n\\",\\n \\"Max95Bps\\": 16777590.28\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询95带宽峰值', + 'description' => '**分三种方式查询：**'."\n" + ."\n" + .'- 当同时指定StartTime 和 EndTime 时，若 EndTime 与 StartTime 差值在 24 小时内，则查询 StartTime 所在当天的 95 峰值，否则查询 StartTime 所在月份的 95 峰值。'."\n" + ."\n" + .'- 当同时指定TimePoint 和 Cycle 时，返回 TimePoint 所在周期的 95 峰值。'."\n" + ."\n" + .'- 当指定StartTime 和 EndTime 时，若额外指定了 Cycle，可以返回查询范围内所有指定 cycle 对应的 95 峰值。'."\n" + ."\n" + .'当这三种方式都不指定时，默认返回过去 24 小时的 95 峰值。'."\n" + ."\n\n" + .'- 数据最大查询跨度：90天'."\n" + ."\n" + .'- 数据最小查询粒度：1天'."\n" + ."\n" + .'- 数据最大查询范围：90天'."\n" + ."\n" + .'- 单用户调用频率：100次/秒。'."\n" + ."\n" + .'- 获取数据单位：bit/s。', + ], + 'DescribeVodSSLCertificateList' => [ + 'summary' => '调用本接口按照域名查询证书列表信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '236814', + 'abilityTreeNodes' => [ + 'FEATUREvod0O92P0', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值：1 。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。 取值：1~1000之间的任意整数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + 'default' => '1000', + ], + ], + [ + 'name' => 'SearchKeyword', + 'in' => 'query', + 'schema' => [ + 'description' => '证书名称模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'certabc'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4AF6-D7393642CA58****', + ], + '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' => '1512388610', + ], + 'Fingerprint' => [ + 'description' => '证书指纹。', + 'type' => 'string', + 'example' => '****', + ], + 'CertName' => [ + 'description' => '证书名称。', + 'type' => 'string', + 'example' => 'video-ssl', + ], + 'Issuer' => [ + 'description' => '证书发行商。', + 'type' => 'string', + 'example' => '****', + ], + 'CertId' => [ + 'description' => '证书ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '235437', + ], + 'Common' => [ + 'description' => '证书中的CN属性，一般是一个域名。', + 'type' => 'string', + 'example' => 'test', + ], + 'CertRegion' => [ + 'description' => '证书所在地域。支持**cn-hangzhou**和**ap-southeast-1**，默认**cn-hangzhou** .', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '当前页数，起始值为1，默认为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页大小，取值：1~1000之间的任意整数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotFoundCertList', + 'errorMessage' => 'The certList is null.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"CertificateListModel\\": {\\n \\"Count\\": 2,\\n \\"CertList\\": {\\n \\"Cert\\": [\\n {\\n \\"LastTime\\": 1512388610,\\n \\"Fingerprint\\": \\"****\\",\\n \\"CertName\\": \\"video-ssl\\",\\n \\"Issuer\\": \\"****\\",\\n \\"CertId\\": 235437,\\n \\"Common\\": \\"test\\",\\n \\"CertRegion\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n }\\n}","type":"json"}]', + 'title' => '查询证书列表-按域名', + 'description' => '本接口目前仅支持 **华东2（上海）** 地域。', + ], + 'SetVodDomainSSLCertificate' => [ + 'summary' => '调用本接口用于设置某域名下证书功能是否启用及更新证书信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236821', + 'abilityTreeNodes' => [ + 'FEATUREvod0O92P0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '点播加速域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'CertName', + 'in' => 'query', + 'schema' => [ + 'description' => '证书名称。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cert_name', + ], + ], + [ + 'name' => 'CertId', + 'in' => 'query', + 'schema' => [ + 'description' => '证书id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12342707', + ], + ], + [ + 'name' => 'CertType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '证书类型。'."\n" + ."\n" + .'- **upload**：上传证书。'."\n" + .'- **cas**：证书中心证书。', + 'type' => 'string', + 'required' => false, + 'example' => 'cas', + 'enum' => [ + 'cas', + 'upload', + ], + ], + ], + [ + 'name' => 'SSLProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTPS证书是否启用。取值：'."\n" + ."\n" + .'- **on**：启用。'."\n" + .'- **off**：不启用。', + 'type' => 'string', + 'required' => true, + 'example' => 'off', + ], + ], + [ + 'name' => 'SSLPub', + 'in' => 'query', + 'schema' => [ + 'description' => '安全证书内容。不启用证书则无需输入，配置证书请输入证书内容。', + 'type' => 'string', + 'required' => false, + 'example' => '****', + ], + ], + [ + 'name' => 'SSLPri', + 'in' => 'query', + 'schema' => [ + 'description' => '私钥内容。不启用证书则无需输入，配置证书请输入私钥内容。', + 'type' => 'string', + 'required' => false, + 'example' => '****', + ], + ], + [ + 'name' => 'CertRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '证书Region。取值：'."\n" + .'- **ap-southeast-1**（新加坡）'."\n" + .'- **cn-hangzhou**（杭州）'."\n" + ."\n" + .'默认值为**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Env', + 'in' => 'query', + 'schema' => [ + 'description' => '是否灰度下发证书。'."\n" + .'取值：**staging**：灰度下发证书。'."\n" + .'不传或者传任何其他值，都是正式下发证书。', + 'type' => 'string', + 'required' => false, + 'example' => 'staging', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F4C6D5BE-BF13-45*****6C-516EA8906DCD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidSSLProtocol.ValueNotSupported', + 'errorMessage' => 'The specified SSLProtocol is invalid.', + ], + [ + 'errorCode' => 'SSLPub.MissingParameter', + 'errorMessage' => 'The SSLPub parameter is required.', + ], + [ + 'errorCode' => 'SSLPri.MissingParameter', + 'errorMessage' => 'The SSLPri parameter is required.', + ], + [ + 'errorCode' => 'InvalidSSLPub', + 'errorMessage' => 'The specified SSLPub is invalid.', + ], + [ + 'errorCode' => 'InvalidSSLPri', + 'errorMessage' => 'The specified SSLPri is invalid.', + ], + [ + 'errorCode' => 'Certificate.MissMatch', + 'errorMessage' => 'The SSLPri does not match the certificate.', + ], + [ + 'errorCode' => 'InvalidCertificate.TooLong', + 'errorMessage' => 'The maximum length of the certificate is exceeded.', + ], + [ + 'errorCode' => 'InvalidCertName.TooLong', + 'errorMessage' => 'The length of the certificate name cannot exceed 128 characters.', + ], + [ + 'errorCode' => 'AuthenticationFailed', + 'errorMessage' => 'Error performing verification.', + ], + [ + 'errorCode' => 'SetDomainCertificate.ParameterError', + 'errorMessage' => 'The specified parameters are invalid.', + ], + [ + 'errorCode' => 'Certificate.StatusError', + 'errorMessage' => 'The status of the certificate is invalid.', + ], + [ + 'errorCode' => 'DeleteFailed', + 'errorMessage' => 'Error deleting the certificate.', + ], + [ + 'errorCode' => 'Certificate.NotFind', + 'errorMessage' => 'The certificate does not exist.', + ], + [ + 'errorCode' => 'Certificate.Duplicated', + 'errorMessage' => 'The certificate name already exists.', + ], + [ + 'errorCode' => 'Certificate.FormatError', + 'errorMessage' => 'The format of the certificate is invalid.', + ], + [ + 'errorCode' => 'Certificate.KeyNull', + 'errorMessage' => 'The private key is required.', + ], + [ + 'errorCode' => 'Key.Malformed', + 'errorMessage' => 'The specified Key format is invalid.', + ], + [ + 'errorCode' => 'CertStorage.failed', + 'errorMessage' => 'Error saving the certificate.', + ], + [ + 'errorCode' => 'CertificateContent.Duplicated', + 'errorMessage' => 'The certificate has been uploaded; do not upload again.', + ], + [ + 'errorCode' => 'Certificate.Expired', + 'errorMessage' => 'The certificate has expired.', + ], + [ + 'errorCode' => 'InvalidDomain.notOnline', + 'errorMessage' => 'The domain is offline. Check the status of the domain and try again later.', + ], + [ + 'errorCode' => 'Decode.Error', + 'errorMessage' => 'Error decoding the SSLPub or SSLPri certificate.', + ], + [ + 'errorCode' => 'sslPub.Error', + 'errorMessage' => 'Error encoding SSLPub.', + ], + [ + 'errorCode' => 'sslPri.Error', + 'errorMessage' => 'Error encoding SSLPri.', + ], + [ + 'errorCode' => 'DomainInSafeMode', + 'errorMessage' => 'The domain is in safe mode. To request permission, contact Customer Service.', + ], + [ + 'errorCode' => 'CreateCertificateFailed', + 'errorMessage' => 'Create certificate failed,please try again.', + ], + [ + 'errorCode' => 'Abs.CertRegion.ValueNotSupported', + 'errorMessage' => 'CertRegion is not supported.', + ], + [ + 'errorCode' => 'CertNameAlreadyExists', + 'errorMessage' => 'The CertName already exists.', + ], + [ + 'errorCode' => 'InvalidDomain.Offline', + 'errorMessage' => 'The domain provided is offline.', + ], + [ + 'errorCode' => 'DomainOwnerVerifyFail', + 'errorMessage' => 'Owner verification of the root domain failed.', + ], + ], + 403 => [ + [ + 'errorCode' => 'DomainInProtectedMode', + 'errorMessage' => 'The domain is in protection mode. To request permission, contact Customer Service.', + ], + ], + [ + [ + 'errorCode' => 'CertName.MissingParameter', + 'errorMessage' => 'You must specify CertName.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F4C6D5BE-BF13-45*****6C-516EA8906DCD\\"\\n}","type":"json"}]', + 'title' => '设置点播域名证书', + 'description' => '- 本接口目前仅支持 **华东2（上海）** 地域。'."\n" + ."\n" + .'- 单用户调用频率：30次/秒。'."\n" + ."\n" + .'- 调用方式：POST。', + ], + 'DescribeVodEditingUsageData' => [ + 'summary' => '调用DescribeVodEditingUsageData查询点播云剪辑用量。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '208113', + 'abilityTreeNodes' => [ + 'FEATUREvodXLM48P', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据起始时间点。日期格式按照ISO8601表示法，使用UTC时间。格式为：YYYY-MM-DDThh:mmZ。'."\n" + ."\n" + .'若为空，则默认读取最近24小时的数据。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-11-06T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取数据结束时间点。日期格式按照ISO8601表示法，使用UTC时间。格式为：YYYY-MM-DDThh:mmZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-11-07T16:00:00Z', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '地域。默认返回所有地域。支持批量查询，多个区域用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Specification', + 'in' => 'query', + 'schema' => [ + 'description' => '输出规格。', + 'type' => 'string', + 'required' => false, + 'example' => 'H264.SD', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。使用说明，请参见[多应用](~~113600~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6CB55B62-6E5F-54D1-80BF-DFA3DE9F0***', + ], + 'StartTime' => [ + 'description' => '获取数据起始时间点。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2024-11-06T16:00:00Z', + ], + 'EndTime' => [ + 'description' => '获取数据结束时间点。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2024-11-07T16:00:00Z', + ], + 'EditingData' => [ + 'description' => '用量数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Specification' => [ + 'description' => '输出规格。', + 'type' => 'string', + 'example' => 'H264.SD', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'TimeStamp' => [ + 'description' => '时间片起始时刻。使用UTC时间，格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2024-11-06T16:00:00Z', + ], + 'Duration' => [ + 'description' => '音/视频时长。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidStartTime.Malformed', + 'errorMessage' => 'Specified StartTime is malformed.', + ], + [ + 'errorCode' => 'InvalidEndTime.Malformed', + 'errorMessage' => 'Specified EndTime is malformed.', + ], + [ + 'errorCode' => 'InvalidParameterType', + 'errorMessage' => 'The specified Type is invalid.', + ], + [ + 'errorCode' => 'InvalidTimeSpan', + 'errorMessage' => 'The time span exceeds the limit.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid input parameter.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CB55B62-6E5F-54D1-80BF-DFA3DE9F0***\\",\\n \\"StartTime\\": \\"2024-11-06T16:00:00Z\\",\\n \\"EndTime\\": \\"2024-11-07T16:00:00Z\\",\\n \\"EditingData\\": [\\n {\\n \\"Specification\\": \\"H264.SD\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"TimeStamp\\": \\"2024-11-06T16:00:00Z\\",\\n \\"Duration\\": 123\\n }\\n ]\\n}","type":"json"}]', + 'title' => '点播云剪辑用量查询', + 'description' => '- 单用户调用频率：10次/秒'."\n" + ."\n" + .'**支持查询的时间粒度**：'."\n" + ."\n" + .'根据单次查询的最大时间跨度不同，对应的自适应时间粒度和可查询历史数据时间范围如下：'."\n" + .'| 时间粒度 | 单次查询的最大时间跨度 | 可查询历史数据时间范围 |'."\n" + .'| -------------- | -------------- | ------ |'."\n" + .'| 1小时 | 7天 | 31天 | '."\n" + .'| 1天 | 31天 | 366天 |', + ], + 'DescribeVodUserVipsByDomain' => [ + 'summary' => '调用DescribeVodUserVipsByDomain查询域名的IP列表。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREvodHI57GB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '点播加速域名，仅支持查询单个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Available', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询健康VIP。取值：'."\n" + ."\n" + .'- **on**：健康VIP。'."\n" + .'- **off**：全部VIP。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + 'off', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'description' => '点播加速域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6730AC93-7B12-4B*****7F-49EE1FE8BC49', + ], + 'Vips' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Vip' => [ + 'description' => 'VIP地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VIP地址。', + 'type' => 'string', + 'example' => '163.181.xxx.xxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => 'The specified value of parameter "DomainName" can not be empty.', + ], + [ + 'errorCode' => 'InvalidDomain.NotFound', + 'errorMessage' => 'The domain provided is offline or not exist.', + ], + [ + 'errorCode' => 'IllegalOperation', + 'errorMessage' => 'Illegal domain operate is not permitted.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DomainName\\": \\"example.com\\",\\n \\"RequestId\\": \\"6730AC93-7B12-4B*****7F-49EE1FE8BC49\\",\\n \\"Vips\\": {\\n \\"Vip\\": [\\n \\"163.181.xxx.xxx\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询节点IP列表-L1', + 'description' => '本接口仅支持华东2（上海）地域。', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'vod.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'vod.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'vod.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'vod.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'vod.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'vod.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'vod.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'vod.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'vod.us-west-1.aliyuncs.com', + ], + ], +]; |