{
"version": "2026-03-25",
"minCliVersion": "1.0.0",
"resources": {
"collection": {
"description": "Create and manage vector collections.",
"operations": {
"create": {
"description": "Create a new collection.",
"http": {
"method": "POST",
"path": "/v2/vectordb/collections/create"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--name",
"description": "collection name"
},
{
"name": "dimension",
"type": "integer",
"cli": "--dimension",
"requiredUnless": "body",
"description": "vector dimension"
},
{
"name": "metricType",
"type": "string",
"cli": "--metric-type",
"default": "COSINE",
"description": "distance metric",
"choices": [
"COSINE",
"L2",
"IP"
]
},
{
"name": "idType",
"type": "string",
"cli": "--id-type",
"description": "primary key type",
"choices": [
"Int64",
"VarChar"
]
},
{
"name": "autoID",
"type": "boolean",
"cli": "--auto-id",
"description": "auto-generate primary key"
},
{
"name": "primaryFieldName",
"type": "string",
"cli": "--primary-field",
"description": "primary key field name"
},
{
"name": "vectorFieldName",
"type": "string",
"cli": "--vector-field",
"description": "vector field name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"bodyParam": "--body",
"examples": [
"# Quick create with defaults (COSINE metric, auto schema)",
"zilliz collection create --name my_collection --dimension 768",
"",
"# Create with L2 metric and VarChar primary key",
"zilliz collection create --name my_collection --dimension 768 --metric-type L2 --id-type VarChar",
"",
"# Create with full schema via JSON body",
"zilliz collection create --name my_collection --body file://schema.json"
]
},
"list": {
"description": "List all collections.",
"http": {
"method": "POST",
"path": "/v2/vectordb/collections/list"
},
"params": [
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz collection list"
]
},
"describe": {
"description": "Get details of a collection.",
"http": {
"method": "POST",
"path": "/v2/vectordb/collections/describe"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--name",
"description": "collection name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz collection describe --name my_collection"
]
},
"drop": {
"description": "Drop a collection. This action is irreversible.",
"http": {
"method": "POST",
"path": "/v2/vectordb/collections/drop"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--name",
"description": "collection name to drop"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz collection drop --name my_collection"
]
},
"rename": {
"description": "Rename a collection.",
"http": {
"method": "POST",
"path": "/v2/vectordb/collections/rename"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--name",
"description": "current collection name"
},
{
"name": "newCollectionName",
"type": "string",
"required": true,
"cli": "--new-name",
"description": "new collection name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "current database name"
},
{
"name": "newDbName",
"type": "string",
"cli": "--new-database",
"description": "target database name (for cross-db rename)"
}
],
"examples": [
"zilliz collection rename --name old_collection --new-name new_collection"
]
},
"load": {
"description": "Load a collection into memory for search.",
"http": {
"method": "POST",
"path": "/v2/vectordb/collections/load"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--name",
"description": "collection name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz collection load --name my_collection"
]
},
"release": {
"description": "Release a collection from memory.",
"http": {
"method": "POST",
"path": "/v2/vectordb/collections/release"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--name",
"description": "collection name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz collection release --name my_collection"
]
},
"get-load-state": {
"description": "Get collection load state.",
"http": {
"method": "POST",
"path": "/v2/vectordb/collections/get_load_state"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--name",
"description": "collection name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz collection get-load-state --name my_collection"
]
},
"get-stats": {
"description": "Get collection statistics (row count, etc.).",
"http": {
"method": "POST",
"path": "/v2/vectordb/collections/get_stats"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--name",
"description": "collection name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz collection get-stats --name my_collection"
]
},
"has": {
"description": "Check if a collection exists.",
"http": {
"method": "POST",
"path": "/v2/vectordb/collections/has"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--name",
"description": "collection name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz collection has --name my_collection"
]
},
"flush": {
"description": "Flush collection data to disk.",
"http": {
"method": "POST",
"path": "/v2/vectordb/collections/flush"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--name",
"description": "collection name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz collection flush --name my_collection"
]
},
"compact": {
"description": "Compact collection segments to optimize storage.",
"http": {
"method": "POST",
"path": "/v2/vectordb/collections/compact"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--name",
"description": "collection name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz collection compact --name my_collection"
]
}
}
},
"vector": {
"description": "Search, insert, and query vector data.",
"operations": {
"insert": {
"description": "Insert entities into a collection.",
"http": {
"method": "POST",
"path": "/v2/vectordb/entities/insert"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "data",
"type": "array",
"requiredUnless": "body",
"cli": "--data",
"description": "entities as JSON array or file://path.json"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"bodyParam": "--body",
"examples": [
"# Insert with inline JSON",
"zilliz vector insert --collection my_col --data '[{\"id\": 1, \"vector\": [0.1, 0.2, 0.3]}]'",
"",
"# Insert from a JSON file",
"zilliz vector insert --collection my_col --data file:///path/to/data.json"
]
},
"upsert": {
"description": "Upsert entities (insert or update if exists).",
"http": {
"method": "POST",
"path": "/v2/vectordb/entities/upsert"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "data",
"type": "array",
"requiredUnless": "body",
"cli": "--data",
"description": "entities as JSON array or file://path.json"
},
{
"name": "partitionName",
"type": "string",
"cli": "--partition",
"description": "partition name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"bodyParam": "--body",
"examples": [
"# Upsert with inline JSON",
"zilliz vector upsert --collection my_col --data '[{\"id\": 1, \"vector\": [0.1, 0.2, 0.3]}]'",
"",
"# Upsert from a JSON file",
"zilliz vector upsert --collection my_col --data file:///path/to/data.json"
]
},
"search": {
"description": "Search for similar vectors.",
"http": {
"method": "POST",
"path": "/v2/vectordb/entities/search"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "data",
"type": "array",
"required": true,
"cli": "--data",
"description": "query vectors as JSON array"
},
{
"name": "annsField",
"type": "string",
"cli": "--anns-field",
"description": "vector field to search on"
},
{
"name": "limit",
"type": "integer",
"default": 10,
"cli": "--limit",
"description": "max results to return"
},
{
"name": "filter",
"type": "string",
"cli": "--filter",
"description": "scalar filter expression"
},
{
"name": "outputFields",
"type": "array",
"cli": "--output-fields",
"description": "fields to return as JSON array"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"# Basic vector search",
"zilliz vector search --collection my_col --data '[[0.1, 0.2, 0.3]]' --limit 10",
"",
"# Search with scalar filter",
"zilliz vector search --collection my_col --data '[[0.1, 0.2]]' --filter 'age > 18' --output-fields '[\"name\", \"age\"]'"
]
},
"hybrid-search": {
"description": "Perform hybrid search with multiple vectors and reranking.",
"http": {
"method": "POST",
"path": "/v2/vectordb/entities/hybrid_search"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "search",
"type": "array",
"requiredUnless": "body",
"cli": "--search",
"description": "search requests as JSON array (unless --body)"
},
{
"name": "rerank",
"type": "object",
"requiredUnless": "body",
"cli": "--rerank",
"description": "reranking strategy as JSON (unless --body)"
},
{
"name": "limit",
"type": "integer",
"default": 10,
"cli": "--limit",
"description": "max results to return"
},
{
"name": "outputFields",
"type": "array",
"cli": "--output-fields",
"description": "fields to return as JSON array"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"bodyParam": "--body",
"examples": [
"zilliz vector hybrid-search --collection my_col --body file://hybrid-search.json"
]
},
"query": {
"description": "Query entities by scalar filter expression.",
"http": {
"method": "POST",
"path": "/v2/vectordb/entities/query"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "filter",
"type": "string",
"required": true,
"cli": "--filter",
"description": "scalar filter expression"
},
{
"name": "limit",
"type": "integer",
"default": 10,
"cli": "--limit",
"description": "max results to return"
},
{
"name": "outputFields",
"type": "array",
"cli": "--output-fields",
"description": "fields to return as JSON array"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz vector query --collection my_col --filter 'id > 100' --limit 10"
]
},
"get": {
"description": "Get entities by primary key IDs.",
"http": {
"method": "POST",
"path": "/v2/vectordb/entities/get"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "id",
"type": "array",
"required": true,
"cli": "--id",
"description": "primary key IDs as JSON array"
},
{
"name": "outputFields",
"type": "array",
"cli": "--output-fields",
"description": "fields to return as JSON array"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz vector get --collection my_col --id '[1, 2, 3]'"
]
},
"delete": {
"description": "Delete entities by filter expression.",
"http": {
"method": "POST",
"path": "/v2/vectordb/entities/delete"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "filter",
"type": "string",
"required": true,
"cli": "--filter",
"description": "filter expression for entities to delete"
},
{
"name": "partitionName",
"type": "string",
"cli": "--partition",
"description": "partition name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz vector delete --collection my_col --filter 'id in [1, 2, 3]'"
]
}
}
},
"database": {
"description": "Create and manage databases.",
"operations": {
"create": {
"description": "Create a new database. (Dedicated only)",
"dedicatedOnly": true,
"http": {
"method": "POST",
"path": "/v2/vectordb/databases/create"
},
"params": [
{
"name": "dbName",
"type": "string",
"required": true,
"cli": "--name",
"description": "database name"
}
],
"bodyParam": "--body",
"examples": [
"zilliz database create --name my_database"
]
},
"list": {
"description": "List all databases.",
"http": {
"method": "POST",
"path": "/v2/vectordb/databases/list"
},
"params": [],
"examples": [
"zilliz database list"
]
},
"describe": {
"description": "Get details of a database. (Dedicated only)",
"dedicatedOnly": true,
"http": {
"method": "POST",
"path": "/v2/vectordb/databases/describe"
},
"params": [
{
"name": "dbName",
"type": "string",
"required": true,
"cli": "--name",
"description": "database name"
}
],
"examples": [
"zilliz database describe --name my_database"
]
},
"drop": {
"description": "Drop a database. (Dedicated only)",
"dedicatedOnly": true,
"http": {
"method": "POST",
"path": "/v2/vectordb/databases/drop"
},
"params": [
{
"name": "dbName",
"type": "string",
"required": true,
"cli": "--name",
"description": "database name to drop"
}
],
"examples": [
"zilliz database drop --name my_database"
]
}
}
},
"index": {
"description": "Create and manage vector indexes.",
"operations": {
"create": {
"description": "Create an index on a collection field.",
"http": {
"method": "POST",
"path": "/v2/vectordb/indexes/create"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"bodyParam": "--body",
"examples": [
"zilliz index create --collection my_col --body '{\"indexParams\": [{\"fieldName\": \"vector\", \"indexType\": \"AUTOINDEX\"}]}'"
]
},
"list": {
"description": "List indexes on a collection.",
"http": {
"method": "POST",
"path": "/v2/vectordb/indexes/list"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz index list --collection my_collection"
]
},
"describe": {
"description": "Get details of an index.",
"http": {
"method": "POST",
"path": "/v2/vectordb/indexes/describe"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "indexName",
"type": "string",
"required": true,
"cli": "--index-name",
"description": "index name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz index describe --collection my_collection --index-name my_index"
]
},
"drop": {
"description": "Drop an index.",
"http": {
"method": "POST",
"path": "/v2/vectordb/indexes/drop"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "indexName",
"type": "string",
"required": true,
"cli": "--index-name",
"description": "index name to drop"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz index drop --collection my_collection --index-name my_index"
]
}
}
},
"partition": {
"description": "Create and manage collection partitions.",
"operations": {
"create": {
"description": "Create a partition in a collection.",
"http": {
"method": "POST",
"path": "/v2/vectordb/partitions/create"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "partitionName",
"type": "string",
"required": true,
"cli": "--partition",
"description": "partition name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz partition create --collection my_collection --partition my_partition"
]
},
"list": {
"description": "List partitions in a collection.",
"http": {
"method": "POST",
"path": "/v2/vectordb/partitions/list"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz partition list --collection my_collection"
]
},
"drop": {
"description": "Drop a partition.",
"http": {
"method": "POST",
"path": "/v2/vectordb/partitions/drop"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "partitionName",
"type": "string",
"required": true,
"cli": "--partition",
"description": "partition name to drop"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz partition drop --collection my_collection --partition my_partition"
]
},
"has": {
"description": "Check if a partition exists.",
"http": {
"method": "POST",
"path": "/v2/vectordb/partitions/has"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "partitionName",
"type": "string",
"required": true,
"cli": "--partition",
"description": "partition name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz partition has --collection my_collection --partition my_partition"
]
},
"get-stats": {
"description": "Get partition statistics.",
"http": {
"method": "POST",
"path": "/v2/vectordb/partitions/get_stats"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "partitionName",
"type": "string",
"required": true,
"cli": "--partition",
"description": "partition name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz partition get-stats --collection my_collection --partition my_partition"
]
},
"load": {
"description": "Load partitions into memory.",
"http": {
"method": "POST",
"path": "/v2/vectordb/partitions/load"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "partitionNames",
"type": "array",
"required": true,
"cli": "--names",
"description": "partition names as JSON array"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz partition load --collection my_collection --names '[\"p1\", \"p2\"]'"
]
},
"release": {
"description": "Release partitions from memory.",
"http": {
"method": "POST",
"path": "/v2/vectordb/partitions/release"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "collection name"
},
{
"name": "partitionNames",
"type": "array",
"required": true,
"cli": "--names",
"description": "partition names as JSON array"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz partition release --collection my_collection --names '[\"p1\", \"p2\"]'"
]
}
}
},
"user": {
"description": "Create and manage database users. (Dedicated only)",
"dedicatedOnly": true,
"operations": {
"create": {
"description": "Create a new database user.",
"http": {
"method": "POST",
"path": "/v2/vectordb/users/create"
},
"params": [
{
"name": "userName",
"type": "string",
"required": true,
"cli": "--user",
"description": "username"
},
{
"name": "password",
"type": "string",
"required": true,
"cli": "--password",
"description": "password"
}
],
"examples": [
"zilliz user create --user my_user --password my_password"
]
},
"list": {
"description": "List all database users.",
"http": {
"method": "POST",
"path": "/v2/vectordb/users/list"
},
"params": [],
"examples": [
"zilliz user list"
]
},
"describe": {
"description": "Get details of a user.",
"http": {
"method": "POST",
"path": "/v2/vectordb/users/describe"
},
"params": [
{
"name": "userName",
"type": "string",
"required": true,
"cli": "--user",
"description": "username"
}
],
"examples": [
"zilliz user describe --user my_user"
]
},
"drop": {
"description": "Drop a database user.",
"http": {
"method": "POST",
"path": "/v2/vectordb/users/drop"
},
"params": [
{
"name": "userName",
"type": "string",
"required": true,
"cli": "--user",
"description": "username to drop"
}
],
"examples": [
"zilliz user drop --user my_user"
]
},
"update-password": {
"description": "Update user password.",
"http": {
"method": "POST",
"path": "/v2/vectordb/users/update_password"
},
"params": [
{
"name": "userName",
"type": "string",
"required": true,
"cli": "--user",
"description": "username"
},
{
"name": "password",
"type": "string",
"required": true,
"cli": "--password",
"description": "current password"
},
{
"name": "newPassword",
"type": "string",
"required": true,
"cli": "--new-password",
"description": "new password"
}
],
"examples": [
"zilliz user update-password --user my_user --password old_pass --new-password new_pass"
]
},
"grant-role": {
"description": "Grant a role to a user.",
"http": {
"method": "POST",
"path": "/v2/vectordb/users/grant_role"
},
"params": [
{
"name": "userName",
"type": "string",
"required": true,
"cli": "--user",
"description": "username"
},
{
"name": "roleName",
"type": "string",
"required": true,
"cli": "--role",
"description": "role name to grant"
}
],
"examples": [
"zilliz user grant-role --user my_user --role admin"
]
},
"revoke-role": {
"description": "Revoke a role from a user.",
"http": {
"method": "POST",
"path": "/v2/vectordb/users/revoke_role"
},
"params": [
{
"name": "userName",
"type": "string",
"required": true,
"cli": "--user",
"description": "username"
},
{
"name": "roleName",
"type": "string",
"required": true,
"cli": "--role",
"description": "role name to revoke"
}
],
"examples": [
"zilliz user revoke-role --user my_user --role admin"
]
}
}
},
"role": {
"description": "Create and manage access control roles. (Dedicated only)",
"dedicatedOnly": true,
"operations": {
"create": {
"description": "Create a new role.",
"http": {
"method": "POST",
"path": "/v2/vectordb/roles/create"
},
"params": [
{
"name": "roleName",
"type": "string",
"required": true,
"cli": "--role",
"description": "role name"
}
],
"examples": [
"zilliz role create --role my_role"
]
},
"list": {
"description": "List all roles.",
"http": {
"method": "POST",
"path": "/v2/vectordb/roles/list"
},
"params": [],
"examples": [
"zilliz role list"
]
},
"describe": {
"description": "Get details and privileges of a role.",
"http": {
"method": "POST",
"path": "/v2/vectordb/roles/describe"
},
"params": [
{
"name": "roleName",
"type": "string",
"required": true,
"cli": "--role",
"description": "role name"
}
],
"examples": [
"zilliz role describe --role my_role"
]
},
"drop": {
"description": "Drop a role.",
"http": {
"method": "POST",
"path": "/v2/vectordb/roles/drop"
},
"params": [
{
"name": "roleName",
"type": "string",
"required": true,
"cli": "--role",
"description": "role name to drop"
}
],
"examples": [
"zilliz role drop --role my_role"
]
},
"grant-privilege": {
"description": "Grant a privilege to a role.",
"http": {
"method": "POST",
"path": "/v2/vectordb/roles/grant_privilege"
},
"params": [
{
"name": "roleName",
"type": "string",
"required": true,
"cli": "--role",
"description": "role name"
},
{
"name": "objectType",
"type": "string",
"required": true,
"cli": "--object-type",
"description": "object type",
"choices": [
"Global",
"Collection",
"Database"
]
},
{
"name": "objectName",
"type": "string",
"required": true,
"cli": "--object-name",
"description": "object name (or * for all)"
},
{
"name": "privilege",
"type": "string",
"required": true,
"cli": "--privilege",
"description": "privilege name (e.g. Search, Insert, CreateCollection)"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"# Grant search on a specific collection",
"zilliz role grant-privilege --role my_role --object-type Collection --object-name my_col --privilege Search",
"",
"# Grant all privileges on all collections",
"zilliz role grant-privilege --role my_role --object-type Collection --object-name '*' --privilege '*'"
]
},
"revoke-privilege": {
"description": "Revoke a privilege from a role.",
"http": {
"method": "POST",
"path": "/v2/vectordb/roles/revoke_privilege"
},
"params": [
{
"name": "roleName",
"type": "string",
"required": true,
"cli": "--role",
"description": "role name"
},
{
"name": "objectType",
"type": "string",
"required": true,
"cli": "--object-type",
"description": "object type",
"choices": [
"Global",
"Collection",
"Database"
]
},
{
"name": "objectName",
"type": "string",
"required": true,
"cli": "--object-name",
"description": "object name (or * for all)"
},
{
"name": "privilege",
"type": "string",
"required": true,
"cli": "--privilege",
"description": "privilege name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz role revoke-privilege --role my_role --object-type Collection --object-name my_col --privilege Search"
]
}
}
},
"alias": {
"description": "Create and manage collection aliases.",
"operations": {
"create": {
"description": "Create an alias pointing to a collection.",
"http": {
"method": "POST",
"path": "/v2/vectordb/aliases/create"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "target collection name"
},
{
"name": "aliasName",
"type": "string",
"required": true,
"cli": "--alias",
"description": "alias name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz alias create --collection my_collection --alias my_alias"
]
},
"list": {
"description": "List all aliases.",
"http": {
"method": "POST",
"path": "/v2/vectordb/aliases/list"
},
"params": [
{
"name": "dbName",
"type": "string",
"required": true,
"cli": "--database",
"description": "database name"
},
{
"name": "collectionName",
"type": "string",
"cli": "--collection",
"description": "filter by collection name"
}
],
"examples": [
"zilliz alias list --database default"
]
},
"describe": {
"description": "Get details of an alias.",
"http": {
"method": "POST",
"path": "/v2/vectordb/aliases/describe"
},
"params": [
{
"name": "aliasName",
"type": "string",
"required": true,
"cli": "--alias",
"description": "alias name"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz alias describe --alias my_alias"
]
},
"alter": {
"description": "Reassign an alias to another collection.",
"http": {
"method": "POST",
"path": "/v2/vectordb/aliases/alter"
},
"params": [
{
"name": "collectionName",
"type": "string",
"required": true,
"cli": "--collection",
"description": "new target collection"
},
{
"name": "aliasName",
"type": "string",
"required": true,
"cli": "--alias",
"description": "alias name to reassign"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz alias alter --collection new_collection --alias my_alias"
]
},
"drop": {
"description": "Drop an alias.",
"http": {
"method": "POST",
"path": "/v2/vectordb/aliases/drop"
},
"params": [
{
"name": "aliasName",
"type": "string",
"required": true,
"cli": "--alias",
"description": "alias name to drop"
},
{
"name": "dbName",
"type": "string",
"cli": "--database",
"description": "database name"
}
],
"examples": [
"zilliz alias drop --alias my_alias"
]
}
}
}
}
}