---
title: "查询区域列表 | OceanBase 文档中心"
description: 查询区域列表 功能说明 查询区域信息列表。 调用说明 接口约束 调用者需要具备 HOST_VIEWER 权限。 请求路径 GET /api/v2/compute/regions 请求参数 参数 类型 必选 示例值 描述 page Integer 否 1 分页页码，从 1 开始 size Integer 否 10 请求…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*lJTmRZ61jSUAAAAAAAAAAAAADiGDAQ/original) 云平台 OCPV 4.0.3 企业版

# 查询区域列表

更新时间：2023-08-10 11:45:58

## 功能说明

查询区域信息列表。

## 调用说明

### 接口约束

调用者需要具备 HOST_VIEWER 权限。

### 请求路径

`GET /api/v2/compute/regions`

### 请求参数

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| page | Integer | 否 | 1 | 分页页码，从 1 开始 |
| size | Integer | 否 | 10 | 请求数据的分页大小。 默认值：10 最大值：2000 |
| sort | String | 否 | id,asc | 请求数据的排序规则 |

### 返回结果

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| data | Object | 请求的数据 |
| ├─ contents | Array | Region 的数组，详细数据结构见下表 |
| ├─ page | Object | 分页信息 |
| ├─ totalElements | Integer | 总记录数 |
| ├─ totalPage | Integer | 总页数 |
| ├─ number | Integer | 当前页码 |
| ├─ size | Integer | 当前页大小 |
| successful | Boolean | 请求是否成功 |
| timestamp | Datetime | 服务端完成请求的时间戳 |
| duration | Integer | 服务端处理请求的时间（毫秒） |
| status | Integer | 符合 HTTP Status 规范的编码 |
| traceId | String | 请求的 Trace ID，用于排查问题 |
| server | String | 响应请求的应用服务的地址 |

Region 的数据结构

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| id | Integer | 区域 ID |
| name | String | 区域名称 |
| description | String | 区域描述信息 |
| createTime | String | 区域信息创建时间 |
| updateTime | String | 区域信息修改时间 |

## 示例

### 请求示例

`GET /api/v2/compute/regions?page=1&size=10`

### 返回示例

```unknow
{
  "data": {
    "contents": [
      {
        "createTime": "2021-07-22T20:04:15+08:00",
        "id": 1000002,
        "name": "testregion",
        "updateTime": "2021-07-22T20:04:15+08:00"
      },
      {
        "createTime": "2021-07-21T20:42:02+08:00",
        "id": 1,
        "name": "beijing",
        "updateTime": "2021-07-21T20:42:02+08:00"
      }
    ],
    "page": {
      "number": 1,
      "size": 2000,
      "totalElements": 2,
      "totalPages": 1
    }
  },
  "duration": 29,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-08-25T15:54:02.484+08:00",
  "traceId": "0aa496e9309747b2"
}

```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线