华为云用户手册

  • 什么是业务用户 AstroZero中存在两类用户:用户(User)和业务用户(PortalUser)。 用户(User)是指在AstroZero中添加的IAM用户或WeLink用户,是应用的开发者。 业务用户(PortalUser)是访问在AstroZero中开发的一个业务应用的用户账号。当一个项目使用了AstroZero提供的业务服务功能,而业务用户是用这个项目注册的账号来开通试用业务系统的,并不是直接注册AstroZero的账号,这种用户即是AstroZero的业务用户。 例如,在AstroZero中注册了账号“A”,并使用账号“A”在AstroZero中开发了一个应用“X”。账号“B”是通过应用“X”注册的账号,并登录使用应用“X”。这种情况下,账号“A”是管理员用户(User),账号“B”是业务用户(PortalUser)。关于用户和业务用户的更多介绍,请参见图解AstroZero中用户那些事。 图1 AstroZero中用户行为
  • 样式文件 样式文件中,图片及字体文件的引用,需使用相对路径。 字体文件需要放置在与样式文件同级的目录中,目录名称为font、fonts(两个任选其一即可),可设置子层目录,子层目录命名无要求。 目录及图片、文件的命名仅支持数字、字母(大小写均可)、下划线和中划线。 支持的图片格式,包含png、jpg、jpeg、gif、bmp和webp。 支持的字体文件格式,包含tiff、woff、ttf、otf、eot和svg。 多个Widget样式可以抽取为单独库文件,独立库文件可以方便进行整体样式主题的切换。缺点是Widget的运行,需要对这个库文件产生依赖。 如果Widget比较独立,也可以将样式文件定义到Widget作用域的css中。
  • 桥接器Bridge Widget数据访问需要封装到Bridge中,不允许在Widget中,直接通过ajax访问业务数据服务。 通过Bridge的封装,可以保持Widget的稳定性。未来数据源的切换不需要升级Widget,只需要切换Bridge即可。 对于数据消费类的Bridge,mock目录不允许为空。 Mock数据会在编辑状态加载,如果直接调用API,可能会因为API的不稳定而引起UI渲染异常。 一个查询API一个Bridge,更新API当前可以共用同一个Bridge。 前端对象需要在Bridge中,进行明确定义,字段清晰。
  • 函数/方法注释 函数/方法注释采用典型的JSDoc的注释方式。 函数注释入参说明:@param + 1个空格+ {参数类型} + 1个空格 + 参数名+ 1个空格 + 参数说明。 函数注释出参说明:@return + 1个空格 + {参数类型} + 1个空格 + 出参说明(如果没有出参,则出参说明可不写)。 有关键逻辑或者重大变更时,增加改动者及改动描述。 /** * 在地图上创建标志 * * @param {String} latLng 经纬度信息 * @param {Object} mapInfo 地图描点信息 * @return {Boolean} 在地图上创建点选标志的结果 * @version 20180310 modify by xxx shangsan 修改地图上描点的样式 * @version 20180314 modify by xxx wangwu 在地图上描点增加事件发送,供外部订阅 */ var placeMarkerAndPanTo=function(latLng, mapInfo) { //返回创建点选标志的结果 return true; }
  • 开放性 Widget自身是开放的,直接引用业界优秀的开源组件可以提高开发效率。 例如,使用MVVM框架Vue(Vue相比AngularJS更轻量,性能更优)以及使用基于Vue的前端控件库Quasar,Element-UI。 不允许引入JQuery,因为框架已默认提供,引入后会引起运行冲突异常。 非特殊场景,组件的尺寸大小不建议写成固定值,可以指定最大/最小值。 非特殊场景,不允许直接对DOM元素添加CSS。DOM元素的样式通过显式的class引用,保证样式只作用在当前组件。
  • 扩展知识 标准页面预置了二维码组件,用于生成二维码。使用该组件可将游客访问的打卡页面地址做成二维码,后续可将此二维码直接分享给其他游客(匿名用户)扫码体检。 制作二维码方法如下: 使用开发者账号登录AstroZero开发环境,进入一个应用,例如1创建的“mypage”应用。 鼠标放在“Page”下,单击界面上出现的“+”,在弹出菜单中选择“标准页面”。 设置页面标签和名称,例如“testcode”,单击“添加”。 参考图26,向标准页面中拖入一个二维码组件,在右侧属性面板中设置“内容或链接”为7.b改造后的地址。 https://appcuberun.cn-north-4.huaweicloud.com/magno/render/hwtest__mypage_0000000000XXXXXXX/view-mobile/mypage 图26 配置二维码组件 表1 二维码组件属性说明 属性 说明 内容或链接 设置扫描二维码后,要展示的文本内容或者跳转的链接地址。 宽度 二维码的宽度,单位像素。 默认值:150 容错级别 二维码被遮挡或残破时依然能被识别的几率,容错级别越高抗残破或遮挡的能力就越强。 空白间距 四周空白间距,单位像素。 前景色 二维码的颜色。 背景色 背景颜色。 中间Logo 二维码中间Logo图片,可不用设置。 设置Logo后,如果扫描二维码识别失败,可以调高容错级别或调大二维码 Logo大小 Logo大小,单位像素。 单击页面上方保存页面,单击预览页面。 图27 生成二维码 将上一步生成的二维码分享给游客,游客通过微信或者支付宝扫描二维码,可扫码体验,进行健康打卡。
  • 条件(Condition) 条件(Condition)是SCP生效的特定条件,包括条件键和运算符。 条件键表示SCP语句的Condition元素中的键值。根据适用范围,分为全局级条件键和服务级条件键。 全局级条件键(前缀为g:)适用于所有操作,在鉴权过程中,云服务不需要提供用户身份信息,系统将自动获取并鉴权。详情请参见:全局条件键。 服务级条件键(前缀为服务缩写,如vpcep:)仅适用于对应服务的操作,详情请参见表4。 单值/多值表示API调用时请求中与条件关联的值数。单值条件键在API调用时的请求中最多包含一个值,多值条件键在API调用时请求可以包含多个值。例如:g:SourceVpce是单值条件键,表示仅允许通过某个VPC终端节点发起请求访问某资源,一个请求最多包含一个VPC终端节点ID值。g:TagKeys是多值条件键,表示请求中携带的所有标签的key组成的列表,当用户在调用API请求时传入标签可以传入多个值。 运算符与条件键、条件值一起构成完整的条件判断语句,当请求信息满足该条件时,SCP才能生效。支持的运算符请参见:运算符。 VPCEP定义了以下可以在SCP的Condition元素中使用的条件键,您可以使用这些条件键进一步细化SCP语句应用的条件。 表4 VPCEP支持的服务级条件键 服务级条件键 类型 单值/多值 说明 vpcep:VpceServiceName string 单值 按照终端节点服务名称进行筛选。 vpcep:VpceServiceOwner string 单值 按照终端节点服务所有者进行筛选。 vpcep:VpceServicePrivateDnsName string 单值 按您传入的终端节点服DNS名称筛选访问权限。 vpcep:VpceServiceOrgPath string 单值 按照终端节点服务所有者的组织路径进行筛选。 vpcep:VpceEndpointOrgPath string 单值 按照终端节点所有者的组织路径进行筛选。 vpcep:VpceEndpointOwner string 单值 按照终端节点所有者的账号进行筛选。 vpcep:VpcId string 多值 根据指定的虚拟私有云资源ID过滤访问。
  • 前提条件 给用户组授权之前,请您了解用户组可以添加的RAM权限,并结合实际需求进行选择,RAM支持的系统权限如表1所示。若您需要对除RAM之外的其他服务授权,IAM支持服务的所有权限请参见系统权限。 表1 RAM系统权限 权限名称 描述 RAM FullAccess 资源访问管理服务所有权限。 RAM ReadOnlyAccess 资源访问管理服务只读权限。 RAM ResourceShareParticipantAccess 资源访问管理服务资源共享邀请的处理权限。
  • 概述 资源访问管理(Resource Access Manager,简称RAM)服务为用户提供安全的跨账号共享资源的能力。如果您有多个账号,您可以创建一次资源,并使用RAM服务将该资源共享给其他账号使用。如果您的账号由组织管理,则您可以与组织、OU或成员账号共享资源。您还可以按账号ID与特定的账号共享,无论账号是否属于组织。 本章节将为您介绍如下内容: 创建共享 更新共享 查看共享 删除共享 查看您共享的资源 查看资源使用者 父主题: 共享您的资源
  • 支持共享的资源 表1 支持共享的云服务和资源类型 云服务 资源类型 是否支持主动退出共享 应用场景 VPC Subnet:子网 是 共享VPC功能支持多个账号在一个集中管理、共享的VPC内创建云资源,比如ECS、ELB、RDS等。VPC的所有者可以将VPC内的子网共享给一个或者多个账号使用。通过共享VPC功能,可以简化网络配置,帮助您统一配置和运维多个账号下的资源,有助于提升资源的管控效率,降低运维成本。 更多信息请参见共享VPC。 DNS Private Zones:内网域名 是 基于资源访问管理(Resource Access Manager,简称RAM)服务,云解析服务可以实现跨账号共享内网域名,资源所有者将内网域名同时共享给多个其他账号使用,资源使用者接受共享邀请后就可以访问和使用共享的内网域名。 更多信息请参见共享内网域名。 Resolver Rules:解析器规则 是 基于资源访问管理(Resource Access Manager,简称RAM)服务,云解析服务可以实现跨账号共享转发规则,资源所有者将转发规则同时共享给多个其他账号使用,资源使用者接受共享邀请后就可以访问和使用共享的转发规则。 更多信息请参见共享转发规则。 SCM Cert:证书 是 云证书管理服务提供共享功能,用户可以将SSL证书同时共享给同一组织单元内的所有成员账号,这些账号可以将共享证书部署到ELB、WAF和CDN等服务,以启用HTTPS协议。 更多信息请参见共享证书。 PCA CA:私有CA 是 云证书管理服务私有证书管理提供共享功能,用户可以将私有CA同时共享给同一组织单元内的所有成员账号,这些账号可以使用共享CA来签发证书。 更多信息请参见共享私有CA。 ER Instances:实例 是 暂无 FunctionGraph Function:函数 是 基于资源访问管理(Resource Access Manager,简称RAM)服务,函数工作流服务可以实现跨账号共享函数,资源所有者将函数同时共享给多个其他账号使用,资源使用者接受共享邀请后就可以访问和使用共享的函数。 更多信息请参见共享函数。 父主题: 附录
  • 使用限制 单账号跟踪的事件可以通过云审计控制台查询。多账号的事件只能在账号自己的事件列表页面去查看,或者到组织追踪器配置的OBS桶中查看,也可以到组织追踪器配置的CTS/system日志流下面去查看。 用户通过云审计控制台只能查询最近7天的操作记录。如果需要查询超过7天的操作记录,您必须配置转储到对象存储服务(OBS),才可在OBS桶里面查看历史文件。否则,您将无法追溯7天以前的操作记录。 云上操作后,1分钟内可以通过云审计控制台查询管理类事件操作记录,5分钟后才可通过云审计控制台查询数据类事件操作记录。
  • 响应示例 状态码: 200 处理成功返回。 { "asset_id" : "41cff636d5b12a51e7eb2838bbf45201", "base_info" : { "title" : "Avatar", "video_name" : "视频点播 VOD 视频.mp4", "description" : "Avatar, marketed as James Cameron's Avatar, is a 2009 American\nepic science fiction film directed, written, produced, and\nco-edited by James Cameron", "category_id" : -1, "category_name" : "其他", "create_time" : "20190612032250", "last_modified" : "20190613075030", "video_type" : "MP4", "tags" : "test1,test2", "meta_data" : { "pack_type" : null, "codec" : "H.264", "duration" : 131, "video_size" : 4942645, "width" : 1280, "hight" : 720, "height" : 720, "bit_rate" : 173, "frame_rate" : 30 }, "video_url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/5597e59de70722eaeb9b18c274e249b2.mp4", "sign_url" : "", "cover_info_array" : [ { "cover_url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/cover/Cover0.jpg" } ] }, "transcode_info" : { "template_group_name" : "system_template_group", "output" : [ { "play_type" : "HLS", "url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/play_video/index.m3u8", "encrypted" : 0, "meta_data" : { "pack_type" : null, "codec" : "H.264", "duration" : 0, "video_size" : 0, "width" : 0, "hight" : 0, "height" : 0, "bit_rate" : 0, "frame_rate" : 0 } }, { "play_type" : "HLS", "url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/play_video/视频点播VOD 视频_1_854X480_600_0.m3u8", "encrypted" : 0, "quality" : "SD", "meta_data" : { "pack_type" : null, "codec" : "H.264", "duration" : 130, "video_size" : 7976960, "width" : 854, "hight" : 480, "height" : 480, "bit_rate" : 421, "frame_rate" : 30000, "quality" : "SD" } }, { "play_type" : "DASH", "url" : "https://355.cdn-vod.huaweicloud.com/asset/41cff636d5b12a51e7eb2838bbf45201/play_video/index.mpd", "encrypted" : 0, "meta_data" : { "pack_type" : null, "codec" : "H.264", "duration" : 0, "video_size" : 0, "width" : 0, "hight" : 0, "height" : 0, "bit_rate" : 0, "frame_rate" : 0 } }, { "play_type" : "DASH", "encrypted" : 0, "quality" : "SD", "meta_data" : { "pack_type" : null, "codec" : "H.264", "duration" : 130, "video_size" : 7976960, "width" : 854, "hight" : 480, "height" : 480, "bit_rate" : 421, "frame_rate" : 30000, "quality" : "SD" } } ], "exec_desc" : "Transcode success", "transcode_status" : "TRANSCODE_SUCCEED" } } 状态码: 403 处理失败返回。 { "error_code" : "VOD.10064", "error_msg" : "Media asset classification does not exist, please check." }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 asset_id String VOD分配的媒资ID,仅支持查询,不支持修改。 asset_status String 媒资状态。 "CREATING":上传中 "FAILED":上传失败 "CREATED":上传成功 "PUBLISHED":已发布 "DELETED":已删除 transcode_status String 转码状态。 "UN_TRANSCODE":未转码 "WAITING_TRANSCODE":等待转码,排队中 "TRANSCODING":转码中 "TRANSCODE_SUCCEED":转码成功 "TRANSCODE_FAILED":转码失败 base_info BaseInfo object 媒资基本信息。 transcode_info TranscodeInfo object 转码生成文件信息。 说明: 仅当转码成功后才能查询到此信息,未转码、正在转码以及转码失败时,无此字段信息。 表5 BaseInfo 参数 参数类型 描述 title String 媒资标题。 长度不超过128个字节,UTF8编码。 video_name String 媒资文件名。 description String 媒资描述。 长度不超过1024个字节。 category_id Long 媒资分类id。 category_name String 媒资分类名称。 create_time String 媒资创建时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 last_modified String 媒资最近修改时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 video_type String 音视频文件类型。 取值如下: 视频文件:MP4、TS、MOV、MXF、MPG、FLV、WMV、AVI、M4V、F4V、MPEG、3GP、ASF、MKV。 音频文件:MP3、OGG、WAV、WMA、APE、FLAC、AAC、AC3、MMF、AMR、M4A、M4R、WV、MP2。 tags String 媒资标签。 单个标签不超过16个字节,最多不超过16个标签。 多个用逗号分隔,UTF8编码。 meta_data MetaData object 视频的元数据信息。 经过视频解析后产生,包括封装格式、大小、分辨率、码率、帧率。 video_url String 原始视频文件的访问地址。 sign_url String 原视频文件的OBS临时访问地址。仅调用查询指定媒资的详细信息接口时才返回具体值。 cover_info_array Array of CoverInfo objects 封面信息。 subtitle_info Array of SubtitleInfo objects 字幕信息数组 source_path File_addr object 媒资存储参数信息。查询接口,仅媒资为托管时有返回值。 output_path File_addr object 媒资存储参数信息。查询接口,仅媒资为托管时有返回值。 表6 CoverInfo 参数 参数类型 描述 cover_url String 封面文件的下载地址。 表7 SubtitleInfo 参数 参数类型 描述 url String 字幕文件的下载地址 id Integer 字幕文件id type String 字幕文件类型 language String 字幕文件语言种类 表8 File_addr 参数 参数类型 描述 bucket String OBS的bucket名称。 location String 桶所在的区域名, 如“华北-北京四”的区域名为“cn-north-4”,创建的桶所在区域必须和点播服务所在区域保持一致。 object String 文件的存储路径。 表9 TranscodeInfo 参数 参数类型 描述 template_group_name String 转码模板组名称。 output Array of Output objects 转码输出数组。 HLS或DASH格式:此数组的成员个数为n+1,n为转码输出路数。 MP4格式:此数组的成员个数为n,n为转码输出路数。 exec_desc String 执行情况描述。 transcode_status String 转码状态。 取值如下: UN_TRANSCODE:未转码 WAITING_TRANSCODE:待转码 TRANSCODING:转码中 TRANSCODE_SUCCEED:转码成功 TRANSCODE_FAILED:转码失败 表10 Output 参数 参数类型 描述 play_type String 协议类型。 取值如下: hls dash mp4 url String 播放URL。 group_id String 所属转码组Id group_name String 所属转码组名称 encrypted Integer 标记流是否已被加密。 取值如下: 0:表示未加密。 1:表示已被加密。 quality String 清晰度。 取值如下: FLUENT:流畅 SD:标清 HD:高清 FULL_HD:超清 meta_data MetaData object 视频的元数据信息。 经过视频解析后产生,包括封装格式、大小、分辨率、码率、帧率。 表11 MetaData 参数 参数类型 描述 pack_type String 视频封装格式。 取值如下: MP4 TS MOV MXF MPG FLV WMV MP3 WMA APE FLAC AAC AC3 MMF AMR M4A M4R OGG WAV WV MP2 AVI F4V M4V MPEG HLS DASH codec String 视频编码格式。 取值如下: MPEG-2 MPEG-4 H.264 H.265 WMV Vorbis AAC AC-3 AMR APE FLAC MP3 MP2 WMA PCM ADPCM WavPack 说明: 如果codec返回unknown,说明不支持解析用户当前发送的音视频编码格式。 duration Long 视频时长。 若视频的原时长为非整数,则该字段值为原时长的向上取整。 video_size Long 视频文件大小。 单位:字节。 width Long 视频宽度(单位:像素)。 编码为H.264的取值范围:[32,3840]之间2的倍数。 编码为H.265的取值范围:[320,3840]之间4的倍数。 hight Long 视频高度(单位:像素)。 编码为H.264的取值范围:[32,2160]之间2的倍数 。 编码为H.265的取值范围:[240,2160]之间4的倍数。 bit_rate Long 视频平均码率。 frame_rate Long 帧率(单位:帧每秒)。 取值如下: FRAMERATE_AUTO = 1, FRAMERATE_10 = 2, FRAMERATE_15 = 3, FRAMERATE_2397 = 4, // 23.97 fps FRAMERATE_24 = 5, FRAMERATE_25 = 6, FRAMERATE_2997 = 7, // 29.97 fps FRAMERATE_30 = 8, FRAMERATE_50 = 9, FRAMERATE_60 = 10 默认值:1。 单位:帧每秒。 quality String 清晰度。 取值如下: FULL_HD:超高清 HD:高清 SD:标清 FLUENT:流畅 AD:自适应 2K 4K audio_channels Integer 音频的声道数。 状态码: 403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • URI GET /v1.0/{project_id}/asset/obs/host/task/details 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 source_bucket 是 String 媒资原始输入存放的桶。 source_object 是 String 媒资原始输入的objectKey。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token,使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。
  • 请求示例 创建媒资,使用URL拉取方式。基于音视频源文件URL,将音视频文件离线拉取上传到点播服务 POST https://{endpoint}/v1.0/{project_id}/asset/upload_by_url Content-Type: application/json { "upload_metadatas": [ { "url": "https://mpc-test.obs.cn-north-4.myhuaweicloud.com/Avatar_480P.mp4", "title": "Avatar test test", "video_type": "MP4", "description": "Avatar, test", "category_id": 1, "tags": "mytags", "auto_publish": 1 }, { "url": "https://mpc-test.obs.cn-north-4.myhuaweicloud.com/Avatar_720.mp4", "title": "Avatar test test", "video_type": "MP4", "description": "Avatar, test", "category_id": 1, "tags": "mytags", "auto_publish": 1 } ] }
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 upload_assets Array of UploadAsset objects 待拉取创建的媒资元数据 表8 UploadAsset 参数 参数类型 描述 url String 待拉取音视频文件的URL。 asset_id String 新创建媒资的媒资id error_code String 错误码。 error_msg String 错误描述。 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 响应示例 状态码: 200 处理成功返回。 { "upload_assets" : [ { "url" : "https://mpc-test.obs.cn-north-4.myhuaweicloud.com/Avatar_480P.mp4", "asset_id" : "f488337c31c8e4622f1590735b134c65", "error_code" : null, "error_msg" : null }, { "url" : "https://mpc-test.obs.cn-north-4.myhuaweicloud.com/Avatar_720.mp4", "asset_id" : "f488337c31c8e4622f1590525b134c65", "error_code" : null, "error_msg" : null } ] } 状态码: 400 处理失败返回。 { "error_code" : "VOD.10003", "error_msg" : "The specified key does not exist." }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token,使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 表3 请求Body参数 参数 是否必选 参数类型 描述 upload_metadatas 是 Array of UploadMetaDataByUrl objects 待拉取创建的媒资元数据 表4 UploadMetaDataByUrl 参数 是否必选 参数类型 描述 video_type 是 String 上传音视频文件的格式。 取值如下: 视频文件:MP4、TS、MOV、MXF、MPG、FLV、WMV、AVI、M4V、F4V、MPEG、3GP、ASF、MKV、M3U8 音频文件:MP3、OGG、WAV、WMA、APE、FLAC、AAC、AC3、MMF、AMR、M4A、M4R、WV、MP2 若上传格式为音频文件,则不支持转码、添加水印和字幕。 title 是 String 媒资标题,长度不超过128个字节,UTF-8编码。 url 是 String 待拉取音视频文件的URL。 说明: URL必须以扩展名结尾,暂只支持http和https协议,其中HTTP方式存在安全风险,建议使用HTTPS。不建议您将认证凭据等敏感信息写在URL。 description 否 String 视频描述,长度不超过1024个字节。 category_id 否 Integer 媒资分类ID。 您可以调用创建媒资分类接口或在点播控制台的分类设置中创建对应的媒资分类,并获取分类ID。 说明: 若不设置或者设置为-1,则上传的音视频归类到系统预置的“其它”分类中。 tags 否 String 视频标签。 单个标签不超过16个字节,最多不超过16个标签。 多个用逗号分隔,UTF8编码。 auto_publish 否 Integer 是否自动发布。 取值如下: 0:表示不自动发布。 1:表示自动发布。 默认值:1。 template_group_name 否 String 转码模板组名称。 若不为空,则使用指定的转码模板对上传的音视频进行转码,您可以在视频点播控制台配置转码模板,具体请参见《点播服务用户指南》中的“转码设置”。 说明: 若同时设置了“template_group_name”和“workflow_name”字段,则“template_group_name”字段生效。 auto_encrypt 否 Integer 是否自动加密。 取值如下: 0:表示不加密。 1:表示需要加密。 默认值:0。若设置为需要加密,则必须配置转码模板,且转码的输出格式是HLS。 auto_preheat 否 Integer 是否自动预热到CDN。 取值如下: 0:表示不自动预热。 1:表示自动预热。 默认值:0。 thumbnail 否 Thumbnail object 截图参数 review 否 Review object 媒资审核参数。 说明: 仅“华北-北京一”、“华北-北京四”点播服务支持此功能。 workflow_name 否 String 工作流名称。 若不为空,则使用指定的工作流对上传的音视频进行处理,您可以在视频点播控制台配置工作流,具体请参见《点播服务用户指南》中的“工作流设置”。 表5 Thumbnail 参数 是否必选 参数类型 描述 type 是 String 截图类型。 取值如下: time:每次进行截图的间隔时间。 dots: 按照指定的时间点截图。 quantity: 按照指定张数,根据视频时长等分视频截图。 quantity 否 Integer type取值为quantity时必填。 按照指定张数,根据视频时长等分视频截图。 取值范围:[1,10]之间的整数。 quantity_time 否 Integer type取值为quantity时选填。 按照指定时间间隔取指定张数截图。 取值范围:[0,2147483647]之间的整数。 time 否 Integer 根据时间间隔采样时的时间间隔值。单位:秒。 type取值为time时。 默认值:12 取值范围:[0,100]之间的整数。 dots 否 Array of integers type取值为dots时必填。指定时间截图时的时间点数组。 cover_position 否 Integer 该值表示指定第几张截图作为封面。 默认值:1。 format 否 Integer 截图文件格式。 取值如下: 1:jpg。 默认值:1 。 aspect_ratio 否 Integer 纵横比,图像缩放方式。 取值如下: 0:自适应(保持原有宽高比)。 1:16:9。 默认值:0。 max_length 否 Integer 截图最长边的尺寸。 单位:像素。 宽边尺寸按照该尺寸与原始视频像素等比缩放计算。 默认值:480。 表6 Review 参数 是否必选 参数类型 描述 template_id 是 String 审核模板ID。您可以在视频点播控制台配置审核模板后获取,具体请参见《点播服务用户指南》中的“审核设置”。 说明: 仅“华北-北京一”、“华北-北京四”点播服务支持此功能。 interval 否 Integer 截图检测时间间隔,取值范围为[0,100],该参数在请求参数中忽略。 politics 否 Integer 鉴政内容检测置信度,取值范围为[0,100],该参数在请求参数中忽略。 置信度越高,说明审核结果越可信。未开启或设置为0时,表示未进行此项检测。 terrorism 否 Integer 鉴恐内容的检测置信度,取值范围为[0,100],该参数在请求参数中忽略。 置信度越高,说明审核结果越可信。未开启或设置为0时,表示未进行此项检测。 porn 否 Integer 鉴黄内容的检测置信度,取值范围为[0,100],该参数在请求参数中忽略。 置信度越高,说明审核结果越可信。未开启或设置为0时,表示未进行此项检测。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 tasks Array of TakeOverTask objects 托管任务信息。 total Integer 任务数量。 表5 TakeOverTask 参数 参数类型 描述 bucket String 桶名。 object String 目录/文件名。 host_type Integer 托管类型。 取值如下: 0:表示存储到点播桶 1:表示存储在租户桶 2:表示存储到租户OBS桶中,且输出目录与源文件的存储目录相同。 output_bucket String 输出桶 。 output_path String 输出路径 。 task_id String 任务ID。 suffix Array of strings 托管文件类型。 template_group_name String 转码模板组 。 create_time String 创建时间。 end_time String 结束时间。 status String 任务状态。 exec_desc String 媒资的任务执行描述汇总。 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 响应示例 状态码: 200 处理成功返回。 { "tasks" : [ { "bucket" : "obs-test", "object" : "play_violin.mp4", "host_type" : 0, "output_bucket" : "", "output_path" : null, "task_id" : "973", "suffix" : [ ], "template_group_name" : null, "create_time" : "20210629074248", "end_time" : "20210629074250", "status" : "SUCCEED", "exec_desc" : null } ], "total" : 1 } 状态码: 403 处理失败返回。 { "error_code" : "VOD.10053", "error_msg" : "The request parameter is illegal, illegal field: {xx}." }
  • URI GET /v1.0/{project_id}/asset/obs/host/stock/task 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String 任务状态。 task_id 否 String 任务ID。 page 否 Integer 分页编号,默认为0。 size 否 Integer 每页记录数。 默认10,范围[1,100],指定task_id时该参数无效。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token,使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token,使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 表3 请求Body参数 参数 是否必选 参数类型 描述 bucket 是 String 源桶名。 object 是 String 源目录名或源文件名。 suffix 否 Array of strings 批量托管时的文件后缀名列表。不传或传空值时,表示托管所有音视频文件,不进行后缀名过滤。 template_group_name 否 String 转码模板组名称。 若不为空,则使用指定的转码模板对上传的音视频进行转码,您可以在视频点播控制台配置转码模板,具体请参见转码设置。 说明: 若同时设置了“template_group_name”和“workflow_name”字段,则“template_group_name”字段生效。 workflow_name 否 String 工作流名称。 若不为空,则使用指定的工作流对上传的音视频进行处理,您可以在视频点播控制台配置工作流,具体请参见《点播服务用户指南》中的“工作流设置”。 host_type 否 Integer 表示音视频处理后生成的媒资文件所存储的位置类型。 取值如下所示: 0:表示存储到点播桶。 1:表示存储在租户桶。 2:表示存储到租户桶,并且存储路径与源文件一致。 output_bucket 否 String 输出桶名,host_type为1时必选 output_path 否 String 输出路径名,host_type为1时必选
  • 请求示例 创建媒资,使用存量托管方式。将已存储在OBS桶中的音视频文件同步到点播服务 POST https://{endpoint}/v1.0/{project_id}/asset/obs/host/stock/task Content-Type: application/json { "bucket": "obs-gg", "object": "1/Shoushu_FLV.flv", "suffix": [], "template_group_name": "original_template_group", "host_type": 1, "output_bucket": "obs-gg", "output_path": "ouput/" }
  • 响应示例 状态码: 200 处理成功返回。 { "total" : 0, "task_id" : "973", "task_status" : "SUCCEED", "assets" : [ ] } 状态码: 403 处理失败返回。 { "error_code" : "VOD.10053", "error_msg" : "The request parameter is illegal, illegal field: {xx}." }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数。 task_id String 任务ID。 task_status String 任务状态。 assets Array of AssetDetails objects 媒资信息。 表5 AssetDetails 参数 参数类型 描述 asset_id String VOD分配的媒资ID,仅支持查询,不支持修改。 asset_status String 媒资状态。 "CREATING":上传中 "FAILED":上传失败 "CREATED":上传成功 "PUBLISHED":已发布 "DELETED":已删除 transcode_status String 转码状态。 "UN_TRANSCODE":未转码 "WAITING_TRANSCODE":等待转码,排队中 "TRANSCODING":转码中 "TRANSCODE_SUCCEED":转码成功 "TRANSCODE_FAILED":转码失败 base_info BaseInfo object 媒资基本信息。 transcode_info TranscodeInfo object 转码生成文件信息。 说明: 仅当转码成功后才能查询到此信息,未转码、正在转码以及转码失败时,无此字段信息。 表6 BaseInfo 参数 参数类型 描述 title String 媒资标题。 长度不超过128个字节,UTF8编码。 video_name String 媒资文件名。 description String 媒资描述。 长度不超过1024个字节。 category_id Long 媒资分类id。 category_name String 媒资分类名称。 create_time String 媒资创建时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 last_modified String 媒资最近修改时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 video_type String 音视频文件类型。 取值如下: 视频文件:MP4、TS、MOV、MXF、MPG、FLV、WMV、AVI、M4V、F4V、MPEG、3GP、ASF、MKV。 音频文件:MP3、OGG、WAV、WMA、APE、FLAC、AAC、AC3、MMF、AMR、M4A、M4R、WV、MP2。 tags String 媒资标签。 单个标签不超过16个字节,最多不超过16个标签。 多个用逗号分隔,UTF8编码。 meta_data MetaData object 视频的元数据信息。 经过视频解析后产生,包括封装格式、大小、分辨率、码率、帧率。 video_url String 原始视频文件的访问地址。 sign_url String 原视频文件的OBS临时访问地址。仅调用查询指定媒资的详细信息接口时才返回具体值。 cover_info_array Array of CoverInfo objects 封面信息。 subtitle_info Array of SubtitleInfo objects 字幕信息数组 source_path File_addr object 媒资存储参数信息。查询接口,仅媒资为托管时有返回值。 output_path File_addr object 媒资存储参数信息。查询接口,仅媒资为托管时有返回值。 表7 CoverInfo 参数 参数类型 描述 cover_url String 封面文件的下载地址。 表8 SubtitleInfo 参数 参数类型 描述 url String 字幕文件的下载地址 id Integer 字幕文件id type String 字幕文件类型 language String 字幕文件语言种类 表9 File_addr 参数 参数类型 描述 bucket String OBS的bucket名称。 location String 桶所在的区域名, 如“华北-北京四”的区域名为“cn-north-4”,创建的桶所在区域必须和点播服务所在区域保持一致。 object String 文件的存储路径。 表10 TranscodeInfo 参数 参数类型 描述 template_group_name String 转码模板组名称。 output Array of Output objects 转码输出数组。 HLS或DASH格式:此数组的成员个数为n+1,n为转码输出路数。 MP4格式:此数组的成员个数为n,n为转码输出路数。 exec_desc String 执行情况描述。 transcode_status String 转码状态。 取值如下: UN_TRANSCODE:未转码 WAITING_TRANSCODE:待转码 TRANSCODING:转码中 TRANSCODE_SUCCEED:转码成功 TRANSCODE_FAILED:转码失败 表11 Output 参数 参数类型 描述 play_type String 协议类型。 取值如下: hls dash mp4 url String 播放URL。 group_id String 所属转码组Id group_name String 所属转码组名称 encrypted Integer 标记流是否已被加密。 取值如下: 0:表示未加密。 1:表示已被加密。 quality String 清晰度。 取值如下: FLUENT:流畅 SD:标清 HD:高清 FULL_HD:超清 meta_data MetaData object 视频的元数据信息。 经过视频解析后产生,包括封装格式、大小、分辨率、码率、帧率。 表12 MetaData 参数 参数类型 描述 pack_type String 视频封装格式。 取值如下: MP4 TS MOV MXF MPG FLV WMV MP3 WMA APE FLAC AAC AC3 MMF AMR M4A M4R OGG WAV WV MP2 AVI F4V M4V MPEG HLS DASH codec String 视频编码格式。 取值如下: MPEG-2 MPEG-4 H.264 H.265 WMV Vorbis AAC AC-3 AMR APE FLAC MP3 MP2 WMA PCM ADPCM WavPack 说明: 如果codec返回unknown,说明不支持解析用户当前发送的音视频编码格式。 duration Long 视频时长。 若视频的原时长为非整数,则该字段值为原时长的向上取整。 video_size Long 视频文件大小。 单位:字节。 width Long 视频宽度(单位:像素)。 编码为H.264的取值范围:[32,3840]之间2的倍数。 编码为H.265的取值范围:[320,3840]之间4的倍数。 hight Long 视频高度(单位:像素)。 编码为H.264的取值范围:[32,2160]之间2的倍数 。 编码为H.265的取值范围:[240,2160]之间4的倍数。 bit_rate Long 视频平均码率。 frame_rate Long 帧率(单位:帧每秒)。 取值如下: FRAMERATE_AUTO = 1, FRAMERATE_10 = 2, FRAMERATE_15 = 3, FRAMERATE_2397 = 4, // 23.97 fps FRAMERATE_24 = 5, FRAMERATE_25 = 6, FRAMERATE_2997 = 7, // 29.97 fps FRAMERATE_30 = 8, FRAMERATE_50 = 9, FRAMERATE_60 = 10 默认值:1。 单位:帧每秒。 quality String 清晰度。 取值如下: FULL_HD:超高清 HD:高清 SD:标清 FLUENT:流畅 AD:自适应 2K 4K audio_channels Integer 音频的声道数。 状态码: 403 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • URI GET /v1.0/{project_id}/asset/obs/host/stock/task/details 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID。 page 否 Integer 分页编号,默认为0。 size 否 Integer 每页记录数。 默认10,范围[1,100]
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token,使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。
  • CCE管理地址获取 登录HCS系统。 获取“云容器引擎CCE”的地址。 服务列表选择“云容器引擎CCE”。 取前半段地址,例如下图的https://console.huaweicloud.com/cce2.0。 获取镜像地址。 服务列表里选择“容器镜像服务”。 单击“我的镜像”,下载指令里,“docker pull”后面的部分即可镜像地址。 将2和3里获取的地址进行拼接,即为CCE管理地址。 拼接样例: https://console.huaweicloud.com/cce2.0?package={package} 其中 https://console.huaweicloud.com/cce2.0即为2里获取的地址。 {package}部分,中括号里的内容替换为3获取的地址。 父主题: 授权委托的信息获取
共100000条