Read a vector namespace

POST /v1/tenants/{tenant}/vector-indexes/{index}/namespaces/describe

Inspect one namespace's stored recordsPending counters and stored-record counts describe different states.

Select the index and namespaceUse the namespace's exact name.
Read its state and countersInspect record_count and pending work separately.
Interpret current usageDo not add unrelated counters into one total.

Before you start

Use your database bearer token.

Use the target vector index and, where required, its namespace. The examples use index demo-search and namespace demo.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`index`	`string`	Required

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Request body

application/json

Limits and accepted values

include_deleting: true needs manage on the index and currently answers 501.

Field	Type	Required
`include_deleting`	`boolean`	Optional
`name`	`string`	Required

Read the result

record_count describes stored records, while pending counters describe work that is not yet in the same state. Do not add every counter together as though they were disjoint totals.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
404	Check the resource ID and API route.
413	Split or reduce the request body.
415	Send the required Content-Type.
422	Correct the values or unsupported combination.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
501	Check deployment support for this operation.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request POST "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/vector-indexes/demo-search/namespaces/describe" \
  --header "Authorization: Bearer ${OC_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary '{
  "name": "demo"
}'

Response example

Examples use synthetic values to show the response format.

Response status

{
  "name": "demo",
  "namespace_id": "33333333-3333-4333-8333-333333333333",
  "state": "active",
  "record_count": 2,
  "pending_records": 0,
  "pending_new_records": 0,
  "dense_ids": 2,
  "sparse_ids": 0,
  "declared_capacity": 1000,
  "position": {
    "domain": "wal",
    "value": "1042:0"
  }
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Request bodyCopy Anchor Link