Skip to main content
Astra Automation
Une version plus récente de ce produit est disponible.
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

Lister tous les systèmes de stockage backend

PDF

GET /accounts/{account_id}/topology/v1/storageBackends

Renvoie un tableau JSON contenant toutes les ressources correspondantes de la collection. Si des champs individuels sont spécifiés dans la requête, le tableau JSON items contiendra les champs demandés pour chaque ressource correspondante dans l'ordre indiqué.

Paramètres

Nom Type Dans Obligatoire Description

identifiant_compte

chaîne

chemin

Vrai

ID de la ressource de compte conteneur

  • exemple: {{.Account}}

inclure

chaîne

requête

Faux

Indique les champs qui doivent être renvoyés lors de l’énumération d’une collection.

Exemples d'URL : « include=id », « include=id,name »

Exemples OpenAPI : « id »

  • Exemple : id,name,state

limite

chaîne

requête

Faux

Indique le nombre maximal de ressources à renvoyer lors de l’énumération d’une collection.

Exemples d'URL : « limit=2 »

Exemples OpenAPI : « 2 »

Réponse

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
Nom Type Obligatoire Description

articles

tableau[N'importe lequel de : "corps de réponse storageBackend_1.3_get_response_body", tableau[]]

Vrai

les métadonnées

"type_astra_metadata_list"

Vrai
Exemple de réponse 
{
  "type": "application/astra-storageBackends",
  "version": "1.3",
  "items": [
    [
      "d6ee1e51-d65f-415a-a3d4-6d7fa8b64943",
      "st1-45",
      "running"
    ],
    [
      "a5c508b7-aacd-4d19-9455-53c0d183ab4e",
      "st2-67",
      "discovered"
    ]
  ],
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Réponse

Status: 401, Unauthorized
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

Faux
Exemple de réponse 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Réponse

Status: 400, Bad request
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

Faux

invalidParams

tableau["invalidParams"]

Faux

Liste des paramètres de requête invalides
Exemple de réponse 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Réponse

Status: 403, Forbidden
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

Faux
Exemple de réponse 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Erreur

Status: 404, Not found
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

Faux
Exemple de réponse d'erreur 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Définitions

Voir les définitions

capacités

Objet JSON contenant les fonctionnalités de ce Storage Backend.

Nom Type Obligatoire Description

FlexClone®

chaîne

Vrai

Chaîne JSON indiquant si ce backend de stockage prend en charge FlexClone.

SnapMirror

chaîne

Vrai

Chaîne JSON indiquant si ce backend de stockage prend en charge SnapMirror.

s3

chaîne

Vrai

Chaîne JSON indiquant si ce Storage Backend prend en charge s3.

ONTAP

Objet JSON contenant des informations spécifiques relatives aux clusters ONTAP.

Nom Type Obligatoire Description

authenticationStyle

chaîne

Vrai

Chaîne JSON indiquant si l'authentification ONTAP est effectuée à l'aide d'une combinaison nom d'utilisateur/mot de passe ou d'un certificat. Les valeurs définies sont :

  • « basic » - Utilise un nom d'utilisateur et un mot de passe

  • « certificat » - Utilise certificat

  • enum : ["basic", "certificate"]

  • exemple : basique

Adresse IP de gestion du backend

chaîne

Faux

Chaîne JSON contenant l'adresse IP utilisée pour se connecter à ce cluster ONTAP.

adresses IP de gestion

tableau[chaîne]

Faux

Tableau JSON de chaînes JSON contenant la liste de toutes les adresses IP de gestion possibles utilisées pour se connecter à ce cluster ONTAP. Ceci est utilisé pour faire correspondre les backends détectés via Trident et les backends de stockage dans Astra.

  • uniqueItems : 1

type_astra_label

Nom Type Obligatoire Description

nom

chaîne

Vrai

valeur

chaîne

Vrai

type_astra_metadata_update

Métadonnées spécifiques au client et au service associées à la ressource. Les valeurs définies sont :

  • Conforme au schéma de métadonnées Astra. Si aucune étiquette n'est spécifiée lors de la création, un objet de métadonnées sera créé sans étiquette. Si aucune étiquette n'est spécifiée lors de la mise à jour, les étiquettes de l'objet de métadonnées, creationTimestamp et createdBy, seront conservées sans modification.

Nom Type Obligatoire Description

étiquettes

tableau["type_astra_label"]

Faux

CréationTimestamp

chaîne

Faux

ModificationTimestamp

chaîne

Faux

CreatedBy

chaîne

Faux

modifiedBy

chaîne

Faux

corps de réponse storageBackend_1.3_get_response_body

Nom Type Obligatoire Description

type

chaîne

Vrai

Type de média de la ressource. Les valeurs définies sont :

  • "application/astra-storageBackend"

version

chaîne

Vrai

Version de la ressource. Les valeurs définies sont :

  • "1,0"

  • "1,1"

  • "1,2"

  • "1,3"

id

chaîne

Vrai

Identifiant unique global de la ressource. Les valeurs définies sont :

  • Conforme au schéma UUIDv4

backendName

chaîne

Vrai

Chaîne JSON contenant un nom spécifié par l'utilisateur pour le stockage backend. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

backendType

chaîne

Vrai

Chaîne JSON contenant une valeur indiquant le type de système de stockage utilisé. Les valeurs définies sont :

  • « ontap » - Le backend de stockage représente un système NetApp ONTAP

  • enum : ["ontap"]

  • exemple : ontap

backendVersion

chaîne

Vrai

Chaîne JSON contenant une valeur indiquant la version du système de stockage utilisé. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

backendCredentialsName

chaîne

Vrai

Chaîne JSON contenant une valeur indiquant le nom d’un ou plusieurs identifiants utilisés pour le backend de stockage. Permet la rotation des identifiants lorsque plusieurs objets d’identifiant portent le même nom. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

configVersion

chaîne

Faux

Chaîne JSON contenant une valeur indiquant la configuration active à utiliser par le stockage backend. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

État

chaîne

Vrai

Chaîne JSON contenant une valeur indiquant l'état opérationnel du stockage backend. Les valeurs définies sont :

  • « découvert » - Le stockage backend a été découvert à partir d'un cluster géré

  • « running » - Le système de stockage fonctionne normalement

  • « inconnu » - L'état du stockage backend ne peut pas être déterminé

  • « Échec » - Le système de stockage principal est dans un état indisponible

stateDesired

chaîne

Faux

Chaîne JSON contenant une valeur indiquant l'état opérationnel souhaité du stockage backend. Les valeurs définies sont :

  • « running » - Le système de stockage sera dans un état de fonctionnement normal

stateUnready

tableau[chaîne]

Vrai

Tableau JSON de chaînes JSON, chacune indiquant la raison pour laquelle un système de stockage ne peut pas passer à l'état « en cours d'exécution », est passé à l'état « en échec » ou « inconnu », et/ou risque de passer à l'état « en échec ». Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 127

managedState

chaîne

Vrai

Chaîne JSON contenant une valeur indiquant l'état de gestion du stockage backend. Les valeurs définies sont :

  • « pending » - Le stockage backend est programmé pour être découvert ou ajouté

  • « unmanaged » : le système de stockage est à l’état « discovered », n’est pas géré et peut être géré.

  • « Géré » - Le système de stockage est dans un état « en cours d'exécution » ou « inconnu » et est sous gestion

managedStateUnready

tableau[chaîne]

Vrai

Tableau JSON de chaînes JSON, chacune indiquant une raison pour laquelle le système de stockage n'est pas éligible à être géré. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 127

healthState

chaîne

Faux

Chaîne JSON contenant une valeur indiquant l'état de santé du stockage backend. Les valeurs définies sont :

  • « Indéterminé » - L'état de la ressource ne peut être déterminé (par exemple, en raison d'un manque de connectivité)

  • « Normal » - La ressource ne présente aucun problème connu et peut fournir des services conformément aux spécifications de l'interface

  • « warning » : La ressource présente des problèmes connus qui ne l’empêchent pas de fournir des services conformément aux spécifications de l’interface.

  • « critical » : La ressource présente des problèmes connus qui l’empêchent de fournir des services conformément aux spécifications de l’interface

healthStateUnready

tableau[chaîne]

Faux

Tableau JSON de chaînes JSON, chacune indiquant une raison pour laquelle un système de stockage n'est pas dans un état de santé normal. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 127

protectionState

chaîne

Vrai

Chaîne JSON contenant une valeur indiquant l'état de protection du stockage backend. "unknown" pour ONTAP. Les valeurs définies sont :

  • « protégé » - Le stockage backend possède une politique de protection définie et est conforme à cette politique

  • « Partiel » - Le stockage backend possède une politique de protection définie, mais n'est pas conforme à cette politique

  • « none » - Le système de stockage n'est pas protégé

  • « unknown » - La conformité de la politique de protection du stockage backend ne peut pas être déterminée

  • énum : ["protected", "partial", "none", "unknown"]

  • exemple: protégé

protectionStateUnready

tableau[chaîne]

Vrai

Tableau JSON de chaînes JSON, chacune indiquant une raison pour laquelle une politique de protection n'est pas conforme. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 127

capacités

"capacités"

Vrai

Objet JSON contenant les fonctionnalités de ce Storage Backend.

ONTAP

"ONTAP"

Faux

Objet JSON contenant des informations spécifiques relatives aux clusters ONTAP.

  • additionalProperties : false

les métadonnées

"type_astra_metadata_update"

Vrai

Métadonnées spécifiques au client et au service associées à la ressource. Les valeurs définies sont :

  • Conforme au schéma de métadonnées Astra. Si aucune étiquette n'est spécifiée lors de la création, un objet de métadonnées sera créé sans étiquette. Si aucune étiquette n'est spécifiée lors de la mise à jour, les étiquettes de l'objet de métadonnées, creationTimestamp et createdBy, seront conservées sans modification.

type_astra_metadata_list

Nom Type Obligatoire Description

continuer

chaîne

Faux

nombre

nombre

Faux

étiquettes

tableau["type_astra_label"]

Faux

CréationTimestamp

chaîne

Faux

ModificationTimestamp

chaîne

Faux

CreatedBy

chaîne

Faux

modifiedBy

chaîne

Faux

invalidParams

Nom Type Obligatoire Description

nom

chaîne

Vrai

Nom du paramètre de requête invalide

raison

chaîne

Vrai

Raison pour laquelle le paramètre de requête est invalide