Documentació d'Asset Core

Documentació del motor d'estat del món determinista i referències de l'API.

Decision Gate docs

llegir Punts finals

Llegir operacions del daemon (consultes i projeccions)

Punts d’extremitat

GET /v1/read/health

Resum: OpenAPI metadades per al punt d’entrada de comprovació de salut del daemon de lectura.

Operation ID: read_health_endpoint

Paràmetres

NomEnRequeritTipusDescripció
x-assetcore-namespacecapçaleraNamespaceIdÀmbit de namespace per a llegir probes de salut (requerit).

Respostes

EstatDescripcióEsquema
200Llegir l’estat de salut del daemonReadHealthResponse
401Sol·licitud no autoritzadaProblemDetails
403Sol·licitud prohibidaProblemDetails
429Quota excedidaProblemDetails
500Servei no disponibleProblemDetails

GET /v1/read/livez

Resum: OpenAPI metadades per a la sonda de viabilitat del daemon de lectura.

Operation ID: read_livez_endpoint

Paràmetres

NomEnRequeritTipusDescripció
x-assetcore-namespacecapçaleraNamespaceIdÀmbit de namespace per a llegir probes de salut (requerit).

Respostes

EstatDescripcióEsquema
200Prova de viabilitat del daemon de lecturaProbeResponse
401Sol·licitud no autoritzadaProblemDetails
403Sol·licitud prohibidaProblemDetails
429Quota excedidaProblemDetails
500Servei no disponibleProblemDetails

GET /v1/read/namespaces/{namespace_id}/classes

Resum: OpenAPI metadades per al punt d’entrada del registre de classes.

ID d’Operació: class_list_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idpathNamespaceIdIdentificador de l’espai de noms
x-assetcore-min-world-seqheadernoenterRequereix projecció per arribar a la seqüència del món especificada abans de respondre.
cursorquerynocadenaCursor opcional ancorat a l’identificador de classe vist per últim cop.
limitquerynoenterNombre màxim d’entrades a retornar (per defecte és 20, limitat a 200).

Respostes

EstatDescripcióEsquema
200Llista de registre de classes paginadaClassListResponse
400Paràmetres de consulta no vàlidsProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/classes/{id}

Resum: OpenAPI metadades per al punt final de detall de classe.

Operation ID: class_detail_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms
idcamíExternalIdIdentificador extern de la classe
x-assetcore-min-world-seqcapçaleranointegerRequereix projecció per arribar a la seqüència del món especificada abans de respondre.

Respostes

EstatDescripcióEsquema
200Detall de la classeClassDetailResponse
400Identificador de classe no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Classe no trobadaProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/classes/{id}/shapes

Resum: OpenAPI metadades per al punt final de formes de classe.

Operation ID: class_shapes_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms
idcamíExternalIdIdentificador extern de la classe
x-assetcore-min-world-seqcapçaleranointegerRequereix projecció per arribar a la seqüència del món especificada abans de respondre.

Respostes

EstatDescripcióEsquema
200Enumeració de formes de classeClassShapesResponse
400Identificador de classe no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Classe no trobadaProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/classes/stats

Resum: OpenAPI metadades per a l’endpoint d’estadístiques de classe.

Operation ID: class_stats_endpoint

Paràmetres

NameInRequiredTypeDescription
namespace_idpathNamespaceIdIdentificador de l’espai de noms
x-assetcore-min-world-seqheadernointegerRequereix projecció per arribar a la seqüència del món especificada abans de respondre.

Respostes

EstatDescripcióEsquema
200Estadístiques del registre de classes i de la botigaClassStatsResponse
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/commits

Resum: OpenAPI metadades per a l’endpoint de la història de commits.

Operation ID: commits_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms
x-assetcore-min-world-seqcapçaleranoenterRequereix projecció per arribar a la seqüència del món especificada abans de respondre.
limitconsultanoenterNombre màxim de commits a retornar (limitada a 100).
from_world_seqconsultanoenterSeqüència del món d’inici per retornar (per defecte: 0, començar des del principi).

Respostes

EstatDescripcióEsquema
200Historial de compromisosCommitsResponse
400Paràmetres de consulta no vàlidsProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/containers

Resum: OpenAPI metadades per al punt d’entrada de llistat de contenidors.

Operation ID: container_list_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms
x-assetcore-min-world-seqcapçaleranoenterRequereix projecció per arribar a la seqüència del món especificada abans de respondre.
ownerconsultanocadenaFiltre d’owner opcional (identificador d’owner extern).
kindconsultanocadenaFiltre de tipus opcional (balance, grid, slots, continuous_line_1d, continuous_grid_2d).
cursorconsultanocadenaCursor opcional ancorat a l’identificador del contenidor vist per últim cop.
limitconsultanoenterNombre màxim d’entrades a retornar (limitades a [MAX_LIST_LIMIT]).

Respostes

EstatDescripcióEsquema
200Llista de contenidorsContainerListResponse
400Paràmetres de filtre no vàlidsProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/containers/{id}

Resum: OpenAPI metadades per al punt d’entrada de cerca de detalls del contenidor.

Operation ID: container_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms
idcamíExternalIdIdentificador extern del contenidor
x-assetcore-min-world-seqcapçaleranointegerRequereix projecció per arribar a la seqüència del món especificada abans de respondre.

Respostes

EstatDescripcióEsquema
200Instantània de detalls del contenidorContainerResponse
400Identificador de contenidor no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Contenidor no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/containers/{id}/balances

Resum: OpenAPI metadades per al punt d’entrada de llistat de balances de contenidors.

Operation ID: container_balances_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms
idcamíExternalIdIdentificador extern del contenidor
x-assetcore-min-world-seqcapçaleranoenterRequereix la projecció per arribar a la seqüència del món especificada abans de respondre.
classconsultanocadenaFiltre opcional sobre l’identificador extern de la classe d’actius (per exemple, "class-1"). Quan està present, només s’inclouen els saldos que coincideixen amb aquesta classe a la resposta.
keyconsultanocadenaFiltre opcional sobre la clau de variant ([StackKey]) expressada com una cadena (per exemple, "42"). Quan està present, només s’inclouen els saldos amb aquesta clau de variant. Si el sistema no utilitza claus de variant per a una classe, ometeu-ho.

Respostes

EstatDescripcióEsquema
200Saldo dels contenidorsBalanceResponse
400Paràmetres de consulta no vàlidsProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Contenidor no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/containers/{id}/commits

Resum: OpenAPI metadades per al punt d’entrada de la història de compromisos del contenidor.

Operation ID: container_commits_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms
idcamíExternalIdIdentificador extern del contenidor
x-assetcore-min-world-seqcapçaleranoenterRequereix projecció per arribar a la seqüència del món especificada abans de respondre.
limitconsultanoenterNombre màxim de commits a retornar (limitats a 100).
from_world_seqconsultanoenterSeqüència del món d’inici a retornar (per defecte: 0, començar des del principi).

Respostes

EstatDescripcióEsquema
200Historial de compromisos del contenidorCommitsResponse
400Paràmetres de consulta no vàlidsProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Contenidor no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/containers/{id}/contents

Resum: OpenAPI metadades per a l’endpoint de continguts del contenidor.

Operation ID: container_contents_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms
idcamíExternalIdIdentificador extern del contenidor
x-assetcore-min-world-seqcapçaleranointegerRequereix projecció per arribar a la seqüència del món especificada abans de respondre.

Respostes

EstatDescripcióEsquema
200Contingut del contenidorContainerContentsResponse
400Identificador de contenidor no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Contenidor no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespaceid}/containers/{id}/continuous1d/placements

Resum: OpenAPI metadades per al punt final de col·locació contínua 1D.

Operation ID: container_continuous_placements_1d_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idrutaNamespaceIdIdentificador de l’espai de noms
idrutaExternalIdIdentificador extern del contenidor
x-assetcore-min-world-seqcapçaleranoenterRequereix projecció per arribar a la seqüència del món especificada abans de respondre.
min_xconsultanoenterLímite mínim X opcional inclusiu (unitats de punt fix).
max_xconsultanoenterLímite màxim X opcional inclusiu (unitats de punt fix).

Respostes

EstatDescripcióEsquema
200Col·locacions de contenidors 1D contínuesContinuous1dPlacementsResponse
400Paràmetres de regió 1D contínua no vàlidsProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Contenidor no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespaceid}/containers/{id}/continuous2d/placements

Resum: OpenAPI metadades per al punt d’entrada de col·locació contínua 2D.

Operation ID: container_continuous_placements_2d_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms
idcamíExternalIdIdentificador extern del contenidor
x-assetcore-min-world-seqcapçaleranoenterRequereix projecció per arribar a la seqüència del món especificada abans de respondre.
min_xconsultanoenterLímite mínim X opcional inclusiu (unitats de punt fix).
min_yconsultanoenterLímite mínim Y opcional inclusiu (unitats de punt fix).
max_xconsultanoenterLímite màxim X opcional inclusiu (unitats de punt fix).
max_yconsultanoenterLímite màxim Y opcional inclusiu (unitats de punt fix).

Respostes

EstatDescripcióEsquema
200Col·locacions de contenidors 2D contínuesContinuous2dPlacementsResponse
400Paràmetres de regió 2D contínua no vàlidsProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Contenidor no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/containers/{id}/grid/cells

Resum: OpenAPI metadades per a l’endpoint de col·locació de la graella.

ID d’Operació: container_grid_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms
idcamíExternalIdIdentificador extern del contenidor
x-assetcore-min-world-seqcapçaleranoenterRequereix projecció per arribar a la seqüència del món especificada abans de respondre.
xconsultanoenterCoordenada X basada en 0 (columna).
yconsultanoenterCoordenada Y basada en 0 (fila).
widthconsultanoenterAmplada de la regió (cèl·lules).
heightconsultanoenterAlçada de la regió (cèl·lules).

Respostes

EstatDescripcióEsquema
200Col·locacions de graella de contenidorsGridPlacementResponse
400Paràmetres de regió de graella no vàlidsProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Contenidor no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/containers/{id}/grid/free

Resum: OpenAPI metadades per al punt d’entrada de cerca de la regió lliure de la graella.

Operation ID: container_grid_free_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms
idcamíExternalIdIdentificador extern del contenidor
x-assetcore-min-world-seqcapçaleranoenterRequereix projecció per arribar a la seqüència del món especificada abans de respondre.
widthconsultanoenterAmplada desitjada de la forma (cel·les).
heightconsultanoenterAltura desitjada de la forma (cel·les).

Respostes

EstatDescripcióEsquema
200Cerca de regió lliure de graellaGridFreeResponse
400Paràmetres de forma de graella no vàlidsProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Contenidor no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/containers/{id}/slots

Resum: OpenAPI metadades per a l’endpoint d’ocupació de slots.

Operation ID: container_slots_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms
idcamíExternalIdIdentificador extern del contenidor
x-assetcore-min-world-seqcapçaleranointegerRequereix projecció per arribar a la seqüència del món especificada abans de respondre.

Respostes

EstatDescripcióEsquema
200Ocupació del contenidor de slotsSlotResponse
400Identificador de contenidor no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Contenidor no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/freshness

Resum: OpenAPI metadades per al punt final de frescor de la projecció.

Operation ID: freshness_endpoint

Paràmetres

NameInRequiredTypeDescription
namespace_idpathNamespaceIdIdentificador de l’espai de noms
x-assetcore-min-world-seqheadernointegerRequereix projecció per arribar a la seqüència del món especificada abans de respondre.

Respostes

EstatDescripcióEsquema
200Metadades de frescor de la projeccióFreshnessResponse
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Projecció no disponibleProblemDetails

GET /v1/read/namespaces/{namespace_id}/instances

Resum: OpenAPI metadades per al punt d’entrada de llistat d’instàncies.

Operation ID: instance_list_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idpathNamespaceIdIdentificador de l’espai de noms
x-assetcore-min-world-seqheadernointegerRequereix projecció per arribar a la seqüència del món especificada abans de respondre.
classquerynostringFiltre de classe opcional (identificador extern).
variant_keyquerynostringFiltre de clau de variant opcional.
ownerquerynostringFiltre de propietari opcional (identificador de propietari extern).
cursorquerynostringCursor opcional ancorat a l’identificador de la darrera instància vista.
limitquerynointegerNombre màxim d’entrades a retornar (limitades a [MAX_LIST_LIMIT]).

Respostes

EstatDescripcióEsquema
200Llista d’instànciesInstanceListResponse
400Paràmetres de consulta no vàlidsProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/instances/{id}

Resum: OpenAPI metadades per a l’endpoint de detalls de la instància.

Operation ID: instance_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms
idcamíExternalIdIdentificador extern de la instància
x-assetcore-min-world-seqcapçaleranoenterRequereix projecció per arribar a la seqüència del món especificada abans de respondre.

Respostes

EstatDescripcióEsquema
200Detall de la instànciaInstanceResponse
400Identificador d’instància no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Instància no trobadaProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/owners/{id}/summary

Resum: OpenAPI metadades per al punt d’entrada de resum del propietari.

Operation ID: owner_summary_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idrutaNamespaceIdIdentificador de l’espai de noms
idrutaExternalIdIdentificador extern del propietari
x-assetcore-min-world-seqcapçaleranoenterRequereix projecció per arribar a la seqüència del món especificada abans de respondre.

Respostes

EstatDescripcióEsquema
200Resum del propietariOwnerSummaryResponse
400Identificador de propietari no vàlidProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Proprietari no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/replay

Resum: OpenAPI metadades per al punt final de reproducció.

Operation ID: replay_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms
x-assetcore-min-world-seqcapçaleranoenterRequereix projecció per arribar a la seqüència del món especificada abans de respondre.
from_world_seqconsultanoenterSeqüència del món per reproduir (inclusiu).
limitconsultanoenterNombre màxim de lots a retornar (limitada a 100).

Respostes

EstatDescripcióEsquema
200Repetir lotsReplayResponse
400Paràmetres de consulta no vàlidsProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails

GET /v1/read/namespaces/{namespace_id}/stream

Resum: OpenAPI metadades per al punt final de flux de lectura.

ID d’operació: read_stream_endpoint

Paràmetres

NomEnRequeritTipusDescripció
namespace_idcamíNamespaceIdIdentificador de l’espai de noms
x-assetcore-min-world-seqcapçaleranoenterRequereix projecció per arribar a la seqüència del món especificada abans de respondre.
Last-Event-IdcapçaleranoenterCursor de reanudació SSE; el flux es reanuda a last_event_id + 1.
from_world_seqconsultanoenterSeqüència del món opcional per començar a transmetre (inclusiu).
limitconsultanoenterNombre màxim opcional de lots a emetre abans de tancar el flux.

Respostes

EstatDescripcióEsquema
200Flux de lots de compromisos (SSE)StreamEntry
400Paràmetres de consulta no vàlidsProblemDetails
401Sol·licitud no autoritzadaProblemDetails
404Espai de noms no trobatProblemDetails
425La projecció no ha arribat a la seqüència mundial sol·licitadaProblemDetails
429Quota excedidaProblemDetails
500Error intern del servidorProblemDetails
503Flux no disponibleProblemDetails

GET /v1/read/readyz

Resum: OpenAPI metadades per a la sonda de disponibilitat del daemon de lectura.

Operation ID: read_readyz_endpoint

Paràmetres

NomEnRequeritTipusDescripció
x-assetcore-namespacecapçaleraNamespaceIdÀmbit de namespace per a llegir probes de salut (requerit).

Respostes

EstatDescripcióEsquema
200Llegir la sonda de disponibilitat del daemonReadReadyzResponse
401Sol·licitud no autoritzadaProblemDetails
403Sol·licitud prohibidaProblemDetails
429Quota excedidaProblemDetails
500Servei no disponibleProblemDetails
503Lector no disponibleReadReadyzResponse

GET /v1/read/startupz

Resum: OpenAPI metadades per a la prova d’inici del daemon de lectura.

Operation ID: read_startupz_endpoint

Paràmetres

NomEnRequeritTipusDescripció
x-assetcore-namespacecapçaleraNamespaceIdÀmbit de namespace per a llegir probes de salut (requerit).

Respostes

EstatDescripcióEsquema
200Prova d’inici del daemon de lecturaProbeResponse
401Sol·licitud no autoritzadaProblemDetails
403Sol·licitud prohibidaProblemDetails
429Quota excedidaProblemDetails
500Servei no disponibleProblemDetails