Neues Konto erstellen
Erstellt ein neues Konto und gibt die gewünschten Werte für die Account API Ressource an. Dies dient zum Einrichten und Konfigurieren von Kontodetails für den Zugriff auf die Services.
HTTP-Methode und Endpunkt
POST /accounts
Nutzungshinweise
Gibt die gewünschten Werte für die zu erstellende Account-API-Ressource an.
Anfragetext
Gibt die gewünschten Werte für die zu erstellende Account-API-Ressource an.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
Medientyp der Ressource. Definierte Werte sind:
|
Version |
Zeichenkette |
True |
Version der Ressource. Definierte Werte sind:
|
Name |
Zeichenkette |
True |
JSON-Zeichenkette mit einem Namen für das Konto. Folgende Werte sind definiert:
|
Metadaten |
Falsch |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
|
Beispielanfrage
{
"type": "application/astra-account",
"version": "1.0",
"name": "Testing 123"
}
Antwort
Status: 201, Returns the newly created account resource in the JSON response body.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
Medientyp der Ressource. Definierte Werte sind:
|
Version |
Zeichenkette |
True |
Version der Ressource. Definierte Werte sind:
|
id |
Zeichenkette |
True |
Weltweit eindeutiger Bezeichner der Ressource. Definierte Werte sind:
|
Name |
Zeichenkette |
True |
JSON-Zeichenkette mit einem Namen für das Konto. Folgende Werte sind definiert:
|
Zustand |
Zeichenkette |
True |
JSON-Zeichenkette mit einem Wert, der den Betriebsstatus des Kontos angibt. Folgende Werte sind definiert:
|
isEnabled |
Zeichenkette |
True |
JSON-Zeichenkette, die angibt, dass das Konto aktiviert ist. Definierte Werte sind:
|
enabledTimestamp |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit dem Zeitstempel, der angibt, wann das Konto zuletzt aktiviert wurde. Wenn das Konto noch nie aktiviert wurde, ist dieses Feld nicht vorhanden. Definierte Werte sind:
|
accountContact |
Falsch |
JSON-Objekt mit Benutzerkontaktinformationen zur Erstellung eines Inhaberbenutzers bei der Kontoaktivierung. |
|
Metadaten |
True |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
|
Beispielantwort
{
"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"
}
}
Antwort
Status: 401, Unauthorized
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
|
Status |
Zeichenkette |
True |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Antwort
Status: 400, Bad request
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
|
Status |
Zeichenkette |
True |
|
Korrelations-ID |
Zeichenkette |
Falsch |
|
invalidFields |
Array["invalidFields"] |
Falsch |
Liste ungültiger Anfragetextfelder |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Antwort
Status: 409, Conflict
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
|
Status |
Zeichenkette |
True |
|
Korrelations-ID |
Zeichenkette |
Falsch |
|
invalidFields |
Array["invalidFields"] |
Falsch |
Liste ungültiger Anfragetextfelder |
Beispielantwort
{
"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"
}
Antwort
Status: 403, Forbidden
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
|
Status |
Zeichenkette |
True |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Fehler
Status: 404, Not found
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
|
Status |
Zeichenkette |
True |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispiel-Fehlermeldung
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definitionen
Siehe Definitionen
Typ_Astra_Label
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
True |
|
Wert |
Zeichenkette |
True |
type_astra_metadata_update
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
-
Entspricht dem Astra-Metadatenschema. Wird beim Erstellen kein Label angegeben, wird ein Metadatenobjekt ohne Labels erstellt. Wird beim Aktualisieren kein Label angegeben, bleiben die Labels, creationTimestamp und createdBy, des Metadatenobjekts unverändert erhalten.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Etiketten |
Array["Typ_Astra_Label"] |
Falsch |
|
CreationZeitstempel |
Zeichenkette |
Falsch |
|
Änderungszeitstempel |
Zeichenkette |
Falsch |
|
Erstellt von |
Zeichenkette |
Falsch |
|
modifiedBy |
Zeichenkette |
Falsch |
postalAddress
JSON-Objekt, das eine Sammlung von JSON-Zeichenketten enthält, die eine Adresse angeben. Wenn dieser Schlüssel nicht existiert, bedeutet dies, dass keine Adresse angegeben wurde. Wenn dieser Schlüssel existiert, sind alle sechs enthaltenen JSON-Zeichenketten vorhanden. Wenn Sie nichts angeben, ist die Zeichenkette leer.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
addressCountry |
Zeichenkette |
True |
JSON-Zeichenkette mit dem Ländernamen oder Ländercode, der der Postanschrift gemäß ISO 3166 Alpha-2 zugeordnet ist. Definierte Werte sind:
|
addressLocality |
Zeichenkette |
True |
JSON-Zeichenkette mit dem Ort (z. B. Stadt) zur Postanschrift. Folgende Werte sind definiert:
|
addressRegion |
Zeichenkette |
True |
JSON-Zeichenkette mit der Region (z. B. Bundesland), die der Postanschrift zugeordnet ist. Folgende Werte sind definiert:
|
postalCode |
Zeichenkette |
True |
JSON-Zeichenkette mit der Postleitzahl, die der Postanschrift zugeordnet ist. Definierte Werte sind:
|
streetAddress1 |
Zeichenkette |
True |
JSON-Zeichenkette mit der Straßenadresse, die der Postanschrift zugeordnet ist. Folgende Werte sind definiert:
|
streetAddress2 |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit optionalen zusätzlichen Adressinformationen, Postfach und mehr. Definierte Werte sind:
|
accountContact
JSON-Objekt mit Benutzerkontaktinformationen zur Erstellung eines Inhaberbenutzers bei der Kontoaktivierung.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
firstName |
Zeichenkette |
True |
JSON-Zeichenkette mit dem vom Benutzer angegebenen Vornamen in Langform. Folgende Werte sind definiert:
|
lastName |
Zeichenkette |
True |
JSON-Zeichenkette mit einem vom Benutzer angegebenen, ausgeschriebenen Nachnamen. Folgende Werte sind definiert:
|
companyName |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit dem dem Benutzer zugeordneten Firmennamen. Existiert dieser Schlüssel nicht, wurde kein Firmenname angegeben. Folgende Werte sind definiert:
|
Zeichenkette |
True |
JSON-Zeichenketten, die eine vom Benutzer angegebene E-Mail-Adresse enthalten. Definierte Werte sind:
|
|
Telefon |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit der Telefonnummer des Benutzers. Existiert dieser Schlüssel nicht, bedeutet dies, dass keine Telefonnummer angegeben wurde. Definierte Werte sind:
|
postalAddress |
True |
JSON-Objekt, das eine Sammlung von JSON-Zeichenketten enthält, die eine Adresse angeben. Wenn dieser Schlüssel nicht existiert, bedeutet dies, dass keine Adresse angegeben wurde. Wenn dieser Schlüssel existiert, sind alle sechs enthaltenen JSON-Zeichenketten vorhanden. Wenn Sie nichts angeben, ist die Zeichenkette leer. |
invalidParams
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
True |
Name des ungültigen Abfrageparameters |
Grund |
Zeichenkette |
True |
Grund, warum der Abfrageparameter ungültig ist |
invalidFields
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
True |
Name des ungültigen Anfragetextfelds |
Grund |
Zeichenkette |
True |
Grund, warum das Anfragekörperfeld ungültig ist |