文档

GetCapacity - 查询容器信息

更新时间:

查询容器信息。

接口说明

支持指定查询条件。当指定多个条件时,需同时满足全部条件才能实现查询容器信息功能。

调试

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

授权信息

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

请求参数

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

项目 ID。

d9a8****
AppIdstring

应用 ID。

13027****
AppVersionstring

应用版本 ID。

35067****
DistrictIdstring

区域 ID。取值:

  • huadong

  • xinan

  • huanan

  • huabei

  • huazhong

huadong
PageSizeinteger

分页时每页显示的数据行数。最大值:100,默认值:20。

20
PageNuminteger

页码。起始值:1,默认值:1。

1

返回参数

名称类型描述示例值
object

返回参数。

Totalinteger

容器信息记录数。

100
PageNuminteger

页码。

1
PageSizeinteger

数据行数。

20
Capacitiesarray<object>

容器信息。

object
DistrictIdstring

区域 ID。取值:

  • huadong

  • xinan

  • huanan

  • huabei

  • huazhong

huadong
AppIdstring

应用 ID。

13027****
AppVersionstring

应用版本 ID。

35067****
SessionCapacityinteger

该容器支持的会话数量。

2
ProjectIdstring

项目 ID。

d9a8****
RequestIdstring

请求 ID。

46329898-489C-4E63-9BA1-C1DA5C5D0986

示例

正常返回示例

JSON格式

{
  "Total": 100,
  "PageNum": 1,
  "PageSize": 20,
  "Capacities": [
    {
      "DistrictId": "huadong\n",
      "AppId": "13027****",
      "AppVersion": "35067****",
      "SessionCapacity": 2,
      "ProjectId": "d9a8****"
    }
  ],
  "RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-05-20API 内部配置变更,不影响调用查看变更详情
2022-12-05OpenAPI 返回结构发生变更查看变更详情