Query Available Regions

Query the available regions.

Request URL

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

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String Pass the access token in the header.

Format: Bearer {access_token}.

Response parameters

Parameter Type Description
data Array <Details> The detailed information.
requestId String The unique ID of the request, which can be used to quickly locate the request.
status String Request result:
  • Success
  • Failed
time Long The response time.
Note: The YCM API response returns a timestamp, you can convert the timestamp to detailed date and time as needed. For more information, see Convert Timestamp to Local Date and Time.
Details
Parameter Type Description
regionId Integer The ID of the region.
region String The name of the region.

Example

Request example

GET /dm/open_api/v1/cluster/regions HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQyNzQ3NjJ9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0Mjc2NTYyLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJkMWQxNjliZS00YjYyLTQ3N2QtOGZjMS1jYTU5MTcyYjZhNmUiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.35bEv8Z4lD9DmE1uSyFpcIgnWYUrcpsnTEGu0Sf4q1g
Response example
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
}