Lister les ressources de l'API K8s pour un cluster géré
Suggérer des modifications
PDF
GET /accounts/{account_id}/topology/v1/managedClusters/{managedCluster_id}/apiResources
Renvoie un tableau JSON contenant toutes les ressources correspondantes de la collection. Si des champs individuels sont spécifiés dans la requête, le tableau JSON items contiendra les champs demandés pour chaque ressource correspondante dans l'ordre indiqué.
Paramètres
| Nom | Type | Dans | Obligatoire | Description |
|---|---|---|---|---|
identifiant_compte |
chaîne |
chemin |
Vrai |
ID de la ressource de compte conteneur
|
id_cluster_géré |
chaîne |
chemin |
Vrai |
ID de la ressource managedCluster conteneur |
inclure |
chaîne |
requête |
Faux |
Indique les champs qui doivent être renvoyés lors de l’énumération d’une collection. Exemples d'URL : « include=id », « include=id,name » Exemples OpenAPI : « id »
|
limite |
chaîne |
requête |
Faux |
Indique le nombre maximal de ressources à renvoyer lors de l’énumération d’une collection. Exemples d'URL : « limit=2 » Exemples OpenAPI : « 2 » |
Réponse
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.| Nom | Type | Obligatoire | Description |
|---|---|---|---|
articles |
tableau[N'importe lequel de : "corps de réponse apiResource_1.0_get_response_body", tableau[]] |
Vrai |
|
les métadonnées |
Vrai |
Exemple de réponse
{
"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"
}
}Réponse
Status: 401, Unauthorized| Nom | Type | Obligatoire | Description |
|---|---|---|---|
type |
chaîne |
Vrai |
|
titre |
chaîne |
Vrai |
|
détail |
chaîne |
Vrai |
|
statut |
chaîne |
Vrai |
|
identifiant de corrélation |
chaîne |
Faux |
Exemple de réponse
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}Réponse
Status: 400, Bad request| Nom | Type | Obligatoire | Description |
|---|---|---|---|
type |
chaîne |
Vrai |
|
titre |
chaîne |
Vrai |
|
détail |
chaîne |
Vrai |
|
statut |
chaîne |
Vrai |
|
identifiant de corrélation |
chaîne |
Faux |
|
invalidParams |
tableau["invalidParams"] |
Faux |
Liste des paramètres de requête invalides |
Exemple de réponse
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}Réponse
Status: 403, Forbidden| Nom | Type | Obligatoire | Description |
|---|---|---|---|
type |
chaîne |
Vrai |
|
titre |
chaîne |
Vrai |
|
détail |
chaîne |
Vrai |
|
statut |
chaîne |
Vrai |
|
identifiant de corrélation |
chaîne |
Faux |
Exemple de réponse
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}Erreur
Status: 404, Not found| Nom | Type | Obligatoire | Description |
|---|---|---|---|
type |
chaîne |
Vrai |
|
titre |
chaîne |
Vrai |
|
détail |
chaîne |
Vrai |
|
statut |
chaîne |
Vrai |
|
identifiant de corrélation |
chaîne |
Faux |
Exemple de réponse d'erreur
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}Définitions
Voir les définitions
type_astra_label
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
nom |
chaîne |
Vrai |
|
valeur |
chaîne |
Vrai |
type_astra_metadata
Métadonnées spécifiques au client et au service associées à la ressource. Les valeurs définies sont :
-
Conforme au schéma de métadonnées Astra
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
étiquettes |
tableau["type_astra_label"] |
Vrai |
|
CréationTimestamp |
chaîne |
Vrai |
|
ModificationTimestamp |
chaîne |
Vrai |
|
CreatedBy |
chaîne |
Vrai |
|
modifiedBy |
chaîne |
Faux |
corps de réponse apiResource_1.0_get_response_body
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
type |
chaîne |
Vrai |
Type de média de la ressource. Les valeurs définies sont :
|
version |
chaîne |
Vrai |
Version de la ressource. Les valeurs définies sont :
|
id |
chaîne |
Vrai |
Identifiant unique global de la ressource. Les valeurs définies sont :
|
apiVersion |
chaîne |
Vrai |
Chaîne JSON représentant la version de l'API de la ressource, telle que définie dans ou par Kubernetes. APIVersion définit le schéma versionné pour cette représentation d'objet. Les serveurs doivent convertir les schémas reconnus vers la dernière valeur interne et peuvent rejeter les valeurs non reconnues. Plus d'informations : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
type |
chaîne |
Vrai |
Chaîne JSON représentant le type de la ressource, tel que défini dans ou par Kubernetes. Le champ kind utilise la casse chameau et contient une valeur de chaîne représentant la ressource REST que cet objet représente. Les serveurs peuvent l'inférer à partir du point de terminaison auquel le client soumet les demandes. Il ne peut pas être mis à jour. Plus d'informations : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
les métadonnées |
Vrai |
Métadonnées spécifiques au client et au service associées à la ressource. Les valeurs définies sont :
|
type_astra_metadata_list
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
continuer |
chaîne |
Faux |
|
nombre |
nombre |
Faux |
|
étiquettes |
tableau["type_astra_label"] |
Faux |
|
CréationTimestamp |
chaîne |
Faux |
|
ModificationTimestamp |
chaîne |
Faux |
|
CreatedBy |
chaîne |
Faux |
|
modifiedBy |
chaîne |
Faux |
invalidParams
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
nom |
chaîne |
Vrai |
Nom du paramètre de requête invalide |
raison |
chaîne |
Vrai |
Raison pour laquelle le paramètre de requête est invalide |