Hoppa till innehållet
Stackship-dokumentation English

Vektorlagringar (Qdrant)AnvändareMaskinöversatt

API-referens

Alla HTTP-slutpunkter i modulen db-qdrant: autentisering, IAM-åtgärd, parametrar, innehåll och statuskoder.

Genererad från modulens kod när dess image byggdes — redigera inte. Sökvägarna är relativa till https://api.example.com.

Docs

GET /docs/db-qdrant/manifest.json

  • Autentisering: krävs
  • Operationsnamn: DocsManifest_db-qdrant

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token

GET /docs/db-qdrant/{path}

  • Autentisering: krävs
  • Operationsnamn: DocsFile_db-qdrant

Parametrar

Namn Plats Typ Obligatorisk
path sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token

Qdrant Compute Plans

GET /boundaries/{boundaryId}/resources/qdrantcomputeplans

List all available qdrantcomputeplans

  • Autentisering: krävs
  • Operationsnamn: ListQdrantComputePlans

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK PagedListResponse<QdrantResourcePlanDto>
401 Inte inloggad, eller ogiltig token
500 Internt fel ProblemDetails

GET /boundaries/{boundaryId}/resources/qdrantcomputeplans/{resourceId}

Get a specific qdrantcomputeplan by ID

  • Autentisering: krävs
  • Operationsnamn: GetQdrantComputePlan

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceId sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK QdrantResourcePlanDto
401 Inte inloggad, eller ogiltig token
404 Hittades inte
500 Internt fel ProblemDetails

Qdrant Databases

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/qdrantclusters/{name}/apikey

Get the API key for a Qdrant cluster

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
name sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/readSecrets på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/qdrantclusters/{name}/apikey/rotate

Rotate the API key for a Qdrant cluster

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
name sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/writeSecrets på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/qdrantclusters/{name}/connectioninfo

Get the connection info (REST and gRPC endpoints) for a Qdrant cluster

  • Autentisering: krävs
  • IAM-åtgärd: qdrantcluster/read — utvärderas på resursen i sökvägen

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
name sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/qdrantclusters/{name}/external-ip

Get the externally reachable address of a Qdrant cluster's ingress

  • Autentisering: krävs
  • IAM-åtgärd: qdrantcluster/read — utvärderas på resursen i sökvägen

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
name sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/qdrantclusters/{name}/health

Check if a Qdrant cluster is healthy

  • Autentisering: krävs
  • IAM-åtgärd: qdrantcluster/read — utvärderas på resursen i sökvägen

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
name sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/read på det utvärderade omfånget

QdrantCluster

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/qdrantclusters

List all qdrantclusters in a resource group

  • Autentisering: krävs
  • IAM-åtgärd: qdrantcluster/read — utvärderas på resursen i sökvägen
  • Operationsnamn: ListQdrantClusters

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/qdrantclusters/config

Get list configuration for qdrantclusters

  • Autentisering: krävs
  • IAM-åtgärd: qdrantcluster/read — utvärderas på resursen i sökvägen
  • Operationsnamn: GetQdrantClustersConfig

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg string Ja
resourceGroupName sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/read på det utvärderade omfånget

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/qdrantclusters/{resourceName}

Delete a qdrantcluster

  • Autentisering: krävs
  • IAM-åtgärd: qdrantcluster/delete — utvärderas på resursen i sökvägen
  • Operationsnamn: DeleteQdrantCluster

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
resourceName sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/delete på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/qdrantclusters/{resourceName}

Get a specific qdrantcluster

  • Autentisering: krävs
  • IAM-åtgärd: qdrantcluster/read — utvärderas på resursen i sökvägen
  • Operationsnamn: GetQdrantCluster

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
resourceName sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/read på det utvärderade omfånget

PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/qdrantclusters/{resourceName}

Partially update an existing qdrantcluster using JSON Merge Patch

  • Autentisering: krävs
  • IAM-åtgärd: qdrantcluster/write — utvärderas på resursen i sökvägen
  • Operationsnamn: PatchQdrantCluster

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
resourceName sökväg string Ja

Begärans innehåll: any

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/write på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/qdrantclusters/{resourceName}

Create a new qdrantcluster

  • Autentisering: krävs
  • IAM-åtgärd: qdrantcluster/write — utvärderas på resursen i sökvägen
  • Operationsnamn: CreateQdrantCluster

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
resourceName sökväg string Ja

Begärans innehåll: QdrantClusterDto

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/write på det utvärderade omfånget

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/qdrantclusters/{resourceName}

Update an existing qdrantcluster

  • Autentisering: krävs
  • IAM-åtgärd: qdrantcluster/write — utvärderas på resursen i sökvägen
  • Operationsnamn: UpdateQdrantCluster

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
resourceName sökväg string Ja

Begärans innehåll: QdrantClusterDto

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/write på det utvärderade omfånget

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/qdrantclusters/{resourceName}/actions/{action}

Execute a lifecycle action (start, stop, restart) on a qdrantcluster

  • Autentisering: krävs
  • IAM-åtgärd: qdrantcluster/write — utvärderas på resursen i sökvägen
  • Operationsnamn: ExecuteQdrantClusterAction

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
resourceName sökväg string Ja
action sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/write på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/qdrantclusters/{resourceName}/scale

Get current scale of a qdrantcluster

  • Autentisering: krävs
  • IAM-åtgärd: qdrantcluster/read — utvärderas på resursen i sökvägen
  • Operationsnamn: GetQdrantClusterScale

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
resourceName sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/read på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/qdrantclusters/{resourceName}/scale

Scale a qdrantcluster

  • Autentisering: krävs
  • IAM-åtgärd: qdrantcluster/scale — utvärderas på resursen i sökvägen
  • Operationsnamn: ScaleQdrantCluster

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
resourceName sökväg string Ja

Begärans innehåll: ScaleRequest

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/scale på det utvärderade omfånget

GET /boundaries/{boundaryId}/resources/qdrantclusters

List all qdrantclusters across all resource groups

  • Autentisering: krävs
  • IAM-åtgärd: qdrantcluster/read — utvärderas på resursen i sökvägen
  • Operationsnamn: ListAllQdrantClusters

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resources/qdrantclusters/config

Get list configuration for all qdrantclusters

  • Autentisering: krävs
  • IAM-åtgärd: qdrantcluster/read — utvärderas på resursen i sökvägen
  • Operationsnamn: GetAllQdrantClustersConfig

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte qdrantcluster/read på det utvärderade omfånget

Övriga slutpunkter

GET /readyz

  • Autentisering: ingen — anonyma anrop accepteras
  • Operationsnamn: StackshipReadiness

Svar

Status Betydelse Innehåll

Scheman

PagedListResponse<QdrantResourcePlanDto>

Egenskap Typ Kan vara null
items QdrantResourcePlanDto [] Nej
pagination PaginationMeta Nej

PaginationMeta

Egenskap Typ Kan vara null
hasNextPage boolean Nej
hasPreviousPage boolean Nej
page integer Nej
pageSize integer Nej
totalItems integer Nej
totalPages integer Nej

QdrantClusterDto

Egenskap Typ Kan vara null
allowedCidrs string Ja
apiKeyEnabled boolean Nej
boundary string Nej
boundaryId uuid Nej
clusterId uuid Nej
clusterName string Nej
collection string Nej
computePlan string Ja
cpuLimit string Ja
cpuRequest string Ja
createdAt date-time Nej
enableIngress boolean Nej
enableLoadBalancer boolean Nej
id uuid Nej
imageName string Ja
ingressHost string Ja
memoryLimit string Ja
memoryRequest string Ja
name string Nej
phase string Ja
publicEndpoint string Ja
qdrantVersion string Nej
readyReplicas integer Ja
region string Nej
replicas integer Ja
resourceGroup string Nej
resourcePlanId string Ja
status string Nej
statusMessage string Ja
storageClass string Ja
storageSize string Ja
tags map (string) Nej

QdrantResourcePlanDto

Egenskap Typ Kan vara null
cpuLimit string Nej
cpuRequest string Nej
description string Nej
id string Nej
isProductionReady boolean Nej
memoryLimit string Nej
memoryRequest string Nej
name string Nej
replicas integer Nej
storageClass string Nej
storageSize string Nej
verdict string Nej
verdictReason string Ja

ScaleRequest

Egenskap Typ Kan vara null
targetScale integer Nej