华为云用户手册

参数说明 表1 结构格式说明表 名称 类型 说明 alive Boolean 是否是活体。 picture String 检测出最大人脸的图片base64。 actions List 动作列表。详细参数请参见表 字段要素说明。 表2 actions字段要素说明 名称 类型 说明 action Integer 动作编号，取值范围：[1,2,3,4]，其中： 1：左摇头 2：右摇头 3：点头 4：嘴部动作 confidence Double 系统对检测对象是否为活体的判定置信程度，取值范围为0到1。置信度越高，表示系统越确定检测对象是一个真实的活体。可结合alive参数进行判断，alive返回true表示为活体。

状态码 表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协议的版本，无法完成处理。 父主题： 附录

错误码 调用API出错后，将不会返回结果数据。调用方可根据每个API对应的错误码来定位错误原因。当调用出错时，HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时，可以联系客服，并提供错误码，以便我们尽快帮您解决问题。 异常响应样例 { "error_code": "FRS.0202", "error_msg": " The service has been freeze." } 参数说明 参数 是否必选 类型 说明 error_code 否 String 错误码。 error_msg 否 String 错误消息。 错误码说明 错误码类别 状态码 错误码 说明 处理措施 服务类公共错误 （错误码区间：1～99） 403 FRS.0002 鉴权token失败，用户token错误或者已过期。 请参考认证鉴权章节，重新获取您的token信息，并使用获取的token来调用 人脸识别服务 的接口。 400 FRS.0010 缺少请求头或者请求头为空。 请参考构造请求章节，检查公共消息头是否配置。 400 FRS.0011 缺少参数。 请检查请求参数必填参数是否遗漏。 400 FRS.0012 请求参数格式不正确。 请检查参数输入的格式是否合法。 检查必填参数是否填写完整。 检查输入数据规格是否符合约束限制。 400 FRS.0013 输入的人脸图片尺寸过大或过小。 请上传符合规范的人脸图片。 人脸图片分辨率需小于4096*4096，图片中人脸像素大于80*80，建议120*120以上。 400 FRS.0014 输入的不是json格式。 请检查body体的json格式是否合法。 400 FRS.0015 图片base64解析错误。 使用Base64图像数据时，注意编码格式要与API文档中的请求示例保持一致。图片转base64方法可参考如何获取图片的base64编码 使用本地图片文件时，请检查文件是否为图片，且图片类型满足约束。 使用图片URL地址时，请检查URL是否为OBS地址，且地址为图片文件的路径。 400 FRS.0016 上传的文件格式不支持。 请参考约束与限制章节，上传支持识别的文件格式。 400 FRS.0017 上传的body体超出允许的范围。 上传的body体超出允许的范围，请检查图片和分辨率的大小是否在允许的范围内。 请参考约束与限制章节，使用符合规定的图片。 500 FRS.0018 服务内部错误。 请联系客服提供支持。 400 FRS.0019 服务未开通。 请登录 人脸识别 管理控制台，根据业务需求，选择需要开通的服务。 400 FRS.0020 子服务未开通。 请登录人脸识别管理控制台，根据业务需求，选择需要开通的子服务。 如已开通服务，请检查开通服务的区域（或账号）与调用服务的区域（或账号）是否一致；若一致请检查API的URL是否拼写正确。 400 FRS.0021 无效OBS的url。 请参考请求样例，检查OBS的url是否正确。 400 FRS.0023 OBS上的文件大小超出范围。 请参考约束与限制章节，检查OBS中文件的大小是否符合接口要求 400 FRS.0024 OBS上的文件不存在。 请检查OBS上的文件是否存在。 400 FRS.0027 OBS未授权。 请登录人脸识别管理控制台，点击右上角“服务授权”，完成OBS授权。 403 FRS.0028 Project ID跟Token不匹配。 请检查 获取Token 的Project ID是否和请求url上的Project ID一致。 400 FRS.0032 排序字段以及类型不支持，只支持数字类型。 排序字段以及类型不支持，只支持数字类型。请参考sort语法章节查看示例。 429 FRS.0033 当前请求数太多，超过流控限制。 建议控制请求策略或者进行重试，建议扩容以增加QPS配额。 400 FRS.0035 下载地址不合法。 请参考请求样例，检查OBS的url是否正确。 400 FRS.0036 从url获取文件失败。 请使用OBS提供的url上传图片，并检查url是否正确。 服务管理错误 （错误码区间：201～300） 400 FRS.0201 此用户已经注册了。 此用户已经注册了。 400 FRS.0202 服务已经被冻结。 请联系客服提供支持。 400 FRS.0203 更新用户信息失败。 请检查输入的用户信息。 人脸库资源错误 （错误码区间：301～400） 400 FRS.0301 无法创建已经存在的人脸库。 请检查输入的人脸库名称，创建的人脸库已存在，请更换人脸库名称后重新创建。 400 FRS.0302 人脸库不存在。 请检查输入的人脸库是否存在。 400 FRS.0304 未检测到人脸，无法搜索。 请参考约束与限制章节，上传符合规范的人脸图片。 400 FRS.0305 超过最大的人脸库数量，无法创建新的人脸库。 请检查人脸库数量是否超出限制联系客服提供支持。 403 FRS.0306 超过人脸库容量限制，无法增加更多的人脸。 请新增人脸库，重新添加人脸到新的人脸库中。 人脸资源错误 （错误码区间：401～500） 400 FRS.0401 找不到对应类型的值，无法删除。 请参考人脸资源管理接口说明。 400 FRS.0402 输入的字段不存在。 请参考人脸资源管理接口说明。 400 FRS.0403 Face ID不存在。 请检查输入的Face ID是否存在。 400 FRS.0404 未检测到人脸，无法添加。 请参考约束与限制章节，上传符合规范的人脸图片。 400 FRS.0405 未定义的自定义字段，无法添加。 请检查添加的自定义字段是否存在，创建自定义字段后再进行添加。 400 FRS.0406 导入的数据类型与定义不匹配。 请检查导入的数据类型是否与定义的数据类型一致。 400 FRS.0407 批量删除未找到匹配数据。 请检查需要删除的数据信息是否存在。 人脸比对错误 （错误码区间：501～600） 400 FRS.0501 照片未检测到人脸。 请参考约束与限制章节，上传符合规范的人脸图片。 人脸搜索错误码 （错误码区间：29～31） 400 FRS.0029 过滤格式错误。 请参考人脸搜索请求参数章节，检查输入格式是否合法。 400 FRS.0030 返回字段未定义。 请参考人脸搜索请求参数章节，检查return_fields是否定义。 400 FRS.0031 排序字段不在返回字段中。 请参考人脸搜素请求参数章节，检查排序字段是否定义。 活体检测错误 （错误码区间：701～800） 400 FRS.0701 视频解析错误。 请检查视频是否有损坏。 400 FRS.0702 不支持的动作。 请参考动作活体检测的请求参数，检查输入的动作是否存在。 400 FRS.0703 Action time非法。 请检查输入是否合法。 400 FRS.0704 传入的action数量超过10个。 传入的action数量超过10个。 400 FRS.0705 匹配模式不支持。 请参考约束与限制章节，检查输入是否合法。 400 FRS.0706 视频时长不支持，限制[1-15]秒。 视频时长超过限制[1-15]秒，请使用符合时长要求的视频。 400 FRS.0707 照片未检测到人脸。 请参考约束与限制章节，检查照片中是否有人脸或者人脸是否满足约束限制。 400 FRS.0708 检查输入的人脸图片质量是否满足要求。 请参考约束与限制章节，检查输入的人脸图片质量是否满足要求。 400 FRS.0751 视频数据解析失败。 请参考约束与限制章节，检查输入的视频是否满足要求。 400 FRS.0709 检查输入的人脸图片包含多张人脸。 请检查输入的人脸图片是否包含多张人脸，静默活体检测仅支持单人脸照片。 网关错误码 错误码类别 状态码 错误码 说明 处理措施 网关类错误 （错误码区间：1～400） 404 APIG.0101 访问的API不存在或尚未在环境中发布。 请检查API的URL是否拼写正确，例如，URL中是否缺少project_id。 检查URI中的区域信息是否和调用服务配置的区域是否对应。 HTTP请求方法（POST，GET等）是否正确。 具体的URI信息请在各接口的API页面查看。 413/504 APIG.0201 请求体超过范围或者后端超时。 请检查请求的大小是否合法，请联系客服检查后端服务是否运行正常。 401 APIG.0301 IAM 身份验证信息不正确： decrypt token fail：token解析失败。 token expires：token过期。 verify aksk signature fail：AK/SK认证失败。 token解析失败，请检查获取token的方法，请求体信息是否填写正确，token是否正确；检查获取token的环境与调用的环境是否一致。 token超时（token expires） ，请重新获取token，使用不过期的token。 请检查AK/SK是否正确（AK对应的SK错误，不匹配；AK/SK中多填了空格）。 AK/SK频繁出现鉴权出错，连续错误5次以上，被锁定5分钟（5分钟内，则一直认为其是异常的鉴权请求），5分钟后解锁重新认证。 检查账号权限，是否欠费，被冻结等。 401 APIG.0307 Token需要更新 Token有效期为24小时，请使用重新获取Token调用API。 检查接口URL中的终端节点是否填写正确。部署在不同区域间的服务，不可以跨区域调用。如果调用了不同区域的接口，导致判断为Token失效，显示APIG.0307错误码。 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 父主题： 附录

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

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

字符串类型 单值 title:quick Request Body示例： { "image_base64":"/9j/4AAQSkZJRgABAQAAAQABAAD...", "filter" : "id:zhangsan"} 多条件 title:quick && color:brown Request Body示例： { "image_base64":"/9j/4AAQSkZJRgABAQAAAQABAAD...", "filter" : "id:zhangsan && number:30"} 非，使用括号分隔 (!color:brown) Request Body示例： { "image_base64":"/9j/4AAQSkZJRgABAQAAAQABAAD...", "filter" : "(!id:zhangsan)"}

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

数值类型 数值类型的范围查询，[]包含两端点值，{}不包含两端点值。 rowkey:[1 TO *] 大于等于1 rowkey:[* TO 1] 小于等于1 rowkey:[1 TO 10] 1到10 Request Body示例： { "image_base64":"/9j/4AAQSkZJRgABAQAAAQABAAD...", "filter" : "number:[1 TO *]"} 单值。 rowkey:1 值为1 Request Body示例： { "image_base64":"/9j/4AAQSkZJRgABAQAAAQABAAD...", "filter" : "number:10"} 多条件，使用()区分优先级。 rowkey:[1 TO *] && externalImageID:1 (rowkey:[1 TO *] && externalImageID:1) || timestamp:1000 rowkey:[1 TO *] && (externalImageID:1 || timestamp:1000) Request Body示例： { "image_base64":"/9j/4AAQSkZJRgABAQAAAQABAAD...", "filter" : "number:[1 TO 20] && external_image_id:test"} 非，需要在非语句前后加括号。 externalImageID:1 && (!rowkey:2) Request Body示例： { "image_base64":"/9j/4AAQSkZJRgABAQAAAQABAAD...", "filter" : "external_image_id:test && (!number:10)"}

参数说明 表1 结果格式说明表 名称 类型 说明 project_id String 项目ID，获取方法请参见获取项目ID/账号名/AK/SK。 image_url String 图片的URL路径，目前仅支持华为云上OBS的URL，且人脸识别服务有权限读取该OBS桶的数据。开通读取权限的操作请参见服务授权。 image_file File 本地图片文件，图片不能超过8MB，建议小于1MB。上传文件时，请求格式为multipart。 image_base64 String 图像数据，Base64编码，要求： Base64编码后大小不超过8MB，建议。 图片为JPG/JPEG/BMP/PNG格式。 similarity Double 人脸相似度，1表示最大，0表示最小，值越大表示越相似。一般情况下超过0.93即可认为是同一个人。 face_set_name String 人脸库名称，1位到64位之间，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。 face_set_capacity Integer 人脸库最大的容量，填写1万整数倍的数字，例如30000。默认为100000，最大值为100000，可通过创建新的人脸库进行扩容，每个用户可使用10个人脸库，每个人脸库容量为10万个人脸特征。如需扩容单个人脸库规模，请联系华为云客服确认扩容规模与价格。 face_id String 导入人脸时，系统返回的人脸编号，为8个随机生成的大小写字母组成。 external_image_id String 用户指定的图片外部ID，与当前图像绑定。用户没提供，系统会生成一个。该ID长度范围为1～36位，可以包含字母、数字、中划线或者下划线，不包含其他的特殊字符。 external_fields Json 根据用户自定义数据类型，填入相应的数值。创建人脸库时，定义该字段。具体参见自定义字段。 top_n Integer 返回查询到最相似的N张人脸，N默认为10。如果返回前5个，则该变量N的值为5。 取值范围1～1000。 threshold Double 人脸相似度阈值，低于这个阈值则不返回，取值范围[0,1]，一般情况下建议取值0.93，默认为0。 offset Integer 从第几条数据读起，默认为0。 limit Integer 读取多少条，默认为5。 video_url String 视频的URL路径，目前仅支持华为云上OBS的URL，且人脸识别服务有权限读取该OBS桶的数据。开通读取权限的操作请参见服务授权。视频要求： 视频Base64编码后大小不超过8MB。 限制视频时长1～15秒。 建议帧率10fps～30fps。 封装格式：mp4、avi、flv、webm、asf、mov。 视频编码格式： h261、h263、h264、hevc、vc1、vp8、vp9、wmv3。 video_file File 本地视频文件。上传文件时，请求格式为multipart。视频要求： 视频文件大小不超过8MB，建议客户端压缩到200KB~2MB。 限制视频时长1～15秒。 建议帧率10fps～30fps。 封装格式：mp4、avi、flv、webm、asf、mov。 视频编码格式： h261、h263、h264、hevc、vc1、vp8、vp9、wmv3。 video_base64 String 视频数据，Base64编码，要求： Base64编码后大小不超过8MB，建议客户端压缩到200KB~2MB。 限制视频时长1～15秒。 建议帧率10fps～30fps。 封装格式：mp4、avi、flv、webm、asf、mov。 视频编码格式： h261、h263、h264、hevc、vc1、vp8、vp9、wmv3。 actions String 动作代码顺序列表，英文逗号（,）分隔。建议单动作，目前支持的动作有： 1：左摇头 2：右摇头 3：点头 4：嘴部动作 action_time String 该参数为动作时间数组拼接的字符串，数组的长度和actions的数量一致，每一项代表了对应次序动作的起始时间和结束时间，单位为距视频开始的毫秒数。 error_code String 调用失败时的错误码。 error_msg String 调用失败时的错误信息。 attributes String 是否返回人脸属性，希望获取的属性列表，多个属性用逗号隔开。目前支持的属性有： 0：人脸姿态 2：年龄 3：人脸关键点 4：装束（帽子、眼镜） 5：笑脸

APIG.0101 在调用人脸识别接口时，报错“APIG.0101”，“The API does not exist or has not been published in the environment”。该报错表示调用接口时使用的请求地址或者URL不存在或没有发布。 参考API使用说明获取正确的请求样例，并检查请求样例中需要修改的参数“{endpoint}”、{project_id}，是否按规范进行替换。同时检查url中填写的endpoint区域时否和开通服务区域一致。 参考API使用说明获取正确的请求样例。 # 查询服务状态https://{endpoint}/v1/{project_id}/subscribe 将请求样例中的“{endpoint}”进行替换。人脸识别服务的请求地请参考终端节点终端节点章节进行获取。 例如，如果您的服务部署在华北-北京四区域，则该区域的endpoint为“face.cn-north-4.myhuaweicloud.com”。 将请求样例中的“{project_id}”进行替换。项目ID的获取方法请参见获取项目ID。 URL请参考构造请求构造请求章节。

操作场景 本节内容介绍了调用API时，常见的报错及处理办法。 表1 调用API高频报错处理办法 常见报错 处理办法 FRS.0020子服务未开通 开通该服务，检查开通服务的区域（或账号）与调用服务的区域（或账号）是否一致，检查API的URL是否拼写正确。 APIG.0101 检查请求地址或者URL是否填写正确。 账密报错The username or password is wrong 请确认近期华为云账号是否有升级为华为账号。如果进行过升级，建议您创建一个IAM账户，使用该账户获取Token。

FRS.0020子服务未开通 在调用人脸识别接口时，报错“FRS.0020”，子服务未开通。该报错表示您的子服务没有开通，或url填写错误。 如未开通服务请登录人脸识别服务控制台人脸识别服务控制台选择“开通服务”。 如已经开通服务，请检查调用接口的请求地址是否正确。 您还可以通过这个视频教程了解如何构造请求调用API：https://bbs.huaweicloud.com/videos/102987。 图1 检查区域信息

账密报错The username or password is wrong 获取Token时出现“The username or password is wrong.”。 请确认近期华为云账号是否有升级为华为账号。当前，如果您通过华为账号入口登录华为云账号，就会指引升级。华为云账号若已升级为华为账号，将不支持获取账号Token。 建议您创建一个IAM账户，使用该账户获取Token。 详细处理步骤请参见如何处理账密报错。

调用API获取项目ID 项目ID还可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。选中“Headers”配置项，添加“KEY”为“X-Auth-Token”，“VALUE”为获取的Token值，详细的接口认证鉴权请参见认证鉴权。 响应示例如下，例如人脸识别服务部署的区域为“cn-north-1”，响应消息体中查找“name”为“cn-north-1”，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-1", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

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

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 faces Array of DetectFace objects 检测到的人脸。 调用失败时无此字段。 表5 DetectFace 参数 参数类型 描述 bounding_box BoundingBox object 人脸在图像中的位置。 attributes Attributes object 人脸关键属性，比如头部姿态。 表6 BoundingBox 参数 参数类型 描述 width Integer 人脸图像所在矩形框的宽度。 top_left_y Integer 矩形框左上角纵坐标。 top_left_x Integer 矩形框左上角横坐标。 height Integer 人脸图像所在矩形框的高度。 表7 Attributes 参数 参数类型 描述 dress Dress object 包含glass和hat两个属性结果。 glass String 是否戴眼镜： yes：戴眼镜 dark：戴墨镜 none：未戴眼镜 unknown：未知 hat String 是否戴帽子： yes：戴帽子 none：未戴帽子 unknown：未知 age Integer 年龄。 mask String 是否戴口罩： yes：戴口罩 none：未戴口罩 unknown：未知 beard String 胡须： yes：有胡须 none：无胡须 unknown：未知 phototype String 图片类型： idcard：证件照 monitor：摄像头监控 internet photo：网络图片 quality FaceQuality object 图片中人脸的遮挡度、模糊度、光照强度、姿态角度。 hair String 发型： long：长发 short：短发 unknown：未知 expression expression object 人脸表情，包括中性、高兴、害怕、惊讶、伤心、生气、厌恶。 face_angle Integer 人脸图片旋转角（顺时针偏转角度），支持0°、90°、180°和270°图片旋转。 表8 Dress 参数 参数类型 描述 glass String 是否戴眼镜： yes：戴眼镜 dark：戴墨镜 none：未戴眼镜 unknown：未知 hat String 是否戴帽子： yes：戴帽子 none：未戴帽子 unknown：未知 表9 FaceQuality 参数 参数类型 描述 推荐值 total_score Double 人脸质量总分，取值范围[0-1]，分值越大质量越高。 大于0.45 blur Double 模糊度，取值范围[0-1]，分值越大模糊问题越严重。 小于0.3 pose Double 姿态，取值范围[0-1]，分值越大姿态问题越严重。 小于0.3 occlusion Double 遮挡，取值范围[0-1]，分值越大遮挡问题越严重。 小于0.3 illumination Double 光照，取值范围[0-1]，分值越大光照问题越严重。 小于0.3 表10 expression 参数 参数类型 描述 type String 人脸表情类型： neutral：中性 happy：高兴 fear：害怕 surprise：惊讶 sad：伤心 angry：生气 disgust：厌恶 unknown：图片质量问题导致未识别 probability Double 表情置信度，取值范围[0-1]。 状态码： 400 表11 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。FRS支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账，当前仅支持按需计费模式。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用FRS服务，账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID，正常使用FRS服务，账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID（包含特殊字符等），正常使用FRS服务，账单的企业项目会被分类到"default"中。 表3 请求Body参数 参数名 是否必选 参数类型 说明 image_url 与image_file、image_base64三选一 String 图片的URL路径，目前仅支持华为云上OBS的URL，使用时只需保证FRS有权限读取该OBS桶的数据。开通读取权限的操作请参见服务授权。 OBS URL格式如下，可在OBS控制台获取。 https://BucketName.obs.xxxx.com/ObjectName image_file 与image_url、image_base64三选一 File 本地图片文件，要求： 图片不能超过8MB，建议小于1MB。 上传文件时，请求格式为multipart。 image_base64 与image_file、image_url三选一 String 图像数据，Base64编码，要求： Base64编码后大小不超过8MB，建议小于1MB。 图片为JPG/JPEG/BMP/PNG格式。 attributes 否 String 是否返回人脸属性，希望获取的属性列表，多个属性间使用逗号（,）隔开。目前支持的属性有： 2：年龄 4：装束（帽子、眼镜） 6：口罩 7：发型 8：胡须 11：图片类型 12：质量 13：表情 21：人脸图片旋转角（顺时针偏转角度），支持0°、90°、180°和270°图片旋转。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 face_number Integer 删除的人脸数量。 调用失败时无此字段。 face_set_id String 人脸库ID。 调用失败时无此字段。 face_set_name String 人脸库名称。 调用失败时无此字段。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。FRS支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账，当前仅支持按需计费模式。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用FRS服务，账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID，正常使用FRS服务，账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID（包含特殊字符等），正常使用FRS服务，账单的企业项目会被分类到"default"中。

URI DELETE /v2/{project_id}/face-sets/{face_set_name}/faces?field_name=field_value 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参见获取项目ID/账号名/AK/SK。 face_set_name 是 String 人脸库名称。 field_name 是 String 按条件删除的字段名，支持固定字段（external_image_id和face_id），以及用户的自定义字段（不支持空字符串和null值删除）。

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 face_set_info FaceSetInfo object 人脸库信息，详见FaceSetInfo。 调用失败时无此字段。 表6 FaceSetInfo 参数 参数类型 描述 face_number Integer 人脸库中已有的人脸特征的数量。 external_fields Object 用户的自定义字段。 face_set_id String 人脸库ID，随机生成的包含八个字符的字符串。 face_set_name String 人脸库名称。 create_date String 创建时间。 face_set_capacity Integer 人脸库最大的容量。创建人脸库时，请求参数如果不设置face_set_capacity参数，默认每个人脸库最大容量为10万个人脸特征。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

功能介绍 创建用于存储人脸特征的人脸库。您最多可以创建10个人脸库，每个人脸库最大容量为10万个人脸特征。如有更大规格的需求请联系客服。 前提条件： 请确保您已开通人脸搜索服务。 默认情况下，一个人脸库最大可支持10万个人脸特征，一个用户最多可创建10个人脸库，最多可支持10*10万（100万）个人脸特征。 如您的需求超出100万个人脸特征，可通过工单或者服务热线（ 4000-955-988或950808 转1）与我们联系，咨询具体解决方案。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。FRS支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账，当前仅支持按需计费模式。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用FRS服务，账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID，正常使用FRS服务，账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID（包含特殊字符等），正常使用FRS服务，账单的企业项目会被分类到"default"中。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 image1_face CompareFace object 第1幅图像中检测到的人脸，DetectFace结构见DetectFace。 调用失败时无此字段。 image2_face CompareFace object 第2幅图像中检测到的人脸，DetectFace结构见DetectFace。 调用失败时无此字段。 similarity Double 人脸相似度，1表示最大，0表示最小，值越大表示越相似。一般情况下超过0.93即可认为是同一个人。如果图片质量较低，也会影响相似度。 调用失败时无此字段。 表5 CompareFace 参数 参数类型 描述 bounding_box BoundingBox object 人脸在图像中的位置。 表6 BoundingBox 参数 参数类型 描述 width Integer 人脸图像所在矩形框的宽度。 top_left_y Integer 矩形框左上角纵坐标。 top_left_x Integer 矩形框左上角横坐标。 height Integer 人脸图像所在矩形框的高度。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。FRS支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账，当前仅支持按需计费模式。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用FRS服务，账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID，正常使用FRS服务，账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID（包含特殊字符等），正常使用FRS服务，账单的企业项目会被分类到"default"中。 表3 请求Body参数 参数名 参数类型 是否必选 说明 image1_url String 与image1_file、image1_base64三选一 图片的URL路径，目前仅支持华为云上OBS的URL，使用时只需保证FRS有权限读取该OBS桶的数据。开通读取权限的操作请参见服务授权。 OBS URL格式如下，可在OBS控制台获取。 https://BucketName.obs.xxxx.com/ObjectName image1_file File 与image1_url、image1_base64三选一 本地图片文件，要求： 图片不能超过8MB，建议小于1MB。 上传文件时，请求格式为multipart。 image1_base64 String 与image1_file、image1_url三选一 图像数据，Base64编码，要求： Base64编码后大小不超过8MB，建议小于1MB。 图片为JPG/JPEG/BMP/PNG格式。 image2_url String 与image2_file、image2_base64三选一 图片的URL路径，目前仅支持华为云上OBS的URL，且人脸识别服务有权限读取该OBS桶的数据。开通读取权限的操作请参见服务授权。 image2_file File 与image2_url、image2_base64三选一 本地图片文件，要求： 图片不能超过8MB，建议小于1MB。 上传文件时，请求格式为multipart。 image2_base64 String 与image2_file、image2_url三选一 图像数据，Base64编码，要求： Base64编码后大小不超过8MB，建议小于1MB。 图片为JPG/JPEG/BMP/PNG格式。

功能介绍 人脸比对是将两个人脸进行比对，来判断是否为同一个人，返回比对置信度。如果传入的图片中包含多个人脸，选取最大的人脸进行比对。 前提条件： 请确保您已开通人脸识别服务，具体操作方法请参见申请服务。 约束限制： 人脸比对输入的两张图片总大小。 只支持识别JPG、PNG、JPEG、BMP格式的图片。 application/json请求的body中，请使用标准Json格式。 Base64编码中请勿使用回车换行。 系统不保存用户图片。 图片大小小于8MB，由于过大图片会导致时延较长，并且图片信息量不大，建议小于1MB。 图片分辨率小于4096*4096，图片中人脸像素大于80*80，建议120*120以上。 为保证识别效果，人脸图片建议要求如下： 光照大于200lux、无反光强光阴影现象。 人脸无遮挡、整体清晰无拖尾抖动等运动模糊。 侧脸不超过30°、俯仰角小于15°、偏转角小于15°、图片中人脸保持竖置正脸。 具体的约束限制信息请参见约束与限制章节。 建议： 由于过大图片对识别算法精度无明显提升，同时会导致时延较长，建议传入图片小于1MB，一般500KB左右足够。 OBS上存储的图片也建议小于1MB。 图片中人脸像素建议120*120以上。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 faces Array of SearchFace objects 查找的人脸集合，详见SearchFace。 调用失败时无此字段。 表5 SearchFace 参数 参数类型 描述 bounding_box BoundingBox object 人脸在图像中的位置。 similarity Double 人脸搜索时用于被检索的相似度。 external_fields Object 用户添加的额外自定义字段。 external_image_id String 人脸所在的外部图片ID。 face_id String 人脸ID，由系统内部生成的唯一ID。 表6 BoundingBox 参数 参数类型 描述 width Integer 矩形框宽度。 top_left_y Integer 矩形框左上角纵坐标。 top_left_x Integer 矩形框左上角横坐标。 height Integer 矩形框高度。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。FRS支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账，当前仅支持按需计费模式。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用FRS服务，账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID，正常使用FRS服务，账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID（包含特殊字符等），正常使用FRS服务，账单的企业项目会被分类到"default"中。 表3 请求Body参数 参数名 参数类型 是否必选 说明 image_url String 与image_file、image_base64、face_id四选一 图片的URL路径，目前仅支持华为云上OBS的URL，使用时只需保证FRS有权限读取该OBS桶的数据。开通读取权限的操作请参见服务授权。 image_file File 与image_url、image_base64、face_id四选一 本地图片文件，图片不能超过8MB，建议小于1MB。上传文件时，请求格式为multipart。 image_base64 String 与image_file、image_url、face_id四选一 图像数据，Base64编码，要求： Base64编码后大小不超过8MB，建议小于1MB。 图片为JPG/JPEG/BMP/PNG格式。 face_id String 与image_file、image_base64、image_url四选一 导入人脸时，系统返回的人脸编号，即人脸ID。 top_n Integer 否 返回查询到的最相似的N张人脸，N默认为10，取值范围[0,1000]。 N张人脸按照置信度降序排序，置信度越大越靠前。 threshold Double 否 人脸相似度阈值，低于这个阈值则不返回，取值范围[0,1]，一般情况下建议取值0.93，默认为0。 sort JsonArray 否 支持字段排序，参考sort语法。 filter String 否 过滤条件，参考filter语法。 return_fields JsonArray 否 指定返回的自定义字段。

功能介绍 人脸搜索是指在已有的人脸库中，查询与目标人脸相似的一张或者多张人脸，并返回相应的置信度。如果图片中包含多个人脸，选取图片中检测到的最大尺寸人脸作为检索的输入。 支持传入图片或者faceID进行人脸搜索。 前提条件： 请确保您已开通人脸识别服务，具体操作方法请参见申请服务。 约束限制： 只支持识别JPG、PNG、JPEG、BMP格式的图片。 application/json请求的body中，请使用标准Json格式。 Base64编码中请勿使用回车换行。 系统不保存用户图片。 图片大小小于8MB，由于过大图片会导致时延较长，并且图片信息量不大，建议小于1MB。 图片分辨率小于4096*4096，图片中人脸像素大于80*80，建议120*120以上。 为保证识别效果，人脸图片建议要求如下： 光照大于200lux、无反光强光阴影现象。 人脸无遮挡、整体清晰无拖尾抖动等运动模糊。 侧脸不超过30°、俯仰角小于15°、偏转角小于15°、图片中人脸保持竖置正脸。 其他的约束限制信息请参见约束与限制章节。 建议： 由于过大图片对识别算法精度无明显提升，同时会导致时延较长，建议传入图片小于1MB，一般500KB左右足够。 OBS上存储的图片也建议小于1MB。 图片中人脸像素建议120*120以上。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。FRS支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账，当前仅支持按需计费模式。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 说明： 创建企业项目后，在传参时，有以下三类场景。 携带正确的ID，正常使用FRS服务，账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID，正常使用FRS服务，账单的企业项目会显示对应不存在的企业项目ID。 携带正确的ID，正常使用FRS服务，账单的企业项目会被分类到企业ID对应的企业项目中。 表3 请求Body参数 参数名 参数类型 是否必选 说明 face_id String 是 人脸ID，由系统内部生成的唯一ID。 external_image_id String 否 用户指定的图片外部ID，与当前图像绑定。用户不设置该参数时，系统会自动生成一个。该ID长度范围为[1,36]，可以包含字母、数字、中划线或者下划线，不包含其他的特殊字符。 这里是待修改的参数，external_image_id和external_fields至少选一个。 external_fields Object 否 自定义字段的key值长度范围为[1,36]，string类型的value长度范围为[1,256]，具体参见自定义字段。 这里是待修改的参数，external_image_id和external_fields至少选一个。