Returns detailed tenants list.
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": 2, "criteria": []}}], "type": "rpc", "tid": 1}"
Request Fields
Field | Type | Value(s) | Description |
---|---|---|---|
action | string |
| The action that is invoked |
method | string |
| The method that is invoked |
data | array | Filter parameters. See the | |
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 |
| string | Tenant parameter to be sorted with |
| boolean |
|
criteria | 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: |
| string | Value of a criterion. |
| list <string> | Attribute values. Used for the |
Response Sample
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. If allocatedDesired = actual , then either number of sockets is allocated for the tenant or it has not changed |
| 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. If allocatedEc2InstancesDesired = actual, then either number of EC2 instances is allocated for the tenant or it has not changed |
| int | Number of physical servers allocated for the tenant |
| 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 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 | State of the tenant. Possible values: OK, WARNING, INACCESSIBLE, ERROR |
| string | Status of the tenant. Possible values: NONE, UPDATING |
| string | Defines the pending change in the tenant’s state. Possible values: NONE, CREATE_PENDING, CHANGE_PENDING |
| string | State of the tenant alarms. Possible values: OK, WARNING, ERROR |
| boolean | true if a shared lock is set for the tenant. false otherwise |
| boolean | true if an exclusive lock is set for the tenant. false otherwise |
| boolean | Indicates whether the tenant was edited |
| boolean | Indicates whether the tenant state was discovered once |
| int | A value from 0 to 100 . For a newly created tenant, the value is set to 0 |
| 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 | Error code of the alert |
| string | Title of the alert |
| string | Description of the alert |
| int | Number of tenant items |