Skip to main content
Eine neuere Version dieses Produkts ist erhältlich.
Die deutsche Sprachversion wurde als Serviceleistung für Sie durch maschinelle Übersetzung erstellt. Bei eventuellen Unstimmigkeiten hat die englische Sprachversion Vorrang.

Aufgabe abrufen

Änderungen vorschlagen
PDFs

GET /accounts/{account_id}/core/v1/tasks/{task_id}

Gibt die gespeicherte Task-API-Ressource im JSON-Antworttext zurück.

Parameter

Name Typ In Erforderlich Beschreibung

Konto-ID

Zeichenkette

Pfad

True

ID der übergeordneten Kontoressource

  • Beispiel: {{.Account}}

task_id

Zeichenkette

Pfad

True

ID der aufzulistenden Aufgabensammlung

Antwort

Status: 200, Returns the stored Task API resource in the JSON response body.
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Medientyp der Ressource. Folgende Werte sind definiert:

  • "application/astra-task"

Version

Zeichenkette

True

Version der Ressource. Folgende Werte sind definiert:

  • "1,0"

  • "1,1"

id

Zeichenkette

True

Weltweit eindeutiger Bezeichner der Ressource. Folgende Werte sind definiert:

  • Entspricht dem UUIDv4-Schema

Name

Zeichenkette

True

JSON-Zeichenkette mit einem durch Punktnotation (.) dargestellten hierarchischen Namen für die Aufgabe. Folgende Werte sind definiert:

  • Mindestlänge: 3

  • Maximale Länge: 127

  • Definierter regulärer Ausdruck ist: „^[a-z])(\.([a-z])+$“

Zusammenfassung

Zeichenkette

True

JSON-Zeichenkette mit der Kurzfassung der Aufgabe. Folgende Werte sind definiert:

  • Mindestlänge: 3

  • Maximale Länge: 63

description

Zeichenkette

True

JSON-Zeichenkette mit einer Beschreibung der Aufgabe. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 511

Service

Zeichenkette

Falsch

JSON-Zeichenfolge mit dem Namen des Dienstes, der die Aufgabe verwaltet. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 31

übergeordneteAufgaben-ID

Zeichenkette

Falsch

JSON-Zeichenkette mit einer global eindeutigen Kennung einer übergeordneten Aufgabe der Aufgabe. Folgende Werte sind definiert:

  • Entspricht dem Astra-Identifikatorschema

Benutzer-ID

Zeichenkette

Falsch

JSON-Zeichenkette mit der Benutzer-ID, die einer Aufgabe zugeordnet ist. Nur für Aufgaben enthalten, die mit benutzerinitiierten Aktionen verknüpft sind. Folgende Werte sind definiert:

  • Entspricht dem Astra-Identifikatorschema

Ressourcen-ID

Zeichenkette

True

JSON-Zeichenkette mit einer global eindeutigen Kennung der Ressource, die der Aufgabe zugeordnet ist. Folgende Werte sind definiert:

  • Entspricht dem Astra-Identifikatorschema

resourceURI

Zeichenkette

True

JSON-Zeichenkette mit der URI des Tasks. Folgende Werte sind definiert:

  • Mindestlänge: 3

  • Maximale Länge: 4095

resourceCollectionURI

Array[string]

True

JSON-Array von JSON-Zeichenketten, die jeweils die vollständig expandierte Zugriffs-URL der mit der Aufgabe verknüpften Ressource angeben. Folgende Werte sind definiert:

  • Mindestlänge: 3

  • Maximale Länge: 4095

Zustand

Zeichenkette

True

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

  • "notStarted" - Die Ausführung des Tasks wurde noch nicht gestartet.

  • "running" - Der Task wird ausgeführt.

  • „completed“ – Die Aufgabe ist abgeschlossen.

  • "pausing" - Die Aufgabe wurde angehalten.

  • "pausiert" - Die Aufgabe ist pausiert.

  • "Abbrechen" - Die Aufgabe wurde zum Abbrechen angefordert.

  • "abgebrochen" - Die Aufgabe wurde abgebrochen.

  • "fehlgeschlagen" - Die Aufgabe ist fehlgeschlagen.

  • Mindestlänge: 1

  • Maximale Länge: 31

stateTransitions

Array["type_astra_stateTransition"]

True

JSON-Array von JSON-Objekten, die jeweils die Menge der zulässigen Zustandsübergänge von einem definierten Zustand aus darstellen. Jedes JSON-Objekt enthält die Felder "from" und "to", wobei der Wert von "from" der Name eines Zustands ist und der Wert von "to" ein Array zulässiger Zielzustände ist.

  • Mindestlänge: 1

  • Maximale Länge: 31 Zum Beispiel: "stateTransitions" : [ { "from": "running", "to": ["paused", "cancelled"] }, { "from": "paused", "to": ["running", "cancelled"] }, ]

stateDetails

Array["type_astra_stateDetail"]

True

Ein JSON-Array mit JSON-Objekten, das zusätzliche Details zum aktuellen "state" enthält. Dieses Feld zeigt an, wenn Bedingungen oder Fehler vorliegen, die verhindern, dass der tatsächliche Zustand dem gewünschten Zustand entspricht. Sind keine Details verfügbar, ist dieses Array leer.

  • Mindestanzahl: 0

orderHint

Nummer

Falsch

JSON-Zahl, die die Reihenfolge der Teilaufgaben repräsentiert. Dieses Feld kann vom Client verwendet werden, um die Teilaufgaben von der kleinsten zur größten zu sortieren.

percentDone

Nummer

Falsch

Eine JSON-Zahl, die den prozentualen Fortschritt einer laufenden Aufgabe enthält. Wenn die Aufgabe abgeschlossen ist, wird dieser Wert auf "100" gesetzt.

startTime

Zeichenkette

Falsch

JSON-Zeichenkette mit dem Zeitstempel, der den Startzeitpunkt der Aufgabe angibt. Folgende Werte sind definiert:

  • Entspricht dem ISO-8601 Datums- und Zeitschema

endTime

Zeichenkette

Falsch

JSON-Zeichenkette mit dem Zeitstempel, der das Ende der Aufgabe angibt. Folgende Werte sind definiert:

  • Entspricht dem ISO-8601 Datums- und Zeitschema

cancelTime

Zeichenkette

Falsch

JSON-Zeichenkette mit dem Zeitstempel, der angibt, wann die Aufgabe abgebrochen wurde. Folgende Werte sind definiert:

  • Entspricht dem ISO-8601 Datums- und Zeitschema

Metadaten

"type_astra_metadata"

True

Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Folgende Werte sind definiert:

  • Entspricht dem Astra Metadatenschema
Beispielantwort 
{
  "type": "application/astra-task",
  "version": "1.1",
  "id": "26e8e8ef-5549-5928-98dd-2c3d43a608e8",
  "name": "astra.backup.prep",
  "summary": "Backup preparation",
  "description": "Task to prepare for the application backup",
  "service": "nautilus",
  "userID": "abda967f-cd2c-4237-908e-99266648c553",
  "parentTaskID": "9cc8c321-6af1-406c-8158-2c6582c247f8",
  "resourceID": "626a0978-d55f-4841-8b7c-dc0c0f592c6f",
  "resourceURI": "/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/k8s/v1/apps/7c8bef49-697e-4fb4-810c-675cef4cf6c9/appSnaps/2b6dafc3-2172-4431-a482-6306b2703130",
  "resourceCollectionURI": [
    "/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/topology/v1/clouds/0df3f1a0-7203-4c12-aabf-a7bee6302671/clusters/dfd9de2d-6f0b-437b-a737-c8f7f176cd14/namespaces/f8b58091-4b9c-4c64-9b40-018dbaf7c5de/apps/f670bf11-8850-44bd-b330-815af6186a06/appSnaps/2b6dafc3-2172-4431-a482-6306b2703130",
    "/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/topology/v1/clouds/0df3f1a0-7203-4c12-aabf-a7bee6302671/clusters/dfd9de2d-6f0b-437b-a737-c8f7f176cd14/namespaces/923708f8-0435-45b5-8c00-fbdef3ffaf25/apps/f670bf11-8850-44bd-b330-815af6186a06/appSnaps/2b6dafc3-2172-4431-a482-6306b2703130"
  ],
  "state": "running",
  "stateTransitions": [
    {
      "from": "running",
      "to": [
        "paused",
        "cancelled"
      ]
    },
    {
      "from": "paused",
      "to": [
        "running",
        "cancelled"
      ]
    }
  ],
  "stateDetails": [],
  "orderHint": 0,
  "percentDone": 20.25,
  "startTime": "2020-08-06T12:24:52.256624Z",
  "endTime": "2020-08-06T12:26: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

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

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/1",
  "title": "Resource not found",
  "detail": "The resource specified in the request URI wasn't found.",
  "status": "404"
}

Definitionen

Siehe Definitionen

type_astra_stateTransition

Name Typ Erforderlich Beschreibung

aus

Zeichenkette

True

:

Array[string]

True

additionalDetails

type_astra_stateDetail

Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

additionalDetails

"additionalDetails"

Falsch

Typ_Astra_Label

Name Typ Erforderlich Beschreibung

Name

Zeichenkette

True

Wert

Zeichenkette

True

type_astra_metadata

Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Folgende Werte sind definiert:

  • Entspricht dem Astra Metadatenschema

Name Typ Erforderlich Beschreibung

Etiketten

Array["Typ_Astra_Label"]

True

CreationZeitstempel

Zeichenkette

True

Änderungszeitstempel

Zeichenkette

True

Erstellt von

Zeichenkette

True

modifiedBy

Zeichenkette

Falsch

invalidParams

Name Typ Erforderlich Beschreibung

Name

Zeichenkette

True

Name des ungültigen Abfrageparameters

Grund

Zeichenkette

True

Grund, warum der Abfrageparameter ungültig ist