调用ListCustomGroups获取自定义库列表。

使用说明

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

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListCustomGroups

系统规定参数。取值:ListCustomGroups

Algorithm String landmark

自定义类型,取值:

  • landmark:自定义地标。
  • object:自定义物体。
PageNumber Integer 1

页码。

PageSize Integer 10

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

返回数据

名称 类型 示例值 描述
RequestId String 580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5

请求ID,具有唯一性。

PageNumber Integer 1

页码。

PageSize Integer 10

每页数量。

TotalCount Long 1

总数量。

CustomGroups Array of CustomGroup

自定义库。

CustomGroup
CustomGroupId String 1

自定义库ID。

CustomGroupName String 自定义库名称

自定义库名称。

CustomGroupDescription String 这是一个自定义库

自定义库描述。

示例

请求示例

http(s)://mts.cn-shanghai.aliyuncs.com/?Action=ListCustomGroups
&Algorithm=landmark
&PageNumber=1
&PageSize=10
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListCustomGroupsResponse>
    <RequestId>580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>1</TotalCount>
    <CustomGroups>
        <CustomGroupId>1</CustomGroupId>
        <CustomGroupName>自定义库名称</CustomGroupName>
        <CustomGroupDescription>这是一个自定义库</CustomGroupDescription>
    </CustomGroups>
</ListCustomGroupsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5",
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 1,
  "CustomGroups" : [ {
    "CustomGroupId" : "1",
    "CustomGroupName" : "自定义库名称",
    "CustomGroupDescription" : "这是一个自定义库"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError errorMsg:%s 内部错误,偶发请重试。

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