Get Summary

Get Summary

Query api to get the summary for Telco Cloud Automation

Request
URI
POST
https://{api_host}/hybridity/api/nfvo/summary/query
COPY
Request Body

Filter object.

filter of type(s) application/json
Required 
{
    "filter": {
        "id": [
            "string"
        ]
    }
}
filter_filter
filter
Optional

filter

Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved summary.

Returns summaryResponse of type(s) application/json 
{
    "vims": [
        {
            "vimType": "string",
            "name": "string",
            "stats": {
                "cpu": {
                    "capacity": "number",
                    "used": "number",
                    "available": "number",
                    "unit": "string"
                },
                "memory": {
                    "capacity": "number",
                    "used": "number",
                    "available": "number",
                    "unit": "string"
                },
                "storage": {
                    "capacity": "number",
                    "used": "number",
                    "available": "number",
                    "unit": "string"
                }
            },
            "connection": {
                "status": "string",
                "remoteStatus": "string"
            }
        }
    ],
    "networkFunctions": {
        "instances": [
            {
                "productName": "string",
                "instantiationState": "string",
                "name": "string",
                "provider": "string",
                "type": "string"
            }
        ],
        "catalogs": [
            {
                "name": "string",
                "productName": "string",
                "provider": "string",
                "type": "string",
                "managedBy": "string",
                "onboardingState": "string",
                "operationalState": "string"
            }
        ]
    },
    "networkServices": {
        "instances": [
            {
                "instantiationState": "string",
                "name": "string"
            }
        ],
        "catalogs": [
            {
                "name": "string",
                "descriptorName": "string",
                "descriptorDesigner": "string",
                "onboardingState": "string",
                "operationalState": "string",
                "descriptorVersion": "string"
            }
        ]
    },
    "alarms": [
        {
            "perceivedSeverity": "string",
            "name": "string"
        }
    ]
}
array of summaryResponse_vims
vims
Optional

vims

summaryResponse_networkFunctions
networkFunctions
Optional

networkFunctions

summaryResponse_networkServices
networkServices
Optional

networkServices

array of summaryResponse_alarms
alarms
Optional

alarms


500

Internal Server Error

Returns errorResponse of type(s) application/json 
{
    "errors": [
        "error.yaml Object"
    ]
}
array of error.yaml
errors
Optional

errors


On This Page
Summary Operations
POST
Get Summary