List Cloud Regions

Lists all available cloud regions of a specific cloud provider.

---

GET

https://controller.api.{cloud-region}.zillizcloud.com/v1/regions

---

Example

Notes

• This API requires an API Key as the authentication token.

curl --request GET \
    --url "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/regions?cloudId=gcp" \
    --header "Authorization: Bearer ${API_KEY}" \
    --header "accept: application/json" \
    --header "content-type: application/json"

You can obtain valid cloudId values by performing List Cloud Providers operations.

Success response:

{
    "code": 200,
    "data": [
        {
            "cloudId": "gcp",
            "domain": "*.api.gcp-us-west1.cloud-uat3.zilliz.com",
            "regionId": "gcp-us-west1"
        }
    ]
}

Request

Parameters

• Query parameters

  Parameter	Description
  cloudId	string The ID of a valid cloud provider.

• No path parameters required

Request Body

No request body required

Response

Returns a list of all available regions that the specified cloud provider offers.

Response Bodies

• Response body if we process your request successfully

{
    "code": "integer",
    "data": [
        {
            "cloudId": "string",
            "regionId": "string",
            "domain": "string"
        }
    ]
}

• Response body if we failed to process your request

{
    "code": integer,
    "message": string
}

Properties

The properties in the returned response are listed in the following table.

Property	Description
code	integer Indicates whether the request succeeds. 200: The request succeeds. Others: Some error occurs.
code	integer
data	array
data[]	object
data[].cloudId	string The ID of a cloud provider
data[].regionId	string The ID of a cloud region
data[].domain	string The base URL of an Zilliz Cloud open API endpiont
message	string Indicates the possible reason for the reported error.

Possible Errors

Code	Error Message
80001	The token is illegal
80002	The token is invalid
90117	Invalid domain name used