全部產品
Search
文件中心

AI Guardrails:添加個體到個體組

更新時間:Jul 06, 2024

調用addPersonToGroup介面將個體添加到個體組。

您可以將一個個體添加到一個或者多個個體組。如果您指定了一個不存在的個體組,則會自動建立該個體組。
說明 最多支援建立100個個體組。

QPS限制

本介面的單使用者QPS限制為10次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。

請求文法

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

要求標頭

該介面使用公用要求標頭,無特殊要求標頭。請參見公用要求標頭

請求參數

名稱

類型

是否必選

樣本值

描述

clientInfo

JSONObject

{"userId":"120234234","userNick":"Mike","userType":"others"}

用戶端資訊,由ClientInfo結構體通過JSON序列化獲得,包含umid、imei等資訊,具體結構描述,請參見ClientInfo

RequestBody

RequestBody中還需要填入以下參數,用來指定個體和個體組資訊。
名稱類型是否必選樣本值描述
personIdStringperson1要操作的個體ID。
groupIdsStringArray["group1","group2"]個體要加入的個體組ID列表。
個體組ID僅支援使用英文字母、數字、底線(_)和中劃線(-),且不超過32個字元。
說明 如果您指定的個體組ID不存在,則會自動建立該個體組。

返回資料

所有請求均返回JSON格式的資料。關於返回資料中的公用欄位,請參見公用返回參數。返回資料中的data欄位表示與業務相關的資料,一般是一個JSON結構體或數組。

說明

響應出錯的情況下,data欄位可能為空白。

該介面返回的data欄位包含以下參數。

名稱類型樣本值描述
codeInteger200

錯誤碼,和HTTP狀態代碼一致。

更多資訊,請參見公用錯誤碼

personIdStringperson1個體ID。
groupIdsStringArray["group1","group2"]個體所屬的個體組ID列表。

樣本

請求樣本
POST /green/sface/person/groups/add HTTP/1.1
公用要求標頭
{
    "personId": "person1",
    "groupIds": [
        "group1",
        "group2"
    ]
}
正常返回樣本
{
    "msg": "OK",
    "code": 200,
    "requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
    "data": {
        "code": 200,
        "personId": "person1",
        "groupIds": [
            "group1",
            "group2"
        ]
    }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。