文档

ListCustomEntities - 获取自定义库下实体列表

更新时间:

获取自定义库下实体列表。

接口说明

本接口目前支持的地域为华北 2(北京)、华东 2(上海)、华东 1(杭州),其他地域暂不支持。

QPS 限制

本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Algorithmstring

自定义类型,取值:

  • landmark:自定义地标。

  • object:自定义物体。

landmark
CustomGroupIdstring

自定义库 ID。

1
PageNumberinteger

页码。

1
PageSizeinteger

每页数量。单页最大数量不超过 50。

10

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID,具有唯一性。

580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5
PageNumberinteger

页码。

1
PageSizeinteger

每页数量。

10
TotalCountlong

总数量。

1
CustomEntitiesobject []

自定义库实体列表。

CustomEntityIdstring

自定义库实体 entityID。

1
CustomEntityNamestring

自定义库实体 entity 名称。

exampleName
CustomEntityInfostring

自定义实体的额外信息,JSON String 类型。

{ "finegrainName":"example" }

示例

正常返回示例

JSON格式

{
  "RequestId": "580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "CustomEntities": {
    "CustomEntity": [
      {
        "CustomEntityId": "1",
        "CustomEntityName": "exampleName",
        "CustomEntityInfo": "{ \"finegrainName\":\"example\" }"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorerrorMsg:%s内部错误,偶发请重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-09-06新增 OpenAPI看变更集
  • 本页导读 (1)