escriure Punts Finals
Escriviu operacions de daemon (transaccions i mutacions)
Punts d’extremitat
GET /v1/write/health
Resum: OpenAPI metadades per a la salut del daemon d’escriptura.
Operation ID: health_endpoint
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Estat de salut del daemon d’escriptura | HealthResponse |
| 503 | Les comprovacions de salut han fallat | ProblemDetails |
GET /v1/write/livez
Resum: OpenAPI metadades per a la prova de viabilitat del daemon d’escriptura.
Operation ID: livez_endpoint
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Prova de viabilitat del daemon d’escriptura | ProbeResponse |
| 503 | El daemon d’escriptura no està actiu | ProblemDetails |
GET /v1/write/namespaces
Resum: OpenAPI metadades per a llistat d’espais de noms.
Operation ID: list_namespaces_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
limit | consulta | no | enter | Nombre màxim d’articles a retornar. |
page_token | consulta | no | PageToken | Token de paginació opac per a la següent pàgina. |
tenant_id | consulta | no | TenantId | Filtre de llogater opcional. |
owner_principal_id | consulta | no | PrincipalId | Filtre de principal propietari opcional. |
policy_class | consulta | no | PolicyClass | Filtre de classe de política opcional. |
lifecycle | consulta | no | LifecycleState | Filtre de cicle de vida opcional. |
write_mode | consulta | no | NamespaceWriteMode | Filtre de mode d’escriptura opcional. |
draining | consulta | no | boolean | Filtre de drenatge opcional. |
frozen | consulta | no | boolean | Filtre de congelat opcional. |
include_deleted | consulta | no | boolean | Incloure espais de noms eliminats quan sigui cert. |
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Llista d’espais de noms | NamespaceListResponse |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Espai de noms no trobat | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
POST /v1/write/namespaces
Resum: OpenAPI metadades per a la creació d’espais de noms.
Operation ID: create_namespace_endpoint
Correu de sol·licitud
- Content type: application/json
- Esquema:
NamespaceCreateRequest
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Namespace creat o ja present | NamespaceCreateResponse |
| 400 | Identificador de namespace no vàlid | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Namespace no trobat | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
ELIMINAR /v1/escriure/nomsespais/{namespace_id}
Resum: OpenAPI metadades per eliminar espais de noms.
Operation ID: delete_namespace_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
| namespace_id | camí | sí | NamespaceId | Identificador de l’espai de noms |
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Namespace eliminat | NamespaceDeleteResponse |
| 400 | Identificador de namespace no vàlid | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Namespace no trobat | ProblemDetails |
| 412 | Namespace té recursos adjunts | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
GET /v1/write/namespaces/{namespace_id}
Resum: OpenAPI metadades per obtenir metadades de l’espai de noms.
Operation ID: get_namespace_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
| namespace_id | camí | sí | NamespaceId | Identificador de l’espai de noms |
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Metadades del namespace | NamespaceGetResponse |
| 400 | Identificador de namespace no vàlid | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Namespace no trobat | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
PATCH /v1/write/namespaces/{namespace_id}
Resum: OpenAPI metadades per actualitzar les metadades de l’espai de noms.
Operation ID: update_namespace_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
| namespace_id | camí | sí | NamespaceId | Identificador de l’espai de noms |
Correu de sol·licitud
- Content type: application/json
- Esquema:
NamespaceUpdateRequest
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Espai de noms actualitzat | NamespaceUpdateResponse |
| 400 | Identificador d’espai de noms no vàlid | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Espai de noms no trobat | ProblemDetails |
| 412 | Condició prèvia de revisió fallida | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespace_id}/commit
Resum: OpenAPI metadades per a la presentació de compromisos.
Operation ID: commit_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
| namespace_id | camí | sí | NamespaceId | Identificador de l’espai de noms |
Correu de sol·licitud
- Content type: application/json
- Schema: CommitRequest
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Compromís acceptat | CommitResponse |
| 400 | Payload de compromís no vàlid | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Espai de noms no trobat | ProblemDetails |
| 409 | Clau d’idempotència reutilitzada amb un payload diferent | ProblemDetails |
| 422 | Validació del compromís fallida | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespace_id}/commit/preflight
Resum: OpenAPI metadades per al preflight de commit.
Operation ID: commit_preflight_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
| namespace_id | camí | sí | NamespaceId | Identificador de l’espai de noms |
Correu de sol·licitud
- Content type: application/json
- Schema: CommitRequest
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Resultat del preflight de commit | PreflightCommitResponse |
| 400 | Càrrega de commit no vàlida | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Espai de noms no trobat | ProblemDetails |
| 422 | Validació del commit fallida | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespaceid}/commits/{commitid}/reverse
Resum: OpenAPI metadades per a revertir compromisos.
Operation ID: reverse_commit_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
namespace_id | path | sí | NamespaceId | Identificador de l’espai de noms |
commit_id | path | sí | string | Identificador del commit |
Correu de sol·licitud
- Content type: application/json
- Esquema:
ReverseCommitRequest
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Compromís invers aplicat | ReverseCommitResponse |
| 400 | Càrrega de compromís invers no vàlida | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Compromís no trobat | ProblemDetails |
| 409 | Fallida de la precondició del compromís invers | ProblemDetails |
| 410 | Compromís invers ja no disponible | ProblemDetails |
| 422 | Fallida de la validació del compromís invers | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespace_id}/lifecycle
Resum: OpenAPI metadades per actualitzar el cicle de vida de l’espai de noms.
Operation ID: namespace_lifecycle_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
| namespace_id | camí | sí | NamespaceId | Identificador de l’espai de noms |
Correu de sol·licitud
- Content type: application/json
- Esquema:
NamespaceLifecycleRequest
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Cicle de vida de l’espai de noms actualitzat | NamespaceLifecycleResponse |
| 400 | Identificador d’espai de noms no vàlid | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Espai de noms no trobat | ProblemDetails |
| 412 | Condició prèvia de revisió fallida | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespaceid}/operationalstate
Resum: OpenAPI metadades per actualitzar l’estat operatiu de l’espai de noms.
Operation ID: namespace_operational_state_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
| namespace_id | camí | sí | NamespaceId | Identificador de l’espai de noms |
Correu de sol·licitud
- Content type: application/json
- Esquema:
NamespaceOperationalStateRequest
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Estat operatiu de l’espai de noms actualitzat | NamespaceOperationalStateResponse |
| 400 | Identificador d’espai de noms no vàlid | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Espai de noms no trobat | ProblemDetails |
| 412 | Fallida de la condició prèvia de revisió | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespace_id}/placement
Resum: OpenAPI metadades per actualitzar la col·locació de l’espai de noms.
Operation ID: namespace_placement_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
| namespace_id | camí | sí | NamespaceId | Identificador de l’espai de noms |
Correu de sol·licitud
- Content type: application/json
- Esquema:
NamespacePlacementRequest
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Col·locació de l’espai de noms actualitzada | NamespacePlacementResponse |
| 400 | Identificador d’espai de noms no vàlid | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Espai de noms no trobat | ProblemDetails |
| 412 | Condició prèvia de revisió fallida | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespaceid}/registerclass
Resum: OpenAPI metadades per a la registració de classes.
Operation ID: register_class_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
| namespace_id | camí | sí | NamespaceId | Identificador de l’espai de noms |
Correu de sol·licitud
- Content type: application/json
- Esquema:
RegisterClassRequest
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Classe registrada | RegisterClassResponse |
| 400 | Càrrega de sol·licitud no vàlida | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Espai de noms no trobat | ProblemDetails |
| 409 | La classe ja existeix | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespaceid}/registerclasscontinuousshape_1d
Resum: OpenAPI metadades per al registre continu de formes de classe 1D.
Operation ID: register_class_continuous_shape_1d_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
| namespace_id | camí | sí | NamespaceId | Identificador de l’espai de noms |
Correu de sol·licitud
- Content type: application/json
- Esquema:
RegisterClassContinuousShape1dRequest
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Forma de classe 1D contínua registrada | RegisterClassContinuousShape1dResponse |
| 400 | Càrrega de sol·licitud no vàlida | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Espai de noms no trobat | ProblemDetails |
| 409 | La forma de classe ja existeix | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespaceid}/registerclasscontinuousshape_2d
Resum: OpenAPI metadades per al registre de formes de classe contínues 2D.
Operation ID: register_class_continuous_shape_2d_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
| namespace_id | camí | sí | NamespaceId | Identificador de l’espai de noms |
Correu de sol·licitud
- Content type: application/json
- Esquema:
RegisterClassContinuousShape2dRequest
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Forma de classe 2D contínua registrada | RegisterClassContinuousShape2dResponse |
| 400 | Càrrega de sol·licitud no vàlida | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Espai de noms no trobat | ProblemDetails |
| 409 | La forma de classe ja existeix | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespaceid}/registerclass_shape
Resum: OpenAPI metadades per al registre de formes de classe.
Operation ID: register_class_shape_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
| namespace_id | camí | sí | NamespaceId | Identificador de l’espai de noms |
Correu de sol·licitud
- Content type: application/json
- Esquema:
RegisterClassShapeRequest
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Forma de classe registrada | RegisterClassShapeResponse |
| 400 | Càrrega de sol·licitud no vàlida | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Espai de noms no trobat | ProblemDetails |
| 409 | La forma de classe ja existeix | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
GET /v1/write/namespaces/{namespace_id}/status
Resum: OpenAPI metadades per a l’estat de l’espai de noms.
Operation ID: namespace_status_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
| namespace_id | camí | sí | NamespaceId | Identificador de l’espai de noms |
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Metadades d’estat de l’espai de noms | NamespaceStatusResponse |
| 400 | Identificador d’espai de noms no vàlid | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Espai de noms no trobat | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
GET /v1/write/namespaces/changes
Resum: OpenAPI metadades per a llistat de canvis d’espai de noms.
Operation ID: list_namespace_changes_endpoint
Paràmetres
| Nom | En | Requerit | Tipus | Descripció |
|---|---|---|---|---|
limit | consulta | no | enter | Nombre màxim d’articles a retornar. |
page_token | consulta | no | ChangeToken | Token opac de paginació per a la següent pàgina. |
since_updated_at_ms | consulta | sí | enter | Límite inferior per a les marques de temps actualitzades (mil·lisegons des de l’epoch). |
tenant_id | consulta | no | TenantId | Filtre opcional de llogater. |
owner_principal_id | consulta | no | PrincipalId | Filtre opcional de principal propietari. |
policy_class | consulta | no | PolicyClass | Filtre opcional de classe de política. |
lifecycle | consulta | no | LifecycleState | Filtre opcional de cicle de vida. |
write_mode | consulta | no | NamespaceWriteMode | Filtre opcional de mode d’escriptura. |
draining | consulta | no | boolean | Filtre opcional de drenatge. |
frozen | consulta | no | boolean | Filtre opcional de congelat. |
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Llista de canvis de namespace | NamespaceChangeListResponse |
| 400 | Paràmetres de sol·licitud no vàlids | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Namespace no trobat | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
POST /v1/write/namespaces/forkfromsnapshot
Resum: OpenAPI metadades per bifurcar espais de noms.
ID d’operació: fork_namespace_from_snapshot_endpoint
Correu de sol·licitud
- Content type: application/json
- Esquema:
NamespaceForkFromSnapshotRequest
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Namespace bifurcat del snapshot | NamespaceForkFromSnapshotResponse |
| 400 | Paràmetres de sol·licitud no vàlids | ProblemDetails |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Namespace no trobat | ProblemDetails |
| 409 | Namespace ja existeix | ProblemDetails |
| 422 | Validació del snapshot fallida | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
GET /v1/write/namespaces/status
Resum: OpenAPI metadades per a llistat dels registres d’estat de l’espai de noms.
Operation ID: namespace_status_list_endpoint
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Llista d’estats de l’espai de noms | NamespaceStatusListResponse |
| 401 | Sol·licitud no autoritzada | ProblemDetails |
| 404 | Espai de noms no trobat | ProblemDetails |
| 429 | Quota excedida | ProblemDetails |
| 500 | Error intern del daemon | ProblemDetails |
GET /v1/write/readyz
Resum: OpenAPI metadades per a la sonda de disponibilitat del daemon d’escriptura.
Operation ID: readyz_endpoint
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Prova de disponibilitat del daemon d’escriptura | ReadyzResponse |
| 503 | El daemon d’escriptura no està llest | ReadyzResponse |
GET /v1/write/startupz
Resum: OpenAPI metadades per a la prova d’inici del daemon de escritura.
Operation ID: startupz_endpoint
Respostes
| Estat | Descripció | Esquema |
|---|---|---|
| 200 | Prova d’inici del daemon d’escriptura | ProbeResponse |
| 503 | El daemon d’escriptura no ha començat | ProblemDetails |