创建作业_视频分析服务 VAS_API参考_视频内容审核_华为云

(1)

视频分析服务

API 参考

文档版本 06

发布日期 2021-08-24

(2)

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。

商标声明

和其他华为商标均为华为技术有限公司的商标。

本文档提及的其他所有商标或注册商标，由各自的所有人拥有。

注意

您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定，华为公司对本文档内容不做任何明示或暗示的声明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

华为技术有限公司

地址：深圳市龙岗区坂田华为总部办公楼邮编：518129

网址：

https://www.huawei.com

客户服务邮箱：

[email protected]

客户服务电话：4008302118

(3)

1 ^{使用前必读}

1.1 概述

欢迎使用视频分析服务（Video Analysis Service，简称VAS），VAS依靠AI技术对视频进行智能分析，提供了视频预处理、视频内容分析、视频编辑、视频搜索等功能。视频分析服务包含了对视频中目标的检测、跟踪、属性识别、行为识别、内容审核、摘要、标签等能力，在多种场景下为用户提供快捷高效的视频分析能力。

您可以使用本文档提供的API对视频数据进行相关分析处理。支持的全部API请参见API

概览。

在调用视频分析服务API之前，请确保已经充分了解视频分析服务相关概念，详细信息请参见产品介绍。

1.2 终端节点

终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询所有服务的终端节点。

视频分析服务的终端节点如表1-1所示，请您根据业务需要选择对应区域的终端节点。

表1-1 视频分析服务 Endpoint

区域名称区域终端节点（Endpoint）协议类型

华北-北京

一 cn-north-1 iva.cn-

north-1.myhuaweicloud.com HTTPS 华北-北京

四

cn-north-4 iva.cn-

north-4.myhuaweicloud.com HTTPS 亚太-曼谷 ap-southeast-2 iva.ap-

southeast-2.myhuaweicloud.com HTTPS 华东-上海

二

cn-east-2 iva.cn-east-2.myhuaweicloud.com HTTPS

API 参考 1 使用前必读

(6)

区域名称区域终端节点（Endpoint）协议类型华东-上海

一 cn-east-3 iva.cn-east-3.myhuaweicloud.com HTTPS 华南-广州 cn-south-1 iva.cn-

south-1.myhuaweicloud.com HTTPS 中国-香港 ap-southeast-1 iva.ap-

southeast-1.myhuaweicloud.com HTTPS 亚太-新加

坡 ap-southeast-3 iva.ap-

southeast-3.myhuaweicloud.com HTTPS

1.3 约束与限制

受技术与成本多种因素制约，视频分析服务存在一些约束限制。其中系统级约束限制，是所有子服务的约束。除系统级约束限制外，各子服务还有独立的约束限制。

系统级约束限制

● 支持扩展名为avi、wmv、mpg、mpeg、mp4、mov、m4v、mkv的视频文件。

● 不支持OBS桶上经过KMS加密后的视频。

● 单个视频大小不能超过4GB。

● 支持常见的帧率（fps）：23.97、24、25、29.97、30、50、60。

● 支持H.264、H.265、MPEG2、MPEG4、VC1、VP8、VP9编码格式视频的GPU解码。

编码格式最大分辨率

MPEG2 1920*1080

MPEG4 1920*1080

VC1 2048*1024

H.264 1920*1080

H.265 1920*1080

VP8 1920*1080

VP9 1920*1080

视频 OCR

● 从指定的URL地址中读取视频数据时，视频大小不能超过1GB。

● 支持识别数字、中文简体文字、中文繁体文字、英文字幕等。

● 能够识别场景较为清晰的水平文字、以及部分竖直文字和艺术字体，不能很好的处理环形文字、倾斜角度较大等场景。

(7)

● 视频分辨率不低于300*300。

● 视频帧率必须大于1。

● 支持的区域：北京一、北京四。

视频内容审核

● 视频帧率不小于1。

● 目前不保证API调用的并发能力。

● 支持的区域：北京一、北京四、上海一。

1.4 基本概念

● 账号

用户注册华为云时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。

● 用户

由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。

在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。

● 区域（Region）

从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属 Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。

详情请参见区域和可用区。

● 可用区（AZ，Availability Zone）

一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。

● 项目

华为云的区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。

(8)

图1-1 项目隔离模型

同样在我的凭证下，您可以查看项目ID。

(9)

2 ^{API 概览}

视频分析服务提供了RESTful API，支持您通过HTTPS请求调用，您可以使用的功能如

表2-1所示。

表2-1 视频分析服务 API

服务功能 API 说明

视频内容

分析视频OCR

创建视频OCR作业

该API用于创建视频质量分析的作业，识别视频画面质量，将视频画面的质量进行归类，从而过滤出清晰的高质量视频。

查询作业列表

该API用于查询并显示视频质量

分析的作业列表。

查询单个作业

该API根据作业ID查询并显示单

个作业详情。

删除作业

该API用于根据作业ID删除指定作业。

视频内容

审核视频内容审

核

创建作业

该API接口用于创建视频内容审

核的作业。

查询作业列表

该API接口用于查询并显示视频

内容审核的作业列表。

查询单个作业

该API接口用于查询并显示单个

作业详情。

删除作业

该API接口用于删除指定作业。

API 参考 2 API 概览

(10)

3 ^{如何调用 API}

3.1 开通服务

根据服务功能的发布阶段，开通方式分为以下两种：

● 邀测/商用：目前邀测/商用阶段的服务功能，需要用户提供账号信息给对应功能的技术支持，技术支持处理完后用户才可以使用服务的算法功能，具体请参见邀测/

商用功能的开通步骤。

● 公测：公测阶段的服务功能，用户可在控制台完成开通的操作，具体请参见公测

功能的开通步骤。

当前各个功能的发布阶段请参见功能的发布阶段。

邀测/商用功能的开通步骤

1. 登录控制台上的“我的凭证”界面，如图3-1所示。

图3-1 我的凭证界面

2. 获取用户的账号信息，邀测和商用需要的信息不相同，具体如下：

– 邀测：需要用户名和项目ID。

– 商用：需要账号名和项目ID。

3. 将已获取的账号信息提供给对应功能的技术支持。

4. 技术支持处理完成后，用户登录视频分析服务管理控制台可以看到具体的服务功能，且操作列为“创建作业”时表示开通成功，如图3-2所示。

API 参考 3 如何调用 API

(11)

图3-2 服务功能展示

公测功能的开通步骤

1. 登录华为云的视频分析服务控制台。

2. 选择“服务”，会看到功能列表。

如果您是首次进入视觉服务界面，需要您进行公测申请，公测审批当前是人工审批，一般需要等待1～2天，如遇节假日顺延。

3. 根据业务需求，选择待开通的功能（例如：视频OCR），单击操作列的“申请公测”。

功能的公测申请无需审批，可实时开通。

4. 服务功能的操作列显示“创建作业”时表示开通成功。

服务功能只需开通一次即可，后续使用无需再申请。

功能的发布阶段

表3-1 发布阶段

服务功能发布阶段

视频审核视频内容审核商用

3.2 构造请求

本节介绍REST API请求的组成，并以调用IAM服务的获取用户Token接口来说明如何调用API，该API获取用户的Token，Token可以用于调用其他API时鉴权。

您还可以通过这个视频教程了解如何构造请求调用API。

请求 URI

请求URI由如下部分组成。

{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

表3-2 请求 URI

参数说明

URI-scheme 传输请求的协议，当前所有API均采用HTTPS协议。

(12)

参数说明

Endpoint 承载REST服务端点的服务器域名或IP，不同服务在不同区域时，对应Endpoint不同，可以从终端节点中获取。

例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn- north-4.myhuaweicloud.com”。

resource-

path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。

query-string 查询参数，可选，查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。

例如，您需要获取IAM在“华北-北京四””区域的Token，则需使用“华北-北京四”

区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的 URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。

https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 说明

为查看方便，服务每个具体API的URI，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法

HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。

表3-3 HTTP 方法

方法说明

GET 请求服务器返回指定资源。

PUT 请求服务器更新指定资源。

POST 请求服务器新增资源或执行特殊操作。

DELETE 请求服务器删除指定资源，如删除对象等。

HEAD 请求服务器资源头部。

PATCH 请求服务器更新资源的部分内容。

当资源不存在的时候，PATCH可能会去创建一个新的资源。

在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为：

POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens

(13)

请求消息头

附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。

需要添加到请求中的公共消息头如表3-4所示。

表3-4 公共请求消息头

参数名说明是否必选示例

Content-

type 消息体的类型（格式），

默认取值为“application/

json”。

是 application/json

Content-

Length 请求body长度，单位为

Byte。 POST/PUT请

求必填。GET 不能包含。

3495

X-Project-Id project id，用于不同

project取token。否 e9993fc787d94b6c886 cbaa340f9c0f4

X-Auth-

Token 用户Token，也就是调用

获取用户Token接口的响

应值，该接口是唯一不需要认证的接口。

否

使用Token认证时必选。

-

X-Sdk-Date 请求的发生时间，格式为 (YYYYMMDD'T'HHMMSS 'Z')。

取值为当前系统的GMT时间。

否

如果使用ak/sk 做接口认证的时候，那么此字段必须设置；如果使用 PKI token的时候，不必设置。

20190307T101459Z

Authorizati

on 签名认证信息。

该值来源于请求签名结果，使用AK/SK进行加密签名的时候需要。

类型：字符串默认值：无

否

使用AK/SK认证时必选。

SDK-HMAC-SHA256 Credential=ZIRRKMT WPTQFQI1WKNKB/

20150907//ec2/

sdk_request,

SignedHeaders=conte nt-type;host;x-sdk- date,

Signature=55741b610f 3c9fa3ae40b5a8021eb f7ebc2a28a603fc62d2 5cb3bfe6608e1994

(14)

参数名说明是否必选示例 Host 请求的服务器信息，从服

务API的URL中获取。

值为hostname[:port]。

端口缺省时使用默认的端口，https的默认端口为 443。

否

使用AK/SK认证时必选。

code.test.com or

code.test.com:443

说明

公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。AK/SK 认证的详细说明请参见API签名指南。

例如，对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。

POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体

请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。

每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。

对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中

username

为用户名，

domainname

为用户所属的账号名称，

********

为用户登录密码，

cn-north-4

为project的name，获取方法请参见获取用户名、账号名和项目

name。

说明

● scope参数定义了Token的作用范围，取值为project或domain，示例中取值为project，表示获取的Token仅能访问指定project下的资源，取值为domainname时，表示获取的token可以访问指定账号下所有资源，scope参数的详细说明，请参见获取用户Token。

● project name：在“我的凭证”页面，项目列表中“项目”列的值就是“project name”，

具体获取方式请参见获取用户名、账号名和项目name。

POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type:application/json

{ "auth": { "identity": {

"methods": ["password"], "password": {

"user": {

"name": "username", "password": "**********", "domain": {

"name": "domainname"

}

(15)

} } }, "scope": { "project": {

"name": "cn-north-4"

} } }}

到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token，返回的响应消息头中“x-

subject-token”的值，就是需要获取的用户Token。有了Token之后，您就可以使用 Token认证调用其他API。

3.3 认证鉴权

调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。

● Token认证：通过Token认证通用请求。

● AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key)加密调用请求。

Token 认证

说明

Token的有效期为24小时，需要使用同一个Token鉴权时，可以缓存起来，避免频繁调用。

Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。

Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。

Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的 Token，即调用获取用户Token接口时，请求body中“auth.scope”的取值需要选择

“project”，请求示例如下。

{ "auth": { "identity": { "methods": [ "password"

],

"password": { "user": {

"name": "username", "password": "********", "domain": {

"name": "domainname"

} } } }, "scope": { "project": {

"name": "xxxxxxxx"

} } } }

(16)

获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，

其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token:

ABCDEFJ....”加到请求消息头即可，如下所示。

GET https://iam.cn-north-4.myhuaweicloud.com/v3/auth/projects Content-Type: application/json

X-Auth-Token: ABCDEFJ....

您还可以通过这个视频教程了解如何使用Token认证。

AK/SK 认证

说明

AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。

AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。

● AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥 ID和私有访问密钥一起使用，对请求进行加密签名。

● SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，

可标识发送方，并防止请求被修改。

使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。

须知

签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

3.4 返回结果

请求发送以后，您会收到响应，包含：状态码、响应消息头和响应消息体。

状态码

状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。

对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。

响应消息头

对应请求消息头，响应同样也有消息头，如“Content-type”。

(17)

表3-5 公共响应消息头

消息头名称说明是否必选

Content-Type 用于指明发送给接收者的实体正文的媒体类型。

类型：字符串。

默认值：application/json; charset=UTF-8

是

X-request-id 此字段携带请求ID号，以便任务跟踪。

类型：字符串。request_id-timestamp-

hostname（request_id在服务器端生成UUID，

timestamp为当前时间戳，hostname为处理当前接口的服务器名称）。

默认值：无。

否

X-ratelimit 此字段携带总计流控请求数。

类型：整型。

默认值：无。

否

X-ratelimit-

used 此字段携带剩下请求数。

类型：整型。

默认值：无。

否

X-ratelimit-

window 此字段携带流控单位。

类型：字符串。单位按照分钟、小时、天。

默认值：小时。

否

对于获取用户Token接口，返回如图1所示的消息头。

其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用 Token认证调用其他API。

图3-3 获取用户 Token 响应消息头

(18)

响应消息体

响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。

对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。

{ "token": {

"expires_at": "2019-02-13T06:52:13.855000Z", "methods": [

"password"

],

"catalog": [ {

"endpoints": [ {

"region_id": "cn-north-4", ...

当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。

{ "error_message": "The format of message is error", "error_code": "AS.0001"

}

其中，error_code表示错误码，error_message表示错误描述信息，具体请参见错误

码。

(19)

4 视频分析服务 API

4.1 创建作业

功能介绍

该API用于创建所选视频分析服务的作业。

URI

● URI格式

POST /v2/{project_id}/services/{service_name}/tasks

● 参数说明

名称是否必选类型说明

project_id 是 String 服务所在区域对应的项目ID，

获取方法请参见获取项目ID。

service_name 是 String 所选视频分析服务名称。

请求消息

● 请求示例

POST /v2/6204a5bd270343b5885144cf9c8c158d/services/video-analyze/tasks { "name": "task-est",

"description": "description", "input": {

"type": "obs", "data": [ {

"bucket": "obs-iva", "path": "input/demo.mp4"

} ] }, "output": { "obs": {

"bucket": "obs-iva", "path": "output/"

API 参考 4 视频分析服务 API

(20)

} },

"service_version":"1.0"

}

● 请求参数说明

参数名称是否为必选类型描述信息

name 是 String 作业名称，只能由字母（a～z，A

～Z）、数字（0～9）、中划线

（-）、下划线（_）组成，长度范围为[1，100]。

description 否 String 作业描述信息，最大长度为500字符长度。

input 是 Object 视频数据的输入列表。

详细参数定义参见task.input（任

务输入参数）。

service_vers

ion 是 String 功能版本。

output 是 Object 结果数据的输出列表。

详细参数定义见task.output（任

务输出参数）。

响应消息

● 响应示例

[ { "id": "f18320e61e4c4dc685aa2dfc22a28dc5" } ]

● 返回作业ID列表

参数名称类型描述信息

id String 作业ID。

返回值

● 正常 201

● 异常

返回值说明

400 Bad Request 请求错误，具体返回错误码请参考错误

码。

401 Unauthorized 鉴权失败。

403 Forbidden 没有操作权限。

(21)

返回值说明

404 Not Found 找不到资源。

500 Internal Server Error 服务内部错误。

503 Service Unavailable 服务不可用。

4.2 获取作业列表

功能介绍

该API用于查询所选视频分析服务的作业列表。

URI

● URI格式

GET /v2/{project_id}/services/{service_name}/tasks

● 参数说明

project_id 是 String 项目ID。

请求消息

● 请求示例

GET /v2/6204a5bd270343b5885144cf9c8c158d/services/video-analyze/tasks

● 请求参数请参见queryOption（作业列表查询参数）。

响应消息

● 响应示例

{ "count": 1, "tasks":[

{

"id": "f18320e61e4c4dc685aa2dfc22a28dc5", "name": "task01",

"description": "sss", "input": {

} ] }, "output": { "obs": {

(22)

} },

"service_version":"1.0", "state": "RUNNING",

"created_at": "2018-06-12T13:00:01Z", "updated_at": "2018-06-13T13:00:01Z"

} ] }

● 响应参数说明

tasks Array of

taskDetail 作业详情，定义见task.detail（作业

详情参数）。

count Integer 符合查询条件的总条目数。

返回值

● 正常 200

● 异常

返回值说明

码。

4.3 获取作业详情

功能介绍

该API用于查询并显示所选视频分析服务的单个作业详情。

URI

● URI格式

GET /v2/{project_id}/services/{service_name}/tasks/{task_id}

● 参数说明

(23)

名称是否必选类型说明 project_id 是 String 项目ID。

task_id 是 String 作业ID。

请求消息

请求样例GET /v2/6204a5bd270343b5885144cf9c8c158d/services/video-analyze/tasks/

f18320e61e4c4dc685aa2dfc22a28dc5

响应消息

● 响应样例

{ "id": "f18320e61e4c4dc685aa2dfc22a28dc5", "name": "task",

} ] }, "output": { "obs": {

} },

"service_version":"1.0", "state": "ABNORMAL",

}

taskDetail Object 作业详情，定义见task.detail（作业

详情参数）。

返回值

● 正常 200

● 异常

(24)

返回值说明

码。

4.4 删除作业

功能介绍

该API用于根据作业ID删除所选视频分析服务的指定作业。

URI

● URI格式

DELETE /v2/{project_id}/services/{service_name}/tasks/{task_id}

● 参数说明

请求消息

请求示例DELETE /v2/6204a5bd270343b5885144cf9c8c158d/services/video-analyze/tasks/

响应消息

● 删除失败时的响应示例

{ "error_code": "IVA.0005",

"error_msg": "The requested resource is NOT found. The taskId f18320e61e4c4dc685aa2dfc22a28dc5 is not found."

}

(25)

参数名称描述信息

error_code 错误码。

error_msg 错误信息。

返回值

● 正常

输出类型是hosting时返回202，其它都返回200。

● 异常

返回值说明

码。

(26)

5 视频内容分析 API

5.1 视频 OCR

5.1.1 创建视频 OCR 作业

功能介绍

该API用于创建视频OCR的作业，通过自动分析视频中出现的文字内容，可以识别并提取违规或者关键信息。

说明

● 支持扩展名为avi、wmv、mpg、mpeg、mp4、mov、m4v、mkv的视频文件。

● 不支持OBS桶上经过KMS加密后的视频。

● 从指定的URL地址中读取视频数据时，视频大小不能超过1GB。

● 支持识别数字、中文简体文字、中文繁体文字、英文字幕等。

● 能够识别场景较为清晰的水平文字、以及部分竖直文字和艺术字体，不能很好的处理环形文字、倾斜角度较大等场景。

● 视频分辨率不低于300*300。

● 视频帧率必须大于1。

● 支持的区域：北京一、北京四。

URI

● URI格式

POST /v2/{project_id}/services/video-ocr/tasks

● 参数说明

project_id 是 String 服务所在区域对应的项目 ID，获取方法请参见获取

项目ID。

API 参考 5 视频内容分析 API

(27)

请求消息

● 请求示例

POST /v2/6204a5bd270343b5885144cf9c8c158d/services/video-ocr/tasks {

"name": "task-est", "description": "description", "input": {

} ] }, "output": { "obs": {

} },

"service_config": { "common": {

"area": "0,0,0.5,0.5;"

"threshold": 0.5 }

},

}

● 参数说明

name 是 String 作业名称，只能由中文、字母（a～zA～

Z）、数字（0～9）、中划线（-）、下划线（_）组成，长度范围为[1，100]。

descripti

on 否 String 作业描述信息，最大长度为500字符长度。

input 是 Object 视频数据的输入列表，目前视频OCR支持以下输入类型：

● obs：从华为云OBS中读取视频数据，

视频大小不能超过4GB。不支持OBS桶上经过KMS加密后的视频。

● url：从指定的URL地址中读取视频数据，视频大小不能超过1GB。目前支持OBS的URL，且需要设置该URL对匿名用户可读取权限，设置方法请参见

桶的访问权限。

详细参数定义参见task.input（任务输入

参数）。

(28)

output 是 Object 结果数据的输出列表，目前视频OCR支持以下输出类型：

● obs：将结果输出到您指定的OBS桶中。

● hosting：结果将托管到服务侧的 OBS，该OBS路径由服务指定，您可以通过调用查询单个作业API获取该路径。

详细参数定义见task.output（任务输出

参数）。

service_c

onfig 否 Object 服务算法配置，字段结构跟服务相关，参数定义见serviceConfig字段结构说明。

service_v

ersion 是 String 功能版本填为“1.0”。

● service_config字段结构说明

area 否 String 选择文字识别的区间，以“;”作为不同区域的分割符号，每一个区域的前两个数值，代表区域左上角

（x，y）的百分比坐标；后两个数值代表所选区域宽、高占图片百分比数值。取值范围为[0，1]，无默认值。

threshold 否 Float 控制输出文字的置信度，值越高，

文字的精准度就越高，对应的召回率会降低。取值范围为[0，1.00]，

默认值为0.50。

响应消息

● 响应示例

识别结果

视频识别结果在用户输入的output路径下，以json文件的方式保存。

(29)

● 结果文件内容示例

{ "name": "obs-wxh/demo.mp4", "fps": 15,

"contents": [ {

"time_start": "00:00:00", "time_end": "00:00:01", "content": [

"云领创新", "数绘未来",

"2018世界人工智能大会"

] }, {

"云领创新", "数绘未来", "改变才刚刚开始"

] }, {

"阶段一",

"通用目的技术生产力", "应用发展曲线"

] } ]}

● 结果文件的字段说明

字段描述信息

name 视频名称。

fps 视频帧率。

time_start 内容起始时间。

time_end 内容结束时间。

content 识别出的具体文字内容。

返回值

● 正常 201

● 异常

返回值说明

码。

(30)

返回值说明

5.1.2 查询作业列表

功能介绍

该API用于查询并显示视频OCR的作业列表。

URI

● URI格式

GET /v2/{project_id}/services/video-ocr/tasks

● 参数说明

project_id 是 String 项目ID。获取方

法请参见获取项

目ID。

请求消息

● 请求示例

GET /v2/6204a5bd270343b5885144cf9c8c158d/services/video-ocr/tasks

响应消息

● 响应示例

{ "count": 1, "tasks": [ {

"id": "f18320e61e4c4dc685aa2dfc22a28dc5", "name": "ocr-task",

} ] }, "output": { "obs": {

"bucket": "obs-iva",

(31)

"path": "output/"

} },

"service_config": { "common": { "area": "0,0,0.5,0.5;"

"threshold": 0.5 }

},

"service_version":"1.0", "state": "RUNNING",

} ]}

tasks Array of

详情参数）。

返回值

● 正常 200

● 异常

返回值说明

码。

5.1.3 查询单个作业

功能介绍

该API用于查询并显示单个作业详情。

URI

● URI格式

GET /v2/{project_id}/services/video-ocr/tasks/{task_id}

(32)

● 参数说明

project_id 是 String 项目ID。获取方法请参见

获取项目ID。

请求消息

请求示例GET /v2/6204a5bd270343b5885144cf9c8c158d/services/video-ocr/tasks/

响应消息

● 响应示例

{ "id": "f18320e61e4c4dc685aa2dfc22a28dc5", "name": "ocr-task",

} ] }, "output": { "obs": {

} },

"gpu_device_ID": "0"

} },

"service_version":"1.0", "state": "ABNORMAL",

}

详情参数）。

返回值

● 正常 200

(33)

● 异常

返回值说明

码。

5.1.4 删除作业

功能介绍

该API用于删除指定作业。

URI

● URI格式

DELETE /v2/{project_id}/services/video-ocr/tasks/{task_id}

● 参数说明

请求消息

请求示例DELETE /v2/6204a5bd270343b5885144cf9c8c158d/services/video-ocr/tasks/

响应消息

}

error_code 错误码。具体请参考错误码。

(34)

返回值

● 正常

● 异常

返回值说明

码。

(35)

6 ^{视频内容审核}

6.1 创建作业

功能介绍

该接口用于创建视频内容审核的作业。

URI

● URI格式

POST /v2/{project_id}/services/video-moderation/tasks

● 参数说明名称是

否必选

类型说明

project

_id 是 Strin

g 服务所在区域对应的项目ID，获取方法请参见获取项目

ID。

请求消息

● 示例

POST /v2/6204a5bd270343b5885144cf9c8c158d/services/video-moderation/tasks {

"name": "task-test", "description": "description", "input": {

"bucket": "obs-iva", "index": 0,

"path": "input/demo.mp4"

} ] },

"output": {

API 参考 6 视频内容审核

(36)

"obs": {

},

"hosting": {}

},

"frame_interval": 5,

"categories": "porn,terrorism,politics", "text_categories": "porn,politics", "upload": "false",

"use_ocr": "true", "use_sis": "true"

} },

}

● 参数说明

name 是 String 作业名称，只能由中文、字母

（a～zA～Z）、数字（0～9）、

中划线（-）、下划线（_）组成，长度范围为[1，100]。

description 否 String 作业描述信息，最大长度为500 字符长度。

input 是 Object 视频数据的输入列表，目前只支

持以下输入类型，且只支持一路输入，不支持多个OBS文件或 URL：

● obs：从华为云OBS中读取视频数据。

● url：从指定的URL地址中读取视频数据。

详细参数定义参见task.input

（任务输入参数）。

output 是 Object 结果数据的输出列表，目前只支

持以下输出类型：

● obs：将结果输出到指定的 OBS桶中。

● hosting：结果将托管到服务侧的OBS，该OBS路径由服务指定，您可以通过调用查询单

个作业API获取该路径。

详细参数定义参见task.output

（任务输出参数）。

(37)

service_config 否 Object 服务算法配置，字段结构跟服务相关，目前配置项为common，

详细参数定义参见

serviceConfig.common字段结构...。

service_version 是 String 功能版本为“1.2”。

● service_config.common字段结构说明

参数是否必选类型说明

frame_

interva l

是 Integer 截帧时间间隔，单位为秒/帧。

catego

ries 是 String 视频检测场景。

● politics：政治人物的检测。

● terrorism：暴恐元素的检测。

● porn：涉黄内容元素的检测。

可通过配置上述场景，来完成对应场景元素的检测。

说明

如需配置多个检测场景，则将多个场景名称使用英文半角逗号拼接。例如，"categories":

"politics,terrorism,porn"。

text_ca tegorie s

否 String 语音或文字审核服务的检测场景，目前主要支持以下几种：

● politics：政治人物的检测。

● porn：涉黄内容元素的检测。

● ad：广告的检测。

● abuse：辱骂内容元素的检测。

● contraband：违禁品的检测

● flood：灌水内容元素的检测。

当使用语音或文字检测服务时，这里应当设置出对应的场景。

说明

如需配置多个检测场景，则将多个场景名称使用英文半角逗号拼接。例如，"text_categories":

"politics,porn"。

(38)

use_sis 否 String 是否使用语音审核服务。

● true：使用

● false：不使用

当不设置该参数或参数为空时，默认为不使用。

use_oc

r 否 String 是否使用文字审核服务。

● true：使用

upload 否 String 是否使用问题场景图片上传服务。

● true：使用

当使用该服务时，必须设置obs输出目录，否则图片无法上传。问题图片会自动上传至输出路径/

task_id目录下。

响应消息

● 响应示例

返回值

● 正常 201

● 异常

返回值说明

码。

(39)

返回值说明

6.2 查询作业列表

功能介绍

该API用于查询并显示视频内容审核的作业列表。

URI

● URI格式

GET /v2/{project_id}/services/video-moderation/tasks

● 参数说明

project_id 是 String 项目ID。获取方法请参见获取

项目ID。

请求消息

● 请求示例

GET /v2/6204a5bd270343b5885144cf9c8c158d/services/video-moderation/tasks

响应消息

● 响应示例

{ "count": 1, "tasks": [ {

"id": "f18320e61e4c4dc685aa2dfc22a28dc5", "name": "moderation-task",

"description": "description", "input": {

"data": [ {

"bucket": "obs-iva", "index": 0,

"path": "input/demo.mp4"

} ],

"type": "obs"

}, "output": { "obs": {

} },

(40)

"categories": "porn", "frame_interval": 5,

"text_categories": "porn,politics", "upload": "false",

"use_ocr": "true", "use_sis": "true"

} },

"service_version": "1.2", "state": "RUNNING",

} ]}

tasks Array of

详情参数）。

返回值

● 正常 200

● 异常

返回值说明

码。

6.3 查询单个作业

功能介绍

该API用于查询并显示单个作业详情。

(41)

URI

● URI格式

GET /v2/{project_id}/services/video-moderation/tasks/{task_id}

● 参数说明

project_id 是 String 项目ID。获取方法请参见获取项目

ID。

请求消息

请求示例GET /v2/6204a5bd270343b5885144cf9c8c158d/services/video-moderation/tasks/

响应消息

● 响应示例

{ "description": "description", "service_version": "1.2", "output": {

"obs": {

},

"hosting": { "obs": [ {

"bucket": "obs-iva",

"path": "hosting/f18320e61e4c4dc685aa2dfc22a28dc5/result.json"

} ],

"result_json_overdue_at": "2019-03-01T10:32:32Z"

} }, "input": { "type": "obs", "data": [ {

"bucket": "obs-iva", "path": "input/demo.mp4", "index": 0

} ] },

"created_at": "2019-03-01T10:32:12Z", "service_config": {

"common": { "frame_interval": 1, "categories": "ad", "text_categories": "ad", "upload": "false", "use_ocr": "true", "use_sis": "true"

} },

"name": "video-moderation-2",

"id": "f18320e61e4c4dc685aa2dfc22a28dc5",

(42)

"state": "SUCCEEDED", "hosting_result": {

"overdueDate": "2019-03-28T10:32:32Z",

"data": "{\"result\": {\"frames\": [{\"detail\": {\"ad\": [{\"confidence\": 0,\"label\": \"ad\"}, {\"confidence\": 1,\"label\": \"normal\"}],\"ocr_ad\": [{\"text\": \"抢答器\"}]},\"frame_begin\":

92.0,\"frame_end\": 93.0,\"frame_img_path\": \"taskrd16xsvl/92_ad.jpg\",\"frame_suggestion\": \"block

\",\"suspect_categories\": [\"ocr_ad\"]}],\"suggestion\": \"block\",\"voices\": [{\"content\": \"这个反应的抢答器，啊那么他身体上的一些不方便呢不会受到这个影响。好，请科学助理为两位戴上防干扰耳机，啊我不需要而且我觉得戴的不舒服，OK啊其实不戴耳机对我来说没有太大的干扰，我的注意力非常非常集中，除了屏幕上的这个摄像图和数字之外，我其他的看不到也听不到。\",\"detail\": {\"ad\": [\"抢答器\"]},

\"voice_begin\": 92.24,\"voice_end\": 117.62,\"voice_suggestion\": \"block\"}]},\"video_path\": \"input/

demo.mp4\"}",

"fileSize": "329 bytes", "status": "AVAILABLE"

},

"updated_at": "2019-03-02T10:32:34Z"

}

详情参数）。

结果说明

视频内容审核结果在用户输入的output路径下，以json文件的方式保存。

● 结果文件内容示例

{ "video_path": "demo.mp4", "result": {

"frames": [ {

"detail": { "ad": [ {

"confidence": 0, "label": "ad"

}, {

"confidence": 1, "label": "normal"

} ], "ocr_ad": [ {

"text": "抢答器"

} ] },

"frame_begin": 92.0, "frame_end": 93.0,

"frame_img_path": "taskrd16xsvl/92_ad.jpg", "frame_suggestion": "block",

"suspect_categories": [ "ocr_ad"

] } ], "voices": [ {

"content": "这个反应的抢答器，啊那么他身体上的一些不方便呢不会受到这个影响。好，请科学助理为两位戴上防干扰耳机，啊我不需要而且我觉得戴的不舒服，OK啊其实不戴耳机对我来说没有太大的干扰，我的注意力非常非常集中，除了屏幕上的这个摄像图和数字之外，我其他的看不到也听不到。",

(43)

"detail": { "ad": [ "抢答器"

] },

"voice_begin": 92.24, "voice_end": 117.62, "voice_suggestion": "block"

} ],

"suggestion": "block"

} }

● 结果文件的字段说明

video_path 视频路径。

result 视频处理结果。

● result字段说明

suggestion 视频处理建议。

● review：建议人工复查。

● block：建议封禁。

● pass：审核通过。

voices Json数组，表示语音场景问题详情，详细参数定义参见

•语音场景问题片段具体字段含义。

当没有语音场景问题帧时，该数组显示为空。

frames Json数组，表示视频问题帧详情，详细参数定义参见•

视频场景问题帧具体字段含义。

当没有视频问题帧时，该数组显示为空。

● 语音场景问题片段具体字段含义

voice_begin 起始时间。

voice_end 结束时间。

content 语音文本内容。

detail 该片段具体情况，politics为涉政检测结果，porn为涉黄检测结果。具体字段含义参考文本内容检测API文档。

(44)

voice_suggestion 该片段处理建议。

● block：建议禁止。

● 视频场景问题帧具体字段含义

frame_begin 起始帧位置。

单位：秒。

frame_end 结束帧位置。

单位：秒。

suspect_categories 该帧可疑的场景，其中有ocr前缀的为图片转文字后的审核结果。

frame_img_path 当该帧的frame_suggestion为review或者block时，并且创建视频作业时upload配置为true，会将当前帧作为图片保存到OBS上， frame_img_path表示图片的OBS 保存地址。

detail 该帧具体情况，politics为涉政检测结果，terrorism为暴恐检测结果，porn为涉黄检测结果。具体字段含义参考图像内容检测API文档以及上述的文本内容审核API 文档。

frame_suggestion 该帧处理建议。

● block：建议禁止。

返回值

● 正常 200

● 异常

返回值说明

码。

(45)

返回值说明

6.4 删除作业

功能介绍

该API用于删除指定作业。

URI

● URI格式

DELETE /v2/{project_id}/services/video-moderation/tasks/{task_id}

● 参数说明

project_

id 是 String 项目ID。获取方法请参见获取项目

ID。

请求消息

请求示例DELETE /v2/6204a5bd270343b5885144cf9c8c158d/services/video-moderation/tasks/

响应消息

}

error_code 错误码。具体请参考错误码。

返回值

● 正常

(46)

● 异常

返回值说明

码。

6.5 错误码说明

当服务处理出错后，返回的结果中会包含相应的错误码和错误信息，可用来定位错误原因。当找不到错误原因时，可以联系客服，并提供错误码，以便尽快帮您解决问题。

错误码错误信息描述处理措施

ALG.moderation

.001 decode error 视频或音频解析出错。

检查视频格式是否支持。

ALG.moderation

.500 Unknown error 视频或音频解析

出错。检查视频格式是否支

持。

ALG.002 - 视频下载失败。检查视频格式是否支

持。

VAS.AIS.

00000001.400 Unrecognized video format, Sorry we can't parse the video file.

视频解析错误。检查视频格式是否支持。

VAS.AIS.

00000002.400 Unrecognized audio format, Sorry we can't extract audio from the video file.

音频提取错误。检查视频格式是否支持。

VAS.AIS.

00000003.400 The request has been throttling, try later or reset the value of interval.

请求限流错误。请联系客服。

VAS.AIS.

00000004.400 The request

params *** error. 请求参数配置错误。

修改配置参数并重试。

(47)

错误码错误信息描述处理措施 VAS.AIS.

00000005.400 Please set obs output path, if you want to use upload service.

上传未配置obs桶

错误。配置上传obs桶并重

试。

VAS.AIS.

00000100.500 Service internal

error. 服务内部错误。请联系客服。

(48)

7 ^公共参数

7.1 任务输入/输出参数

task.input（任务输入参数）

● task.input参数说明

参数是否

必选

类型说明

type 是 String 视频数据的输入类型：

● obs：表示从华为云OBS中读取视频数据。

● url：表示从指定的URL地址中读取视频数据。

● edgecamera：表示从指定的边缘摄像头读取数据。

● vis：从视频接入服务中读取视频数据。

● edgerestful：表示从客户自定义的流媒体服务器读取数据。

● vcn ：表示从华为云VCN中读取视频数据。

API 参考 7 公共参数

(49)

参数是否必选

类型说明

data 是 Array of data

objects 数据输入内容：

● type为obs时，请参见obs.data字段数

据结构说明。

● type为url时，请参见url.data字段数据

结构说明。

● type为edgecamera时，请参见

edge.data字段数据结构说明。

● type为vis时，请参见vis.data字段数据

结构说明。

● type为edgerestful时，请参见

edgerestful.data字段数据结构说明。

● type为vcn时，请参见vcn.data字段数

据结构说明。

vcn 否 Object vcn的相关信息。当且仅当type为vcn时，

才需要填写，请参见type是vcn时，vcn字

段数据结构说明。

● 当type是obs时，data字段数据结构说明

bucket 是 String OBS桶名称。

path 是 String OBS桶内的路径，例如

“output/c1.mp4”。

● 当type是url时，data字段数据结构说明

url 是 String 视频数据的URL，目前支持

OBS URL，且需要设置该URL 对匿名用户可读权限。

● 当type是edgecamera时，data字段数据结构说明

id 是 String 边缘摄像头id。

● 当type是vis时，data字段数据结构说明

(50)

stream_name 是 String 视频接入服务中的视频流名称。

● 当type是edgerestful时，data字段数据结构说明

node_id 是 String 用于运行的边缘节点id, 下发边缘多任务作业时该字段不填写。

url 是 String 容器获取EDGERESTFUL流的rest请求。

格式：http(s):ip:port/xxx。

certificate_

check 是 Boolean true：算法侧需要对https请求进行证书校验。

false：算法侧无需证书校验。

默认值：false。

平台侧仅对齐进行输入校验，不涉及业务逻辑。

rtsp_path_i

n_response 是 String 返回body体中edgerestful流地址的路径，不能以/开头。例如：data/url。

● 当type是vcn时，data字段数据结构说明

node_id 否 String 用于运行的边缘节点id，下发边缘多任务作业时该字段不填写。

device_id 是 String 设备id号，符合正则表达式：^([0-9]

{20}[#]{1}[a-zA-Z0-9]{32})|([0-9]

{20}[#]{1}[0-9]{1,10}[#]{1}[a-zA- Z0-9]{32})$。

● 当type是vcn时，vcn字段数据结构说明

ip 是 String vcn服务器的IP地址。

port 是 String vcn服务器的端口号。

username 是 String vcn服务器的账号名。

password 是 String vcn服务器与上述账号对应的密码。

创建作业_视频分析服务 VAS_API参考_视频内容审核_华为云

视频分析服务

API 参考

华为技术有限公司

https://www.huawei.com

[email protected]

目 录

1 使用前必读... 1

1.1 概述... 1

1.2 终端节点...1

1.3 约束与限制... 2

1.4 基本概念...3

2 API 概览... 5

3 如何调用 API...6

3.1 开通服务...6

3.2 构造请求...7

3.3 认证鉴权... 11

3.4 返回结果... 12

4 视频分析服务 API...15

4.1 创建作业... 15

4.2 获取作业列表...17

4.3 获取作业详情...18

4.4 删除作业... 20

5 视频内容分析 API...22

5.1 视频 OCR... 22

5.1.1 创建视频 OCR 作业... 22

5.1.2 查询作业列表... 26

5.1.3 查询单个作业... 27

5.1.4 删除作业... 29

6 视频内容审核...31

6.1 创建作业... 31

6.2 查询作业列表...35

6.3 查询单个作业...36

6.4 删除作业... 41

6.5 错误码说明... 42

7 公共参数...44

7.1 任务输入/输出参数... 44

7.2 作业查询/详情参数... 50

8 附录... 54

8.1 状态码...54

8.2 错误码...56

8.3 获取项目 ID/账号名/AK/SK... 59

A 修订记录... 61

1 使用前必读

1.1 概述

概览。

1.2 终端节点

1.3 约束与限制

系统级约束限制

视频 OCR

视频内容审核

1.4 基本概念

2 API 概览

表2-1所示。

创建视频OCR作业

查询作业列表

查询单个作业

删除作业

创建作业

查询作业列表

查询单个作业

删除作业

3 如何调用 API

3.1 开通服务

商用功能的开通步骤。

功能的开通步骤。

邀测/商用功能的开通步骤

公测功能的开通步骤

功能的发布阶段

3.2 构造请求

请求 URI

请求方法

请求消息头

获取用户Token接口的响

请求消息体

username

domainname

********

cn-north-4

name。

目录

1 ^{使用前必读}

2 ^{API 概览}

3 ^{如何调用 API}