Alle ASUP-Ressourcen auflisten
GET /accounts/{account_id}/core/v1/asups
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 |
|---|---|---|---|---|
Konto-ID |
Zeichenkette |
Pfad |
Wahr |
ID der übergeordneten Kontoressource
|
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" |
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: "asup_1.0_get_response_body", array[]] |
Wahr |
|
Metadaten |
Wahr |
Beispielantwort
{
"type": "application/astra-asups",
"version": "1.0",
"items": [
{
"type": "application/astra-asup",
"version": "1.0",
"id": "80796606-79ba-480b-966c-e4c600fbf623",
"creationState": "completed",
"creationStateDetails": [],
"upload": "true",
"uploadState": "running",
"uploadStateDetails": [],
"triggerType": "manual",
"dataWindowStart": "2020-08-05T12:24:00.000000Z",
"dataWindowEnd": "2020-08-06T12:24:52.000000Z",
"metadata": {
"labels": [],
"creationTimestamp": "2020-08-06T12:24:52.256624Z",
"modificationTimestamp": "2020-08-06T12:24:52.256624Z",
"createdBy": "1b32a508-cc6f-4f1b-809f-c42fd91b4848"
}
},
{
"type": "application/astra-asup",
"version": "1.0",
"id": "6503131d-8b36-4434-b34f-73661ae8100b",
"creationState": "completed",
"creationStateDetails": [],
"upload": "true",
"uploadState": "completed",
"uploadStateDetails": [],
"triggerType": "scheduled",
"dataWindowStart": "2020-08-04T13:30:00.000000Z",
"dataWindowEnd": "2020-08-05T13:30:00.000000Z",
"metadata": {
"labels": [],
"creationTimestamp": "2020-08-05T13:30:00.012321Z",
"modificationTimestamp": "2020-08-05T13:30:00.012321Z",
"createdBy": "1b32a508-cc6f-4f1b-809f-c42fd91b4848"
}
}
],
"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
additionalDetails
type_astra_stateDetail
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
additionalDetails |
Falsch |
Typ_Astra_Label
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
Wahr |
|
Wert |
Zeichenkette |
Wahr |
type_astra_metadata
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
-
Entspricht dem Astra-Metadatenschema. Falls beim Erstellen keine Bezeichnung angegeben wird, wird ein Metadatenobjekt ohne Bezeichnungen erstellt.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Etiketten |
Array["Typ_Astra_Label"] |
Wahr |
|
CreationZeitstempel |
Zeichenkette |
Wahr |
|
Änderungszeitstempel |
Zeichenkette |
Wahr |
|
Erstellt von |
Zeichenkette |
Wahr |
|
modifiedBy |
Zeichenkette |
Falsch |
asup_1.0_get_response_body
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
Medientyp der Ressource. Definierte Werte sind:
|
Version |
Zeichenkette |
Wahr |
Version der Ressource. Definierte Werte sind:
|
id |
Zeichenkette |
Wahr |
Weltweit eindeutiger Bezeichner der Ressource. Definierte Werte sind:
|
creationState |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem Wert, der den Erstellungsstatus des AutoSupport Bundles angibt. Für die Status „abgeschlossen“ und „teilweise“ kann das Bundle durch einen GET der Ressourcen-URI mit einem Accept-Header heruntergeladen werden, der „/“ oder „application/gzip“ enthält. Definierte Werte sind:
|
creationStateDetails |
Array["type_astra_stateDetail"] |
Wahr |
JSON-Array von JSON-Objekten, das zusätzliche Details darüber auflistet, warum "creationState" in "partial" oder "failed" übergegangen ist. Falls keine Details verfügbar sind, ist dieses Array leer.
|
hochladen |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem Wert, der angibt, ob das AutoSupport-Bundle nach erfolgreicher Erstellung hochgeladen werden soll. Definierte Werte sind:
|
uploadState |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Wert, der den Status des AutoSupport Bundle-Uploads angibt, falls dieser angefordert wurde. Definierte Werte sind:
|
uploadStateDetails |
Array["type_astra_stateDetail"] |
Falsch |
JSON-Array von JSON-Objekten, das zusätzliche Details darüber auflistet, warum „uploadState“ in „failed“ übergegangen ist. Falls keine Details verfügbar sind, ist dieses Array leer.
|
triggerType |
Zeichenkette |
Wahr |
JSON-Zeichenfolge mit einem Wert, der angibt, was die Erstellung der ASUP-Ressource ausgelöst hat. Definierte Werte sind:
|
dataWindowStart |
Zeichenkette |
Wahr |
JSON-Zeichenfolge mit einem Zeitstempel, der den Startzeitpunkt des AutoSupport-Bundle-Datenerfassungsfensters angibt. Standardmäßig 24 Stunden vor dem "dataWindowEnd"-Schlüsselwert. Muss vor dem "dataWindowEnd"-Schlüsselwert liegen. Maximal 7 Tage vor dem aktuellen Zeitpunkt der Anfrage. Definierte Werte sind:
|
dataWindowEnd |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem Zeitstempel, der das Ende des AutoSupport-Bundle-Datenerfassungsfensters angibt. Standardmäßig wird die aktuelle Zeit der Anfrage verwendet. Definierte Werte sind:
|
Metadaten |
Wahr |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
|
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 |