List Cloud Providers

Lists all cloud providers available on Zilliz Cloud.

GET

/v1/clouds

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 On 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}}

export TOKEN="YOUR_API_KEY"

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

Responses200 - application/json

SUCCESS

Returns a list of applicable cloud providers.

codeinteger

Response code.

dataarray

Response payload, which is a list of cloud providers.

[]dataobject

A cloud provider.

cloudIdstring

The ID of a cloud provider.

descriptionstring

The description of the cloud provider.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 200,
    "data": [
        {
            "cloudId": "aws",
            "description": "Amazon Web Services"
        },
        {
            "cloudId": "gcp",
            "description": "Google Cloud Platform"
        },
        {
            "cloudId": "azure",
            "description": "Microsoft Azure"
        }
    ]
}