华为云用户手册

FunctionGraph最佳实践 当您了解如何创建函数等基本操作后，可以根据自身的业务需求使用 函数工作流 FunctionGraph 提供的一系列常用实践。 本文介绍函数工作流 FunctionGraph 常用实践，帮助您更好的使用函数工作流。 表1 常用最佳实践 实践 描述 使用函数压缩图片 本实践基于函数工作流服务实践所编写，用于指导您使用函数工作流服务实现图片压缩的功能。 使用函数为图片打水印 本实践基于函数工作流服务实践所编写，用于指导您使用函数工作流服务实现为图片打水印的功能。 函数+LTS：日志实时分析实战 通过LTS 云日志 服务，快速完成E CS 等服务器的任务运行日志采集、加工和转换。 通过函数工作流服务中的函数创建LTS触发器获取日志数据，经由自定义函数对日志中的关键信息进行分析和处理，过滤出告警日志。 SMN 消息通知服务通过短信和邮件推送告警信息，通知业务人员进行处理。 将函数处理后的日志数据投递至OBS桶中集中存储，便于后续处理。 函数+ CTS ：登录/登出安全分析实战 通过CTS 云审计 服务，完成对公有云账户对各个云服务资源操作动作和结果的实时记录。 通过在函数工作流服务中创建CTS触发器获取订阅的资源操作信息，经由自定义函数对资源操作的信息进行分析和处理，产生告警日志。 SMN 消息通知 服务通过短信和邮件推送告警信息，通知业务人员进行处理。 定时开关华为公有云虚拟机 当您需要在特定时间打开或者关闭华为公有云虚拟机时，可以考虑通过函数服务调用华为云ECS接口，定时开关虚拟机。 开机节点：需要定时打开的虚拟机。 关机节点：需要定时关闭的虚拟机。 使用函数处理IOT数据 该案例演示您如何使用FunctionGraph 与IotDA 服务组合，处理物联网设备上报以及设备状态变动的相关数据。物联网设备在IotDA 平台进行管理，设备产生的数据可以从IotDA直接流转触发FunctionGraph 的函数运行。用户可以根据需要编写函数处理这些数据。 通常该组合，可以适用于以下场景，如将设备上报的数据在处理后进行存储到如OBS；对上报的数据进行结构化，清洗然后存储到数据库；根据设备状态变化进行事件通知等。 工作流+函数：自动化处理OBS中数据 本实践基于函数流服务实践所编写，用于指导您使用函数流服务实现OBS数据处理的功能。

步骤二：本地验证 启动docker容器 docker run -u 1003:1003 -p 8000:8000 custom_container_event_example:latest 打开一个新的命令行窗口，向开放的8000端口发送消息，访问模板代码中指定的/init路径 curl -XPOST -H 'Content-Type: application/json' localhost:8000/init 按照模块代码中返回 Hello init 打开一个新的命令行窗口，向开放的8000端口发送消息，访问模板代码中指定的/invoke路径 curl -XPOST -H 'Content-Type: application/json' -d '{"message":"HelloWorld"}' localhost:8000/invoke 按照模块代码中返回 Hello invoke 在容器启动端口可以看到 Listening on http://localhost:8000 receive {} receive { message: 'HelloWorld' } 或者使用docker logs命令获取容器的日志

准备工作 注册华为账号 并实名认证。 在创建函数前，请先注册华为账号并实名认证，具体步骤请参考注册华为账号并开通华为云和实名认证介绍。 如果您已有一个华为账号并实名认证，请跳过此步骤。 免费额度。 函数工作流服务每个月都会提供一定数量的免费额度，免费额度是子主账户共同使用，具体详情请参见免费额度。 当免费额度使用完后，若您继续使用函数工作流时，账户的可用额度小于待结算的账单时，即被判定为账户欠费。欠费后，可能会影响您的服务资源的正常运行，请及时充值，具体详情请参考账户充值。 为用户添加函数的操作权限。 本章节所有操作均默认具有操作权限，请确保您登录的用户已有“FunctionGraph Administrator”权限，即FunctionGraph服务所有权限，更多权限的说明请参考权限管理。

步骤五：测试函数 在函数详情页，单击“测试”，在弹窗中创建新的测试事件。 选择“apig-event-template”，事件名称输入“helloworld”，测试事件修改为如下所示，完成后单击“创建”。 { "body": "{\"message\": \"helloworld\"}", "requestContext": { "requestId": "11cdcdcf33949dc6d722640a13091c77", "stage": "RELEASE" }, "queryStringParameters": { "responseType": "html" }, "httpMethod": "POST", "pathParameters": {}, "headers": { "Content-Type": "application/json" }, "path": "/helloworld", "isBase64Encoded": false }

步骤二：本地验证 启动docker容器 docker run -u 1003:1003 -p 8000:8000 custom_container_http_example:latest 打开一个新的命令行窗口，向开放的8000端口发送消息，支持访问模板代码中根目录“/”下所有路径，以下以“helloworld”为例。 curl -XPOST -H 'Content-Type: application/json' -d '{"message":"HelloWorld"}' localhost:8000/helloworld 按照模块代码中返回 Hello FunctionGraph, method POST 在容器启动端口可以看到 receive {"message":"HelloWorld"} 或者使用docker logs命令获取容器的日志

准备工作 注册华为账号并实名认证。 在创建函数前，请先注册华为账号并实名认证，具体步骤请参考注册华为账号并开通华为云和实名认证介绍。 如果您已有一个华为账号并实名认证，请跳过此步骤。 免费额度。 函数工作流服务每个月都会提供一定数量的免费额度，免费额度是子主账户共同使用，具体详情请参见免费额度。 当免费额度使用完后，若您继续使用函数工作流时，账户的可用额度小于待结算的账单时，即被判定为账户欠费。欠费后，可能会影响您的服务资源的正常运行，请及时充值，具体详情请参考账户充值。 为用户添加函数的操作权限。 本章节所有操作均默认具有操作权限，请确保您登录的用户已有“FunctionGraph Administrator”权限，即FunctionGraph服务所有权限，更多权限的说明请参考权限管理。

准备工作 注册华为账号并实名认证。 在创建函数前，请先注册华为账号并实名认证，具体步骤请参考注册华为账号并开通华为云和实名认证介绍。 如果您已有一个华为账号并实名认证，请跳过此步骤。 免费额度。 函数工作流服务每个月都会提供一定数量的免费额度，免费额度是子主账户共同使用，具体详情请参见免费额度。 当免费额度使用完后，若您继续使用函数工作流时，账户的可用额度小于待结算的账单时，即被判定为账户欠费。欠费后，可能会影响您的服务资源的正常运行，请及时充值，具体详情请参考账户充值。 为用户添加函数的操作权限。 本章节所有操作均默认具有操作权限，请确保您登录的用户已有“FunctionGraph Administrator”权限，即FunctionGraph服务所有权限，更多权限的说明请参考权限管理。

准备工作 注册华为账号并实名认证。 在创建函数前，请先注册华为账号并实名认证，具体步骤请参考注册华为账号并开通华为云和实名认证介绍。 如果您已有一个华为账号并实名认证，请跳过此步骤。 免费额度。 函数工作流服务每个月都会提供一定数量的免费额度，免费额度是子主账户共同使用，具体详情请参见免费额度。 当免费额度使用完后，若您继续使用函数工作流时，账户的可用额度小于待结算的账单时，即被判定为账户欠费。欠费后，可能会影响您的服务资源的正常运行，请及时充值，具体详情请参考账户充值。 为用户添加函数的操作权限。 本章节所有操作均默认具有操作权限，请确保您登录的用户已有“FunctionGraph Administrator”权限，即FunctionGraph服务所有权限，更多权限的说明请参考权限管理。

响应示例 状态码：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, "duration_ms" : 131000, "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, "duration_ms" : 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, "duration_ms" : 130000, "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, "duration_ms" : 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, "duration_ms" : 130000, "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、WEBM 音频文件：MP3、OGG、WAV、WMA、APE、FLAC、AAC、AC3、MMF、AMR、M4A、M4R、WV、MP2 tags String 媒资标签。 单个标签不超过24个字节，最多不超过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 视频时长，单位：秒。 若视频的原时长为非整数，则该字段值为原时长的向下取整。 若视频的原时长小于1，则该字段值为1。 duration_ms 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的倍数。 height Long 视频高度（单位：像素） bit_rate Long 视频平均码率。 frame_rate Long 帧率（单位：帧每秒）。 quality String 清晰度。 取值如下： FULL_HD：超高清 HD：高清 SD：标清 FLUENT：流畅 AD：自适应 2K 4K audio_channels Integer 音频的声道数。 状态码：403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token，使用Token鉴权方式时必选。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。

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。

请求参数 表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参数 参数 是否必选 参数类型 描述 asset_id 是 String 原媒资ID storage_mode 是 String 存储模式。 取值如下： STANDARD：标准存储。 WARM：低频存储。 COLD：归档存储。 restore_mode 否 String 归档恢复方式。 取值如下： TEMP：临时 FOREVER：永久 days 否 Integer 从归档存储临时恢复为标准存储的时间。 取值范围：1-30。单位：天。 restore_tier 否 String 归档恢复选项。 EXPEDITED：快速恢复 STANDARD：标准恢复 默认值：EXPEDITED。

响应示例 状态码：200 处理成功返回。 { "task_result_array" : [ { "asset_id" : "2305739f855413a84af9e6ad6e2b21be", "status" : "SUCCEED" } ] } 状态码：400 处理失败返回。 { "error_code" : "VOD.10053", "error_msg" : "The request parameter is illegal, illegal field: {xx}." }

功能介绍 修改媒资文件在OBS的存储模式。 媒资上传默认为标准存储模式，支持转为低频或者归档存储模式。 低频存储可恢复为标准存储或者降级为归档存储。 归档存储仅支持恢复为标准存储，不支持直接转为低频存储。 当媒资处于截图、转码等任务处理中状态时无法修改存储模式。 低频模式最低存储时间为30天，归档模式最低存储时间为90天。未满此时间提前取回或删除媒资文件，仍会按最低存储时间收费。 媒资从低频或归档模式恢复成标准模式也会收取媒资取回的费用。 OBS存储计费注意事项，如下所示： 以低频存储模式为例进行说明，如果存储时间为28天（＜30天），则按照最低存储时间30天计费；如果存储时间为31天（≥30天），则按实际天数计费。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 task_result_array Array of TaskResult objects 修改媒资存储模式任务的下发结果。 表5 TaskResult 参数 参数类型 描述 asset_id String 媒资ID status String 查看修改媒资存储模式的任务是否下发成功。 SUCCEED：成功 FAILED：失败 状态码：400 表6 响应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." }

请求示例 创建媒资，使用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 错误描述。

请求参数 表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、WEBM、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 视频标签 。 单个标签不超过24个字节，最多不超过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 鉴政内容检测置信度，取值范围为-1或者[0,100]，该参数在请求参数中忽略。 置信度越高，说明审核结果越可信。未开启或设置为0时，表示未进行此项检测。politics、terrorism、porn三个参数不能同时为0。 terrorism 否 Integer 鉴恐内容的检测置信度，取值范围为-1或者[0,100]，该参数在请求参数中忽略。 置信度越高，说明审核结果越可信。未开启或设置为0时，表示未进行此项检测。politics、terrorism、porn三个参数不能同时为0。 porn 否 Integer 鉴黄内容的检测置信度，取值范围为-1或者[0,100]，该参数在请求参数中忽略。 置信度越高，说明审核结果越可信。未开启或设置为0时，表示未进行此项检测。politics、terrorism、porn三个参数不能同时为0。

请求示例 发布媒资 POST https://{endpoint}/v1.0/{project_id}/asset/status/publish Content-Type: application/json { "asset_id": [ "f488337c31c8e4622f1590735b134c65", "07ba4d46463355e800c2f42f628f0631" ] }

响应示例 状态码：200 处理成功返回。 { "asset_info_array" : [ { "asset_id" : "f488337c31c8e4622f1590735b134c65", "status" : "UNCREATED", "description" : "Asset meta download fail, errorCode is VOD.100021010,\nerrorMsg is Internal server communication is abnormal", "base_info" : { "title" : "Avatar test test", "video_name" : "Avatar_480P.mp4", "description" : "Avatar, test", "category_id" : -1, "category_name" : "其他", "create_time" : "20180209024019", "last_modified" : "20180209024019", "video_type" : "MP4", "tags" : "mytags" } }, { "asset_id" : "07ba4d46463355e800c2f42f628f0631", "status" : " UNCREATED", "description" : "no asset" } ] } 状态码：403 处理失败返回。 { "error_code" : "VOD.10062", "error_msg" : "Media asset or resource does not exist, please check." }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 asset_info_array Array of AssetInfo objects 发布的媒资信息。 表5 AssetInfo 参数 参数类型 描述 asset_id String VOD分配的媒资ID，仅支持查询，不支持修改。 is_multi_transcode Boolean 是否是多转码模式 status String 媒资状态。 取值如下： UNCREATED：未创建（媒资ID不存在 ） DELETED：已删除 CANCELLED：上传取消 SERVER_ERROR：上传失败（点播服务端故障） UPLOAD_FAILED：上传失败（向OBS上传失败） CREATING：创建中 PUBLISHED：已发布 WAITING_TRANSCODE：待发布（转码排队中） TRANSCODING：待发布（转码中） TRANSCODE_FAILED：待发布（转码失败） TRANSCODE_SUCCEED：待发布（转码成功） CREATED：待发布（未转码） NO_ASSET：该媒资不存在 DELETING：正在删除 DELETE_FAILED：删除失败 OBS_CREATING：OBS转存方式创建中 OBS_CREATE_FAILED： OBS转存失败 OBS_CREATE_SUC CES S： OBS转存成功 description String 媒资子状态或描述信息。 对于媒资异常场景，描述具体的异常原因。 对于正常场景，描述媒资的处理信息。 base_info BaseInfo object 媒资基本信息。 play_info_array Array of PlayInfo objects 转码文件的播放信息。 HLS或DASH：此数组的成员个数为n+1，n为转码输出路数。 MP4：此数组的成员个数为n，n为转码输出路数。 表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、WEBM 音频文件：MP3、OGG、WAV、WMA、APE、FLAC、AAC、AC3、MMF、AMR、M4A、M4R、WV、MP2 tags String 媒资标签。 单个标签不超过24个字节，最多不超过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 PlayInfo 参数 参数类型 描述 play_type String 播放协议类型。 取值如下： hls dash mp4 group_id String 所属转码组Id group_name String 所属转码组名称 url String 播放URL。 encrypted Integer 标记流是否已被加密。 取值如下： 0：表示未加密。 1：表示已被加密。 默认值：0。 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 视频时长，单位：秒。 若视频的原时长为非整数，则该字段值为原时长的向下取整。 若视频的原时长小于1，则该字段值为1。 duration_ms 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的倍数。 height Long 视频高度（单位：像素） bit_rate Long 视频平均码率。 frame_rate Long 帧率（单位：帧每秒）。 quality String 清晰度。 取值如下： FULL_HD：超高清 HD：高清 SD：标清 FLUENT：流畅 AD：自适应 2K 4K audio_channels Integer 音频的声道数。 状态码：403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求参数 表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参数 参数 是否必选 参数类型 描述 asset_id 是 Array of strings VOD分配的媒资ID，仅支持查询，不支持修改。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token，使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 sign_str String 带授权签名字符串的URL。具体调用示例请参见示例2：媒资分段上传（20M以上）。示例：https://{obs_domain}/{bucket}?AWSAccessKeyId={AccessKeyID}&Expires={ExpiresValue}&Signature={Signature} 状态码：403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码：200 处理成功返回。 { "sign_str" : "https://obs.cn-north-4.myhuaweicloud.com:443/obs-vod-1/%7Bproject_id%7D/f488337c31c8e4622f1590735b134c65/Avatar_480P.mp4?AWSAccessKeyId=CBN2J**********0RCSN&Expires=1518147618&Signature=kZYh0hEos2V**********AHGyXA%3D" } 状态码：403 处理失败返回。 { "error_code" : "VOD.10053", "error_msg" : "The request parameter is illegal, illegal field: {xx}." }

请求示例 初始化上传任务： GET https://{endpoint}/v1.1/{project_id}/asset/authority?http_verb=POST&content_type={type}&bucket={bucket}&object_key={objectKey} 上传段： GET https://{endpoint}/v1.1/{project_id}/asset/authority?http_verb=PUT&content_md5={md5}&part_number={num}&upload_id={id}&bucket={bucket}&object_key={objectKey} 合并段： GET https://{endpoint}/v1.1/{project_id}/asset/authority?http_verb=POST&upload_id={id}&bucket={bucket}&object_key={objectKey} 取消段： GET https://{endpoint}/v1.1/{project_id}/asset/authority?http_verb=DELETE&bucket={bucket}&object_key={objectKey}&upload_id={uploadId} 列举已上传的段： GET https://{endpoint}/v1.1/{project_id}/asset/authority?http_verb=GET&bucket={bucket}&object_key={objectKey}&upload_id={uploadId}

功能介绍 客户端请求创建媒资时，如果媒资文件超过20MB，需采用分段的方式向OBS上传，在每次与OBS交互前，客户端需通过此接口获取到授权方可与OBS交互。 该接口可以获取初始化多段上传任务、上传段、合并段、列举已上传段、取消段合并的带有临时授权的URL，用户需要根据OBS的接口文档配置相应请求的HTTP请求方法、请求头、请求体，然后请求对应的带有临时授权的URL。 视频分段上传方式和OBS的接口文档保持一致，包括HTTP请求方法、请求头、请求体等各种入参，此接口的作用是为用户生成带有鉴权信息的URL（鉴权信息即sign_str），用来替换OBS接口中对应的URL，临时给用户开通向点播服务的桶上传文件的权限。 调用获取授权接口时需要传入bucket、object_key、http_verb，其中bucket和object_key是由创建媒资：上传方式接口中返回的响应体中的target字段获得的bucket和object，http_verb需要根据指定的操作选择。 此接口为v1.1版本，暂不支持前端跨域访问，可以后端访问。如需前端跨域访问，请使用v1.0版本接口，详见获取分段上传授权。 v1.1版本的接口返回结果不需要拼接url，拿到结果中的sign_str，直接发送请求即可。

URI GET /v1.1/{project_id}/asset/authority 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 http_verb 是 String 分段上传时调用OBS接口的HTTP方法，具体操作需要的HTTP方法请参考OBS的接口文档。 初始化上传任务：POST 上传段：PUT 合并段：POST 取消段：DELETE 列举已上传段：GET bucket 是 String 桶名。 调用创建媒资：上传方式接口中返回的响应体中的target字段获得的bucket值。 object_key 是 String 对象名。 调用创建媒资：上传方式接口中返回的响应体中的target字段获得的object值。 content_type 否 String 文件类型对应的content-type，当为上传任务初始化场景该字段必填。 参数填写可参考媒资分段上传（20M以上）。 视频文件：video/视频格式，如：“video/mp4” 音频文件：audio/音频格式，如：“audio/mp3” 图片文件：image/图片格式，如：“image/png” 字幕文件：application/octet-stream content_md5 否 String 上传段时每段的MD5。 upload_id 否 String 每一个上传任务的id，是OBS初始化视频分段上传任务后返回的值。除上传任务初始化场景外，该字段必填。 part_number 否 Integer 上传段时每一段的id。 取值范围：[1,10000]。