查询可用区域

查询可用区域。

请求 URL

GET {base_url}/dm/open_api/v1/cluster/regions

请求参数

请求头
参数 是否必填 类型 描述
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。

响应参数

参数 类型 描述
data Array <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 描述
regionId Integer 区域 ID。
region String 区域名称。

示例

请求示例

GET /dm/open_api/v1/cluster/regions HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQyNzQ3NjJ9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0Mjc2NTYyLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJkMWQxNjliZS00YjYyLTQ3N2QtOGZjMS1jYTU5MTcyYjZhNmUiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.35bEv8Z4lD9DmE1uSyFpcIgnWYUrcpsnTEGu0Sf4q1g
响应示例
HTTP/1.1 200 OK
{
  "data": [
    {
      "regionId": 1,
      "region": "China(GuangDong)"
    },
    {
      "regionId": 2,
      "region": "China(Shanghai)"
    },
    {
      "regionId": 3,
      "region": "India(Mumbai)"
    },
    {
      "regionId": 4,
      "region": "Asia Pacific(Singapore)"
    }
  ],
  "requestId": "cc4673ad-0cda-46d6-bba7-8984b15979a7",
  "status": "Success",
  "time": 1664274776
}