Status API (4.1.0)

Download OpenAPI specification:Download

ONAP: onap-discuss@lists.onap.org URL: https://onap.readthedocs.io License: Apache 2.0

Provides a healthcheck to verify that the NBI component is running as expected as a standalone application or that the NBI can communicate with other onap modules that it needs.

Status

This API retieves the status of the NBI application as a healthcheck

Default

{
    "name": "nbi",
    "status": "ok",
    "version": "v3"
}

Optional

?fullStatus=true

{
    "name": "nbi",
    "status": "ok",
    "version": "v3",
    "components": [
        {
            "name": "sdc connectivity",
            "status": "ko"
        },
        {
            "name": "so connectivity",
            "status": "ok"
        },
        {
            "name": "aai connectivity",
            "status": "ok"
        },
        {
            "name": "dmaap connectivity",
            "status": "ok"
        }
    ]
}

query Parameters

fullStatus

boolean

Default: false

Responses

200

get /status

http://serverRoot:30274/nbi/api/v4/status

https://serverRoot:30274/nbi/api/v4/status

Response samples

Content type

application/json;charset=utf-8

Copy

Expand all Collapse all


{"name": "nbi",
"status": "ok",
"version": "string",
"components": 
[
{"name": "sdc connectivity",
"status": "ok"
}
]
}