List Cloud Providers
Lists all cloud providers available on Zilliz Cloud.
GET
https://controller.${CLOUD_REGION}.zillizcloud.com/v1/clouds
Example
📘Notes
This API requires an API key as the authentication token.
export CLOUD_REGION="gcp-us-west1"
export API_KEY=""
curl --location --request GET "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/clouds" \
--header "Authorization: Bearer ${API_KEY}"
Possible response is similar to the following.
{
"code": 200,
"data": [
{
"cloudId": "aws",
"description": "amazon aws"
},
{
"cloudId": "gcp",
"description": "GCP"
},
{
"cloudId": "azure",
"description": "azure"
}
]
}
Request
Parameters
-
No query parameters required
-
No path parameters required
-
Header parameters
Parameter Description Authorization string
Request Body
No request body required
Response
Returns a list of all available cloud providers on Zilliz Cloud.
Response Body
{
"code": "integer",
"data": [
{
"cloudId": "string",
"description": "string"
}
]
}
Property | Description |
---|---|
code | integer Indicates whether the request succeeds.
|
data | array |
data[] | object |
data[].cloudId | string The ID of a cloud provider. |
data[].description | string The description of the cloud provider. |
Error Response
{
"code": integer,
"message": string
}
Property | Description |
---|---|
code | integer Indicates whether the request succeeds.
|
message | string Indicates the possible reason for the reported error. |