API-referens
Alla HTTP-slutpunkter i modulen db-postgres: 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.
Cluster
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters
List all postgresclusters in a resource group
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen - Operationsnamn:
ListClusters
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 postgrescluster/read på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/config
Get list configuration for postgresclusters
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen - Operationsnamn:
GetClustersConfig
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 postgrescluster/read på det utvärderade omfånget |
DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{resourceName}
Delete a cluster
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/delete— utvärderas på resursen i sökvägen - Operationsnamn:
DeleteCluster
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 postgrescluster/delete på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{resourceName}
Get a specific cluster
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen - Operationsnamn:
GetCluster
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 postgrescluster/read på det utvärderade omfånget |
PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{resourceName}
Partially update an existing cluster using JSON Merge Patch
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/write— utvärderas på resursen i sökvägen - Operationsnamn:
PatchCluster
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 postgrescluster/write på det utvärderade omfånget |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{resourceName}
Create a new cluster
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/write— utvärderas på resursen i sökvägen - Operationsnamn:
CreateCluster
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: PostgresClusterDto
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte postgrescluster/write på det utvärderade omfånget |
PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{resourceName}
Update an existing cluster
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/write— utvärderas på resursen i sökvägen - Operationsnamn:
UpdateCluster
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: PostgresClusterDto
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte postgrescluster/write på det utvärderade omfånget |
PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{resourceName}/actions/{action}
Execute a lifecycle action (start, stop, restart) on a cluster
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/write— utvärderas på resursen i sökvägen - Operationsnamn:
ExecuteClusterAction
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 postgrescluster/write på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{resourceName}/scale
Get current scale of a cluster
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen - Operationsnamn:
GetClusterScale
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 postgrescluster/read på det utvärderade omfånget |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{resourceName}/scale
Scale a cluster
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/scale— utvärderas på resursen i sökvägen - Operationsnamn:
ScaleCluster
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 postgrescluster/scale på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{resourceName}/snapshots
List snapshots of a cluster
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen - Operationsnamn:
ListClusterSnapshots
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 postgrescluster/read på det utvärderade omfånget |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{resourceName}/snapshots
Create a snapshot of a cluster
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/createSnapshot— utvärderas på resursen i sökvägen - Operationsnamn:
CreateClusterSnapshot
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: CreateSnapshotRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte postgrescluster/createSnapshot på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{resourceName}/snapshots/pitr-window
The point-in-time recovery window of a cluster
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen - Operationsnamn:
GetClusterPitrWindow
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 postgrescluster/read på det utvärderade omfånget |
DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{resourceName}/snapshots/{snapshotId}
Delete a snapshot of a cluster
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/deleteSnapshot— utvärderas på resursen i sökvägen - Operationsnamn:
DeleteClusterSnapshot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
sökväg | string |
Ja |
resourceName |
sökväg | string |
Ja |
snapshotId |
sökväg | uuid |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte postgrescluster/deleteSnapshot på det utvärderade omfånget |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{resourceName}/snapshots/{snapshotId}/restore
Restore a cluster from a snapshot
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/restoreSnapshot— utvärderas på resursen i sökvägen - Operationsnamn:
RestoreClusterFromSnapshot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
sökväg | string |
Ja |
resourceName |
sökväg | string |
Ja |
snapshotId |
sökväg | uuid |
Ja |
Begärans innehåll: RestoreSnapshotRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte postgrescluster/restoreSnapshot på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resources/postgresclusters
List all postgresclusters across all resource groups
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen - Operationsnamn:
ListAllClusters
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 postgrescluster/read på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resources/postgresclusters/config
Get list configuration for all postgresclusters
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen - Operationsnamn:
GetAllClustersConfig
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 postgrescluster/read på det utvärderade omfånget |
Docs
GET /docs/db-postgres/manifest.json
- Autentisering: krävs
- Operationsnamn:
DocsManifest_db-postgres
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
GET /docs/db-postgres/{path}
- Autentisering: krävs
- Operationsnamn:
DocsFile_db-postgres
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
path |
sökväg | string |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
PostgreSQL Compute Plans
GET /boundaries/{boundaryId}/resources/postgrescomputeplans
List all available postgrescomputeplans
- Autentisering: krävs
- Operationsnamn:
ListPostgreSQLComputePlans
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | PagedListResponse<PostgresResourcePlanDto> |
401 |
Inte inloggad, eller ogiltig token | |
500 |
Internt fel | ProblemDetails |
GET /boundaries/{boundaryId}/resources/postgrescomputeplans/{resourceId}
Get a specific postgrescomputeplan by ID
- Autentisering: krävs
- Operationsnamn:
GetPostgreSQLComputePlan
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceId |
sökväg | string |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | PostgresResourcePlanDto |
401 |
Inte inloggad, eller ogiltig token | |
404 |
Hittades inte | |
500 |
Internt fel | ProblemDetails |
PostgreSQL Databases
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{name}/connectionstring
Get the internal connection string for a PostgreSQL cluster
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/readSecrets— utvärderas på resursen i sökvägen; en dataåtgärd
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
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 postgrescluster/readSecrets på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{name}/connectionstring/external
Get the external (LoadBalancer) connection string for a PostgreSQL cluster
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/readSecrets— utvärderas på resursen i sökvägen; en dataåtgärd
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
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 postgrescluster/readSecrets på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{name}/external-ip
Get the externally reachable address of a PostgreSQL cluster's ingress
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
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 postgrescluster/read på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{name}/health
Check if a PostgreSQL cluster is healthy
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
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 postgrescluster/read på det utvärderade omfånget |
PostgreSQL Editor
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{name}/editor/history
List recent editor activity for a cluster (most recent first).
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
sökväg | string |
Ja |
name |
sökväg | string |
Ja |
limit |
frågesträng | integer |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte postgrescluster/read på det utvärderade omfånget |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{name}/editor/query
Classify, authorize, and (optionally) execute a SQL batch against a postgres cluster.
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
sökväg | string |
Ja |
name |
sökväg | string |
Ja |
Begärans innehåll: EditorQueryRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte postgrescluster/read på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{name}/editor/schemas
List schemas, tables, columns, and primary keys for the cluster's databases.
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/schemaRead— utvärderas på resursen i sökvägen; en dataåtgärd
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
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 postgrescluster/schemaRead på det utvärderade omfånget |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{name}/editor/tables/{schema}/{table}/rows
List rows in a table (keyset-friendly ordering on the primary key).
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
sökväg | string |
Ja |
name |
sökväg | string |
Ja |
schema |
sökväg | string |
Ja |
table |
sökväg | string |
Ja |
limit |
frågesträng | integer |
Nej |
offset |
frågesträng | integer |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte postgrescluster/read på det utvärderade omfånget |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{name}/editor/tables/{schema}/{table}/rows
Insert a row into the table via structured payload.
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
sökväg | string |
Ja |
name |
sökväg | string |
Ja |
schema |
sökväg | string |
Ja |
table |
sökväg | string |
Ja |
Begärans innehåll: RowMutationRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte postgrescluster/read på det utvärderade omfånget |
DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{name}/editor/tables/{schema}/{table}/rows/{pkValue}
Delete a row identified by its single-column primary key.
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
sökväg | string |
Ja |
name |
sökväg | string |
Ja |
schema |
sökväg | string |
Ja |
table |
sökväg | string |
Ja |
pkValue |
sökväg | string |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte postgrescluster/read på det utvärderade omfånget |
PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{name}/editor/tables/{schema}/{table}/rows/{pkValue}
Update a row identified by its single-column primary key.
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
sökväg | string |
Ja |
name |
sökväg | string |
Ja |
schema |
sökväg | string |
Ja |
table |
sökväg | string |
Ja |
pkValue |
sökväg | string |
Ja |
Begärans innehåll: RowMutationRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte postgrescluster/read på det utvärderade omfånget |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{name}/editor/tables/{schema}/{table}/rows:bulk
Update multiple rows in one atomic transaction, each identified by its single-column primary key.
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
sökväg | string |
Ja |
name |
sökväg | string |
Ja |
schema |
sökväg | string |
Ja |
table |
sökväg | string |
Ja |
Begärans innehåll: BulkUpdateRowsRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte postgrescluster/read på det utvärderade omfånget |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{name}/editor/tables/{schema}/{table}/rows:bulk-delete
Delete multiple rows in one atomic transaction by single-column primary key.
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
sökväg | string |
Ja |
name |
sökväg | string |
Ja |
schema |
sökväg | string |
Ja |
table |
sökväg | string |
Ja |
Begärans innehåll: BulkDeleteRowsRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte postgrescluster/read på det utvärderade omfånget |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/postgresclusters/{name}/editor/tables/{schema}/{table}/rows:bulk-insert
Insert multiple rows in one atomic transaction.
- Autentisering: krävs
- IAM-åtgärd:
postgrescluster/read— utvärderas på resursen i sökvägen
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundaryId |
sökväg | uuid |
Ja |
resourceGroupName |
sökväg | string |
Ja |
name |
sökväg | string |
Ja |
schema |
sökväg | string |
Ja |
table |
sökväg | string |
Ja |
Begärans innehåll: BulkInsertRowsRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte postgrescluster/read på det utvärderade omfånget |
Övriga slutpunkter
GET /readyz
- Autentisering: ingen — anonyma anrop accepteras
- Operationsnamn:
StackshipReadiness
Svar
| Status | Betydelse | Innehåll |
|---|
Scheman
BulkDeleteRowsRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
pkValues |
string [] |
Nej |
BulkInsertRowsRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
rows |
map (any) [] |
Nej |
BulkRowUpdate
| Egenskap | Typ | Kan vara null |
|---|---|---|
pkValue |
string |
Nej |
values |
map (any) |
Nej |
BulkUpdateRowsRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
updates |
BulkRowUpdate [] |
Nej |
CreateSnapshotRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
description |
string |
Ja |
ttlHours |
integer |
Ja |
EditorQueryRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
defaultSchema |
string |
Nej |
maxRows |
integer |
Ja |
mode |
ExecutionMode |
Nej |
priorCorrelationId |
uuid |
Ja |
readOnly |
boolean |
Nej |
sql |
string |
Nej |
statementTimeoutMs |
integer |
Ja |
ExecutionMode
Ett av: Review, DryRun, Commit.
PagedListResponse<PostgresResourcePlanDto>
| Egenskap | Typ | Kan vara null |
|---|---|---|
items |
PostgresResourcePlanDto [] |
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 |
PostgresClusterDto
| Egenskap | Typ | Kan vara null |
|---|---|---|
allowedCidrs |
string |
Ja |
backupConfigured |
boolean |
Nej |
backupRetentionPolicy |
string |
Ja |
backupSchedule |
string |
Ja |
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 |
currentPrimary |
string |
Ja |
databaseName |
string |
Ja |
enableLoadBalancer |
boolean |
Nej |
enableSsl |
boolean |
Nej |
id |
uuid |
Nej |
imageName |
string |
Ja |
instances |
integer |
Ja |
memoryLimit |
string |
Ja |
memoryRequest |
string |
Ja |
monitoringEnabled |
boolean |
Nej |
name |
string |
Nej |
networkPolicy |
string |
Ja |
pgBouncerEnabled |
boolean |
Ja |
pgBouncerInstances |
integer |
Ja |
pgBouncerPoolMode |
string |
Ja |
phase |
string |
Ja |
postgresVersion |
string |
Nej |
postgresqlParameters |
map (string) |
Ja |
publicEndpoint |
string |
Ja |
readService |
string |
Ja |
readyInstances |
integer |
Ja |
region |
string |
Nej |
resourceGroup |
string |
Nej |
resourcePlanId |
string |
Ja |
restartImpact |
string |
Ja |
status |
string |
Nej |
storageClass |
string |
Ja |
storageSize |
string |
Ja |
tags |
map (string) |
Nej |
walStorageSize |
string |
Ja |
warnings |
string [] |
Ja |
writeService |
string |
Ja |
PostgresResourcePlanDto
| Egenskap | Typ | Kan vara null |
|---|---|---|
cpuLimit |
string |
Nej |
cpuRequest |
string |
Nej |
description |
string |
Nej |
engineParameters |
map (string) |
Nej |
id |
string |
Nej |
isProductionReady |
boolean |
Nej |
memoryLimit |
string |
Nej |
memoryRequest |
string |
Nej |
name |
string |
Nej |
poolingEnabled |
boolean |
Nej |
poolingInstances |
integer |
Ja |
poolingMode |
string |
Ja |
replicas |
integer |
Nej |
storageClass |
string |
Nej |
storageSize |
string |
Nej |
verdict |
string |
Nej |
verdictReason |
string |
Ja |
walStorageSize |
string |
Ja |
RestoreSnapshotRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
targetTime |
date-time |
Ja |
RowMutationRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
values |
map (any) |
Nej |
ScaleRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
targetScale |
integer |
Nej |