全部產品
Search
文件中心

Content Moderation:查詢人臉圖片

更新時間:Jul 06, 2024

調用getPersonFacesInfo介面查詢個體的人臉資訊,例如人臉圖片的ID、人臉圖片的URL。

QPS限制

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

請求文法

POST /green/sface/faces HTTPS|HTTP

要求標頭

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

請求參數

名稱

類型

是否必選

樣本值

描述

clientInfo

JSONObject

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

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

RequestBody

RequestBody中還需要輸入以下參數,用來指定要查詢的個體資訊。

名稱類型是否必選樣本值描述
personIdStringperson1要查詢的個體ID。
faceIdsArray["11111","2222"]人臉圖片的ID。
說明 如果您未輸入該參數,則返回指定個體ID下的所有人臉圖片的ID。

響應參數

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

說明

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

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

名稱類型樣本值描述
codeInteger200

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

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

faceImageItemsJSONArrayperson1指定個體的人臉對象列表。數組中每個元素是一個結構體。
successBooleantrue人臉資訊是否查詢成功。取值:
  • true:表示查詢成功。
  • false:表示查詢失敗。
faceIdLong2****************6人臉圖片的ID。
urlStringhttps://www.aliyundoc.com/aaa.jpg人臉圖片的URL。

樣本

請求樣本
POST /green/sface/faces HTTP/1.1
公用要求標頭
{
    "personId": "person1",
    "faceIds":["1111","22222"]
}
正常返回樣本
{
    "code":200,
    "requestId":"82E9202A-183F-4DDE-A45E-D554F8FA8D7B",
    "data":{
        "code":200,
        "faceImageItems":[
            {
                "success":true,
                "faceId":2****************6,
                "url":"https://www.aliyundoc.com/aaa.jpg"
            }
        ]
    }
}

錯誤碼

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