Skip to main content

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.

PropertyDescription
codeinteger
dataarray
data[]object
data[].cloudIdstring
The ID of a cloud provider.
data[].descriptionstring
The description of the cloud provider.
messagestring
Indicates the possible reason for the reported error.

Possible Errors

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