openapi: 3.0.0 info: contact: name: VMware description: API for querying HCX site-pair resource containers details. license: name: Copyright (c) 2020-2021 VMware, Inc. All rights reserved. termsOfService: https://hcx.vmware.com/terms-and-conditions title: Query HCX site-pair resource containers 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 site-pair resource containers details from HCX Manager. name: Sitepair resource containers details paths: /service/inventory/resourcecontainer/list: post: description: Returns the HCX site-pair resource containers and their status details. operationId: getHcxSitepairResourceContainers requestBody: description: Site-pair resource containers filtering payload. required: true content: application/json: schema: $ref: '#/components/schemas/resourceContainerListRequest' responses: 200: content: application/json: schema: $ref: '#/components/schemas/resourceContainerListResponse' 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 site-pair resource containers and their status details. tags: - Sitepair resource containers details components: schemas: resourceContainerListRequest: example: '{filter={cloud={local=true,remote=true}}}' type: object properties: filter: type: object properties: cloud: type: object properties: local: type: boolean description: Specifies whether query should return the local resource containers. remote: type: boolean description: Specifies whether query should return the paired remote resource containers. resourceContainerListResponse: example: '{success=true, completed=true, time=1594198351035, version="1.0", data={items=[{url="https://hcxserver_hostname", vcuuid="c879a579-fe68-4f8e-8aa4-c576aaede6ab", version="6.7.0.14368073", buildNumber="14368073", osType="linux-x64", name="wdc-p2-hs3-hcx-nmb2-vm674.eng.vmware.com", resourceId="c879a579-fe68-4f8e-8aa4-c576aaede6ab", resourceType="VC", resourceName="wdc-p2-hs3-hcx-nmb2-vm674.eng.vmware.com", vimId="c879a579-fe68-4f8e-8aa4-c576aaede6ab", vimServerUuid="c879a579-fe68-4f8e-8aa4-c576aaede6ab", endpoint={linkEstablished=1588145721851, isBiDirectional=false, status="ok", lastUpdated=1588145726421, creationDate=1588145721866, isDeleted=false, isInbound=false, linkUuid="7777c63d-7085-4ce8-92b8-a5505cb0ad2e", endpointId="20200429064422164-31f80b84-5d0b-41fb-b2e5-62a925f3e060", endpointType="nsp", url="https://10.197.131.31", uuid="20200429064422164-31f80b84-5d0b-41fb-b2e5-62a925f3e060", orgId="20200429064422164-31f80b84-5d0b-41fb-b2e5-62a925f3e060", nodeType="realm", cloudName="wdc-p2-hs3-hcx-nmb2-vm799.eng.vmware.com", name="wdc-p2-hs3-hcx-nmb2-vm799.eng.vmware.com", cloudType="vc", isValid=true, location={city="Palo Alto", country="United States of America", cityAscii="Palo Alto", latitude=37.4256448, longitude=-122.1703695}, version="3.5.3.16413771", remoteStatus="ok"}, endpointId="20200429064422164-31f80b84-5d0b-41fb-b2e5-62a925f3e060", endpointType="vc", endpointName="wdc-p2-hs3-hcx-nmb2-vm799.eng.vmware.com", endpointUrl="https://10.197.131.31", isValid=true, cloudType="vc", isLocal=false}, {url="https://sc2-10-186-17-157.eng.vmware.com", vcuuid="754475cc-ccff-4b1c-bbd0-65a6d9c10340", version="6.7.0.14368073", buildNumber="14368073", osType="linux-x64", name="sc2-10-186-17-157.eng.vmware.com", resourceId="754475cc-ccff-4b1c-bbd0-65a6d9c10340", resourceType="VC", resourceName="sc2-10-186-17-157.eng.vmware.com", vimId="754475cc-ccff-4b1c-bbd0-65a6d9c10340", vimServerUuid="754475cc-ccff-4b1c-bbd0-65a6d9c10340", endpoint={linkEstablished=1592015222444, isBiDirectional=false, status="ok", lastUpdated=1592015227081, creationDate=1592015222459, isDeleted=false, isInbound=false, linkUuid="d86b69f8-f2df-4cb9-8eea-66c4c583ab9b", endpointId="20200601061527801-844a140f-d6a7-4da7-acef-a1d7616a349d",endpointType="nsp", url="https://10.186.30.165", uuid="20200601061527801-844a140f-d6a7-4da7-acef-a1d7616a349d", orgId="20200601061527801-844a140f-d6a7-4da7-acef-a1d7616a349d", nodeType="realm", cloudName="sc2-10-186-30-165.eng.vmware.com", name="sc2-10-186-30-165.eng.vmware.com", cloudType="vc", isValid=true, location={city="Palo Alto", country="United States of America", cityAscii="Palo Alto", latitude=37.4256448, longitude=-122.1703695}, version="3.5.3.16442492", remoteStatus="ok"}, endpointId="20200601061527801-844a140f-d6a7-4da7-acef-a1d7616a349d", endpointType="vc", endpointName="sc2-10-186-30-165.eng.vmware.com", endpointUrl="https://10.186.30.165", isValid=true, cloudType="vc", isLocal=false}, {url="https://wdc-p2-hs3-hcx-nmb2-vm687.eng.vmware.com", vcuuid="9456298e-4d5f-49f1-92d3-7101e68869df", version="6.7.0.14368073", buildNumber="14368073", osType="linux-x64", name="wdc-p2-hs3-hcx-nmb2-vm687.eng.vmware.com", resourceId="9456298e-4d5f-49f1-92d3-7101e68869df", resourceType="VC", resourceName="wdc-p2-hs3-hcx-nmb2-vm687.eng.vmware.com", vimId="9456298e-4d5f-49f1-92d3-7101e68869df", vimServerUuid="9456298e-4d5f-49f1-92d3-7101e68869df", endpoint={ uuid="20200429065629370-9dd1ee63-ca3f-44d6-9e66-11ef5516e533", lastUpdated=1588143674147, creationDate=1588143672026, isDeleted=false, endpointId="20200429065629370-9dd1ee63-ca3f-44d6-9e66-11ef5516e533", status="ok", isValid="true", isLocal="true", name="wdc-p2-hs3-hcx-nmb2-vm229.eng.vmware.com", cloudName="wdc-p2-hs3-hcx-nmb2-vm229.eng.vmware.com", cloudType="vc", endpointType="hcm", version="3.5.3.16528550", buildNumber="16528550"}, endpointId="20200429065629370-9dd1ee63-ca3f-44d6-9e66-11ef5516e533", endpointType="vc", endpointName="wdc-p2-hs3-hcx-nmb2-vm229.eng.vmware.com", endpointUrl="", isValid=true, cloudType="vc", isLocal=true}]}}' type: object properties: success: type: boolean description: If the value of this parameter is true, it means the API returned successfully with status details. completed: type: boolean description: Completion status. time: type: number description: Time in milliseconds. data: type: object properties: items: type: array items: type: object properties: url: type: string description: URL to the specified resource container end-point. vcuuid: type: string description: Resource container's corresponding vCenter unique identified (UUID). version: type: string description: Resource container's version. buildNumber: type: string description: Resource container's build number. osType: type: string description: Resource conatiner's operating system type. name: type: string description: Name of the Resource container. resourceId: type: string description: Identifier of the Resource container. resourceType: type: string description: Resource container's type. resourceName: type: string description: Resource container's name. vimId: type: string description: Resource container's Vim identifier. vimServerUuid: type: string description: Resource container's Vim server unique identifier. endpoint: type: object properties: linkEstablished: type: number description: Source local container to the cloud container link established time. isBiDirectional: type: boolean description: Is the Source container to the cloud container link bidirectional. status: type: string description: Source local container to the cloud container link status. lastUpdated: type: number description: Last updated time on this container and link related operations. creationDate: type: number description: Resource container and link creation date. isDeleted: type: boolean description: Is this Resource container already deleted. isInbound: type: boolean description: Is this Resource container link in-bound. linkUuid: type: string description: Link unique identifier. endpointId: type: string description: End-point identifier of the resource container. endpointType: type: string description: End-point type of the resource container. The value can be hcm, nsp, or hcx. url: type: string description: URL end-point of the resource container. uuid: type: string description: Unique identifier of the end-point of the resource container. orgId: type: string description: Organization identifier of the end-point resource container. nodeType: type: string description: End-point node record type. cloudName: type: string description: Cloud end-point resource container name. name: type: string description: Name of the resource container. cloudType: type: string description: Endpoint resource container cloud type. isValid: type: boolean description: Is this a valid resource container. isLocal: type: boolean description: Is the resource container local. location: type: object properties: city: type: string description: City where the endpoint resource container resides in. country: type: string description: Country where the endpoint resource container resides in. cityAscii: type: string description: City where the endpoint resource container resides in. latitude: type: number description: Geo latitude where the endpoint resource container resides in. longitude: type: number description: Geo longitude where the endpoint resource container resides in. version: type: string description: Endpoint version. remoteStatus: type: string description: Remote resource container connection status. buildNumber: type: string description: Endpoint server build number. endpointId: type: string description: End-point identifier of the resource container. endpointType: type: string description: End-point type of the resource container. The value can be hcm, nsp or hcx. enum: endpointName: type: string description: Name of the endpoint server. endpointUrl: type: string description: URL of the endpoint server. isValid: type: boolean description: Is endpoint valid. cloudType: type: string description: Endpoint resource container cloud type. isLocal: type: boolean description: Is resource container local. 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