Crea un nuovo account
POST /accounts
Indica i valori desiderati per la risorsa Account API da creare.
Corpo della richiesta
Indica i valori desiderati per la risorsa Account API da creare.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
Tipo di media della risorsa. I valori definiti sono:
|
versione |
stringa |
Vero |
Versione della risorsa. I valori definiti sono:
|
nome |
stringa |
Vero |
Stringa JSON contenente il nome dell'account. I valori definiti sono:
|
metadati |
Falso |
Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:
|
Esempio di richiesta
{
"type": "application/astra-account",
"version": "1.0",
"name": "Testing 123"
}
Risposta
Status: 201, Returns the newly created account resource in the JSON response body.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
Tipo di media della risorsa. I valori definiti sono:
|
versione |
stringa |
Vero |
Versione della risorsa. I valori definiti sono:
|
id |
stringa |
Vero |
Identificatore univoco globale della risorsa. I valori definiti sono:
|
nome |
stringa |
Vero |
Stringa JSON contenente il nome dell'account. I valori definiti sono:
|
stato |
stringa |
Vero |
Stringa JSON contenente un valore che indica lo stato operativo dell'account. I valori definiti sono:
|
isEnabled |
stringa |
Vero |
Stringa JSON che indica che l'account è abilitato. I valori definiti sono:
|
enabledTimestamp |
stringa |
Falso |
Stringa JSON contenente il timestamp che indica quando l'account è stato abilitato per l'ultima volta. Se l'account non è mai stato abilitato, questo campo è assente. I valori definiti sono:
|
accountContact |
Falso |
Oggetto JSON contenente le informazioni di contatto dell'utente per creare un utente proprietario al momento dell'attivazione dell'account. |
|
metadati |
Vero |
Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:
|
Risposta tipo
{
"type": "application/astra-account",
"version": "1.0",
"id": "666a3f38-d4fa-5b62-a391-a69029758d32",
"name": "fraught-pines",
"state": "pending",
"isEnabled": "false",
"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"
}
}
Risposta
Status: 401, Unauthorized
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Risposta
Status: 400, Bad request
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
|
invalidFields |
vettore["invalidFields"] |
Falso |
Elenco dei campi non validi del corpo della richiesta |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Risposta
Status: 409, Conflict
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
|
invalidFields |
vettore["invalidFields"] |
Falso |
Elenco dei campi non validi del corpo della richiesta |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/10",
"title": "JSON resource conflict",
"detail": "The request body JSON contains a field that conflicts with an idempotent value.",
"status": "409"
}
Risposta
Status: 403, Forbidden
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Errore
Status: 404, Not found
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Esempio di risposta di errore
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definizioni
Vedi definizioni
etichetta tipo_astra
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
nome |
stringa |
Vero |
|
valore |
stringa |
Vero |
aggiornamento dei metadati di tipo Astra
Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:
-
Conforme allo schema dei metadati di Astra. Se non specificato in fase di creazione, verrà creato un oggetto metadati senza etichette. Se non specificato in fase di aggiornamento, le etichette dell'oggetto metadati, creationTimestamp e createdBy, verranno conservate senza modifiche.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
etichette |
vettore["etichetta tipo_astra"] |
Falso |
|
CreationTimestamp |
stringa |
Falso |
|
ModificationTimestamp |
stringa |
Falso |
|
CreatedBy |
stringa |
Falso |
|
modifiedBy |
stringa |
Falso |
postalAddress
Oggetto JSON contenente una raccolta di stringhe JSON che specificano un indirizzo. Se questa chiave non esiste, indica che non è stato fornito alcun indirizzo. Se questa chiave esiste, saranno presenti tutte e sei le stringhe JSON contenute. Se non si fornisce nulla, la stringa sarà vuota.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
addressCountry |
stringa |
Vero |
Stringa JSON contenente il nome o il codice del paese associato all'indirizzo postale, come specificato nello standard ISO 3166 Alpha-2. I valori definiti sono:
|
addressLocality |
stringa |
Vero |
Stringa JSON contenente la località (ad esempio, la città) associata all'indirizzo postale. I valori definiti sono:
|
addressRegion |
stringa |
Vero |
Stringa JSON contenente la regione (ad esempio, stato) associata all'indirizzo postale. I valori definiti sono:
|
postalCode |
stringa |
Vero |
Stringa JSON contenente il codice postale associato all'indirizzo postale. I valori definiti sono:
|
streetAddress1 |
stringa |
Vero |
Stringa JSON contenente l'indirizzo stradale associato all'indirizzo postale. I valori definiti sono:
|
streetAddress2 |
stringa |
Falso |
Stringa JSON contenente informazioni aggiuntive facoltative sull'indirizzo stradale, casella postale e altro. I valori definiti sono:
|
accountContact
Oggetto JSON contenente le informazioni di contatto dell'utente per creare un utente proprietario al momento dell'attivazione dell'account.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
firstName |
stringa |
Vero |
Stringa JSON contenente un nome proprio lungo specificato dall'utente. I valori definiti sono:
|
lastName |
stringa |
Vero |
Stringa JSON contenente un cognome esteso specificato dall'utente. I valori definiti sono:
|
companyName |
stringa |
Falso |
Stringa JSON contenente il nome dell'azienda associata all'utente. Se questa chiave non esiste, significa che non è stato fornito un nome di azienda. I valori definiti sono:
|
stringa |
Vero |
Stringhe JSON contenenti un indirizzo email specificato dall'utente. I valori definiti sono:
|
|
telefono |
stringa |
Falso |
Stringa JSON contenente il numero di telefono dell'utente. Se questa chiave non esiste, significa che non è stato fornito un numero di telefono. I valori definiti sono:
|
postalAddress |
Vero |
Oggetto JSON contenente una raccolta di stringhe JSON che specificano un indirizzo. Se questa chiave non esiste, indica che non è stato fornito alcun indirizzo. Se questa chiave esiste, saranno presenti tutte e sei le stringhe JSON contenute. Se non si fornisce nulla, la stringa sarà vuota. |
invalidParams
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
nome |
stringa |
Vero |
Nome del parametro di query non valido |
motivo |
stringa |
Vero |
Motivo per cui il parametro di query non è valido |
invalidFields
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
nome |
stringa |
Vero |
Nome del campo del corpo della richiesta non valido |
motivo |
stringa |
Vero |
Motivo per cui il campo del corpo della richiesta non è valido |