查询地域列表 | OceanBase 文档中心

查询地域列表

更新时间：2026-04-14 15:36:02

本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）提供的 OpenAPI：查询地域列表 DescribeRegions。

功能说明

本接口用于查询 OMS 集群地域列表。

调用说明

接口约束

本接口适用于 OMS V4.3.1 及之后版本。

请求路径

POST /api/v2?Action=DescribeRegions

请求参数

本接口无请求参数。

返回结果

参数	类型	描述
success	boolean	是否调用成功。
errorDetail	object	错误详情。
code	string	错误码。
message	string	描述信息。
advice	string	建议。
requestId	string	请求 ID。
pageNumber	integer	页序号，分页查询时生效。
pageSize	integer	页大小，分页查询时生效。
totalCount	integer	总数，分页查询时生效。
cost	string	请求耗时，单位为秒。
data	object []	地域列表的相关信息。
├─ id	string	地域码，取值范围为 [0,127]。每个地域一个数字，用户自动选择。
├─ region	string	地域，例如 cn-shanghai。
├─ regionCn	string	地域的中文标识。例如，上海。
├─ cmUrl	string	OMS 集群管理服务的地址。例如，`http://xxx.xxx.xxx.xxx:8088`。
├─ code	string	地域编码。
├─ groupName	string	所属集群组。
├─ gmtCreate	string	当前记录的创建时间。
├─ gmtModified	string	当前记录的修改时间。

示例

请求示例

{

}

返回示例

{
    "success":true,
    "errorDetail":null,
    "code":null,
    "message":null,
    "advice":null,
    "requestId":"f270-e685-45e1-bc9d-424****8",
    "pageNumber":null,
    "pageSize":null,
    "totalCount":null,
    "cost":"2 ms",
    "data": [
    {
        "id": 1,
        "region": "cn-shanghai",
        "regionCn": "上海",
        "cmUrl": "http://xxx.xxx.xxx.1:8088",
        "code": 0,
        "groupName": "cn-shanghai",
        "gmtCreate": "2025-08-13T02:57:43.000+00:00",
        "gmtModified": "2025-08-13T08:17:04.000+00:00"
        }
        ]
    }