调用该接口查询指定用户组下的所有用户。
限制条件
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为100。
说明 RAM用户共享阿里云账号配额。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | QueryFaceAllUserIdsByGroupId | 系统规定参数。取值:QueryFaceAllUserIdsByGroupId。 |
IsolationId | String | 是 | ZheJiangHZ | 业务隔离ID,用于隔离同一个阿里云账号下不同业务应用之间的数据。请与调用AddFaceUserGroup接口创建用户组时设置的IsolationId保持一致。 |
PageNo | Integer | 是 | 1 | 指定从返回结果中的第几页开始显示。最小取值为1。 |
PageSize | Integer | 是 | 20 | 返回结果中,每页显示的记录数量。最大取值100,最小取值1,默认取值为20。 |
UserGroupId | String | 是 | kvjy**** | 用户组ID。请传入在调用AddFaceUserGroup接口创建用户组后,获取并保存到本地的用户组ID。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
Code | String | 200 | 接口返回码:
|
Data | Struct | 调用成功时,返回的数据。 |
|
List | Array of List | 用户信息列表。 |
|
CustomUserId | String | 1234567890 | 用户身份识别ID。 |
Name | String | TestName | 用户名。 |
Params | String | selfKey | 自定义参数。 |
UserId | String | 3mtjaqebeq4d**** | 用户ID。 |
Page | Integer | 1 | 当前页码。 |
PageSize | Integer | 20 | 返回结果中,每页显示的记录数量。 |
Total | Integer | 100 | 用户总数。 |
ErrorMessage | String | face group not exist | 调用失败时,返回的出错信息。 |
RequestId | String | 0A13279A-5640-45E7-87AA-83750541AD0E | 阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true | 是否调用成功:
|
示例
请求示例
http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryFaceAllUserIdsByGroupId
&IsolationId=ZheJiangHZ
&PageNo=1
&PageSize=20
&UserGroupId=kvjy****
&<公共请求参数>
正常返回示例
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
}
文档内容是否对您有帮助?