跳转到主要内容
ZStack
平台运维相关接口/平台管理

查询区域列表

分页列出区域，支持按平台或产品类型筛选。

GET/api/v1/regions

操作 ID

ListRegions

起始版本

1.1.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • page
    Integer

    页码。默认值为 `1`。

    示例： 0

  • pageSize
    Integer

    每页返回的记录数。

    示例： 0

  • platformId
    String

    平台ID。

  • productType
    String

    产品类型。

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • regions
    List

    区域列表。

    示例： (nested array)

    • uuid
      String

      资源的UUID，唯一标识该资源。

      示例： a1b2c3d4-e5f6-7890-abcd-ef1234567890

    • name
      String

      资源名称。

      示例： beijing-dc1

    • displayName
      String

      显示名称。用于界面展示。

      示例： Beijing DC-1

    • description
      String

      资源的详细描述。

      示例： Primary datacenter in Beijing

    • status
      String

      状态信息。

      示例： Active

    • createDate
      String

      创建时间。

      示例： 2026-01-15T08:00:00Z

    • lastOpDate
      String

      最近一次操作时间。

      示例： 2026-01-15T08:00:00Z

    • stats
      Object

      统计信息。

      • cloudCount
        Integer

        云数量。

        示例： 1

      • connectionCount
        Integer

        连接数量。

        示例： 3

      • zoneCount
        Integer

        区域数量。

        示例： 2

      • clusterCount
        Integer

        集群数量。

        示例： 4

      • hostCount
        Integer

        主机数量。

        示例： 10

      • vmCount
        Integer

        云主机数量。

        示例： 50

      • k8sClusterCount
        Integer

        K 8 S集群数量。

        示例： 2

      • storageClusterCount
        Integer

        存储集群数量。

        示例： 1

  • total
    Integer

    返回结果总数。

    示例： 10