Skip to main content
Astra Automation
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

Lister les espaces de noms d'un cluster

PDF

GET /accounts/{account_id}/topology/v1/clusters/{cluster_id}/namespaces

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

  • exemple: {{.Account}}

cluster_id

chaîne

chemin

Vrai

ID de la ressource de cluster contenant

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 »

  • exemple : id, nom,kubernetesLabels

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 »

filtre

chaîne

requête

Faux

Indique les champs qui doivent être mis en correspondance pour renvoyer une ressource lors du listage d'une collection.

Les opérateurs pris en charge sont :

  • eq - Égalité

  • lt/gt - Inférieur à/Supérieur à

  • LTE/GTE - Inférieur ou égal à/Supérieur ou égal à

Exemple d'URL : « filter=field%20eq%20%27value%27 »

Exemples OpenAPI : « field eq 'value' »

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 : "namespace_1.2_get_response_body", tableau[]]

Vrai

les métadonnées

"type_astra_metadata_list"

Vrai
Exemple de réponse 
{
  "type": "application/astra-namespaces",
  "version": "1.2",
  "items": [
    [
      "7d451d2f-196e-4234-aee9-7e2376047e63",
      "kube-system",
      [
        {
          "name": "app.kubernetes.io/environment",
          "value": "dev"
        }
      ]
    ],
    [
      "66b0873b-214f-4ac7-89d8-922432f941eb",
      "jenkins",
      [
        {
          "name": "app.kubernetes.io/environment",
          "value": "dev"
        }
      ]
    ]
  ],
  "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

targetSchema

accept-post

accepter-put

indices

Nom Type Obligatoire Description

statut

chaîne

Faux

permettre

tableau[chaîne]

Faux

accept-post

"accept-post"

Faux

autorisations

tableau[chaîne]

Faux

accepter-put

"accepter-put"

Faux

type_astra_link

Nom Type Obligatoire Description

rel

chaîne

Vrai

href

chaîne

Vrai

type

chaîne

Faux

targetSchema

"targetSchema"

Faux

titre

chaîne

Faux

indices

"indices"

Faux

additionalDetails

type_astra_stateDetail

Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

additionalDetails

"additionalDetails"

Faux

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

namespace_1.2_get_response_body

Nom Type Obligatoire Description

type

chaîne

Vrai

Type de média de la ressource. Les valeurs définies sont :

  • "application/astra-namespace"

version

chaîne

Vrai

Version de la ressource. Les valeurs définies sont :

  • "1,0"

  • "1,1"

  • "1,2"

id

chaîne

Vrai

Identifiant unique global de la ressource. Les valeurs définies sont :

  • Conforme au schéma UUIDv4

liens

tableau["type_astra_link"]

Vrai

Liens décrivant les opérations prises en charge sur la ressource.

nom

chaîne

Vrai

Chaîne JSON contenant une valeur indiquant le nom de l'espace de noms. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 255

namespaceState

chaîne

Vrai

Chaîne JSON contenant une valeur indiquant l'état de l'espace de noms. Les valeurs définies sont :

  • « découvert » - L'espace de noms a été trouvé dans le cluster

  • « supprimé » - L'espace de noms a été supprimé du cluster, ou le cluster n'est pas géré mais il peut exister des ressources faisant référence à l'espace de noms

namespaceStateDetails

tableau["type_astra_stateDetail"]

Vrai

Tableau JSON d'objets JSON contenant des informations supplémentaires sur la raison de la transition de l'état « state » vers « state a », « state b » ou « state c ». Si aucune information n'est disponible, ce tableau sera vide. Valeurs possibles :

  • Nombre minimum d’articles : 0

kubernetesLabels

tableau["type_astra_label"]

Faux

Tableau JSON d'objets JSON, chacun contenant une étiquette Kubernetes associée à l'espace de noms. Les valeurs définies sont :

  • Conforme au schéma de tableau d'étiquettes Kubernetes

kubernetesUID

chaîne

Vrai

Chaîne JSON contenant l'UID généré par Kubernetes de la ressource d'espace de noms

clusterID

chaîne

Vrai

Chaîne JSON contenant un identifiant unique global du cluster dans lequel se trouve l'espace de noms. Les valeurs définies sont :

  • Conforme au schéma d'identifiant Astra

systemType

chaîne

Faux

Chaîne JSON indiquant que l'espace de noms est un type d'espace de noms système. Ce champ identifie le type d'espace de noms système, le cas échéant (version 1.1 uniquement). Valeurs définies :

  • « kubernetes » - Un espace de noms système Kubernetes (K8s) générique, par exemple « kube-system »

  • « netapp » - Un espace de noms système NetApp, par exemple « trident » ou « netapp-monitoring »

  • « openshift » - Un espace de noms système OpenShift, par exemple, « openshift-monitoring »

  • "rke" - Un espace de noms Rancher, par exemple "cattle-logging"

  • « autres » - Espaces de noms système courants qui ne correspondent pas nécessairement à d'autres catégories, par exemple « ingress-nginx », « tekton-system »

les métadonnées

"type_astra_metadata"

Vrai

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

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