Skip to main content
Die deutsche Sprachversion wurde als Serviceleistung für Sie durch maschinelle Übersetzung erstellt. Bei eventuellen Unstimmigkeiten hat die englische Sprachversion Vorrang.

Alle Konten auflisten

Änderungen vorschlagen
PDFs

GET /accounts

Gibt ein JSON-Array aller übereinstimmenden Ressourcen in der Sammlung zurück. Wenn in der Anfrage einzelne Felder angegeben werden, enthält das JSON-Array der Elemente die angeforderten Felder für jede übereinstimmende Ressource in der angegebenen Reihenfolge.

Parameter

Name Typ In Erforderlich Beschreibung

Einschließlich

Zeichenkette

Abfrage

Falsch

Gibt an, welche Felder beim Auflisten einer Sammlung zurückgegeben werden sollen.

URL-Beispiele: "include=id", "include=id,name"

OpenAPI-Beispiele: "id"

Grenze

Zeichenkette

Abfrage

Falsch

Gibt die maximale Anzahl der Ressourcen an, die beim Auflisten einer Sammlung zurückgegeben werden sollen.

URL-Beispiele: "limit=2"

OpenAPI-Beispiele: "2"

Filtern

Zeichenkette

Abfrage

Falsch

Gibt an, welche Felder übereinstimmen müssen, um beim Auflisten einer Sammlung eine Ressource zurückzugeben.

Unterstützte Operatoren sind:

  • eq – Gleichheit

  • lt/gt – Kleiner als/Größer als

  • lte/gte – Kleiner oder gleich/Größer oder gleich

URL-Beispiel: "filter=field%20eq%20%27value%27"

OpenAPI-Beispiele: "field eq 'value'"

Orderby

Zeichenkette

Abfrage

Falsch

Gibt die Sortierreihenfolge der Ressourcen beim Auflisten einer Sammlung an.

URL-Beispiele: "orderBy=name", "orderBy=name%20desc"

OpenAPI-Beispiele: "name desc"

überspringen

Zeichenkette

Abfrage

Falsch

Gibt die Anzahl der Ressourcen an, die beim Auflisten einer Sammlung übersprungen werden sollen.

URL-Beispiele: "skip=1"

OpenAPI-Beispiele: "1"

Zählen

Zeichenkette

Abfrage

Falsch

Gibt an, ob die Gesamtzahl der Ressourcen im Metadatenobjekt zurückgegeben werden soll.

URL-Beispiele: "count=true"

OpenAPI-Beispiele: "true"

fortfahren

Abfrage

Falsch

Gibt das Token an, von dem aus die Auflistung fortgesetzt werden soll.

URL-Beispiele: "continue="

OpenAPI-Beispiele: ""</continue>

Antwort

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.
Name Typ Erforderlich Beschreibung

Elemente

array[Beliebig aus: "account_1.0_get_response_body", array[]]

Wahr

Metadaten

"type_astra_metadata_list"

Wahr
Beispielantwort 
{
  "type": "application/astra-accounts",
  "version": "1.0",
  "items": [
    {
      "type": "application/astra-account",
      "version": "1.0",
      "id": "70796606-79ba-480b-966c-e4c600fbf622",
      "name": "fraught-pines",
      "state": "active",
      "isEnabled": "true",
      "enabledTimestamp": "2020-08-06T12:24:52.256624Z",
      "metadata": {
        "labels": [],
        "creationTimestamp": "2020-08-06T12:24:52.256624Z",
        "modificationTimestamp": "2020-08-06T12:24:52.256624Z",
        "createdBy": "1723a17e-9fd1-4636-86e1-2ec9e04bce51"
      }
    },
    {
      "type": "application/astra-account",
      "version": "1.0",
      "id": "7976114d-35ec-48a7-ba31-22d8e94a8bb2",
      "name": "sad-dino",
      "state": "active",
      "isEnabled": "true",
      "enabledTimestamp": "2020-08-06T12:24:52.256624Z",
      "metadata": {
        "labels": [],
        "creationTimestamp": "2020-08-06T12:24:52.256624Z",
        "modificationTimestamp": "2020-08-06T12:24:52.256624Z",
        "createdBy": "1723a17e-9fd1-4636-86e1-2ec9e04bce51"
      }
    }
  ],
  "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

Wahr

Titel

Zeichenkette

Wahr

Detail

Zeichenkette

Wahr

Status

Zeichenkette

Wahr

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

Wahr

Titel

Zeichenkette

Wahr

Detail

Zeichenkette

Wahr

Status

Zeichenkette

Wahr

Korrelations-ID

Zeichenkette

Falsch

invalidParams

Array["invalidParams"]

Falsch

Liste ungültiger Abfrageparameter
Beispielantwort 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Antwort

Status: 403, Forbidden
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

Wahr

Titel

Zeichenkette

Wahr

Detail

Zeichenkette

Wahr

Status

Zeichenkette

Wahr

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

Wahr

Titel

Zeichenkette

Wahr

Detail

Zeichenkette

Wahr

Status

Zeichenkette

Wahr

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

postalAddress

JSON-Objekt mit einer Sammlung von JSON-Zeichenketten, 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

Wahr

JSON-Zeichenkette mit dem Ländernamen oder Ländercode, der der Postanschrift gemäß ISO 3166 Alpha-2 zugeordnet ist. Definierte Werte sind:

  • Mindestlänge: 2

  • Maximale Länge: 2

addressLocality

Zeichenkette

Wahr

JSON-Zeichenkette mit dem Ort (z. B. Stadt) zur Postanschrift. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 63

addressRegion

Zeichenkette

Wahr

JSON-Zeichenkette mit der Region (z. B. Bundesland), die der Postanschrift zugeordnet ist. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 63

postalCode

Zeichenkette

Wahr

JSON-Zeichenkette mit der Postleitzahl, die der Postanschrift zugeordnet ist. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 31

streetAddress1

Zeichenkette

Wahr

JSON-Zeichenkette mit der Straßenadresse, die der Postanschrift zugeordnet ist. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 63

streetAddress2

Zeichenkette

Falsch

JSON-Zeichenkette mit optionalen zusätzlichen Adressinformationen, Postfach und mehr. Definierte Werte sind:

  • Mindestlänge: 1

  • Maximale Länge: 63

accountContact

JSON-Objekt mit Benutzerkontaktinformationen zur Erstellung eines Inhaberbenutzers bei der Kontoaktivierung.

Name Typ Erforderlich Beschreibung

firstName

Zeichenkette

Wahr

JSON-Zeichenkette mit dem vom Benutzer angegebenen Vornamen in Langform. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 63

  • Diese Zeichenkette wird intern validiert, um XSS-, Unicode-, Directory-Traversal- und SQL-Injection-Angriffe zu verhindern.

lastName

Zeichenkette

Wahr

JSON-Zeichenkette mit einem vom Benutzer angegebenen, ausgeschriebenen Nachnamen. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 63

  • Diese Zeichenkette wird intern validiert, um XSS-, Unicode-, Directory-Traversal- und SQL-Injection-Angriffe zu verhindern.

companyName

Zeichenkette

Falsch

JSON-Zeichenkette mit dem dem Benutzer zugeordneten Firmennamen. Existiert dieser Schlüssel nicht, wurde kein Firmenname angegeben. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 63

  • Diese Zeichenkette wird intern validiert, um XSS-, Unicode-, Directory-Traversal- und SQL-Injection-Angriffe zu verhindern.

E-Mail

Zeichenkette

Wahr

JSON-Zeichenketten, die eine vom Benutzer angegebene E-Mail-Adresse enthalten. Definierte Werte sind:

  • Mindestlänge: 1

  • Maximale Länge: 63

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:

  • Mindestlänge: 1

  • Maximale Länge: 31

postalAddress

"postalAddress"

Wahr

JSON-Objekt mit einer Sammlung von JSON-Zeichenketten, 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.

Typ_Astra_Label

Name Typ Erforderlich Beschreibung

Name

Zeichenkette

Wahr

Wert

Zeichenkette

Wahr

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

account_1.0_get_response_body

Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

Wahr

Medientyp der Ressource. Definierte Werte sind:

  • "application/astra-account"

Version

Zeichenkette

Wahr

Version der Ressource. Definierte Werte sind:

  • "1,0"

id

Zeichenkette

Wahr

Weltweit eindeutiger Bezeichner der Ressource. Definierte Werte sind:

  • Entspricht dem UUIDv4-Schema

Name

Zeichenkette

Wahr

JSON-Zeichenkette mit einem Namen für das Konto. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 63

  • Diese Zeichenkette wird intern validiert, um XSS-, Unicode-, Directory-Traversal- und SQL-Injection-Angriffe zu verhindern.

Zustand

Zeichenkette

Wahr

JSON-Zeichenkette mit einem Wert, der den Betriebsstatus des Kontos angibt. Folgende Werte sind definiert:

  • "ausstehend" - Änderungen können nur an Benutzer- und Rollenressourcen unter dem Konto vorgenommen werden (Standardwert)

  • „aktiv“ – Änderungen können an allen Ressourcen unter dem Konto vorgenommen werden

  • "deletePending" - Benutzer können sich nicht anmelden, Datenschutzmaßnahmen werden ausgesetzt, Gebühren fallen nicht mehr an

isEnabled

Zeichenkette

Wahr

JSON-Zeichenkette, die angibt, dass das Konto aktiviert ist. Definierte Werte sind:

  • "falsch" - Benutzern ist die Nutzung dieses Kontos nicht gestattet

  • "true" - Benutzer dürfen dieses Konto verwenden

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:

  • Entspricht dem ISO-8601 Datums- und Zeitschema

accountContact

"accountContact"

Falsch

JSON-Objekt mit Benutzerkontaktinformationen zur Erstellung eines Inhaberbenutzers bei der Kontoaktivierung.

Metadaten

"type_astra_metadata_update"

Wahr

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.

type_astra_metadata_list

Name Typ Erforderlich Beschreibung

fortfahren

Zeichenkette

Falsch

Zählen

Nummer

Falsch

Etiketten

Array["Typ_Astra_Label"]

Falsch

CreationZeitstempel

Zeichenkette

Falsch

Änderungszeitstempel

Zeichenkette

Falsch

Erstellt von

Zeichenkette

Falsch

modifiedBy

Zeichenkette

Falsch

invalidParams

Name Typ Erforderlich Beschreibung

Name

Zeichenkette

Wahr

Name des ungültigen Abfrageparameters

Grund

Zeichenkette

Wahr

Grund, warum der Abfrageparameter ungültig ist