Skip to main content
Astra Automation
È disponibile una versione più recente di questo prodotto.
La versione in lingua italiana fornita proviene da una traduzione automatica. Per eventuali incoerenze, fare riferimento alla versione in lingua inglese.

Elenca le risorse API di K8s per un cluster gestito

PDF

GET /accounts/{account_id}/topology/v1/managedClusters/{managedCluster_id}/apiResources

Restituisce un array JSON di tutte le risorse corrispondenti nella raccolta. Se nella richiesta vengono specificati singoli campi, l'array JSON degli elementi conterrà i campi richiesti per ciascuna risorsa corrispondente nell'ordine specificato.

Parametri

Nome Tipo In Obbligatorio Descrizione

ID account

stringa

percorso

Vero

ID della risorsa account contenitore

  • esempio: {{.Account}}

ID cluster gestito

stringa

percorso

Vero

ID della risorsa managedCluster contenitore

includi

stringa

query

Falso

Indica quali campi devono essere restituiti durante l'elenco di una raccolta.

Esempi di URL: "include=id", "include=id,name"

Esempi OpenAPI: "id"

  • esempio: id,kind,apiVersion

limite

stringa

query

Falso

Indica il numero massimo di risorse da restituire quando si elenca una raccolta.

Esempi di URL: "limit=2"

Esempi OpenAPI: "2"

Risposta

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.
Nome Tipo Obbligatorio Descrizione

elementi

array[Qualsiasi tra: "apiResource_1.0_get_response_body", array[]]

Vero

metadati

"elenco_metadati_tipo_astra"

Vero
Risposta tipo 
{
  "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"
  }
}

Risposta

Status: 401, Unauthorized
Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

titolo

stringa

Vero

dettaglio

stringa

Vero

stato

stringa

Vero

ID correlazione

stringa

Falso
Risposta tipo 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Risposta

Status: 400, Bad request
Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

titolo

stringa

Vero

dettaglio

stringa

Vero

stato

stringa

Vero

ID correlazione

stringa

Falso

invalidParams

vettore["invalidParams"]

Falso

Elenco dei parametri di query non validi
Risposta tipo 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Risposta

Status: 403, Forbidden
Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

titolo

stringa

Vero

dettaglio

stringa

Vero

stato

stringa

Vero

ID correlazione

stringa

Falso
Risposta tipo 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Errore

Status: 404, Not found
Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

titolo

stringa

Vero

dettaglio

stringa

Vero

stato

stringa

Vero

ID correlazione

stringa

Falso
Esempio di risposta di errore 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Definizioni

Vedi definizioni

etichetta tipo_astra

Nome Tipo Obbligatorio Descrizione

nome

stringa

Vero

valore

stringa

Vero

type_astra_metadati

Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:

  • Conforme allo schema di metadati Astra

Nome Tipo Obbligatorio Descrizione

etichette

vettore["etichetta tipo_astra"]

Vero

CreationTimestamp

stringa

Vero

ModificationTimestamp

stringa

Vero

CreatedBy

stringa

Vero

modifiedBy

stringa

Falso

apiResource_1.0_get_response_body

Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

Tipo di media della risorsa. I valori definiti sono:

  • "applicazione/astra-apiResource"

versione

stringa

Vero

Versione della risorsa. I valori definiti sono:

  • "1,0"

id

stringa

Vero

Identificatore univoco globale della risorsa. I valori definiti sono:

  • Conforme allo schema UUIDv4

apiVersion

stringa

Vero

Stringa JSON che rappresenta la versione API della risorsa, come impostata in Kubernetes o da Kubernetes. APIVersion definisce lo schema versionato per questa rappresentazione dell'oggetto. I server dovrebbero convertire gli schemi riconosciuti al valore interno più recente e potrebbero rifiutare i valori non riconosciuti. Ulteriori informazioni: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Tipo

stringa

Vero

Stringa JSON che rappresenta il tipo di risorsa, come impostato in Kubernetes o da Kubernetes. Il campo kind utilizza la notazione camel case e contiene un valore stringa che rappresenta la risorsa REST che questo oggetto rappresenta. I server potrebbero dedurlo dall'endpoint a cui il client invia le richieste. Non può essere aggiornato. Ulteriori informazioni: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadati

"type_astra_metadati"

Vero

Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:

  • Conforme allo schema di metadati Astra

elenco_metadati_tipo_astra

Nome Tipo Obbligatorio Descrizione

continuare

stringa

Falso

conta

numero

Falso

etichette

vettore["etichetta tipo_astra"]

Falso

CreationTimestamp

stringa

Falso

ModificationTimestamp

stringa

Falso

CreatedBy

stringa

Falso

modifiedBy

stringa

Falso

invalidParams

Nome Tipo Obbligatorio Descrizione

nome

stringa

Vero

Nome del parametro di query non valido

motivo

stringa

Vero

Motivo per cui il parametro di query non è valido