List Cloud Regions

Lists all available cloud regions of a specific cloud provider.

---

GET

https://controller.${CLOUD_REGION}.zillizcloud.com/v1/regions

---

Example

📘Notes

This API requires an API key as the authentication token.

export CLOUD_REGION="gcp-us-west1"
export API_KEY=""

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

Possible response is similar to the following.

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

Request

Parameters

• Query parameters

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

• No path parameters required

• Header parameters

  Parameter	Description
  Authorization	string

Request Body

No request body required

Response

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

Response Body

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

Property	Description
code	integer Indicates whether the request succeeds. 0: The request succeeds. Others: Some error occurs.
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

Error Response

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

Property	Description
code	integer Indicates whether the request succeeds. 0: The request succeeds. Others: Some error occurs.
message	string Indicates the possible reason for the reported error.