DescribeSnapshot()

This operation describes a snapshot. Use it to inspect snapshot metadata before restore or cleanup.

c++

Status DescribeSnapshot(const DescribeSnapshotRequest& request, DescribeSnapshotResponse& response)

Request Syntax

c++

auto request = milvus::DescribeSnapshotRequest()
    .WithDatabaseName("default")
    .WithCollectionName("book")
    .WithSnapshotName("snapshot_20260617");

REQUEST METHODS:

• WithDatabaseName(const std::string& db_name)

  Sets the database name.

• WithCollectionName(const std::string& collection_name)

  Sets the collection name.

• WithSnapshotName(const std::string& snapshot_name)

  Sets the snapshot name.

RETURNS:

Status

EXCEPTIONS:

• std::exception

  This exception can be raised if the request cannot be sent or the response cannot be parsed.

Example

c++

auto client = milvus::MilvusClientV2::Create();
milvus::ConnectParam connect_param{"YOUR_CLUSTER_ENDPOINT", "YOUR_CLUSTER_TOKEN"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}

auto request = milvus::DescribeSnapshotRequest()
    .WithDatabaseName("default")
    .WithCollectionName("book")
    .WithSnapshotName("snapshot_20260617");
milvus::DescribeSnapshotResponse response;
status = client->DescribeSnapshot(request, response);
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}