escribir Endpoints
Escribir operaciones de daemon (transacciones y mutaciones)
Puntos finales
GET /v1/write/health
Resumen: OpenAPI metadatos para la salud del daemon de escritura.
ID de operación: health_endpoint
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Estado de salud del daemon de escritura | HealthResponse |
| 503 | Fallaron las comprobaciones de salud | ProblemDetails |
GET /v1/write/livez
Resumen: OpenAPI metadatos para la sonda de actividad del daemon de escritura.
ID de operación: livez_endpoint
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Probar la vivacidad del daemon de escritura | ProbeResponse |
| 503 | El daemon de escritura no está activo | ProblemDetails |
GET /v1/write/namespaces
Resumen: OpenAPI metadatos para listar espacios de nombres.
ID de operación: list_namespaces_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
limit | query | no | integer | Número máximo de elementos a devolver. |
page_token | query | no | PageToken | Token de paginación opaco para la siguiente página. |
tenant_id | query | no | TenantId | Filtro de inquilino opcional. |
owner_principal_id | query | no | PrincipalId | Filtro de principal de propietario opcional. |
policy_class | query | no | PolicyClass | Filtro de clase de política opcional. |
lifecycle | query | no | LifecycleState | Filtro de ciclo de vida opcional. |
write_mode | query | no | NamespaceWriteMode | Filtro de modo de escritura opcional. |
draining | query | no | boolean | Filtro de drenaje opcional. |
frozen | query | no | boolean | Filtro de congelación opcional. |
include_deleted | query | no | boolean | Incluir espacios de nombres eliminados cuando sea verdadero. |
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Lista de espacios de nombres | NamespaceListResponse |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
POST /v1/write/namespaces
Resumen: OpenAPI metadatos para crear espacios de nombres.
ID de operación: create_namespace_endpoint
Cuerpo de la solicitud
- Content type: application/json
- Esquema:
NamespaceCreateRequest
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Espacio de nombres creado o ya presente | NamespaceCreateResponse |
| 400 | Identificador de espacio de nombres no válido | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
ELIMINAR /v1/write/namespaces/{namespace_id}
Resumen: OpenAPI metadatos para eliminar espacios de nombres.
ID de operación: delete_namespace_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
| namespace_id | ruta | sí | NamespaceId | Identificador de espacio de nombres |
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Espacio de nombres eliminado | NamespaceDeleteResponse |
| 400 | Identificador de espacio de nombres inválido | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 412 | El espacio de nombres tiene recursos adjuntos | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
GET /v1/write/namespaces/{namespace_id}
Resumen: OpenAPI metadatos para obtener metadatos de espacio de nombres.
ID de operación: get_namespace_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
| namespace_id | ruta | sí | NamespaceId | Identificador de espacio de nombres |
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Metadatos del espacio de nombres | NamespaceGetResponse |
| 400 | Identificador de espacio de nombres no válido | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
PATCH /v1/write/namespaces/{namespace_id}
Resumen: OpenAPI metadatos para actualizar los metadatos del espacio de nombres.
ID de operación: update_namespace_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
| namespace_id | ruta | sí | NamespaceId | Identificador de espacio de nombres |
Cuerpo de la solicitud
- Content type: application/json
- Esquema:
NamespaceUpdateRequest
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Espacio de nombres actualizado | NamespaceUpdateResponse |
| 400 | Identificador de espacio de nombres no válido | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 412 | Fallo en la condición previa de revisión | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespace_id}/commit
Resumen: OpenAPI metadatos para la presentación de compromisos.
ID de operación: commit_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
| namespace_id | ruta | sí | NamespaceId | Identificador de espacio de nombres |
Cuerpo de la solicitud
- Content type: application/json
- Esquema: CommitRequest
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Compromiso aceptado | CommitResponse |
| 400 | Carga útil de compromiso no válida | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 409 | Clave de idempotencia reutilizada con carga útil diferente | ProblemDetails |
| 422 | Validación de compromiso fallida | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespace_id}/commit/preflight
Resumen: OpenAPI metadatos para el preflight de commit.
ID de operación: commit_preflight_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
| namespace_id | ruta | sí | NamespaceId | Identificador de espacio de nombres |
Cuerpo de la solicitud
- Content type: application/json
- Esquema: CommitRequest
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Resultado de prevalidación de compromiso | PreflightCommitResponse |
| 400 | Carga útil de compromiso no válida | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 422 | Validación de compromiso fallida | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespaceid}/commits/{commitid}/reverse
Resumen: OpenAPI metadatos para reversión de commits.
ID de operación: reverse_commit_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
namespace_id | ruta | sí | NamespaceId | Identificador de espacio de nombres |
commit_id | ruta | sí | string | Identificador de compromiso |
Cuerpo de la solicitud
- Content type: application/json
- Esquema:
ReverseCommitRequest
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Compromiso inverso aplicado | ReverseCommitResponse |
| 400 | Carga útil de compromiso inverso no válida | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Compromiso no encontrado | ProblemDetails |
| 409 | Fallo en la precondición del compromiso inverso | ProblemDetails |
| 410 | Compromiso inverso ya no disponible | ProblemDetails |
| 422 | Fallo en la validación del compromiso inverso | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespace_id}/lifecycle
Resumen: OpenAPI metadatos para actualizar el ciclo de vida del espacio de nombres.
ID de operación: namespace_lifecycle_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
| namespace_id | ruta | sí | NamespaceId | Identificador de espacio de nombres |
Cuerpo de la solicitud
- Content type: application/json
- Esquema:
NamespaceLifecycleRequest
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Ciclo de vida del espacio de nombres actualizado | NamespaceLifecycleResponse |
| 400 | Identificador de espacio de nombres no válido | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 412 | Fallo en la condición previa de revisión | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespaceid}/operationalstate
Resumen: OpenAPI metadatos para actualizar el estado operativo del espacio de nombres.
ID de operación: namespace_operational_state_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
| namespace_id | ruta | sí | NamespaceId | Identificador de espacio de nombres |
Cuerpo de la solicitud
- Content type: application/json
- Esquema:
NamespaceOperationalStateRequest
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Estado operativo del espacio de nombres actualizado | NamespaceOperationalStateResponse |
| 400 | Identificador de espacio de nombres no válido | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 412 | Fallo en la condición previa de revisión | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespace_id}/placement
Resumen: OpenAPI metadatos para actualizar la colocación del espacio de nombres.
ID de operación: namespace_placement_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
| namespace_id | ruta | sí | NamespaceId | Identificador de espacio de nombres |
Cuerpo de la solicitud
- Content type: application/json
- Esquema:
NamespacePlacementRequest
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Colocación de espacio de nombres actualizada | NamespacePlacementResponse |
| 400 | Identificador de espacio de nombres no válido | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 412 | Falló la condición previa de revisión | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespaceid}/registerclass
Resumen: OpenAPI metadatos para el registro de clases.
ID de operación: register_class_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
| namespace_id | ruta | sí | NamespaceId | Identificador de espacio de nombres |
Cuerpo de la solicitud
- Content type: application/json
- Esquema:
RegisterClassRequest
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Clase registrada | RegisterClassResponse |
| 400 | Carga útil de solicitud no válida | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 409 | La clase ya existe | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespaceid}/registerclasscontinuousshape_1d
Resumen: OpenAPI metadatos para el registro continuo de formas de clase 1D.
ID de operación: register_class_continuous_shape_1d_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
| namespace_id | ruta | sí | NamespaceId | Identificador de espacio de nombres |
Cuerpo de la solicitud
- Content type: application/json
- Esquema:
RegisterClassContinuousShape1dRequest
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Forma de clase 1D continua registrada | RegisterClassContinuousShape1dResponse |
| 400 | Carga útil de solicitud no válida | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 409 | La forma de clase ya existe | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespaceid}/registerclasscontinuousshape_2d
Resumen: OpenAPI metadatos para el registro continuo de formas de clase 2D.
ID de operación: register_class_continuous_shape_2d_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
| namespace_id | ruta | sí | NamespaceId | Identificador de espacio de nombres |
Cuerpo de la solicitud
- Content type: application/json
- Esquema:
RegisterClassContinuousShape2dRequest
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Forma de clase 2D continua registrada | RegisterClassContinuousShape2dResponse |
| 400 | Carga útil de solicitud no válida | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 409 | La forma de clase ya existe | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
POST /v1/write/namespaces/{namespaceid}/registerclass_shape
Resumen: OpenAPI metadatos para el registro de formas de clase.
ID de operación: register_class_shape_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
| namespace_id | ruta | sí | NamespaceId | Identificador de espacio de nombres |
Cuerpo de la solicitud
- Content type: application/json
- Esquema:
RegisterClassShapeRequest
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Forma de clase registrada | RegisterClassShapeResponse |
| 400 | Carga útil de solicitud no válida | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 409 | La forma de clase ya existe | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
GET /v1/write/namespaces/{namespace_id}/status
Resumen: OpenAPI metadatos para el estado del espacio de nombres.
ID de operación: namespace_status_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
| namespace_id | ruta | sí | NamespaceId | Identificador de espacio de nombres |
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Metadatos del estado del espacio de nombres | NamespaceStatusResponse |
| 400 | Identificador de espacio de nombres no válido | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
GET /v1/write/namespaces/changes
Resumen: OpenAPI metadatos para listar cambios en el espacio de nombres.
ID de operación: list_namespace_changes_endpoint
Parámetros
| Nombre | En | Requerido | Tipo | Descripción |
|---|---|---|---|---|
limit | query | no | entero | Número máximo de elementos a devolver. |
page_token | query | no | ChangeToken | Token de paginación opaco para la siguiente página. |
since_updated_at_ms | query | sí | entero | Límite inferior para marcas de tiempo actualizadas (milisegundos desde la época). |
tenant_id | query | no | TenantId | Filtro de inquilino opcional. |
owner_principal_id | query | no | PrincipalId | Filtro de principal propietario opcional. |
policy_class | query | no | PolicyClass | Filtro de clase de política opcional. |
lifecycle | query | no | LifecycleState | Filtro de ciclo de vida opcional. |
write_mode | query | no | NamespaceWriteMode | Filtro de modo de escritura opcional. |
draining | query | no | booleano | Filtro de drenaje opcional. |
frozen | query | no | booleano | Filtro de congelación opcional. |
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Lista de cambios de espacio de nombres | NamespaceChangeListResponse |
| 400 | Parámetros de solicitud no válidos | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
POST /v1/write/namespaces/forkfromsnapshot
Resumen: OpenAPI metadatos para bifurcar espacios de nombres.
ID de operación: fork_namespace_from_snapshot_endpoint
Cuerpo de la solicitud
- Content type: application/json
- Esquema:
NamespaceForkFromSnapshotRequest
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Espacio de nombres bifurcado desde la instantánea | NamespaceForkFromSnapshotResponse |
| 400 | Parámetros de solicitud no válidos | ProblemDetails |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 409 | El espacio de nombres ya existe | ProblemDetails |
| 422 | La validación de la instantánea falló | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
GET /v1/write/namespaces/status
Resumen: OpenAPI metadatos para listar registros de estado de espacios de nombres.
ID de operación: namespace_status_list_endpoint
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Lista de estado del espacio de nombres | NamespaceStatusListResponse |
| 401 | Solicitud no autorizada | ProblemDetails |
| 404 | Espacio de nombres no encontrado | ProblemDetails |
| 429 | Cuota excedida | ProblemDetails |
| 500 | Error interno del daemon | ProblemDetails |
GET /v1/write/readyz
Resumen: OpenAPI metadatos para la sonda de disponibilidad del daemon de escritura.
ID de operación: readyz_endpoint
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Probar la disponibilidad del daemon de escritura | ReadyzResponse |
| 503 | El daemon de escritura no está listo | ReadyzResponse |
GET /v1/write/startupz
Resumen: OpenAPI metadatos para la sonda de inicio del daemon de escritura.
ID de operación: startupz_endpoint
Respuestas
| Estado | Descripción | Esquema |
|---|---|---|
| 200 | Probar el inicio del daemon de escritura | ProbeResponse |
| 503 | El daemon de escritura no ha iniciado | ProblemDetails |