This topic describes the OpenAPI for OceanBase Migration Service (OMS) to queries the list of regions of an OMS cluster.
Purpose
This API is used to query the list of OMS regions.
Call description
Limitations
This API is applicable to OMS V4.3.1 and later versions.
Request path
POST /api/v2?Action=DescribeRegions
Request parameters
This API does not require any request parameters.
Response parameters
| Parameter | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the call is successful. |
| errorDetail | object | The error details. |
| code | string | The error code. |
| message | string | The error description. |
| advice | string | The suggestion. |
| requestId | string | The request ID. |
| pageNumber | integer | The page number. This parameter is effective only when you perform paginated query. |
| pageSize | integer | The page size. This parameter is effective only when you perform paginated query. |
| totalCount | integer | The total number of records. This parameter is effective only when you perform paginated query. |
| cost | string | The time spent in processing the request, in seconds. |
| data | object [] | Information about the regions. |
| ├─ id | string | The region code, which is a number in the range [0,127]. Each region is identified by a unique number. |
| ├─ region | string | The region, for example, cn-shanghai. |
| ├─ regionCn | string | The Chinese name of the region. For example, 上海. |
| ├─ cmUrl | string | The URL of the OMS cluster management service. For example, http://xxx.xxx.xxx.xxx:8088. |
| ├─ code | string | The region code. |
| ├─ groupName | string | The cluster group to which the region belongs. |
| ├─ gmtCreate | string | The creation time of the record. |
| ├─ gmtModified | string | The modification time of the record. |
Examples
Request example
{
}
Response example
{
"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"
}
]
}