What's on this page

API Definitions

Asynchronous State Change Events

TNC-O emits events when the state of an assembly and its components changes. Messages that are sent asynchronously are put onto a Kafka bus. The exact topics can be configured. These are emitted in response to Intent Requests causing the state of the Assembly Instance, or its associated components, to change. In the event of a failure to change state, an event will also be emitted. Associated with each example is a table explaining the fields in the example. »

Resource Health Events

Integrity Events These events are sent to enable a resource to indicate if a resource is working or broken. Example Integrity Metric Event { "metricKey" : "142971c5-a84b-4d34-af15-435ba8640aec", "metricName" : "h_integrity", "integrity" : "OK", "message" : "Everything is working" } Field Details Field Description Mandatory metricKey The key given to the resource manager when the resource was created as a token to be used within these messages Yes metricName The name of the metric as defined in the resource descriptor Yes integrity A value indicating if the resource associated with the metric Key is working allowed values are “OK” for working and “BROKEN” when healing is required Yes message An optional test string to include information about the integrity of the resource. »

Error Responses

All the API calls described in this section will return the following information in the Response Body when an error is encountered (e.g. for a 404, 403, 500 Response Code): { "details": {}, "localizedMessage": "string", "url": "string" } Response properties Field Description details Any additional information related to the error that may be useful during debugging localizedMessage User-friendly description of the error that has occurred url the URL of the root cause of the problem or null if unknown »