List Cloud Providers

Lists all cloud providers available on Zilliz Cloud.

---

GET

https://controller.api.{cloud-region}.zillizcloud.com/v1/clouds

---

Example

Notes

• This API requires an API Key as the authentication token.

curl --request GET \
    --url "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/clouds" \
    --header "Authorization: Bearer ${API_KEY}" \
    --header "accept: application/json" \
    --header "content-type: application/json"

Success response:

{
    code: 200,
    data: [
    {
       "cloudId": "aws",
       "description": "amazon cloud"
    },
    {
       "cloudId": "gcp",
       "description": "google cloud"
    }
    ]
}

Request

Parameters

• No query parameters required

• No path parameters required

Request Body

No request body required

Response

Returns a list of all available cloud providers on Zilliz Cloud.

Response Bodies

• Response body if we process your request successfully

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

• Response body if we failed to process your request

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

Properties

The properties in the returned response are listed in the following table.

Property	Description
code	integer Indicates whether the request succeeds. 200: The request succeeds. Others: Some error occurs.
code	integer
data	array
data[]	object
data[].cloudId	string The ID of a cloud provider.
data[].description	string The description of the cloud provider.
message	string Indicates the possible reason for the reported error.

Possible Errors

Code	Error Message
63032	CloudId not exists.
80001	The token is illegal
80002	The token is invalid
90117	Invalid domain name used