跳转到主要内容
API Explorer|API Explorer
平台运维相关接口/平台管理
GETRegion起始版本 1.1.0同步需要认证

查询区域列表

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

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

查询参数

请求参数

查询参数

  • pageInteger

    页码。默认值为 `1`。

    示例： 0

  • pageSizeInteger

    每页返回的记录数。

    示例： 0

  • platformIdString

    平台ID。

  • productTypeString

    产品类型。

响应状态

200 OK

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

  • regionsList

    区域列表。

    示例： (nested array)

    • uuidString

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

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

    • nameString

      资源名称。

      示例： beijing-dc1

    • displayNameString

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

      示例： Beijing DC-1

    • descriptionString

      资源的详细描述。

      示例： Primary datacenter in Beijing

    • statusString

      状态信息。

      示例： Active

    • createDateString

      创建时间。

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

    • lastOpDateString

      最近一次操作时间。

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

    • statsObject

      统计信息。

      • cloudCountInteger

        云数量。

        示例： 1

      • connectionCountInteger

        连接数量。

        示例： 3

      • zoneCountInteger

        区域数量。

        示例： 2

      • clusterCountInteger

        集群数量。

        示例： 4

      • hostCountInteger

        主机数量。

        示例： 10

      • vmCountInteger

        云主机数量。

        示例： 50

      • k8sClusterCountInteger

        K 8 S集群数量。

        示例： 2

      • storageClusterCountInteger

        存储集群数量。

        示例： 1

  • totalInteger

    返回结果总数。

    示例： 10

请求地址

GET/api/v1/regions

/api/v1/regions

操作 ID

ListRegions

永久链接

请求示例

curl -X GET '{host}/api/v1/regions?page=1&pageSize=20' -H 'Authorization: Bearer {token}'

响应示例

200
{"regions": [{"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "beijing-dc1", "displayName": "Beijing DC-1", "description": "Primary datacenter in Beijing", "status": "Active", "createDate": "2026-01-15T08:00:00Z", "lastOpDate": "2026-01-15T08:00:00Z", "stats": {"cloudCount": 1, "connectionCount": 3, "zoneCount": 2, "clusterCount": 4, "hostCount": 10, "vmCount": 50, "k8sClusterCount": 2, "storageClusterCount": 1}}], "total": 10}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史