文档

RegisterCustomFace - 注册⾃定义⼈脸

更新时间:

注册⼀张⾃定义⼈脸。

接口说明

  • 本接口一次仅能注册一张自定义人脸。
  • 一个自定义人脸最多注册 10 张图像。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mts:RegisterCustomFace
  • 全部资源
    *

请求参数

名称类型必填描述示例值
CategoryIdstring

⼈物库 ID,⽤于唯⼀标识⼀个⾃定义⼈物库。由调⽤者⽣成,调⽤者⾃⼰保证唯⼀性(请妥善保存此 ID 便于后续调用其他接口时使用),注意不能与系统⼈物库 ID 相同,如果相同则默认使用系统人物库。最⻓⽀持 120 字符,不限中英文,不区分⼤⼩写。

CategoryId001-****
PersonIdstring

⼈物 ID,⽤于唯⼀标识⼀个⾃定义⼈物。由调⽤者⽣成,调⽤者⾃⼰保证唯⼀性(请妥善保存此 ID 便于后续调用其他接口时使用) 。最⻓⽀持 120 字符,不限中英文,不区分⼤⼩写,返回 FaceId 为 String 类型。

PersonId001-****
ImageUrlstring

需要注册的⼈脸图⽚公网地址,图⽚中有且仅包含⼀张正脸。

http://example-****.jpeg

返回参数

名称类型描述示例值
object

返回数据。

FaceIdstring

⼈脸 ID。

c6cc71cb44a9491093818faf9d60****
RequestIdstring

请求 ID。

91AEA76D-25B5-50DF-9126-AA6BB10FDAF4

示例

正常返回示例

JSON格式

{
  "FaceId": "c6cc71cb44a9491093818faf9d60****",
  "RequestId": "91AEA76D-25B5-50DF-9126-AA6BB10FDAF4"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParametererrorMsg:%s-
500InternalErrorerrorMsg:%s内部错误,偶发请重试。

访问错误中心查看更多错误码。