分页查询指定实体下的所有识别样本信息。
接口说明
-
本接口目前支持的地域为华北 2(北京)、华东 2(上海)、华东 1(杭州)、华南 1(深圳),其他地域暂不支持。
-
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ice:ListRecognitionSamples |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Algorithm |
string |
是 |
识别类型,取值:
|
landmark |
| LibId |
string |
是 |
库 ID,传入则精确查该库;支持传入列表,用","分割。 |
lib1,lib2,lib3 |
| EntityId |
string |
是 |
实体 ID。填"ANY"时,会查询 EntityName。 |
**************544cb84754************ |
| PageNumber |
integer |
是 |
页码 |
1 |
| PageSize |
integer |
是 |
每页返回的记录数 |
10 |
| EntityName |
string |
否 |
实体名。 |
custom_person |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID |
******11-DB8D-4A9A-875B-275798****** |
| PageNumber |
integer |
页码 |
1 |
| PageSize |
integer |
每页返回的记录数 |
20 |
| TotalCount |
integer |
样本总数 |
5 |
| Samples |
object |
||
| Sample |
array<object> |
样本列表 |
|
|
object |
样本 |
||
| SampleId |
string |
样本 ID。 |
**************4d2ba728e2f************** |
| ImageUrl |
string |
样本图片 URL |
https://example.com/sample.png |
| EntityId |
string |
实体 id |
*******49ff-9b15****** |
| LibId |
string |
实体库 id |
**********23da4529998************ |
示例
正常返回示例
JSON格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"PageNumber": 1,
"PageSize": 20,
"TotalCount": 5,
"Samples": {
"Sample": [
{
"SampleId": "**************4d2ba728e2f**************",
"ImageUrl": "https://example.com/sample.png",
"EntityId": "*******49ff-9b15******",
"LibId": "**********23da4529998************"
}
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 500 | InternalError | errorMsg:%s |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。