调用ListFaceGroups接口获取一个媒体集中的人脸分组列表。
接口说明
-
此接口已不再维护,建议使用新版(2020-09-30 版本)接口 QueryFigureClusters 。关于新版与旧版 API 的对比,请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。
-
如果需要根据标记信息等查询人脸分组,必须已调用 UpdateFaceGroup 接口为人脸分组配置相应信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
imm:ListFaceGroups | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Project | string | 是 | 项目名称。 | immimagetest |
SetId | string | 是 | 媒体集的唯一标识。 | set001 |
Marker | string | 否 | 从 Marker 开始按字典序返回人脸分组信息列表。如果不设置此参数,则从头开始返回人脸分组信息。 | CAESEQoPCg0KCUZhY2VDb3VudBABGAEirQEKCQAFAAAAAAAAAAqfAQOaAAAAMVMzMTM3MzQzNjM0MzkzNTM4MzUzNzM2MzAzMjM3MzQzNTNhNjk2ZDZkNjk2ZDYxNjc2NTNhNzM2NTc0NzQ2NTczNzQuUzQ3NzI2Zjc1NzAyZDM0Mzg2NjY0NjQzNDYyNjQyZDM2MzI2MzMzMmQzNDY0NjE2MTJkNjE2NDM5MzgyZDYxNjUzNjYxMzQzMTM3MzM2MTMxMzMzMA== |
Limit | integer | 否 | 返回人脸分组的最大个数,默认值为 20,取值范围为 1~100。 | 5 |
Order | string | 否 | 排序方式,默认值为 DESC。
| DESC |
OrderBy | string | 否 | 排序字段,默认值为 FaceCount。
| FaceCount |
RemarksAQuery | string | 否 | 标记信息查询条件,包括如下四种查询方式,可根据实际选择其中若干项条件进行查询。
| {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]} |
RemarksBQuery | string | 否 | 标记信息查询条件,包括如下四种查询方式,可根据实际选择其中若干项条件进行查询。
| {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]} |
RemarksCQuery | string | 否 | 标记信息查询条件,包括如下四种查询方式,可根据实际选择其中若干项条件进行查询。
| {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]} |
RemarksDQuery | string | 否 | 标记信息查询条件,包括如下四种查询方式,可根据实际选择其中若干项条件进行查询。
| {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]} |
RemarksArrayAQuery | string | 否 | 标记信息查询条件,包括如下四种查询方式,可根据实际选择其中若干项条件进行查询。
| {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]} |
RemarksArrayBQuery | string | 否 | 标记信息查询条件,包括如下四种查询方式,可根据实际选择其中若干项条件进行查询。
| {"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]} |
ExternalId | string | 否 | 外部 ID,用于和您的应用层的 ID(如果有)进行绑定。查询类型为精确匹配。 | externalId001 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "6CD6F064-6999-4B64-B057-5FBD09E48C46",
"NextMarker": "CAESEQoPCg0KCUZhY2VDb3VudBABGAEirQEKCQAFAAAAAAAAAAqfAQOaAAAAMVMzMTM3MzQzNjM0MzkzNTM4MzUzNzM2MzAzMjM3MzQzNTNhNjk2ZDZkNjk2ZDYxNjc2NTNhNzM2NTc0NzQ2NTczNzQuUzQ3NzI2Zjc1NzAyZDM0Mzg2NjY0NjQzNDYyNjQyZDM2MzI2MzMzMmQzNDY0NjE2MTJkNjE2NDM5MzgyZDYxNjUzNjYxMzQzMTM3MzM2MTMxMzMzMA==",
"FaceGroups": [
{
"Gender": "MALE",
"CreateTime": "2021-01-11T02:18:26.174Z",
"RemarksC": "浙江省杭州市",
"GroupCoverFace": {
"FaceId": "b30a7a36997ce986965680fed90c397fc70a533af511346f819976c6a138c594",
"ImageUri": "oss://imm-test/testcases/face1.jpg",
"FaceBoundary": {
"Top": 49,
"Width": 46,
"Height": 45,
"Left": 80
},
"ExternalId": "61e24632982b3e7598f74d4a95a2706cb11b3408#61e2463254140e7b68044db1aeca52771ae6bdb3",
"ImageHeight": 374,
"ImageWidth": 739
},
"FaceCount": 5,
"RemarksArrayB": "[\"remarksb1\",\"remarksb2\"]",
"RemarksD": "浙江省杭州市",
"MaxAge": 28,
"GroupId": "Group-48fdd4bd-62c3-4daa-ad98-ae6a4173a130",
"GroupName": "facegrouptest",
"RemarksA": "oss://imm-test/testcases/",
"AverageAge": 26.4,
"RemarksArrayA": "[\"remarksa1\",\"remarksa2\"]",
"MinAge": 23,
"ImageCount": 5,
"ExternalId": "externalIdtest",
"RemarksB": "face1.jpg",
"ModifyTime": "2021-01-11T02:18:26.174Z"
}
]
}
错误码
访问错误中心查看更多错误码。