Skip to main content

List Cloud Regions

Lists all available cloud regions of a specific cloud provider.

GET
/v1/regions
Base URL

The base URL for this API is in the following format:

https://controller.api.${CLOUD_REGION}.zillizcloud.com

📘Notes
  • You need to replace ${CLOUD_REGION} with the appropriate region for your deployment.
  • To get the cloud region ID, refer to Zilliz Cloud Console or List Cloud Regions.
export CLOUD_REGION="gcp-us-west1"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zillizcloud.com"
Parameters
Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}
cloudIdstringquery

The ID of a valid cloud provider.

Example Value: gcp
export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v1/regions" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"
Responses200 - application/json

A success response.

codeinteger

Response code.

dataarray

Response payload, which is an object containing information about cloud regions.

[]dataobject

A cloud region.

cloudIdstring

The ID of the cloud provider.

regionIdstring

The ID of the cloud region.

domainstring

The base URL of the Zilliz Cloud open API endpiont.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

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