Obtener información sobre inquilinos

Versión del producto: 10.11

Último modificado: 31 julio 2024

Devuelve información detallada sobre el inquilino.

Punto final

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

Ejemplo de solicitud

rizo

Copiar

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}'

Campos de solicitud

Campo	Tipo	Valor(es)	Descripción
`action`	string	MultitenancyManagement	La acción que se invoca
`method`	string	getTenants	El método que se invoca
`data`	array		Filtrar parámetros. Consulte la tabla de filtros a continuación
`type`	string	`rpc`	Tipo de protocolo de comunicación
`tid`	int	1	ID de transacción. Se utiliza para identificar la solicitud tanto por parte del cliente como del servidor

Filtrar

Campo	Tipo	Descripción
`start`	int	ID de inicio del inquilino a devolver
`count`	int	Número de inquilinos a devolver
`sort`	string	Parámetro de inquilino que debe ordenarse con
`sortAsc`	boolean	`true` si el orden es ascendente
`criteria`	Json	Filtrar criterios. Véase el cuadro siguiente

criterios

Campo	Tipo	Descripción
`name`	string	Nombre del criterio. `ID` significa el ID del inquilino
`type`	string	Tipo de criterio. Valores posibles: `AND, OR, EQ` (igual), `NEQ` (no igual), `LIKE` (distingue mayúsculas de minúsculas), I`N, BETWEEN, NOT_NULL, ILIKE, GT, GTE, LT, LTE`
`value`	string	Valor de un criterio. `1`: inquilino`ID=1`
`values`	lista <string>	Valores de los atributos. Utilizado para los valores `IN, BETWEEN` del campo `type`

Muestra de respuesta

rizo

Copiar

{
    "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}}
}

Campos de respuesta

Campo	Valor	Descripción
`message`	string	Mensaje si la solicitud ha fallado
`where`	string	Referencia al método en el que se produjo el problema
`cause`	string	Causa del fallo
data	array	Elementos inquilinos. Consulte la tabla de niños que figura a continuación

niños

Campo	Valor	Descripción
`id`	largo	ID del inquilino
`name`	string	Nombre del inquilino
`uuid`	string	UUid de la sesión correspondiente
`allocated`	int	Zócalos asignados para el inquilino
`allocatedDesired`	int	Número de zócalos que se asignarán al inquilino en algún momento. Se guarda en la base de datos, pero aún no se aplica al inquilino físico.
`allocatedEc2Instances`	int	Número de Instancias de EC2 asignadas al inquilino
`allocatedEc2InstancesDesired`	int	Número de Instancias de EC2 que se asignarán al inquilino en algún momento. Se guarda en la base de datos, pero aún no se aplica al inquilino físico.
`allocatedPhysicalServers`	int	Número de servidores físicos asignados
`allocatedPhysicalServersDesired`	int	Número de máquinas físicas que se asignarán al inquilino en algún momento. Se guarda en la base de datos, pero aún no se aplica al inquilino físico.
`labels`	array	Etiquetas para inquilinos
`email`	string	Correo electrónico de contacto del inquilino
`phone`	string	Teléfono de contacto del inquilino
`website`	string	URL del sitio web del inquilino
`address`	string	Dirección de contacto del inquilino
`logo`	string	Ruta de acceso a la imagen del logotipo inquilino
`showName`	boolean	Si es verdadero, se mostrará el nombre del inquilino
`enabled`	boolean	Si es true, el inquilino estará habilitado
`state`	string	Un estado del inquilino. Valores posibles: `OK, WARNING, INACCESSIBLE, ERROR`
`status`	string	Estado del inquilino. Valores posibles: `NONE, UPDATING`
`changeStatus`	string	Define el cambio pendiente en el estado del inquilino. Valores posibles: `NONE, CREATE_PENDING, CHANGE_PENDING`
`alarmState`	string	Estado de las alarmas del inquilino. Valores posibles: `OK, WARNING, ERROR`
`lockedShared`	boolean	true si se ha establecido un bloqueo compartido para el inquilino. falso en caso contrario
`lockedExclusive`	boolean	`true`si se ha establecido un bloqueo exclusivo para el inquilino. `false`de lo contrario
`wasEdited`	boolean	Indica si se ha editado el inquilino
`wasDiscoveredOnce`	boolean	Indica si el estado del inquilino se detectó una vez
`progress`	int	Un valor de `0` a `100`. Para un inquilino recién creado, el valor se establece en `0`
`alarmCounters`	array	Número de alarmas en el inquilino
`usedVms`	int	Número de máquinas virtuales utilizadas por el inquilino
`usedSockets`	int	Número de zócalos de CPU utilizados por el inquilino
`usedEc2Instances`	int	Número de Instancias de EC2 utilizadas por el inquilino
`usedPhysicalServers`	int	Número de máquinas físicas utilizadas por el inquilino
`alertErrorCode`	string	Un código de error de la alerta
`alertTitle`	string	Título de la alerta
`alertDescription`	string	Descripción de la alerta
`total`	int	Número de elementos inquilinos