Get Available Regions

Retrieve the list of available regions.

Request URL

GET {base_url}/uc-user/api/v1/domains/available-regions

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
X-Source-Region No String The region code of the current access region.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Available_Regions> The available regions.
Available_Regions
Parameter Type Description
currentRegionCode String The region code of the current access region.
defaultRegionCode String The region code of the main region.
regions Array<Region> The list of available regions.
Region
Parameter Type Description
regionCode String The region code.
regionName String The region name.
regionUrl String The access URL of the region.
officialTargetDomain String The official CNAME target domain of the region.
currentAccessRegion Boolean

Whether the region is the current access region.

  • true: The region is the current access region.
  • false: The region is not the current access region.

Example

Request example

GET /uc-user/api/v1/domains/available-regions HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTg4MDQwMCwiaWF0IjoxNzkxODU4ODAwLCJqdGkiOiJlYjczYTljNi05NGY1LTQ5MzItODcyYi0yMDUzMzVmMWE4YTkiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.hTHYgOuTSUnTMWM4NwMB6tPaChCUx2_2SNsSGTpGbIVF1goAOeUi1rbPej1t04EgzC_c6lfRAdf2mB0Uq4JP49DNYKDwbUDerQqc8WeO-RQvd466YJWsGlCJcWEzGaTXPpNG9glzn3i_zArhJN7MyzVKWz5ygKAadH7nQ5RJzLM6sOFnZ5DbTnQ4_uT_P-AdnPcTrlNvP62R58fiKjARMHPR0tHuUA3U0IiMKzH3uRVTyRXY_LccFFVys3Io5J5-ovntsTKaZ0o08kcXh1FJ5BW2Zj_6DJE_-Q1dwzQDkJ7aWJuRNSG30zXakHbuG7UqqFYRG8Y6MUDMoraKaCATKA

Response example

HTTP/1.1 200 OK
{
  "result": {
    "currentRegionCode": "cn-0",
    "defaultRegionCode": "cn-1",
    "regions": [
      {
        "regionCode": "cn-1",
        "regionName": "HongKong",
        "regionUrl": "https://cn-1.test.novo-one.com"
      },
      {
        "regionCode": "afs-1",
        "regionName": "afs-1",
        "regionUrl": "https://afs-1.beta.novo-one.com"
      },
      {
        "regionCode": "de-0",
        "regionName": "de-0",
        "regionUrl": "https://de-0.test.novo-one.com"
      }
    ]
  },
  "requestId": "163679ea901981e07be35bb973903c69",
  "code": "200",
  "message": "SUCCESS"
}