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.

Récupérer un compartiment

PDF

GET /accounts/{account_id}/topology/v1/buckets/{bucket_id}

Renvoie la ressource API Bucket stockée dans le corps de la réponse JSON.

Paramètres

Nom Type Dans Obligatoire Description

identifiant_compte

chaîne

chemin

Vrai

ID de la ressource de compte conteneur

  • exemple: {{.Account}}

bucket_id

chaîne

chemin

Vrai

ID de la collection de compartiments à lister

Réponse

Status: 200, Returns the stored Bucket API resource in the JSON response body.
Nom Type Obligatoire Description

type

chaîne

Vrai

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

  • "application/astra-bucket"

version

chaîne

Vrai

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

  • "1,0"

  • "1,1"

  • "1,2"

id

chaîne

Vrai

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

  • Conforme au schéma UUIDv4

nom

chaîne

Vrai

Chaîne JSON contenant un nom attribué par l'utilisateur au compartiment. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 256

identifiant

chaîne

Vrai

Chaîne JSON contenant l'identifiant des identifiants utilisés pour accéder au compartiment. Les valeurs définies sont :

  • Conforme au schéma d'identifiant Astra

État

chaîne

Vrai

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

  • « pending » - Le compartiment est programmé pour être découvert

  • « disponible » - Le seau est disponible pour utilisation

  • « défaillant » - Le bucket est dans un état de défaillance permanent

  • « supprimé » - Le compartiment n'est actuellement pas accessible

  • « unknown » - L'état du compartiment ne peut être déterminé

stateDetails

tableau["type_astra_stateDetail"]

Vrai

Tableau JSON d'objets JSON contenant des informations supplémentaires sur la raison pour laquelle « state » est passé à « removed » ou « failed ». Si aucun détail n'est disponible, ce tableau sera vide.

  • Nombre minimum d’articles : 0

fournisseur

chaîne

Vrai

Chaîne JSON indiquant le protocole de compartiment pouvant être utilisé pour accéder au compartiment. Les valeurs définies sont :

  • "ontap-s3"

  • "storagegrid-s3"

  • "generic-s3"

  • "gcp"

  • "azure"

  • "aws"

bucketParameters

"bucketParameters"

Vrai

Objet JSON contenant les informations spécifiques au fournisseur de compartiment nécessaires pour accéder au compartiment. Les valeurs spécifiques de ce compartiment varient selon le fournisseur.

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.
Exemple de réponse 
{
  "type": "application/astra-bucket",
  "version": "1.2",
  "id": "9b296ce0-c545-5022-acfa-1980c5aaea97",
  "name": "Test Bucket",
  "credentialID": "8f039324-7795-40bf-a5ca-4442580f7ab0",
  "state": "available",
  "stateDetails": [],
  "provider": "gcp",
  "bucketParameters": {
    "gcp": {
      "bucketName": "bucketName"
    }
  },
  "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

type_astra_stateDetail

Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

s3

Objet JSON fournissant les paramètres du protocole Simple Storage Service (S3). (Utilisez cet objet pour tous les fournisseurs de type S3).

Nom Type Obligatoire Description

URL du serveur

chaîne

Vrai

Chaîne JSON contenant une URL vers le chemin de base du compartiment. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 1023

bucketName

chaîne

Vrai

Chaîne JSON contenant le nom du compartiment S3. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 63

gcp

Objet JSON fournissant les paramètres du protocole Google Cloud.

Nom Type Obligatoire Description

bucketName

chaîne

Vrai

Chaîne JSON contenant le nom du bucket Google Cloud sous-jacent. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 63

azure

Objet JSON fournissant les paramètres du protocole Azure.

Nom Type Obligatoire Description

storageAccount

chaîne

Vrai

Chaîne JSON contenant le nom du compte de stockage Azure. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 63

bucketName

chaîne

Vrai

Chaîne JSON contenant le nom du blob Azure sous-jacent. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 63

bucketParameters

Objet JSON contenant les informations spécifiques au fournisseur de compartiment nécessaires pour accéder au compartiment. Les valeurs spécifiques de ce compartiment varient selon le fournisseur.

Nom Type Obligatoire Description

s3

"s3"

Faux

Objet JSON fournissant les paramètres du protocole Simple Storage Service (S3). (Utilisez cet objet pour tous les fournisseurs de type S3).

gcp

"gcp"

Faux

Objet JSON fournissant les paramètres du protocole Google Cloud.

azure

"azure"

Faux

Objet JSON fournissant les paramètres du protocole Azure.

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

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