list_clusters
Retrieve all clusters associated with your API key in Zilliz Cloud. Manage and view cluster details including status, region, and connection information.
Instructions
List all clusters scoped to API Key in Zilliz Cloud.
If you want to list all clusters, you can set page_size to 100 and current_page to 1.
Args:
page_size: The number of records to include in each response (default: 10)
current_page: The current page number (default: 1)
Returns:
List containing cluster data
Example:
[
{
"cluster_id": "inxx-xxxxxxxxxxxxxxx",
"cluster_name": "dedicated-3",
"description": "",
"region_id": "aws-us-west-2",
"plan": "Standard",
"cu_type": "Performance-optimized",
"cu_size": 1,
"status": "RUNNING",
"connect_address": "https://inxx-xxxxxxxxxxxxxxx.aws-us-west-2.vectordb.zillizcloud.com:19530",
"private_link_address": "",
"project_id": "proj-xxxxxxxxxxxxxxxxxxxxxx",
"create_time": "2024-06-30T16:49:50Z"
}
]
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page_size | No | ||
| current_page | No |