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 compte

PDF

GET /accounts/{account_id}

Renvoie la ressource API Account 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 collection de comptes à lister

  • exemple: {{.Account}}

Réponse

Status: 200, Returns the stored Account 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-account"

version

chaîne

Vrai

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

  • "1,0"

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 pour le compte. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

  • Cette chaîne de caractères est validée en interne afin de prévenir les attaques XSS, Unicode, de traversée de répertoires et d'injection SQL.

État

chaîne

Vrai

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

  • « pending » - Les modifications ne peuvent être apportées qu'aux ressources utilisateur et de rôle du compte (valeur par défaut)

  • « actif » : des modifications peuvent être apportées à n’importe quelle ressource du compte

  • "deletePending" - Les utilisateurs ne peuvent pas se connecter, les opérations de protection des données sont suspendues, les frais ne sont plus facturés

isEnabled

chaîne

Vrai

Chaîne JSON indiquant que le compte est activé. Les valeurs définies sont :

  • "false" - Les utilisateurs ne sont pas autorisés à utiliser ce compte

  • « true » - Les utilisateurs sont autorisés à utiliser ce compte

enabledTimestamp

chaîne

Faux

Chaîne JSON contenant l'horodatage indiquant quand le compte a été activé pour la dernière fois. Si le compte n'a jamais été activé, ce champ est absent. Les valeurs définies sont :

  • Conforme au schéma de date et d'heure ISO-8601

accountContact

"accountContact"

Faux

Objet JSON contenant les informations de contact de l'utilisateur permettant de créer un utilisateur propriétaire lors de l'activation du compte.

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-account",
  "version": "1.0",
  "id": "666a3f38-d4fa-5b62-a391-a69029758d32",
  "name": "fraught-pines",
  "state": "active",
  "isEnabled": "true",
  "enabledTimestamp": "2020-08-06T12:24:52.256624Z",
  "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

postalAddress

Objet JSON contenant une collection de chaînes JSON spécifiant une adresse. Si cette clé n'existe pas, cela indique qu'aucune adresse n'a été fournie. Si cette clé existe, les six chaînes JSON qu'elle contient seront présentes. Si vous ne fournissez rien, la chaîne sera vide.

Nom Type Obligatoire Description

addressCountry

chaîne

Vrai

Chaîne JSON contenant le nom ou le code pays associé à l'adresse postale, conformément à la norme ISO 3166 Alpha-2. Les valeurs définies sont :

  • Longueur minimale : 2

  • Longueur maximale : 2

addressLocality

chaîne

Vrai

Chaîne JSON contenant la localité (par exemple, la ville) associée à l'adresse postale. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

addressRegion

chaîne

Vrai

Chaîne JSON contenant la région (par exemple, l'État) associée à l'adresse postale. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

postalCode

chaîne

Vrai

Chaîne JSON contenant le code postal associé à l'adresse postale. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 31

streetAddress1

chaîne

Vrai

Chaîne JSON contenant l'adresse de rue associée à l'adresse postale. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

streetAddress2

chaîne

Faux

Chaîne JSON contenant des informations complémentaires facultatives telles que l'adresse de rue, la boîte postale, et plus encore. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

accountContact

Objet JSON contenant les informations de contact de l'utilisateur permettant de créer un utilisateur propriétaire lors de l'activation du compte.

Nom Type Obligatoire Description

firstName

chaîne

Vrai

Chaîne JSON contenant le prénom long spécifié par l'utilisateur. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

  • Cette chaîne de caractères est validée en interne afin de prévenir les attaques XSS, Unicode, de traversée de répertoires et d'injection SQL.

lastName

chaîne

Vrai

Chaîne JSON contenant un nom de famille long spécifié par l'utilisateur. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

  • Cette chaîne de caractères est validée en interne afin de prévenir les attaques XSS, Unicode, de traversée de répertoires et d'injection SQL.

companyName

chaîne

Faux

Chaîne JSON contenant le nom de l'entreprise associée à l'utilisateur. Si cette clé n'existe pas, cela indique qu'un nom d'entreprise n'a pas été fourni. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

  • Cette chaîne de caractères est validée en interne afin de prévenir les attaques XSS, Unicode, de traversée de répertoires et d'injection SQL.

e-mail

chaîne

Vrai

Chaînes JSON contenant une adresse e-mail spécifiée par l'utilisateur. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

téléphone

chaîne

Faux

Chaîne JSON contenant le numéro de téléphone de l'utilisateur. Si cette clé n'existe pas, cela indique qu'un numéro de téléphone n'a pas été fourni. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 31

postalAddress

"postalAddress"

Vrai

Objet JSON contenant une collection de chaînes JSON spécifiant une adresse. Si cette clé n'existe pas, cela indique qu'aucune adresse n'a été fournie. Si cette clé existe, les six chaînes JSON qu'elle contient seront présentes. Si vous ne fournissez rien, la chaîne sera vide.

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