Skip to main content
Astra Automation
Une version plus récente de ce produit est disponible.
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

Récupérer un espace de noms

PDF

GET /accounts/{account_id}/topology/v1/namespaces/{namespace_id}

Renvoie la ressource d'API Namespace stockée dans le corps de la réponse JSON.

Paramètres

Nom Type Dans Obligatoire Description

identifiant_compte

chaîne

chemin

Vrai

ID de la ressource de compte conteneur

  • exemple: {{.Account}}

id_espace_de_noms

chaîne

chemin

Vrai

ID de la collection d'espaces de noms à lister

Réponse

Status: 200, Returns the stored Namespace API resource in the JSON 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"

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 aucun détail n'est disponible, ce tableau sera vide. Les valeurs définies sont :

  • 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

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). Les valeurs définies sont :

  • « 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
Exemple de réponse 
{
  "type": "application/astra-namespace",
  "version": "1.1",
  "id": "2de811a6-ce8f-512c-9c3a-9585ca66de22",
  "links": [
    {
      "rel": "canonical",
      "href": "/accounts/0b311ae7-d89a-4a11-a52c-1349ca090415/topology/v1/namespaces/7d451d2f-196e-4234-aee9-7e2376047e63",
      "type": "application/vnd.netapp.astra.namespace"
    },
    {
      "rel": "collection",
      "href": "/accounts/0b311ae7-d89a-4a11-a52c-1349ca090415/topology/v1/clouds/e0490197-872e-4de8-9287-b04a938e801f/clusters/0f284377-e5dc-4dcd-bacd-3197f2b8a347/namespaces",
      "type": "application/vnd.netapp.astra.namespaces"
    }
  ],
  "name": "kube-system",
  "namespaceState": "discovered",
  "namespaceStateDetails": [
    {
      "type": "https://astra.netapp.io/stateDetails/9",
      "title": "Namespace Discovered",
      "detail": "The namespace was discovered in the indicated managed cluster"
    }
  ],
  "kubernetesLabels": [
    {
      "name": "app.kubernetes.io/environment",
      "value": "dev"
    }
  ],
  "clusterID": "0f284377-e5dc-4dcd-bacd-3197f2b8a347",
  "systemType": "kubernetes",
  "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

type_astra_stateDetail

Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

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

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