Get the Region List

Request URL

GET {base_url}/uc-user/api/v1/public/regions

Request parameters

No request parameters. Send the request URL directly to get the region list.

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	Array<Region>	The list of regions.

Region


Parameter	Type	Description
code	String	The code of the region.
name	String	The name of the region.
url	String	The URL of the region.
customDomain	Boolean	Whether the region uses a custom domain.

Example

Request example

GET /uc-user/api/v1/public/regions HTTP/1.1
Host: api.cn.novoone.com

Response example

HTTP/1.1 200 OK
{
  "result": [
    {
      "code": "cn-0",
      "name": "HongKong",
      "url": "https://cn-0.test-byoi.novo-one.com",
      "customDomain": false
    }
  ],
  "requestId": "717a90825c706dabefc8db03fb9a1587",
  "code": "200",
  "message": "SUCCESS"
}