Alle Pakete auflisten
GET /accounts/{account_id}/core/v1/packages
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 die angeforderten Felder für jede übereinstimmende Ressource in der angegebenen Reihenfolge.
Parameter
| Name | Typ | In | Erforderlich | Beschreibung |
|---|---|---|---|---|
Konto-ID |
Zeichenkette |
Pfad |
True |
ID der übergeordneten Kontoressource
|
Filtern |
Zeichenkette |
Abfrage |
Falsch |
Gibt an, welche Felder übereinstimmen müssen, um beim Auflisten einer Sammlung eine Ressource zurückzugeben. Unterstützte Operatoren sind:
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" |
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: "package_1.0_get_response_body", array[]] |
True |
|
Metadaten |
True |
Beispielantwort
{
"type": "application/astra-packages",
"version": "1.0",
"items": [
[
"e280ff62-be35-4f31-a31b-a210a1ad1b33",
"acc",
"22.01.0",
"install"
],
[
"e8507dad-d33f-44b3-9c15-ec55ba6f6473",
"acc",
"22.01.1",
"patch"
]
],
"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/2",
"title": "Collection not found",
"detail": "The collection 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 |
type_astra_stateDetail
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
dependsOnImages
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
imagePath |
Zeichenkette |
True |
JSON-String mit dem Pfad zu diesem Docker-Image. Er darf nicht den Namen der Registry enthalten, sondern nur den absoluten Pfad vom Stammverzeichnis zum Image. Beispiel: /globalcicd/acc Definierte Werte sind:
|
imageName |
Zeichenkette |
True |
JSON-Zeichenkette mit dem Namen des Docker-Images. Folgende Werte sind definiert:
|
imageTag |
Zeichenkette |
True |
JSON-Zeichenkette, die das Tag/die Version dieses Bildes darstellt. Folgende Werte sind definiert:
|
Bilder
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
imageName |
Zeichenkette |
True |
JSON-Zeichenkette mit dem Namen des Docker-Images. Folgende Werte sind definiert:
|
imagePath |
Zeichenkette |
True |
JSON-String mit dem Pfad zu diesem Docker-Image. Er darf nicht den Namen der Registry enthalten, sondern nur den absoluten Pfad vom Stammverzeichnis zum Image. Beispiel: /globalcicd/acc Definierte Werte sind:
|
imageTag |
Zeichenkette |
True |
JSON-Zeichenkette, die das Tag/die Version dieses Bildes darstellt. Folgende Werte sind definiert:
|
imageDigest |
Zeichenkette |
True |
JSON-Zeichenkette, die den Digest dieses Bildes darstellt. Folgende Werte sind definiert:
|
dependsOnImages |
Array["dependsOnImages"] |
Falsch |
JSON-Array von JSON-Objekten, die die zum Installieren oder Aktualisieren des aktuellen Images erforderlichen Images beschreiben. |
dependsOnComponents
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
componentName |
Zeichenkette |
True |
JSON-Zeichenkette, die den Namen der Komponente beschreibt. Folgende Werte sind definiert:
|
Versionen |
Array[string] |
True |
JSON-Array von JSON-Zeichenketten, die die für die Installation des aktuellen Images erforderliche Komponentenversion definieren. |
Artefakte
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
artifactName |
Zeichenkette |
True |
JSON-Zeichenkette mit dem Dateinamen. Folgende Werte sind definiert:
|
artifactIdentifier |
Zeichenkette |
True |
JSON-Zeichenkette mit einer Kennung für diese Datei. Zwischen verschiedenen Versionen desselben Pakettyps kann sich der Dateiname ändern, die Kennung bleibt jedoch in der Regel gleich. Folgende Werte sind definiert:
|
artifactPath |
Zeichenkette |
True |
JSON-Zeichenfolge mit dem Pfad zu diesem Artefakt vom Stammverzeichnis eines bekannten Astra Control Center Data Store/Standorts. Beispiel: /vmware/1.0/ Definierte Werte sind:
|
artifactVersion |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit der Versionsnummer des Artefakts, sofern angegeben. Folgende Werte sind definiert:
|
dependsOnComponents |
Array["dependsOnComponents"] |
Falsch |
JSON-Array von JSON-Objekten, die die installierten Komponenten beschreiben, die zum Installieren/Aktualisieren des aktuellen Images erforderlich sind. |
Dateien
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
fileName |
Zeichenkette |
True |
JSON-Zeichenkette mit dem Dateinamen. Folgende Werte sind definiert:
|
fileIdentifier |
Zeichenkette |
True |
JSON-Zeichenkette mit der Kennung dieser Datei. Zwischen verschiedenen Versionen desselben Pakettyps kann sich der Dateiname ändern, die Kennung bleibt jedoch in der Regel gleich. Folgende Werte sind definiert:
|
fileMediaType |
Zeichenkette |
True |
JSON-Zeichenkette mit dem Dateimedientyp. Definierte Werte sind alle Medientypen, die durch "IANA" definiert sind. Zusätzlich werden application/x-yaml oder application/x-yaml für YAML-Dateien unterstützt.
|
fileContents |
Zeichenkette |
True |
JSON-Zeichenkette mit dem Dateiinhalt. Folgende Werte sind definiert:
|
upgradableVersions
JSON-Objekt, das die minimale und maximale Version enthält, auf die auf die Paketversion aktualisiert werden kann.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
minVersion |
Zeichenkette |
Falsch |
JSON-Zeichenkette, die die Mindestversion beschreibt, die auf die Paketversion aktualisiert werden kann. Folgende Werte sind definiert:
|
maxVersion |
Zeichenkette |
Falsch |
JSON-Zeichenkette, die die maximale Version beschreibt, die auf die Paketversion aktualisiert werden kann. Folgende Werte sind definiert:
|
Abhängigkeiten
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
componentName |
Zeichenkette |
True |
JSON-Zeichenkette, die den Namen der Komponente beschreibt. Folgende Werte sind definiert:
|
componentMinVersion |
Zeichenkette |
Falsch |
JSON-Zeichenkette, die die erforderliche Mindestversion der jeweiligen Komponente beschreibt. Folgende Werte sind definiert:
|
componentMaxVersion |
Zeichenkette |
Falsch |
JSON-Zeichenkette, die die maximal erforderliche Version dieser Komponente beschreibt. Folgende Werte sind definiert:
|
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. Falls beim Erstellen keine Bezeichnung angegeben wird, wird ein Metadatenobjekt ohne Bezeichnungen erstellt.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Etiketten |
Array["Typ_Astra_Label"] |
True |
|
CreationZeitstempel |
Zeichenkette |
True |
|
Änderungszeitstempel |
Zeichenkette |
True |
|
Erstellt von |
Zeichenkette |
True |
|
modifiedBy |
Zeichenkette |
Falsch |
package_1.0_get_response_body
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
Medientyp der Ressource. Folgende Werte sind definiert:
|
Version |
Zeichenkette |
True |
Version der Ressource. Folgende Werte sind definiert:
|
id |
Zeichenkette |
True |
Weltweit eindeutiger Bezeichner der Ressource. Folgende Werte sind definiert:
|
packageName |
Zeichenkette |
True |
JSON-Zeichenkette mit dem Paketnamen. Folgende Werte sind definiert:
|
packageVersion |
Zeichenkette |
True |
JSON-Zeichenkette mit der SemVer des Pakets. Folgende Werte sind definiert:
|
packageType |
Zeichenkette |
True |
JSON-Zeichenkette mit dem Pakettyp, die angibt, ob es sich um ein vollständiges Installationspaket oder einen Patch handelt. Folgende Werte sind definiert:
|
bundleName |
Array[string] |
Falsch |
JSON-Array von JSON-Zeichenketten, die den Namen des Bundles enthalten, in dem das Paket enthalten ist. |
severityLevel |
Zeichenkette |
True |
JSON-Zeichenkette, die den Schweregrad dieser Patch- oder Installationsversion beschreibt. Folgende Werte sind definiert:
|
packageState |
Zeichenkette |
True |
JSON-Zeichenkette mit einem Wert, der den Betriebsstatus des Pakets angibt. Nach der Überprüfung des Pakets und nach dem Import lautet der Status „complete“. Andernfalls lautet der Status „incomplete“. Folgende Werte sind definiert:
|
packageStateTransitions |
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 „from“ den Namen eines Zustands und „to“ ein Array zulässiger Zielzustände angibt. Folgende Werte sind definiert:
|
packageStateDetails |
Array["type_astra_stateDetail"] |
True |
Ein JSON-Array mit JSON-Objekten, das zusätzliche Details zum aktuellen "state" enthält. Sind keine Details verfügbar, ist dieses Array leer.
|
Bilder |
Array["Bilder"] |
Falsch |
JSON-Array von JSON-Objekten, die jeweils ein Docker-Image enthalten, das Teil des Pakets ist. |
Artefakte |
Array["Artefakte"] |
Falsch |
JSON-Array von JSON-Objekten, die die zusätzlichen Artefakte (Binärdateien und andere) beschreiben, die mit diesem Paket verknüpft sind. |
Dateien |
Array["Dateien"] |
Falsch |
JSON-Array von JSON-Objekten, die jeweils ein Nicht-Bild-Artefakt darstellen, das mit diesem Paket verknüpft ist. |
upgradableVersions |
Falsch |
JSON-Objekt, das die minimale und maximale Version enthält, auf die auf die Paketversion aktualisiert werden kann. |
|
Abhängigkeiten |
Array["Abhängigkeiten"] |
Falsch |
JSON-Array von JSON-Objekten, die beschreiben, welche Mindestversion einer bestimmten Abhängigkeit für die Installation dieses Pakets erforderlich ist |
Metadaten |
True |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Folgende Werte sind definiert:
|
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 |
True |
Name des ungültigen Abfrageparameters |
Grund |
Zeichenkette |
True |
Grund, warum der Abfrageparameter ungültig ist |