Feuilles de travail d'analyse

Une feuille de travail ("worksheet" en anglais) correspond à l'écran BUI sur lequel les statistiques sont représentées sous forme graphique. Diverses statistiques peuvent être représentées simultanément, il est également possible d'attribuer un titre aux feuilles de travail pour les enregistrer à des fins de consultation ultérieure. L'enregistrement d'une feuille de travail exécute automatiquement l'action d'archive sur toutes les statistiques ouvertes. Concrètement, toute statistique ouverte continue à être lue et archivée. Vous pouvez utiliser les commandes Worksheet pour gérer les feuilles de travail disponibles dans la BUI.

Nom Description ctime Heure et date de création de la feuille de travail mtime Heure et date de la dernière modification de la feuille de travail name Nom de cette feuille de travail owner Propriétaire de cette feuille de travail uuid Identifiant universel unique de cette feuille de travail

List Worksheets

Répertorie toutes les feuilles de travail d'analyse actuellement configurées.

Exemple de demande :

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

Exemple de réponse :

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

Get Analytics Worksheet

Obtient une feuille de travail d'analyse unique.

Exemple de demande :

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

Exemple de réponse :

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

Create Worksheets

Crée une feuille de travail d'analyse.

Exemple de demande :

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

{"name": "myworksheet"}

Exemple de résultats :

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

Destroy Worksheets

Détruit une feuille de travail d'analyse. Dans cet exemple, le nom de la feuille de travail est utilisé comme identificateur même si l'UUID identifié dans le lien href peut également être utilisé. Le comportement de cette commande est le même que celui de la commande de la CLI permettant de détruire les feuilles de travail.

Exemple de demande :

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

Exemple de réponse :

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

List Worksheet Datasets

Répertorie tous les ensembles de données dans la feuille de travail spécifiée. La configuration de l'ensemble de données utilise les propriétés suivantes.

Nom Description name Nom des statistiques sous-jacentes pour cet ensemble de données drilldowns Analyses descendantes actuellement sélectionnées, le cas échéant seconds Nombre de secondes pendant lesquelles cet ensemble de données est affiché

Exemple de demande :

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

Add Worksheet Dataset

Crée un ensemble de données de feuille de travail.

Exemple de demande :

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}

Exemple de résultats :

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

Modify Worksheet Dataset

Modifie un ensemble de données de feuille de travail existant.

Exemple de demande :

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}

Exemple de résultats :

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