Get Tenant Info
Returns detailed tenant info.
Endpoint
https://<Director_IP_address>:4443/c/router
Request Example
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": 1000,
"criteria": [{
"name": "ID",
"type": "EQ",
"value": "1"}]}
}],
"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
|
---|---|---|
|
int | A start ID of the tenant to be returned |
|
int | Number of tenants to be returned |
|
string |
Tenant parameter to be sorted with |
|
boolean |
|
|
Json | Filter criteria. See the table below |
criteria
Field |
Type |
Description |
---|---|---|
|
string | Name of criterion. ID means the tenant ID |
|
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 |
|
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
{
"action": "MultitenancyManagement",
"method": "getTenants",
"tid": "1",
"type": "rpc",
"message": null,
"where": null,
"cause": null,
"data":
{"children":
[{"id": 1,
"name": "test name",
"uuid": "3a16f608-2a2a-4fe7-94b5-91068725bced",
"allocated": 3,
"allocatedDesired": 3,
"allocatedEc2Instances": 0,
"allocatedEc2InstancesDesired": 0,
"allocatedPhysicalServersDesired": 0,
"labels": [],
"email": "email@email.com",
"phone": "12345",
"website": "www.nakivo.com",
"address": "Some address",
"logo": null,
"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,
"usedPhysicalServers ": 0,
"alertErrorCode": null,
"alertTitle": null,
"alertDescription": null}],
"total":1}}
}
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
|
---|---|---|
|
long | ID of the tenant |
|
string | Name of the tenant |
|
string | UUid of the corresponding session |
|
int | Sockets allocated for the tenant |
|
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 |
|
int | Number of EC2 instances allocated for the tenant |
|
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 |
|
int |
Number of allocated physical servers |
|
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 |
|
array | Tenant's labels |
|
string |
Contact Email of the tenant |
|
string |
Contact phone number of the tenant |
|
string |
URL of the tenant website |
|
string |
Contact address of the tenant |
|
string |
A path to the tenant logo image |
|
boolean |
If true, it will display the name of the tenant |
|
boolean |
If true, the tenant will be enabled |
|
string |
A state of the tenant. Possible values: |
|
string |
Status of the tenant. Possible values: |
|
string |
Defines the pending change in the tenant’s state. Possible values: |
|
string |
State of the tenant’s alarms. Possible values: |
|
boolean |
true if a shared lock is set for the tenant. false otherwise |
|
boolean |
|
|
boolean |
Indicates whether the tenant was edited |
|
boolean |
Indicates whether the tenant’s state was discovered once |
|
int |
A value from |
|
array |
Number of alarms in the tenant |
|
int |
Number of VMs used by the tenant |
|
int |
Number of sockets used by the tenant |
|
int |
Number of EC2 instances used by the tenant |
|
int |
Number of physical machines used by the tenant |
|
string |
An error code of the alert |
|
string |
A title of the alert |
|
string |
A description of the alert |
|
int |
Number of tenant items |