Get Tenants

Get Tenants

Get tenants for the VIM specified by the path parameter vimId

Request
URI
GET
https://{api_host}/hybridity/api/vims/v1/{vimId}/tenants
COPY
Path Parameters
string
vimId
Required

The identifier for the VIM. For TCA the vimId usually starts with the prefix 'vmware_'


Authentication
This operation uses the following authentication methods.
Responses
200

Get tenants for the VIM

Returns Tenant of type(s) application/json
{
    "tenants": [
        {
            "vimType": "vimType",
            "hcxUUID": "hcxUUID",
            "vimUrl": "vimUrl",
            "vimId": "vimId",
            "hcxCloudUrl": "hcxCloudUrl",
            "tags": [
                {
                    "name": "{}",
                    "autoCreated": true
                },
                {
                    "name": "{}",
                    "autoCreated": true
                }
            ],
            "compatible": true,
            "vimName": "vimName",
            "tenantName": "tenantName",
            "stats": {
                "memory": {
                    "unit": "unit",
                    "available": 1,
                    "used": 6,
                    "capacity": 5
                },
                "cpu": {
                    "unit": "unit",
                    "available": 1,
                    "used": 6,
                    "capacity": 5
                },
                "storage": {
                    "unit": "unit",
                    "available": 1,
                    "used": 6,
                    "capacity": 5
                }
            },
            "audit": {
                "creationUser": "creationUser",
                "creationTimestamp": "creationTimestamp"
            },
            "tenantId": "tenantId",
            "name": "name",
            "location": {
                "country": "country",
                "city": "city",
                "latitude": "latitude",
                "cityAscii": "cityAscii",
                "longitude": "longitude"
            },
            "connection": {
                "vimConnectionStatus": "vimConnectionStatus",
                "status": "status",
                "remoteStatus": "remoteStatus"
            },
            "id": "id",
            "username": "username",
            "vnfInstancesCounts": [
                {
                    "totalSize": 0,
                    "state": "state"
                },
                {
                    "totalSize": 0,
                    "state": "state"
                }
            ]
        },
        {
            "vimType": "vimType",
            "hcxUUID": "hcxUUID",
            "vimUrl": "vimUrl",
            "vimId": "vimId",
            "hcxCloudUrl": "hcxCloudUrl",
            "tags": [
                {
                    "name": "{}",
                    "autoCreated": true
                },
                {
                    "name": "{}",
                    "autoCreated": true
                }
            ],
            "compatible": true,
            "vimName": "vimName",
            "tenantName": "tenantName",
            "stats": {
                "memory": {
                    "unit": "unit",
                    "available": 1,
                    "used": 6,
                    "capacity": 5
                },
                "cpu": {
                    "unit": "unit",
                    "available": 1,
                    "used": 6,
                    "capacity": 5
                },
                "storage": {
                    "unit": "unit",
                    "available": 1,
                    "used": 6,
                    "capacity": 5
                }
            },
            "audit": {
                "creationUser": "creationUser",
                "creationTimestamp": "creationTimestamp"
            },
            "tenantId": "tenantId",
            "name": "name",
            "location": {
                "country": "country",
                "city": "city",
                "latitude": "latitude",
                "cityAscii": "cityAscii",
                "longitude": "longitude"
            },
            "connection": {
                "vimConnectionStatus": "vimConnectionStatus",
                "status": "status",
                "remoteStatus": "remoteStatus"
            },
            "id": "id",
            "username": "username",
            "vnfInstancesCounts": [
                {
                    "totalSize": 0,
                    "state": "state"
                },
                {
                    "totalSize": 0,
                    "state": "state"
                }
            ]
        }
    ],
    "vimName": "vimName",
    "vimId": "vimId",
    "cloud_owner": "cloud_owner",
    "cloud_region_id": "cloud_region_id"
}
string
cloud_owner
Optional

TBD

string
cloud_region_id
Optional

TBD

string
vimId
Optional

The identifier for the VIM.

string
vimName
Optional

The name of the VIM instance.

array of Vim
tenants
Optional

The container of the list of VIM instances.