Hojas de trabajo de análisis

Idioma:

Una hoja de trabajo es una pantalla de la BUI en la que se grafican estadísticas. Se pueden trazar estadísticas múltiples al mismo tiempo y se pueden asignar títulos a las hojas de trabajo y guardarlas para visualizarlas en el futuro. La acción de guardar una hoja de trabajo ejecuta automáticamente la acción de archivo en todas las estadísticas abiertas, lo que significa que las estadísticas que estaban abiertas, continúan leyéndose y archivándose continuamente. Los comandos de la hoja de trabajo se pueden usar para administrar las hojas de trabajo disponibles en la BUI.

Nombre	Descripción
ctime	Hora y fecha en la que se creó esta hoja de trabajo
mtime	Hora y fecha en la que se modificó esta hoja de trabajo por última vez
name	Nombre de esta hoja de trabajo
owner	Propietario de esta hoja de trabajo
uuid	Identificador universal de equipo para esta hoja de trabajo

Mostrar hojas de trabajo

Mostrar todas las hojas de trabajo de análisis configuradas actualmente.

Ejemplo de solicitud:

GET /api/analytics/v1/worksheets HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Host: example.zfssa.com:215
Accept: application/json

Ejemplo de respuesta:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 237
X-Zfssa-Analytics-Api: 1.0

{
    "worksheets": [{
        "href": "/api/analytics/v1/worksheets/ab59bcbc...",
        "uuid": "ab59bcbc-080a-cf1a-98c9-9f485bc3a43d"
    }, {
        "href": "/api/analytics/v1/worksheets/bb3ee729...",
        "uuid": "bb3ee729-080a-cf1a-98c9-9f485bc3a43d"
    }]
}

Obtener hoja de trabajo de análisis

Obtiene una sola hoja de trabajo de análisis.

Ejemplo de solicitud:

GET /api/analytics/v1/worksheets/ab59bcbc-080a-cf1a-98c9-9f485bc3a43d
    HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Host: example.zfssa.com:215
Accept: application/json

Ejemplo de respuesta:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 237
X-Zfssa-Analytics-Api: 1.0

{
    "worksheet": {
        "ctime": "Thu Jun 13 2013 02:17:14 GMT+0000 (UTC)",
        "href": "/api/analytics/v1/worksheets
                 /ab59bcbc-080a-cf1a-98c9-9f485bc3a43d",
        "mtime": "Sun Jun 23 2013 16:22:01 GMT+0000 (UTC)",
        "name": "myworksheet",
        "owner": "root",
        "uuid": "ab59bcbc-080a-cf1a-98c9-9f485bc3a43d"
    }
}

Crear hojas de trabajo

Crea una hoja de trabajo de análisis nueva.

Ejemplo de solicitud:

POST /api/analytics/v1/worksheets HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Content-Type: application/json
Content-Length: 26

{"name": "myworksheet"}

Ejemplo de resultados:

HTTP/1.1 201 Created
Content-Length: 280
Location: /api/analytics/v1/worksheets/bb3ee729-4480-4609-89b2-fae2dc016bec

{
    "worksheet": {
        "uuid": "bb3ee729-4480-4609-89b2-fae2dc016bec",
        "name": "myworksheet",
        "owner": "root",
        "ctime": "Fri Aug 23 2013 20:35:00 GMT+0000 (UTC)",
        "mtime": "Fri Aug 23 2013 20:35:00 GMT+0000 (UTC)",
        "href": "/api/analytics/v1/worksheets
                 /bb3ee729-4480-4609-89b2-fae2dc016bec"
    }
}

Cambiar nombre de hojas de trabajo

Cambia el nombre de una hoja de trabajo guardada.

Ejemplo de solicitud:

PUT /api/analytics/v1/worksheets/a442e761-4048-4738-b95f-be0824d7ed09
Authorization: Basic ab6rt4psMWE=
Content-Type: application/json
Content-Length: 26

{"name": "test"}

Ejemplo de respuesta:

HTTP/1.1 202 Accepted
Date: Tue, 20 Dec 2016 00:33:06 GMT
Server: TwistedWeb/10.1.0
Content-Length: 279
X-Zfssa-Version: ak/generic@2013.06.05.7.0,1-1.12
X-Zfssa-Analytics-Api: 1.1
X-Zfssa-Api-Version: 1.0
Content-Type: application/json; charset=utf-8

    {"worksheet":
        {"href": "/api/analytics/v1/worksheets/a442e761-4048-4738-b95f-be0824d7ed09",
        "uuid": "a442e761-4048-4738-b95f-be0824d7ed09",
        "name": "test",
        "owner": "root",
        "ctime": "Wed Dec 14 2016 03:58:28 GMT+0000 (UTC)",
        "mtime": "Tue Dec 20 2016 00:25:57 GMT+0000 (UTC)"
    }
}

Destruir hojas de trabajo

Destruye una hoja de trabajo de análisis. En este ejemplo, se utiliza el nombre de la hoja de trabajo como identificador de la hoja de trabajo, pero también de puede utilizar el uuid identificado en el href. El comportamiento de este comando coincide con el comportamiento del comando de la CLI que destruye las hojas de trabajo.

Ejemplo de solicitud:

DELETE /api/analytics/v1/worksheets/name=myworksheet HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Content-Type: application/json
Content-Length: 26

Ejemplo de respuesta:

HTTP/1.1 204 No Content
X-Zfssa-Analytics-Api: 1.0

Mostrar los conjuntos de datos de la hoja de trabajo

Muestra todos los conjuntos de datos de la hoja de trabajo especificada. La configuración de la hoja de datos utiliza las siguientes propiedades.

Nombre	Descripción
name	Nombre de la estadística subyacente para esta hoja de trabajo.
drilldowns	Opciones desplegables resaltadas actualmente, si las hay.
seconds	Cantidad de segundos que se muestran para este conjunto de datos.

Ejemplo de solicitud:

GET /api/analytics/v1/worksheets/name=myworksheet/datasets HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Host: example.zfssa.com:215
Accept: application/json

Agregar conjunto de datos de hoja de trabajo

Crea un conjunto de datos de la hoja de trabajo.

Ejemplo de solicitud:

POST /api/analytics/v1/worksheets/name=myworksheet/datasets HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Content-Type: application/json
Content-Length: 26

{"name": "nfs4.ops", "seconds": 300}

Ejemplo de resultados:

HTTP/1.1 201 Created
Content-Type: application/json
X-Zfssa-Analytics-Api: 1.0
Location: /api/analytics/v1/worksheets/name=me/datasets/nfs4.ops
Content-Length: 162

{
    "dataset": {
        "href": "/api/analytics/v1/worksheets/name=me/datasets/dataset-008",
        "name": "nfs4.ops",
        "width": 0,
        "drilldowns": [],
        "seconds": 300,
        "time": ""
    }
}

Modificar el conjunto de datos de la hoja de trabajo

Modifica el conjunto de datos de una hoja de trabajo existente.

Ejemplo de solicitud:

PUT /api/analytics/v1/worksheets/name=myworksheet/datasets/dataset-008
    HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Content-Type: application/json
Content-Length: 26

{"seconds": 60}

Ejemplo de resultados:

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 161
X-Zfssa-Analytics-Api: 1.0

{
    "dataset": {
        "href": "/api/analytics/v1/worksheets/name=me/datasets/dataset-008",
        "name": "nfs4.ops",
        "width": 0,
        "drilldowns": [],
        "seconds": 60,
        "time": ""
    }
}