调用getPersonList获取个体列表_内容安全(Content Moderation)-阿里云帮助中心

调用getPersonList接口查询个体组下的所有个体ID。

QPS限制

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

请求语法

POST /green/sface/group/persons HTTPS|HTTP

请求头

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

请求参数

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

RequestBody

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

名称	类型	是否必选	示例值	描述
groupId	String	是	group1	要查询的个体组ID。
currentPage	Integer	否	1	返回的当前分页数，从 1 开始，默认值为 1。
pageSize	Integer	否	20	分页大小，默认值为 20，取值为 1-100。

返回数据

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

说明

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

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

名称	类型	示例值	描述
code	Integer	200	错误码，和HTTP状态码一致。更多信息，请参见公共错误码。
personIds	StringArray	["person1","person2"]	个体组下的所有个体ID列表。
currentPage	Integer	1	返回的当前分页数。
pageSize	Integer	20	返回的分页大小。
totalCount	Integer	100	总的共个体数。

示例

请求示例

POST /green/sface/group/persons HTTP/1.1
公共请求头
{
    "groupId": "group1",
    "pageSize": 10,
    "currentPage": 1
}

正常返回示例

{
    "msg": "OK",
    "code": 200,
    "requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
    "data": {
        "code": 200,
        "personIds": [
            "person1",
            "person2"
        ],
        "pageSize": 10,
        "currentPage": 1,
        "totalCount": 17
    }
}