Alle Berechtigungen auflisten
GET /accounts/{account_id}/core/v1/entitlements
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
|
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:
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: " |
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: "entitlement_1.0_get_response_body", array[]] |
True |
|
Metadaten |
True |
Beispielantwort
{
"type": "application/astra-entitlements",
"version": "1.0",
"items": [
[
"Astra SDS",
"capacity",
"2",
null
],
[
"Astra Enterprise",
"clusters",
"100",
"5e9fe8f7-4c54-441c-ac94-fd8451f9ca38"
]
],
"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
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 |
entitlement_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:
|
Zuweisung |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit der ID des Objekts, dem die Berechtigung zugewiesen ist. Nur vorhanden, wenn die Berechtigung zugewiesen ist. Der Zeichenketteninhalt wurde vom Schema nicht validiert. |
Produkt |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit der aus der Lizenz oder dem Abonnement extrahierten Produktzeichenkette. Der Zeichenketteninhalt wurde vom Schema nicht validiert. |
productVersion |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit der aus der Lizenz oder dem Abonnement extrahierten Versionszeichenkette. Der Zeichenketteninhalt wurde vom Schema nicht validiert. |
entitlementType |
Zeichenkette |
True |
JSON-Zeichenkette mit dem Berechtigungstyp. Diese wird aus der Lizenz oder dem Abonnement extrahiert. Der Zeichenketteninhalt wurde vom Schema nicht validiert. |
entitlementValue |
Zeichenkette |
True |
JSON-Zeichenkette mit der der Berechtigung zugeordneten Kapazität. Der Zeichenketteninhalt wurde vom Schema nicht validiert. |
entitlementConsumption |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit der aktuell genutzten Kapazität des Berechtigungsanspruchs. Der Zeichenketteninhalt wurde vom Schema nicht validiert. |
sourceLicense |
Zeichenkette |
Falsch |
JSON-Zeichenfolge mit der Lizenzobjekt-ID, von der die Berechtigung stammt. Folgende Werte sind definiert:
|
sourceSubscription |
Zeichenkette |
Falsch |
JSON-Zeichenfolge mit der ID des Abonnementobjekts, aus dem die Berechtigung stammt. Folgende Werte sind definiert:
|
validFromTimestamp |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Zeitstempel, der angibt, wann die Berechtigung gültig wird. Folgende Werte sind definiert:
|
validUntilTimestamp |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Zeitstempel, der angibt, wann die Berechtigung nicht mehr gültig ist. Folgende Werte sind definiert:
|
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 |