Get Entity Communication Summary

Get Entity Communication Summary

Get the topology for the request entity as well as the metrics information based on the flow data gathered by Operations for Networks

Request
URI
POST
https://www.mgmt.cloud.vmware.com/ni/api/ni/micro-seg/entity/single
COPY
Request Body

Entity Communication Summary Request

EntityCommunicationSummaryRequest of type(s) application/json
Required 
{
    "scope": {
        "scope_type": "TIER",
        "entity_ids": [
            "10000:562:1904698621",
            "10000:562:1780351215"
        ]
    },
    "group_by": "10000:1:0"
}
EntityScope
scope
Optional

scope

string
group_by
Optional

group_by

TimeRange
time_range
Optional

time_range

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns EntityCommunicationSummaryListResponse of type(s) application/json 
{
    "results": [
        {
            "src_entity_id": "string",
            "src_entity_type": "string",
            "dst_entity_id": "string",
            "dst_entity_type": "string",
            "flow_properties": [
                {
                    "property_type": "string",
                    "count": 0,
                    "query": "string"
                }
            ],
            "network_properties": [
                {
                    "property_type": "string",
                    "ingress": "number",
                    "egress": "number",
                    "total": "number"
                }
            ]
        }
    ],
    "total_count": 0
}
array of EntityCommunicationSummaryResponse
results
Optional

results

integer As int32 As int32
total_count
Optional

total_count


400

Bad Request

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


401

Unauthorized

Operation doesn't return any data structure

500

Internal Error

Operation doesn't return any data structure

On This Page
Microsegmentation Operations
POST
Export Nsx Recommended Rules
POST
Get Connection Graph
POST
Get Entity Communication Summary
POST
List Recommended Rules