Listen Sie die K8s-API-Ressourcen für einen verwalteten Cluster auf
GET /accounts/{account_id}/topology/v1/managedClusters/{managedCluster_id}/apiResources
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
|
managedCluster_id |
Zeichenkette |
Pfad |
True |
ID der enthaltenden managedCluster-Ressource |
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: "apiResource_1.0_get_response_body", array[]] |
True |
|
Metadaten |
True |
Beispielantwort
{
"type": "application/astra-apiResources",
"version": "1.0",
"items": [
[
"e280ff62-be35-4f31-a31b-a210a1ad1b33",
"ClusterRole",
"rbac.authorization.k8s.io/v1"
],
[
"e8507dad-d33f-44b3-9c15-ec55ba6f6473",
"ClusterRoleBinding",
"rbac.authorization.k8s.io/v1"
]
],
"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. Definierte Werte sind:
-
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 |
apiResource_1.0_get_response_body
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
Medientyp der Ressource. Definierte Werte sind:
|
Version |
Zeichenkette |
True |
Version der Ressource. Definierte Werte sind:
|
id |
Zeichenkette |
True |
Weltweit eindeutiger Bezeichner der Ressource. Definierte Werte sind:
|
apiVersion |
Zeichenkette |
True |
JSON-String, der die API-Version der Ressource, wie sie in oder von Kubernetes festgelegt wurde, darstellt. APIVersion definiert das versionierte Schema für diese Objektdarstellung. Server sollten erkannte Schemas in den neuesten internen Wert konvertieren und nicht erkannte Werte ablehnen. Weitere Informationen: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
Art |
Zeichenkette |
True |
JSON-String, der die Art der Ressource darstellt, wie sie in oder von Kubernetes festgelegt wurde. Das Feld „kind“ verwendet CamelCase und enthält einen String-Wert, der die REST-Ressource repräsentiert, die dieses Objekt darstellt. Server können dies aus dem Endpunkt ableiten, an den der Client Anfragen sendet. Es kann nicht aktualisiert werden. Weitere Informationen: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
Metadaten |
True |
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 |
True |
Name des ungültigen Abfrageparameters |
Grund |
Zeichenkette |
True |
Grund, warum der Abfrageparameter ungültig ist |