openapi: 3.0.0 info: contact: name: VMware description: API query for HCX interconnect appliances metrics details. license: name: Copyright (c) 2020-2021 VMware, Inc. All rights reserved. termsOfService: https://hcx.vmware.com/terms-and-conditions title: Query HCX Interconnect appliances metrics API. version: "1.0" security: - x-hm-authorization: [] servers: - url: https://{server}/hybridity/api variables: server: default: hcx_mgr_server description: HCX Manager server host name tags: - description: API to get interconnect appliances metrics details from HCX Manager. name: Interconnect appliances metrics details paths: /metrics/interconnect: post: description: Returns the HCX interconnect appliances metrics details. operationId: getInterconnectApplianceMetrics requestBody: description: Interconnect appliances metrics query for filtering the payload. required: true content: application/json: schema: $ref: '#/components/schemas/interconnectApplianceMetricsRequest' responses: 200: content: application/json: schema: $ref: '#/components/schemas/interconnectApplianceMetricsResponse' description: Ok 401: description: Unauthorized 403: description: Forbidden 400: content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request 500: content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error summary: Returns HCX interconnect appliances metrics details. tags: - Interconnect appliances metrics details components: schemas: interconnectApplianceMetricsRequest: example: '{filter={serviceMeshIds=["servicemesh-c96765a9-9f67-42bc-894d-0c464476ee16"], applianceTypes=["HCX-WAN-IX"], duration={from=1594104223717, to=1594277023717}}, paging={count=5}}' type: object properties: filter: type: object properties: serviceMeshIds: type: array items: type: string applianceTypes: type: array items: type: string duration: type: object properties: from: type: number description: From date-time in milliseconds. to: type: number description: To date-time in milliseconds. paging: type: object properties: count: type: integer description: Count of appliance records to retrieve. interconnectApplianceMetricsResponse: example: '{paging={count=5, next="MTU5NDQ3Mzk4NDAwMHw4ZTU2M2FhZi03YTBmLTRiMGUtYTQ4MC02MDE2Y2VlYzAyZWM="}, items=[{timestamp=1594473714, applianceId="8e563aaf-7a0f-4b0e-a480-6016ceec02ec", serviceMeshId="servicemesh-0e7803a2-7162-4de5-a2e3-78d08c527611", computeProfileId="34c633b5-c1e3-4078-9392-c16c07fd885c", location="20200429065629370-9dd1ee63-ca3f-44d6-9e66-11ef5516e533", applianceType="HCX-WAN-IX", summary={overallStatus="down", servicePipelineStatus="down", overallTransportStatus="up", overallEncryptionTunnelStatus="up", transportSummary=[{transportIp="172.17.12.10", name="172.17.12.10", totalTunnelCount=1, totalActiveTunnelCount=1, aggregatedTunnelStatus="up"}], encryptionTunnelSummary={totalTunnelCount=3, totalActiveTunnelCount=3, aggregatedTunnelStatus="up"}, wanOptStatus="down", reasons=["Overall transport tunnel status is up.", "Overall encryption tunnel status is up.", "Service pipeline status is down."], systemState="good"}, statistics={SystemStatus={State=0, Components=0, Details=[]}, PeerSiteConnectivity={LocalSiteIp="192.0.2.33", PeerSiteIp="192.0.2.34", Summary="down"}, Tunnels=[{Id="t_0", LocalAddress="192.0.2.53", LocalPort=24500, RemoteAddress="192.0.2.58", RemotePort=24500, Timestamp="2020-07-11T13:21:54.916251883Z", Summary="up", Detail="Tunnel alive state is up [policyEngine]", Ikev2Status="up", Counters={RxPackets=9004905, RxPacketErrors=0, RxPacketDropped=0, RxPacketOverruns=0, RxPacketFrame=0, TxPackets=10437994, TxPacketErrors=0, TxPacketDropped=512, TxPacketOverruns=0, TxPacketCarrier=0, Collisions=0, TxQueuelen=1, RxBytes=761282912, TxBytes=1382186312, RxPacketRate=2, TxPacketRate=2, RxBitRate=1785, TxBitRate=1785}, TunnelType="IPSec"}, {Id="te_0", LocalAddress="172.16.12.11", LocalPort=4500, RemoteAddress="172.17.12.10", RemotePort=4500, Timestamp="2020-07-11T13:21:54.923422541Z", Summary="up", Detail="Tunnel alive state is up [policyEngine]", Ikev2Status="", Counters={ RxPackets=37067337, RxPacketErrors=0, RxPacketDropped=0, RxPacketOverruns=0, RxPacketFrame=0, TxPackets=35858914, TxPacketErrors=0, TxPacketDropped=0, TxPacketOverruns=0, TxPacketCarrier=0, Collisions=0, TxQueuelen=1, RxBytes=6350959940, TxBytes=6312770264, RxPacketRate=10, TxPacketRate=9, RxBitRate=13408, TxBitRate=11075 }, TunnelType="IPIP_FOU"}], Ipsec={LoadedConnections=3, ActiveConnections=3 }, WanOpts=[{Address="198.18.0.2", Summary="down", Detail=""}], L2cStatus={ArperStatus={Enabled=false}, RewriteStatus={Rewrites=null}}, FouDynStatus={Tuples=null},TunnelGroupsBuckets=[{Id="tg_g1_g2_1", BucketCount=8, Tunnels=[{Id="t_0", BucketCount=2, UserCount=0, EspUserCount=0},{Id="t_1", BucketCount=4, UserCount=0, EspUserCount=0},{Id="t_2", BucketCount=2, UserCount=0, EspUserCount=0}]},{Id="tg_tee_g1_g2_1", BucketCount=8, Tunnels=[{Id="te_0", BucketCount=8, UserCount=3, EspUserCount=3}]}]}, applianceName="SM-everything-IX-I1"}]}' type: object properties: paging: type: object properties: count: type: integer description: Count of appliance records retrieved. next: type: string description: A link ID to the next set of records to retrieve. items: type: array items: type: object properties: timestamp: type: number description: Time in milliseconds at which the appliance metric record is collected in the HCX manager system level. applianceId: type: string description: Unique identifier for the appliance. serviceMeshId: type: string description: Unique identifier of appliance corresponding service mesh. computeProfileId: type: string description: Unique identifier of compute profile. location: type: string description: End-point location unique identifier. applianceType: type: string description: Type of the appliance summary: type: object properties: overallStatus: type: string description: Overall appliance status. servicePipelineStatus: type: string description: Appliance Service pipeline status. overallTransportStatus: type: string description: Overall transport status of the appliance. overallEncryptionTunnelStatus: type: string description: Overall encryption tunnel status of the appliance. transportSummary: type: array description: Transport Summary of the appliance. items: type: object properties: transportIp: type: string description: Transport IP. name: type: string description: Name of the transport. totalTunnelCount: type: integer description: Total transport tunnel count. totalActiveTunnelCount: type: integer description: Total active transport tunnel count. aggregatedTunnelStatus: type: string description: Aggregated transport tunnel status. encryptionTunnelSummary: type: object description: Encryption tunnel summary of the appliance. properties: totalTunnelCount: type: integer description: Total encryption tunnel count. totalActiveTunnelCount: type: integer description: Total active encryption tunnel count. aggregatedTunnelStatus: type: string description: Aggregated encryption tunnel count. wanOptStatus: type: string description: WAN optimization appliance status. reasons: type: array description: List of errors or warnings. items: type: string systemState: type: string description: System state of the appliance. statistics: type: object description: Statistic of the appliance. properties: SystemStatus: type: object description: System status of the appliance. properties: State: type: integer description: System state. Components: type: integer description: Number of components of the appliance Details: type: array description: System status details of the appliance. items: type: string PeerSiteConnectivity: type: object description: Peer site appliance connectivity details. properties: LocalSiteIp: type: string description: Local site IP address. PeerSiteIp: type: string description: Peer site IP address. Summary: type: string description: Summary status of the peer site connectivity. Tunnels: type: array items: type: object properties: Id: type: string description: Tunnel id. LocalAddress: type: string description: Tunnel local address. LocalPort: type: integer description: Tunnel local port. RemoteAddress: type: string description: Tunnel remote address. RemotePort: type: integer description: Tunnel remote port. Timestamp: type: string description: Time at which tunnel metrics observed. Summary: type: string description: Summary of the tunnel. Detail: type: string description: Details of the tunnel. Ikev2Status: type: string description: IKEv2 status. Counters: type: object description: Counters. properties: RxPackets: type: number description: Rx packets count. RxPacketErrors: type: number description: Rx packet errors count. RxPacketDropped: type: number description: Rx packets dropped count. RxPacketOverruns: type: number description: Rx packets overruns. RxPacketFrame: type: number description: Rx packets frame count. TxPackets: type: number description: Tx packets count. TxPacketErrors: type: number description: Tx packet errors count. TxPacketDropped: type: number description: Tx packets dropped count. TxPacketOverruns: type: number description: Tx packets overruns. TxPacketCarrier: type: number description: Tx packets carrier count. Collisions: type: number description: Collisions count. TxQueuelen: type: number description: Tx queue length. RxBytes: type: number description: Rx bytes. TxBytes: type: number description: Tx bytes. RxPacketRate: type: number description: Rx packet rate. TxPacketRate: type: number description: Tx packet rate. RxBitRate: type: number description: Rx bit rate. TxBitRate: type: number description: Tx bit rate. TunnelType: type: string description: Tunnel type. Ipsec: type: object properties: LoadedConnections: type: integer description: Loaded IPsec connections. ActiveConnections: type: integer description: Active IPsec connections. WanOpts: type: array items: type: object properties: Address: type: string description: WANopt address. Summary: type: string description: Wanopt summary. Detail: type: string description: Wanopt details. L2cStatus: type: object properties: ArperStatus: type: object properties: Enabled: type: boolean description: Whether L2c Arper status is enabled. RewriteStatus: type: object properties: Rewrites: type: string description: L2c rewrite status. FouDynStatus: type: object properties: Tuples: type: string description: FOU tuples details. TunnelGroupsBuckets: type: array items: type: object properties: Id: type: string description: Tunnel group bucket ID. BucketCount: type: integer description: Tunnel group bucket count. Tunnels: type: array description: Tunnels details. items: type: object properties: Id: type: string description: ID of the tunnel. BucketCount: type: integer description: Bucket count. UserCount: type: integer description: User count. EspUserCount: type: integer description: Espuser count. applianceName: type: string description: Name of the appliance. errorResponse: properties: errors: items: $ref: '#/components/schemas/error' type: array type: object error: properties: code: type: string message: type: string type: object securitySchemes: x-hm-authorization: description: Obtained from /hybridity/api/session in: header name: x-hm-authorization type: apiKey