调用addPerson新建个体_内容安全(Content Moderation)-阿里云帮助中心

调用addPerson接口新建一个个体。

新建个体时，您必须为个体指定一个或者多个个体组。如果您指定了一个不存在的个体组，则会自动创建该个体组。

说明

最多支持创建100个个体组。

新建个体后，您可以调用addFaces接口为个体添加关联的人脸图片。

QPS限制

本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。

请求语法

POST /green/sface/person/add HTTPS|HTTP

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求头。

请求参数

名称	类型	是否必选	示例值	描述
clientInfo	JSONObject	否	{"userId":"120234234","userNick":"Mike","userType":"others"}	客户端信息，由ClientInfo结构体通过JSON序列化获得，包含umid、imei等信息，具体结构描述，请参见ClientInfo。

RequestBody

RequestBody中还需要填入以下参数，用来指定个体信息。

名称	类型	是否必选	示例值	描述
groupIds	StringArray	是	["group1","group2"]	新建个体要加入的个体组ID列表。个体组ID仅支持使用英文字母、数字、下划线（_）和中划线（-），且不超过32个字符。说明如果您指定的个体组ID不存在，则会自动创建该个体组。
personId	String	是	person1	新建个体的ID。个体ID仅支持使用英文字母、数字、下划线（_）和中划线（-），且不超过32个字符。
name	String	否	Tom	新建个体的名称。
note	String	否	Male	新建个体的备注信息。

返回数据

所有请求均返回JSON格式的数据。关于返回数据中的公共字段，请参见公共返回参数。返回数据中的data字段表示与业务相关的数据，一般是一个JSON结构体或数组。

说明

响应出错的情况下，data字段可能为空。

该接口返回的data字段包含以下参数。

名称	类型	示例值	描述
code	Integer	200	错误码，和HTTP状态码一致。更多信息，请参见公共错误码。
personId	String	person1	新建个体的ID。
groupIds	StringArray	["group1","group2"]	新建个体对应的个体组ID列表。

示例

请求示例

POST /green/sface/person/add HTTP/1.1
公共请求头
{
    "personId": "person1",
    "groupIds": [
        "group1",
        "group2"
    ]
}

正常返回示例

{
    "code": 200,
    "requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
    "data": {
        "code": 200,
        "personId": "person1",
        "groupIds": [
            "group1",
            "group2"
        ]
    }
}

错误码

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