QueryFaceAllUserIdsByGroupId
調(diào)用該接口查詢指定用戶組下的所有用戶。
限制條件
單個(gè)阿里云賬號(hào)調(diào)用該接口的每秒請(qǐng)求數(shù)（QPS）最大限制為100。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求參數(shù)
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
| Action | String | 是 | QueryFaceAllUserIdsByGroupId | 系統(tǒng)規(guī)定參數(shù)。取值：QueryFaceAllUserIdsByGroupId。 |
| IsolationId | String | 是 | ZheJiangHZ | 業(yè)務(wù)隔離ID，用于隔離同一個(gè)阿里云賬號(hào)下不同業(yè)務(wù)應(yīng)用之間的數(shù)據(jù)。請(qǐng)與調(diào)用AddFaceUserGroup接口創(chuàng)建用戶組時(shí)設(shè)置的IsolationId保持一致。 |
| PageNo | Integer | 是 | 1 | 指定從返回結(jié)果中的第幾頁開始顯示。最小取值為1。 |
| PageSize | Integer | 是 | 20 | 返回結(jié)果中，每頁顯示的記錄數(shù)量。最大取值100，最小取值1，默認(rèn)取值為20。 |
| UserGroupId | String | 是 | kvjy**** | 用戶組ID。請(qǐng)傳入在調(diào)用AddFaceUserGroup接口創(chuàng)建用戶組后，獲取并保存到本地的用戶組ID。 |
調(diào)用API時(shí)，除了本文介紹的該API的特有請(qǐng)求參數(shù)，還需傳入公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)說明，請(qǐng)參見公共參數(shù)文檔。
返回?cái)?shù)據(jù)
| 名稱 | 類型 | 示例值 | 描述 |
| Code | String | 200 | 接口返回碼：
|
| Data | Struct | 調(diào)用成功時(shí)，返回的數(shù)據(jù)。 |
|
| List | Array of List | 用戶信息列表。 |
|
| CustomUserId | String | 1234567890 | 用戶身份識(shí)別ID。 |
| Name | String | TestName | 用戶名。 |
| Params | String | selfKey | 自定義參數(shù)。 |
| UserId | String | 3mtjaqebeq4d**** | 用戶ID。 |
| Page | Integer | 1 | 當(dāng)前頁碼。 |
| PageSize | Integer | 20 | 返回結(jié)果中，每頁顯示的記錄數(shù)量。 |
| Total | Integer | 100 | 用戶總數(shù)。 |
| ErrorMessage | String | face group not exist | 調(diào)用失敗時(shí)，返回的出錯(cuò)信息。 |
| RequestId | String | 0A13279A-5640-45E7-87AA-83750541AD0E | 阿里云為該請(qǐng)求生成的唯一標(biāo)識(shí)符。 |
| Success | Boolean | true | 是否調(diào)用成功：
|
示例
請(qǐng)求示例
http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryFaceAllUserIdsByGroupId
&IsolationId=ZheJiangHZ
&PageNo=1
&PageSize=20
&UserGroupId=kvjy****
&<公共請(qǐng)求參數(shù)>正常返回示例
XML格式
<QueryFaceAllUserIdsByGroupIdResponse>
<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>
<Data>
<PageSize>20</PageSize>
<Total>100</Total>
<Page>1</Page>
<List>
<UserId>3mtjaqebeq4d****</UserId>
<CustomUserId>1234567890</CustomUserId>
<Name>TestName</Name>
</List>
</Data>
<Code>200</Code>
<Success>true</Success>
</QueryFaceAllUserIdsByGroupIdResponse>JSON格式
{
"RequestId": "0A13279A-5640-45E7-87AA-83750541AD0E",
"Data": {
"PageSize": "20",
"Total": "100",
"Page": "1",
"List": [
{
"UserId": "3mtjaqebeq4d****",
"CustomUserId": "1234567890",
"Name": "TestName"
}
]
},
"Code": "200",
"Success": true
}