List Cloud Regions

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

GET

/v2/regions

Base URL

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

https://api.cloud.zilliz.com

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

export TOKEN="YOUR_API_KEY"

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

Responses200 - application/json

SUCCESS

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.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "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"
        }
    ]
}