Feuilles de travail d'analyse

Langue :

Une feuille de travail 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 calcul 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.

Le tableau suivant affiche les propriétés utilisées dans les feuilles de calcul d'analyse.

Propriété	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

Liste des feuilles de travail

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 Tm8gcGVla2luZyE=
Host: zfs-storage.example.com:215
Accept: application/json

Exemple de résultat :

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

Obtention d'une feuille de travail

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 Tm8gcGVla2luZyE=
Host: zfs-storage.example.com:215
Accept: application/json

Exemple de résultat :

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

Création de feuilles de travail

Crée une feuille de travail d'analyse.

Exemple de demande :

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

{"name": "myworksheet"}

Exemple de résultat :

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

Modification du nom d'une feuille de travail

Renomme une feuille de travail enregistrée.

Exemple de demande :

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

{"name": "test"}

Exemple de résultat :

HTTP/1.1 202 Accepted
Date: Tue, 20 Dec 2016 00:33:06 GMT
Server: TwistedWeb/192.0.2
Content-Length: 279
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)"
    }
}

Suppression d'une feuille de travail

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 Tm8gcGVla2luZyE=
Content-Type: application/json
Content-Length: 26

Exemple de résultat :

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

Liste des ensembles de données d'une feuille de travail

Répertorie tous les ensembles de données dans la feuille de travail spécifiée.

Le tableau suivant affiche les propriétés utilisées dans la configuration des ensembles de données.

Propriété	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 Tm8gcGVla2luZyE=
Host: zfs-storage.example.com:215
Accept: application/json

Ajouter un ensemble de données à une feuille de travail

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 Tm8gcGVla2luZyE=
Content-Type: application/json
Content-Length: 26

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

Exemple de résultat :

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

Modifier un ensemble de données d'une feuille de travail

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 Tm8gcGVla2luZyE=
Content-Type: application/json
Content-Length: 26

{"seconds": 60}

Exemple de résultat :

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