华为云用户手册

参数说明 表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：笑脸

调用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" } }

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。 详细处理步骤请参见如何处理账密报错。

参数说明 表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至少选一个。

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

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 face_number Integer 删除的人脸数量。 调用失败时无此字段。 face_set_id String 人脸库ID。 调用失败时无此字段。 face_set_name String 人脸库名称。 调用失败时无此字段。 状态码： 400 表5 响应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参数 参数名 参数类型 是否必选 说明 filter String 是 过滤条件，具体参见filter语法。

获取AK/SK 登录人脸识别管理控制台。 单击页面右上角的用户名，并选择“我的凭证”。 进入“我的凭证”页面。 单击“访问秘钥”页签下的“新增访问密钥”。 弹出“新增访问密钥”对话框。 输入“登录密码”，如果绑定了手机或者邮箱，还需要获取验证码并进行验证。 验证成功后，弹出访问密钥下载对话框。 单击“确定”，并根据提示下载保存访问密钥。 如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 父主题： 获取项目ID/账号名/AK/SK

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 face_set_info FaceSetInfo object 人脸库信息集合，详见FaceSetInfo。 调用失败时无此字段。 表4 FaceSetInfo 参数 参数类型 描述 face_number Integer 人脸库当中的人脸数量。 external_fields Object 用户的自定义字段。 face_set_id String 人脸库ID，随机生成的包含八个字符的字符串。 face_set_name String 人脸库名称。 create_date String 创建时间。 face_set_capacity Integer 人脸库最大的容量。 状态码： 400 表5 响应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 请求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参数 参数 参数类型 描述 face_set_id String 人脸库ID，随机生成的包含八个字符的字符串。 调用失败时无此字段。 face_set_name String 人脸库名称。 调用失败时无此字段。 faces Array of FaceSetFace objects 人脸库当中的人脸结构，详见FaceSetFace。 调用失败时无此字段。 表5 FaceSetFace 参数 参数类型 描述 bounding_box BoundingBox object 人脸在图像中的位置。 BoundingBox结构见BoundingBox。 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 调用失败时的错误信息。 调用成功时无此字段。