本文中含有需要您注意的重要提示信息,忽略該信息可能對您的業務造成影響,請務必仔細閱讀。
調用deletePerson接口刪除指定個體。
警告 刪除個體時,與個體關聯的人臉圖片也將被刪除。請謹慎操作。
QPS限制
本接口的單用戶QPS限制為20次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。
請求語法
POST /green/sface/person/delete HTTPS|HTTP
請求頭
該接口使用公共請求頭,無特殊請求頭。請參見公共請求頭。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
clientInfo | JSONObject | 否 | {"userId":"120234234","userNick":"Mike","userType":"others"} | 客戶端信息,由ClientInfo結構體通過JSON序列化獲得,包含umid、imei等信息,具體結構描述,請參見ClientInfo。 |
RequestBody
RequestBody中還需要填入以下參數,用來指定要刪除的個體信息。
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
personId | String | 是 | person1 | 要刪除的個體ID。 |
返回數據
所有請求均返回JSON格式的數據。關于返回數據中的公共字段,請參見公共返回參數。返回數據中的data字段表示與業務相關的數據,一般是一個JSON結構體或數組。
說明
響應出錯的情況下,data字段可能為空。
該接口返回的data字段包含以下參數。
名稱 | 類型 | 示例值 | 描述 |
code | Integer | 200 | 錯誤碼,和HTTP狀態碼一致。 更多信息,請參見公共錯誤碼。 |
personId | String | person1 | 已被刪除的個體ID。 |
deleteCount | Integer | 1 | 成功刪除的個體數量。 |
示例
請求示例
POST /green/sface/person/delete HTTP/1.1
公共請求頭
{
"personId": "person1"
}
正常返回示例
{
"msg": "OK",
"code": 200,
"requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
"data": {
"code": 200,
"personId": "person1",
"deleteCount": 1
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
文檔內容是否對您有幫助?