Skip to main content

List Cloud Regions (V2)

Lists all available cloud regions. You may list only the applicable regions of a specific cloud provider.

GET/v2/regions
Connection Endpoint

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

https://api.cloud.zilliz.com

📘Notes

The endpoints on the control plane currently supports up to 20 requests per second per user per endpoint.

shell
export BASE_URL="https://api.cloud.zilliz.com"
Parameters
Authorizationstringheaderrequired

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

Example Value: Bearer {{TOKEN}}
Acceptstringheader

Use application/json.

Example Value: application/json
cloudIdstringquery

ID of a cloud provider. You can list applicable cloud providers using List Cloud Providers

Example Value: aws
bash
export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v2/regions" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"
Responses200 OK - application/json

Return a list of cloud regions in detail.

codeinteger

Response code.

dataarray

Response payload.

[]dataobject

List of applicable cloud regions.

cloudIdstring

ID of the cloud provider that provides the region.

regionIdstring

ID of the cloud region.

domainstring

Base URL of the V2 API server at the control plane.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

Successjson
{
    "code": 0,
    "data": [
        {
            "cloudId": "aws",
            "regionId": "aws-us-west-2",
            "domain": "api.cloud.zilliz.com"
        },
        {
            "cloudId": "gcp",
            "regionId": "gcp-us-west1",
            "domain": "api.cloud.zilliz.com"
        },
        {
            "cloudId": "azure",
            "regionId": "az-westus3",
            "domain": "api.cloud.zilliz.com"
        }
    ]
}
Ctrl I