Get Tenant List

Product version: 10.11

Last modified: 31 July 2024

Returns detailed tenants list.

Endpoint

https://<Director_IP_address>:4443/c/router

Request Example

curl

Copy

curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie @cookies.txt \
    --data '{
            "action": "MultitenancyManagement",
            "method": "getTenants",
            "data": [{
                    "filter": {
                            "start": 0,
                            "count": 2,
                            "criteria": []}}],
            "type": "rpc",
            "tid": 1}'

Request Fields

Field	Type	Value(s)	Description
`action`	string	`MultitenancyManagement`	The action that is invoked
`method`	string	`getTenants`	The method that is invoked
`data`	array		Filter parameters. See the `filter` table below
`type`	string	rpc	Type of communication protocol
`tid`	int	1	Transaction ID. Used to identify the request by both the client and the server

filter

Field	Type	Description
`start`	int	A start ID of the tenant to be returned
`count`	int	Number of tenants to be returned
`sort`	string	Tenant parameter to be sorted with
`sortAsc`	boolean	`true` if the order is ascending
`criteria`	Json	Filter criteria. See the table below

criteria

Field	Type	Description
`name`	string	Name of criterion. ID means the tenant ID
`type`	string	Type of the criterion. Possible values: `AND, OR, EQ` (equal), `NEQ` (not equal), `LIKE` (case sensitive), `IN, BETWEEN, NOT_NULL, ILIKE, GT, GTE, LT, LTE`
`value`	string	Value of a criterion. `1` : tenant `ID=1`
`values`	`list <string>`	Attribute values. Used for the `IN, BETWEEN` values of the `type` field

Response Sample

curl

Copy

{
    "action": "MultitenancyManagement",
    "method": "getTenants",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
        "children": [
            { "id": 2,
                "name": "Customer 1",
                "uuid": "aaa6da10-97ea-43ac-80f8-6ddd22faeb93",
                "allocated": 4,
                "allocatedDesired": 4,
                "allocatedEc2Instances": 0,
                "allocatedEc2InstancesDesired": 0,
                "allocatedPhysicalServersDesired": 0"                "labels": [
                    { "id": 2,
                    "name": "asdad",
                    "position": null } ],
                "email": "",
                "phone": "",
                "website": "",
                "address": "",
                "logo": "/c/tenants/aaa6da10-97ea-43ac-80f8-6ddd22faeb93/tenant-data/d2071b7b-2bc1-4da5-864d-d4f153323e51.png",
                "showName": true,
                "enabled": true,
                "state": "OK",
                "status": "NONE",
                "changeStatus": "NONE",
                "alarmState": "OK",
                "lockedShared": false,
                "lockedExclusive": false,
                "wasEdited": false,
                "wasDiscoveredOnce": true,
                "progress": 0,
                "alarmCounters": [ 0, 0, 0, 0 ],
                "usedVms": 0,
                "usedSockets": 0,
                "usedEc2Instances": 0,
                "alertErrorCode": null,
                "alertTitle": null,
                "alertDescription": null },
            { "id": 3,
                "name": "Customer 2",
                "uuid": "e956fc69-b978-41d6-97d4-6e8577600434",
                "allocated": 5,
                "allocatedDesired": 5,
                "allocatedEc2Instances": 0,
                "allocatedEc2InstancesDesired": 0,
                "labels": [],
                "email": "",
                "phone": "",
                "website": "",
                "address": "",
                "logo": "/c/tenants/e956fc69-b978-41d6-97d4-6e8577600434/tenant-data/c5f2898a-6cab-4bfb-a107-192c461f7128.png",
                "showName": true,
                "enabled": false,
                "state": "OK",
                "status": "NONE",
                "changeStatus": "NONE",
                "alarmState": "OK",
                "lockedShared": false,
                "lockedExclusive": false,
                "wasEdited": false,
                "wasDiscoveredOnce": true,
                "progress": 0,
                "alarmCounters": [ 0, 0, 0, 0 ],
                "usedVms": 0,
                "usedSockets": 0,
                "usedEc2Instances": 0,
                "usedPhysicalServers ": 0"                "alertErrorCode": null,
                "alertTitle": null,
                "alertDescription": null } ], 
    "total": 10 } 
}

Response Fields

Field	Value	Description
`message`	string	Message if the request failed
`where`	string	Reference to the method where the problem occurred
`cause`	string	Cause of failure
data	array	Tenant items. See the children table below

children

Field	Value	Description
`id`	`long`	ID of the tenant
`name`	string	Name of the tenant
`uuid`	string	UUid of the corresponding session
`allocated`	int	Sockets allocated for the tenant
`allocatedDesired`	int	Number of sockets to be allocated to the tenant at some point. It is saved in the database but not yet applied to the physical tenant. If `allocatedDesired` = `actual`, then either number of sockets is allocated for the tenant or it has not changed
`allocatedEc2Instances`	int	Number of EC2 instances allocated for the tenant
`allocatedEc2InstancesDesired`	int	Number of EC2 instances to be allocated to the tenant at some point. It is saved in the database but not yet applied to the physical tenant. If allocatedEc2InstancesDesired = actual, then either number of EC2 instances is allocated for the tenant or it has not changed
`allocatedPhysicalServers`	int	Number of physical servers allocated for the tenant
`allocatedPhysicalServersDesired`	int	Number of physical machines to be allocated to the tenant at some point. It is saved in the database but not yet applied to the physical tenant
`labels`	array	Tenant labels
`email`	string	Contact Email of the tenant
`phone`	string	Contact phone number of the tenant
`website`	string	URL of the tenant website
`address`	string	Contact address of the tenant
`logo`	string	A path to the tenant logo image
`showName`	boolean	If `true`, it will display the name of the tenant
`enabled`	boolean	If `true`, the tenant will be enabled
`state`	string	State of the tenant. Possible values: `OK, WARNING, INACCESSIBLE, ERROR`
`status`	string	Status of the tenant. Possible values: `NONE, UPDATING`
`changeStatus`	string	Defines the pending change in the tenant’s state. Possible values: NONE, CREATE_PENDING, CHANGE_PENDING
`alarmState`	string	State of the tenant alarms. Possible values: `OK, WARNING, ERROR`
`lockedShared`	boolean	`true` if a shared lock is set for the tenant. `false` otherwise
`lockedExclusive`	boolean	`true` if an exclusive lock is set for the tenant. `false` otherwise
`wasEdited`	boolean	Indicates whether the tenant was edited
`wasDiscoveredOnce`	boolean	Indicates whether the tenant state was discovered once
`progress`	int	A value from `0` to `100`. For a newly created tenant, the value is set to `0`
`alarmCounters`	array	Number of alarms in the tenant
`usedVms`	int	Number of VMs used by the tenant
`usedSockets`	int	Number of sockets used by the tenant
`usedEc2Instances`	int	Number of EC2 instances used by the tenant
`usedPhysicalServers`	int	Number of physical machines used by the tenant
`alertErrorCode`	string	Error code of the alert
`alertTitle`	string	Title of the alert
`alertDescription`	string	Description of the alert
`total`	int	Number of tenant items