华为云用户手册

设备版本限制 远程配置功能与设备10.0.0版本配套，仅少数其他版本支持部分功能，设备配套关系表如下： 表1 设备配套关系 组网场景 NVR/IVS设备版本 SDC设备版本 适用功能 SDC直连 - SDC 9.0.0.LG0001 SDC 9.0.0.LG0002 SDC 9.0.0.SPC307 SDC 10.0.0及以上 全部 SDC 10.0RC11.SPC100 仅不支持视频编码参数 其他 不支持 NVR/IVS＋SDC透传 NVR 9.0.0 SPC6及以上版本 或 IVS 9.1.0及以上版本 SDC 9.0.0.LG0001 SDC 9.0.0.LG0002 SDC 9.0.0.SPC307 SDC 10.0.0及以上 全部 其他 不支持 其他 - 不支持

IdcardResult 身份证图像文字识别结果结构体。 表1 结构体说明 参数 类型 描述 name String 身份证上识别的名称。 number String 身份证号。 sex String 性别。 birth String 出生日期。 ethnicity String 民族。 address String 地址。 issue String 发证机关。 valid_from String 有效起始日期。 valid_to String 有效结束日期。 表2 VideoResult 参数 参数类型 描述 alive Boolean 是否是活体。 actions Array of ActionsList objects 动作列表。 picture String 检测出最大人脸的图片base64。 表3 ActionsList 参数 参数类型 描述 confidence Double 置信度，取值范围0～1。 action Integer 动作编号，取值范围：[1,2,3,4]，其中： 1：左摇头 2：右摇头 3：点头 4：嘴部动作 父主题： 公共数据结构

调用API获取项目ID 获取项目ID的接口为“GET https://{endpoint}/v3/projects”，其中“{endpoint}”为IAM的终端节点。接口的认证鉴权请参见认证鉴权。 响应示例如下，例如，人证核身服务部署的区域为“cn-north-4”，响应消息体中查找“name”为“cn-north-4”，其中“projects”下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22https://support-intl.huaweicloud.com/zh-cn/devg-apisign/api-sign-provide.htmlcd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

约束与限制 只支持“华北-北京一”、“华北-北京四”区域。 只支持中国大陆身份证的识别。 只支持JPG格式，图片中人像需无遮挡。 图像数据，base64编码，要求base64编码后大小不超过4MB。 图像各边的像素大小在300到8000px之间。 图像中身份证区域有效占比超过15%，保证整张身份证内容及其边缘包含在图像内。 支持图像中身份证要求水平放置。 目前支持检测视频文件，或视频的Base64编码，不支持直接检测视频流，需要用户客户端自己获取视频流并保存成文件，然后调用活体检测接口。 视频文件大小不超过8MB，建议客户端压缩到200KB~2MB。 限制视频时长1～15秒。 建议帧率10fps～30fps。 封装格式：mp4、avi、flv、webm、asf、mov。 视频编码格式：h261、h263、h264、hevc、vc1、vp8、vp9、wmv3。 父主题： 使用前必读

申请服务 正式使用服务之前，必须先申请开通服务，下面是相关服务申请的步骤。 申请人证核身服务之前，必须先申请华为云账号。 首次使用服务时，需要先申请开通该服务。服务只需要开通一次即可，后面使用时无需再次申请。如未开通服务，调用服务时会提示IVS.0015报错，请在调用服务前先进入控制台开通服务，并注意开通服务区域与调用服务的区域保持一致。 登录人证核身服务控制台。 选择需要使用的服务，在操作列单击“开通服务”。 图1 开通服务 服务开通成功后，开通状态显示“已开通”。 父主题： 如何调用API

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 说明 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的endpoint不同，您可以从地区和终端节点获取。 例如IVS服务在“华北-北京四”区域的“endpoint”为“ivs.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，也即API访问路径。 从具体API的URI模块获取，例如人证核身标准版（三要素）API的“resource-path”为“/v2.0/ivs-standard”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如，您需要在“华北-北京四”区域调用人证核身标准版（三要素）API，则需使用“华北-北京四”区域的Endpoint（ivs.cn-north-4.myhuaweicloud.com），并在标准版（三要素）的URI部分找到resource-path（/v2.0/ivs-standard），拼接起来如下所示。 https://ivs.cn-north-4.myhuaweicloud.com/v2.0/ivs-standard 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 人证核身标准版（三要素）的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://ivs.cn-north-4.myhuaweicloud.com/v2.0/ivs-standard

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于人证核身标准版（三要素）接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。 POST https://ivs.cn-north-4.myhuaweicloud.com/v2.0/ivs-standard Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT...Request Body:{ "meta": { "uuid": "user_defined" }, "data": { "req_data": [ { "idcard_image1": "/9j/4AAQSkZJRgABAgEASA...", "idcard_image2": "/9j/4AAAAABQSkZJRgABAgEASB...", "face_image": "/9j/4BBQSkZJRgABAgEASB..." } ] }} 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token请参考认证鉴权。 添加消息头后的请求如下所示。 POST https://ivs.cn-north-4.myhuaweicloud.com/v2.0/ivs-standardContent-Type: application/jsonx-auth-token: MIIaBgYJKoZIhvcNAQcC……

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于人证核身标准版（三要素）接口，返回如下消息体。 { "meta": { "uuid": "user_defined" }, "result": { "service_name": "ivs-standard", "count": 1, "resp_data": [ { "verification_result": "valid", "verification_message": "Successful certification", "verification_code": 1000, "similarity": "88.43", "idcard_result": { "name": "张三", "sex": "男", "birth": "2000-03-06", "ethnicity": "汉", "address": "XX省XX市XX区XX街道XX号", "number": "610XXXXXXXXXXXXXXX" } } ] }} 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_code": "IVS.0003", "error_msg": "Some necessary request parameters in req_data is null."} 其中，error_code表示错误码，error_msg表示错误描述信息。

状态码 HTTP 状态码为三位数，分成五个类别：1xx：相关信息；2xx：操作成功；3xx：重定向；4xx：客户端错误；5xx：服务器错误。 状态码如下所示。 状态码 编码 状态说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTPS的新版本协议。 200 OK 服务器已成功处理了请求。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 No Content 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址，使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 Bad Request 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 Not Found 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 Method Not Allowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Timeout 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request URI Too Long 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested Range Not Satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 Unprocessable Entity 请求格式正确，但是由于含有语义错误，无法响应。 429 Too Many Requests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 Internal Server Error 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 Service Unavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 Gateway Timeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version Not Supported 服务器不支持请求的HTTPS协议的版本，无法完成处理。 父主题： 附录

终端节点 终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询所有服务的终端节点。 人证核身的终端节点如表1所示，请您根据业务需要选择对应区域的终端节点。 表1 人证核身的终端节点 区域名称 区域 终端节点（Endpoint） 部署服务 华北-北京一 cn-north-1 ivs.cn-north-1.myhuaweicloud.com 标准版（三要素）、证件版（二要素） 华北-北京四 cn-north-4 ivs.cn-north-4.myhuaweicloud.com 标准版（三要素）、证件版（二要素） 父主题： 使用前必读

基本概念 账号 用户注册华为云时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证页面，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 华为云的区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 父主题： 使用前必读

终端节点 终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询所有服务的终端节点。 人脸识别服务的终端节点如表1所示，请您根据业务需要选择对应区域的终端节点。 表1 人脸识别服务终端节点 区域名称 区域 终端节点（Endpoint） 协议类型 部署的服务 华北-北京四 cn-north-4 face.cn-north-4.myhuaweicloud.com HTTPS 人脸检测，人脸比对，人脸搜索，静默活体检测，动作活体检测 华东-上海一 cn-east-3 face.cn-east-3.myhuaweicloud.com HTTPS 人脸检测，人脸比对，人脸搜索 华南-广州 cn-south-1 face.cn-south-1.myhuaweicloud.com HTTPS 人脸检测，人脸比对，人脸搜索，动作活体检测 中国-香港 ap-southeast-1 face.ap-southeast-1.myhuaweicloud.com HTTPS 人脸检测、人脸比对、人脸搜索 亚太-曼谷 ap-southeast-2 face.ap-southeast-2.myhuaweicloud.com HTTPS 人脸检测、人脸比对、人脸搜索 父主题： 使用前必读

人脸检测/比对/搜索 人脸比对输入的两张图片总大小小于8MB。 图片大小小于8MB，由于图片过大会导致图片在网络传输过程中耗时较长，建议小于1MB。 图片分辨率小于4096*4096，图片中人脸像素大于80*80，建议120*120以上。 为保证识别效果，人脸图片建议要求如下： 光照大于200lux、无反光强光阴影现象。 人脸无遮挡、整体清晰无拖尾抖动等运动模糊。 侧脸不超过30°、俯仰角小于15°、偏转角小于15°、图片中人脸保持竖置正脸。

动作活体检测 目前支持检测视频文件，或视频的Base64编码，不支持直接检测视频流，需要用户客户端自己获取视频流并保存成文件，然后调用活体检测接口。 视频文件大小不超过8MB，建议客户端压缩到200KB~2MB。 限制视频时长1～15秒。 建议帧率10fps～30fps。 封装格式：mp4、avi、flv、webm、asf、mov。 视频编码格式：h261、h263、h264、hevc、vc1、vp8、vp9、wmv3。

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于人脸检测接口，返回如下消息体。 { "faces": [ { "bounding_box": { "width": 174, "top_left_y": 37, "top_left_x": 22, "height": 174 }, "attributes": { "age": 35, "quality": { "total_score": 0.5869140625, "blur": 0.385498046875, "pose": 0.3349609375, "occlusion": 0.392333984375, "illumination": 0.3408203125 }, "expression": { "type": "happy", "probability": 0.74 } } } ]} 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_code": "FRS.0019", "error_msg": "The service has not been subscribed."} 其中，error_code表示错误码，error_msg表示错误描述信息，具体请参见错误码。

响应消息头 对应请求消息头，响应同样也有消息头，如“Content-type”。 表1 公共响应消息头 消息头名称 说明 是否必选 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 此字段携带流控单位。 类型：字符串。单位按照分钟、小时、天。 默认值：小时。 否

参数说明 表1 结构格式说明表 名称 类型 说明 face_set_name String 人脸库名称。 face_set_id String 人脸库ID，随机生成的包含八个字符的字符串。 create_date String 创建时间。 face_set_capacity Integer 人脸库最大的容量。 face_number Integer 人脸库当中的人脸数量。 external_fields Json 用户的自定义字段。

参数说明 表1 结构格式说明表 名称 类型 说明 alive Boolean 是否是活体。 picture String 检测出最大人脸的图片base64。 actions List 动作列表。详细参数请参见表 字段要素说明。 表2 actions字段要素说明 名称 类型 说明 action Integer 动作编号，取值范围：[1,2,3,4]，其中： 1：左摇头 2：右摇头 3：点头 4：嘴部动作 confidence Double 置信度，取值范围0～1。

参数说明 表1 结构格式说明表 名称 类型 说明 bounding_box BoundingBox object 人脸在图像中的位置。 BoundingBox结构见BoundingBox。 face_id String 人脸ID，由系统内部生成的唯一ID。 external_image_id String 人脸所在的外部图片ID。 similarity Double 人脸搜索时用于被检索的相似度。 external_fields Json 用户添加的额外自定义字段。

数据类型 支持String，Integer，Float，Double，Boolean，Long。 external_image_id，bounding_box，similarity，face_id，create_time，vector，_id，_all，_source为内置字段，自定义字段避免使用。 自定义字段总个数不能超过10个，key的长度范围为[1,36]，可以由数字、字母、下划线和中划线组成。 String类型的value长度范围为[1,256]，可以由数字、字母、下划线和中划线组成。 字段重复定义会被覆盖。 不支持数值类型添加后缀的输入方式，如1.0f，100L，1.0d等。

数值类型 数值类型的范围查询，[]包含两端点值，{}不包含两端点值。 rowkey:[1 TO *] 大于等于1 rowkey:[* TO 1] 小于等于1 rowkey:[1 TO 10] 1到10 单值。 rowkey:1 值为1 多条件，使用()区分优先级。 rowkey:[1 TO *] && externalImageID:1 (rowkey:[1 TO *] && externalImageID:1) || timestamp:1000 rowkey:[1 TO *] && (externalImageID:1 || timestamp:1000) 非，需要在非语句前后加括号。 externalImageID:1 && (!rowkey:2)

sort语法 json array形式，排序只支持数值类型，字段重复定义会被覆盖。 例1：单个排序字段 "sort":[ { "location": "desc" }] 例2：多个排序字段 "sort": [ { "timestamp": "desc" }, { "rowkey": "asc" }] 父主题： 公共数据结构

语法逻辑 "external_fields"以JSON形式定义，名称和类型对应。 Request Body:{ "face_set_name": "test", "face_set_capacity": "100000", "external_fields": { "location": { "type": "long" }, "timestamp": { "type": "integer" }, "male": { "type": "boolean" }, "title": { "type": "string" }, "weight": { "type": "double" }, "score": { "type": "float" } }}

参数说明 表1 结构格式说明表 名称 类型 说明 age Integer 年龄。 dress List of strings 包含glass和hat两个属性结果。 glass String 是否戴眼镜： yes：戴眼镜 none：未戴眼镜 unknown：未知 hat String 是否戴帽子： yes：戴帽子 none：未戴帽子 unknown：未知 mask String 是否戴口罩： yes：戴口罩 none：未戴口罩 unknown：未知 hair String 发型： long：长发 short：短发 unknown：未知 beard String 胡须： yes：有胡须 none：无胡须 unknown：未知 phototype String 图片类型： idcard：证件照 monitor：摄像头监控 internet photo：网络图片 smile String 笑脸。 quality FaceQuality 图片中人脸的遮挡度、模糊度、光照强度、姿态角度。 expression FaceExpression 人脸表情，包括中性、高兴、害怕、惊讶、伤心、生气、厌恶。 face_angle Integer 人脸图片旋转角（顺时针偏转角度），支持0°、90°、180°和270°图片旋转。 dress List of strings 包含glass和hat两个属性结果。 glass String 是否带眼镜： yes：带眼镜 dark：带墨镜 none：未戴眼镜 unknown：未知 hat String 是否带帽子： yes：带帽子 none：未戴帽子 unknown：未知 headpose List of doubles 人脸轮廓坐标值。 pitch_angle Double 围绕X轴旋转，俯仰角，范围[-180,180]。 roll_angle Double 围绕Z轴旋转，翻滚角，范围[-180,180]。 yaw_angle Double 围绕Y轴旋转，偏航角，范围[-180,180]。

参数说明 表1 结构格式说明表 名称 类型 说明 nose_contour List [Point] 鼻子轮廓，Point为轮廓坐标值。 mouth_contour List [Point] 嘴巴轮廓，Point为轮廓坐标值。 eyebrow_contour List [Point] 眉毛轮廓，Point为轮廓坐标值。 eyes_contour List [Point] 眼睛轮廓，Point为轮廓坐标值。 face_contour List [Point] 人脸轮廓，Point为轮廓坐标值。

API概览 人脸识别服务所提供的API，均符合RESTful API设计规范，如表1所示。 表1 人脸识别API 类型 API 说明 人脸检测 人脸检测 人脸检测是对输入图片进行人脸检测和分析，输出人脸在图像中的位置、人脸关键属性。 人脸比对 人脸比对 人脸比对是将两个人脸进行比对，来判断是否为同一个人，返回比对置信度。如果传入的图片中包含多个人脸，选取最大的人脸进行比对。 活体检测 动作活体检测 通过判断视频中的人物动作与传入动作列表是否一致来识别视频中人物是否为活体。如果有多张人脸出现，则选取最大的人脸进行判定。 静默活体检测 基于人脸图片中可能存在的畸变、摩尔纹、反光、倒影、边框等信息，判断图片中的人脸是否来自于真人活体，有效抵御纸质翻拍照、电子翻拍照以及视频翻拍等各种攻击方式。静默活体检测支持单张图片，不支持多人脸图片。 人脸搜索 人脸搜索 人脸搜索是指在已有的人脸库中，查询与目标人脸相似的一张或者多张人脸，并返回相应的置信度。 人脸库资源管理 创建人脸库 创建用于存储人脸特征的人脸库。您最多可以创建10个人脸库，每个人脸库最大容量为10万个人脸特征。如有更大规格的需求请联系客服。 查询所有人脸库 查询当前用户所有人脸库的状态信息。 查询人脸库 查询人脸库当前的状态。 删除人脸库 删除人脸库以及其中所有的人脸。人脸库数据为用户隐私数据，该数据无备份，删除时请谨慎操作。 人脸资源管理 添加人脸 添加人脸到人脸库中，检测到传入的单张图片中存在多少张人脸，则增加多少张人脸到人脸库当中。 查询人脸 查询指定人脸库中人脸信息。 更新人脸 根据人脸ID（face_id）更新单张人脸信息。 删除人脸 根据指定字段删除人脸库中人脸。 批量删除人脸 自定义筛选条件，批量删除人脸库中的符合指定条件的多张人脸。

状态码 表1 状态码 状态码 编码 说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 200 OK 服务器已成功处理了请求。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录

参数说明 表1 结构格式说明表 名称 类型 说明 total_score Double 人脸质量总分，取值范围[0-1]，分值越大质量越高。 blur Double 模糊度，取值范围[0-1]，分值越大模糊问题越严重。 pose Double 姿态，取值范围[0-1]，分值越大姿态问题越严重。 occlusion Double 遮挡，取值范围[0-1]，分值越大遮挡问题越严重。 illumination Double 光照，取值范围[0-1]，分值越大光照问题越严重。