Lister les nœuds de cluster pour un cluster
GET /accounts/{account_id}/topology/v1/clusters/{cluster_id}/clusterNodes
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
|
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 »
|
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 : "clusterNode_1.0_get_response_body", tableau[]] |
Vrai |
|
les métadonnées |
Vrai |
Exemple de réponse
{
"type": "application/astra-clusterNodes",
"version": "1.0",
"items": [
[
"test-0",
"e2-medium"
],
[
"test-1",
"e2-medium"
],
[
"test-2",
"e2-medium"
],
[
"test-3",
"e2-micro"
]
],
"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
étiquettes
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
nom |
chaîne |
Vrai |
Chaîne JSON contenant le nom de l'étiquette Les valeurs définies sont :
|
valeur |
chaîne |
Vrai |
Chaîne JSON contenant la valeur de l'étiquette Defined values are :
|
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 |
clusterNode_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 :
|
nom |
chaîne |
Vrai |
Chaîne JSON contenant une valeur indiquant le nom Kubernetes du nœud. Les valeurs définies sont :
|
rôle |
chaîne |
Vrai |
Chaîne JSON contenant une valeur indiquant le rôle Kubernetes du nœud. Les valeurs définies sont :
|
étiquettes |
tableau["étiquettes"] |
Vrai |
Tableau JSON d'objets JSON, chacun contenant les étiquettes Kubernetes associées au nœud. Si aucune information n'est disponible, ce tableau sera vide.
|
creationTime |
chaîne |
Vrai |
Chaîne JSON contenant un horodatage ISO 8601 indiquant la date et l'heure de création du nœud. Les valeurs définies sont :
|
adresse IP externe |
chaîne |
Vrai |
Chaîne JSON contenant une valeur indiquant l'adresse IP interne du nœud. Les valeurs définies sont :
|
IP interne |
chaîne |
Vrai |
Chaîne JSON contenant une valeur indiquant l'adresse IP externe du nœud. Les valeurs définies sont :
|
zone |
chaîne |
Vrai |
Chaîne JSON contenant une valeur indiquant la zone Kubernetes du nœud. Les valeurs définies sont :
|
région |
chaîne |
Vrai |
Chaîne JSON contenant une valeur indiquant la région Kubernetes du nœud. Les valeurs définies sont :
|
instanceType |
chaîne |
Vrai |
Chaîne JSON contenant une valeur indiquant le type d'instance Kubernetes du nœud. Les valeurs définies sont :
|
kernelVersion |
chaîne |
Vrai |
Chaîne JSON contenant une valeur indiquant la version du noyau utilisée par le nœud. Les valeurs définies sont :
|
osImage |
chaîne |
Vrai |
Chaîne JSON contenant une valeur indiquant l'image du système d'exploitation utilisée par le nœud. Les valeurs définies sont :
|
numCpus |
chaîne |
Vrai |
Chaîne JSON contenant une valeur indiquant le nombre de processeurs attribués au nœud. Les valeurs définies sont :
|
mémoire |
chaîne |
Vrai |
Chaîne JSON contenant une valeur indiquant la quantité de mémoire allouée au nœud. Les valeurs définies sont :
|
État |
chaîne |
Vrai |
Chaîne JSON contenant une valeur indiquant l'état opérationnel du nœud. Les valeurs définies sont :
|
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 |