Go to main content

Guide RESTful API des systèmes Oracle® ZFS Storage Appliance, version OS8.8.x

Quitter la vue de l'impression

Mis à jour : Août 2021
 
 

Schema

Gère des propriétés de schéma personnalisées.

Table 53  Commandes de schéma
Demande
Ajouter au chemin /api/storage/v{1|2}
Description
GET
/schema
Enumération de tous les objets de propriété de schéma NAS
GET
/schema/property
Obtention des propriétés de la propriété du schéma NAS spécifié
POST
/schema
Création d'une nouvelle propriété de schéma NAS
PUT
/schema/property
Modification de l'objet de la propriété du schéma NAS spécifié
DELETE
/schema/property
Suppression de l'objet de la propriété du schéma NAS spécifié

Chaque propriété de schéma personnalisée peut être définie sur les projets, systèmes de fichiers et LUN en ajoutant le préfixe custom: au nom de propriété personnalisée.

Par exemple, le corps PUT suivant modifie une propriété int personnalisée nommée priority :

{"custom:priority": 5}
Table 54  Paramètres de schéma
Paramètre
Description
property
Nom de la propriété (inaltérable)
description
Description de la propriété (pour l'interface de navigateur)
type
Type ("String", "Integer", "PositiveInteger", "Boolean", "EmailAddress", "Host")

Liste des propriétés

Répertorie les propriétés de schéma.

Exemple de demande :

GET /api/storage/v1/schema

Exemple de résultat :

{
    "properties": [{
        "description": "bob",
        "href": "/api/storage/v1/schema/bob",
        "property": "bob",
        "type": "String"
    },{
        "description": "boo",
        "href": "/api/storage/v1/schema/boo",
        "property": "boo",
        "type": "String"
    }]
}

Obtention d'une propriété

Obtient une propriété de schéma.

Exemple de demande :

GET /api/storage/v1/schema/priority

Exemple de résultat :

{
    "property": {
        "description": "priority",
        "href": "/api/storage/v1/schema/priority",
        "property": "bob",
        "type": "Integer"
    }
}

Création d'une propriété

Crée une nouvelle propriété de schéma.

Exemple de demande :

POST /api/storage/v1/schema HTTP/1.1
Host: zfs-storage.example.com:215
Content-Type: application/json
Content-Length: 64

{"property":"priority", "type":"Integer", "description":"Oh my"}

Exemple de résultat :

HTTP/1.1 201 Created
Content-Length: 89
X-Zfssa-Nas-Api: 1.0
Content-Type: application/json
Location: /api/storage/v1/schema/priority

{
    "property": {
        "href": "/api/storage/v1/schema",
        "type": "Integer",
        "description": "Oh my"
    }
}

Modification d'une propriété

Modifie une propriété de schéma.

Exemple de demande :

PUT /api/storage/v1/schema/priority

{"description":"My custom priority level"}

Exemple de résultat :

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

{
    "property": {
        "href": "//api/storage/v1/schema/priority",
        "type": "Integer",
        "description": "My custom priority level"
    }
}

Suppression d'une propriété

Cette commande supprime une propriété de schéma.

Exemple de demande :

DELETE /api/storage/v1/schema/me HTTP/1.1

Exemple de résultat :

HTTP/1.1 204 No Content