列出指定⼈物库下的所有⼈物和⼈脸信息。
接口说明
本接口通过人物 ID 和人物库 ID 进行查询,如果不传入,则默认列出当前 RAM 用户所有人物库和人脸信息。
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
mts:ListCustomPersons | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CategoryId | string | 否 | ⼈物库 ID,⽤于唯⼀标识⼀个⾃定义⼈物库,由调⽤者⽣成,调⽤者⾃⼰保证唯⼀性。若不填写,将列出所有⾃定义⼈物库。最⻓⽀持 120 字符,不区分⼤⼩写 说明
不能与系统⼈物库 ID 相同。
| CategoryId-**** |
PersonId | string | 否 | ⼈物 ID。⽤于唯⼀标识⼀个⾃定义⼈物,由调⽤者⽣成,调⽤者⾃⼰保证唯⼀性。若不填写,将列出 CategoryId 下所有⼈物。 | PersonId-**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "FD4DED6B-0C26-5A8B-A6BE-4FA542AE4D57",
"Categories": {
"Category": [
{
"Persons": {
"Person": [
{
"PersonName": "PersonName-****",
"PersonDescription": "PersonDescription-****",
"Faces": {
"Face": [
{
"ImageUrl": "http://example-****.jpeg",
"FaceId": "15****"
}
]
},
"PersonId": "PersonId-****"
}
]
},
"CategoryId": "CategoryId-****",
"CategoryName": "CategoryName-****",
"CategoryDescription": "CategoryDescription-****"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError | errorMsg:%s | 内部错误,偶发请重试。 |
访问错误中心查看更多错误码。