IBM Cloud Kubernetes Service GraphQL Référence API

L'API IBM Cloud Kubernetes Service GraphQL est disponible à l'adresse https://containers.cloud.ibm.com/graphql. Utilisez cette API pour gérer par programmation les connecteurs d' Satellite, les clusters d' Kubernetes et les nœuds de travail bare metal.

Cette page est générée automatiquement à partir du schéma en ligne.

Requêtes

Les requêtes récupèrent des données sans modifier aucune ressource. Envoyez une requête POST à en https://containers.cloud.ibm.com/graphql indiquant votre question dans le corps de la requête.

node

Rechercher une Node pour l'ID indiqué. Utilisez des fragments pour sélectionner des champs supplémentaires.

Valeurs de retour et arguments de la fonction node
Type Nom Description
Renvoie Node
Argument id (ID!) (obligatoire) L'identifiant de nœud unique au monde.

Exemple de demande

curl -X POST https://containers.cloud.ibm.com/graphql \
  -H "Authorization: Bearer $IAM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "query node($id: ID!) {\n  node(id: $id) {\n    # ... select your fields here\n  }\n}",
  "variables": {
    "id": "abc123"
  }
}'

Exemple de réponse

{
  "data": {
    "node": "<Node>"
  }
}

satelliteConnectors

Énumérez les connecteurs d’ Satellite s auxquels vous avez accès.

Valeurs de retour et arguments pour satelliteConnectors
Type Nom Description
Renvoie SatelliteConnectorConnection
Argument after (String) Renvoyer les connecteurs d' Satellite s après ce curseur.
Argument first (Int) Renvoie les N premiers connecteurs d' Satellite.
Argument last (Int) Renvoie les N derniers connecteurs d' Satellite.
Argument before (String) Renvoyer les connecteurs d' Satellite s situés avant ce curseur.

Exemple de demande

curl -X POST https://containers.cloud.ibm.com/graphql \
  -H "Authorization: Bearer $IAM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "query satelliteConnectors($after: String, $first: Int, $last: Int, $before: String) {\n  satelliteConnectors(after: $after, first: $first, last: $last, before: $before) {\n    # ... select your fields here\n  }\n}",
  "variables": {
    "after": "example-value",
    "first": 0,
    "last": 0,
    "before": "example-value"
  }
}'

Exemple de réponse

{
  "data": {
    "satelliteConnectors": {
      "edges": [
        {
          "cursor": "example-value",
          "node": {
            "createdDate": "2025-01-01T00:00:00Z",
            "crn": "<CloudResourceName>",
            "id": "abc123",
            "name": "example-value",
            "region": {
              "displayName": "...",
              "id": "...",
              "name": "..."
            },
            "resourceGroup": {
              "externalID": "...",
              "id": "...",
              "name": "..."
            },
            "state": "CREATED"
          }
        }
      ],
      "pageInfo": {
        "endCursor": "example-value",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example-value"
      }
    }
  }
}

Mutations

Les mutations permettent de créer, de mettre à jour ou de supprimer des ressources. Chaque mutation nécessite un jeton IAM de type bearer dans l'en-tête Authorization.

addVirtualNetworkInterfaceToBareMetalNode

Ajoute une interface réseau virtuelle (VNI) à un nœud de travail bare metal d' Kubernetes.

Valeurs de retour et arguments pour addVirtualNetworkInterfaceToBareMetalNode
Type Nom Description
Renvoie AddVirtualNetworkInterfaceToBareMetalNodePayload
Argument input (AddVirtualNetworkInterfaceToBareMetalNodeInput!) (obligatoire) Paramètres d'entrée pour ajouter le VNI à un nœud bare metal.

Exemple de demande

curl -X POST https://containers.cloud.ibm.com/graphql \
  -H "Authorization: Bearer $IAM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "mutation addVirtualNetworkInterfaceToBareMetalNode($input: AddVirtualNetworkInterfaceToBareMetalNodeInput!) {\n  addVirtualNetworkInterfaceToBareMetalNode(input: $input) {\n    # ... select your fields here\n  }\n}",
  "variables": {
    "input": "<AddVirtualNetworkInterfaceToBareMetalNodeInput>"
  }
}'

Exemple de réponse

{
  "data": {
    "addVirtualNetworkInterfaceToBareMetalNode": {
      "networkAttachment": "<NetworkAttachment>"
    }
  }
}

createSatelliteConnector

Créez un connecteur Satellite.

Valeurs de retour et arguments pour l' createSatelliteConnector
Type Nom Description
Renvoie CreateSatelliteConnectorPayload
Argument input (CreateSatelliteConnectorInput)

Exemple de demande

curl -X POST https://containers.cloud.ibm.com/graphql \
  -H "Authorization: Bearer $IAM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "mutation createSatelliteConnector($input: CreateSatelliteConnectorInput) {\n  createSatelliteConnector(input: $input) {\n    # ... select your fields here\n  }\n}",
  "variables": {
    "input": "<CreateSatelliteConnectorInput>"
  }
}'

Exemple de réponse

{
  "data": {
    "createSatelliteConnector": {
      "satelliteConnector": {
        "createdDate": "2025-01-01T00:00:00Z",
        "crn": "<CloudResourceName>",
        "id": "abc123",
        "name": "example-value",
        "region": {
          "displayName": "example-value",
          "id": "abc123",
          "name": "example-value"
        },
        "resourceGroup": {
          "externalID": "example-value",
          "id": "abc123",
          "name": "example-value"
        },
        "state": "CREATED"
      }
    }
  }
}

reinitializeKubernetesNode

Réinitialiser un nœud d’ Kubernetes. Cette fonctionnalité n'est pas prise en charge à l'heure actuelle sur les instances de serveurs virtuels VPC.

Valeurs de retour et arguments de la fonction reinitializeKubernetesNode
Type Nom Description
Renvoie ReinitializeKubernetesNodePayload
Argument input (ReinitializeKubernetesNodeInput)

Exemple de demande

curl -X POST https://containers.cloud.ibm.com/graphql \
  -H "Authorization: Bearer $IAM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "mutation reinitializeKubernetesNode($input: ReinitializeKubernetesNodeInput) {\n  reinitializeKubernetesNode(input: $input) {\n    # ... select your fields here\n  }\n}",
  "variables": {
    "input": "<ReinitializeKubernetesNodeInput>"
  }
}'

Exemple de réponse

{
  "data": {
    "reinitializeKubernetesNode": {
      "node": "<KubernetesNode>"
    }
  }
}

removeSatelliteConnector

Supprimer un connecteur Satellite.

Valeurs de retour et arguments pour la fonction removeSatelliteConnector
Type Nom Description
Renvoie RemoveSatelliteConnectorPayload
Argument input (RemoveSatelliteConnectorInput)

Exemple de demande

curl -X POST https://containers.cloud.ibm.com/graphql \
  -H "Authorization: Bearer $IAM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "mutation removeSatelliteConnector($input: RemoveSatelliteConnectorInput) {\n  removeSatelliteConnector(input: $input) {\n    # ... select your fields here\n  }\n}",
  "variables": {
    "input": "<RemoveSatelliteConnectorInput>"
  }
}'

Exemple de réponse

{
  "data": {
    "removeSatelliteConnector": {
      "satelliteConnector": {
        "createdDate": "2025-01-01T00:00:00Z",
        "crn": "<CloudResourceName>",
        "id": "abc123",
        "name": "example-value",
        "region": {
          "displayName": "example-value",
          "id": "abc123",
          "name": "example-value"
        },
        "resourceGroup": {
          "externalID": "example-value",
          "id": "abc123",
          "name": "example-value"
        },
        "state": "CREATED"
      }
    }
  }
}

removeVirtualNetworkInterfaceFromNode

Supprime une interface réseau virtuelle d'un nœud de travail d' Kubernetes.

Valeurs de retour et arguments pour removeVirtualNetworkInterfaceFromNode
Type Nom Description
Renvoie RemoveVirtualNetworkInterfaceFromNodePayload
Argument input (RemoveVirtualNetworkInterfaceFromNodeInput!) (obligatoire) Paramètres d'entrée permettant de supprimer le VNI d'un nœud.

Exemple de demande

curl -X POST https://containers.cloud.ibm.com/graphql \
  -H "Authorization: Bearer $IAM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "mutation removeVirtualNetworkInterfaceFromNode($input: RemoveVirtualNetworkInterfaceFromNodeInput!) {\n  removeVirtualNetworkInterfaceFromNode(input: $input) {\n    # ... select your fields here\n  }\n}",
  "variables": {
    "input": "<RemoveVirtualNetworkInterfaceFromNodeInput>"
  }
}'

Exemple de réponse

{
  "data": {
    "removeVirtualNetworkInterfaceFromNode": {
      "cluster": {
        "id": "abc123",
        "name": "example-value",
        "networkAttachments": {
          "edges": [
            {
              "cursor": "...",
              "node": "..."
            }
          ],
          "pageInfo": {
            "endCursor": "...",
            "hasNextPage": "...",
            "hasPreviousPage": "...",
            "startCursor": "..."
          }
        },
        "region": {
          "displayName": "example-value",
          "id": "abc123",
          "name": "example-value"
        }
      },
      "node": "<NetworkAttachable>",
      "virtualNetworkInterface": "<VirtualNetworkInterface>"
    }
  }
}

updateSatelliteLocation

Mettre à jour un emplacement d' Satellite.

Valeurs de retour et arguments pour updateSatelliteLocation
Type Nom Description
Renvoie UpdateSatelliteLocationPayload
Argument input (UpdateSatelliteLocationInput)

Exemple de demande

curl -X POST https://containers.cloud.ibm.com/graphql \
  -H "Authorization: Bearer $IAM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "mutation updateSatelliteLocation($input: UpdateSatelliteLocationInput) {\n  updateSatelliteLocation(input: $input) {\n    # ... select your fields here\n  }\n}",
  "variables": {
    "input": "<UpdateSatelliteLocationInput>"
  }
}'

Exemple de réponse

{
  "data": {
    "updateSatelliteLocation": {
      "satelliteLocation": {
        "description": "example-value",
        "id": "abc123",
        "name": "example-value"
      }
    }
  }
}

Types d'objet

Les types d'objets représentent les ressources concrètes et les données de réponse renvoyées par l'API.

Compte

Compte IBM Cloud.

Champs du compte
Type Nom Description
Zone externalID (String!) L'identifiant d' IBM Cloud ation du compte.

AddVirtualNetworkInterfaceToBareMetalNodePayload

Contenu de la réponse pour l'ajout d'un VNI à un nœud bare metal.

Champs à remplir pour l' AddVirtualNetworkInterfaceToBareMetalNodePayload
Type Nom Description
Zone networkAttachment (NetworkAttachment!) La connexion réseau créée et ses propriétés.

BareMetalNetworkAttachmentByVLAN

Connexion réseau pour les nœuds bare metal à l'aide du balisage VLAN.

Champs à remplir dans l' BareMetalNetworkAttachmentByVLAN
Type Nom Description
Implémente NetworkAttachment
Zone attachedTo (NetworkAttachable!) Le nœud bare metal auquel cette interface est associée.
Zone canFloat (Boolean!) Cette pièce jointe peut-elle circuler entre les nœuds du cluster?
Zone virtualNetworkInterface (VirtualNetworkInterface!) L'interface réseau virtuelle qui est connectée.
Zone vlanID (Int) ID VLAN utilisé pour cette pièce jointe (2-500). Null si non encore attribué.

BareMetalVirtualNetworkInterface

Interface réseau virtuelle associée à un serveur bare metal.

Champs à remplir pour l' BareMetalVirtualNetworkInterface
Type Nom Description
Implémente VirtualNetworkInterface
Zone autoDelete (Boolean) Le VNI doit-il être automatiquement supprimé lorsqu'il est déconnecté?
Zone externalID (String!) L'ID de ressource VPC de ce VNI.
Zone macAddress (MACAddress) Adresse MAC attribuée à cette interface réseau.
Zone name (String) Nom lisible par l'utilisateur du VNI.
Zone primaryIPAddress (IPv4Address) Adresse IPv4 principale attribuée à cette interface réseau.
Zone securityGroups (SecurityGroupConnection)

Groupes de sécurité appliqués à cette interface réseau.
Arguments en faveur de securityGroups

  • ( after``String ) — Curseur à partir duquel commencer la récupération.
  • first (Int) — Nombre maximal d'éléments à renvoyer.
Zone subnet (Subnet!) Le sous-réseau VPC auquel cette interface réseau est connectée.

CreateSatelliteConnectorPayload

Type de contenu destiné à createSatelliteConnector.

Champs pour l' CreateSatelliteConnectorPayload
Type Nom Description
Zone satelliteConnector (SatelliteConnector) Le nouvel SatelliteConnector.

KubernetesCluster

Un cluster de services IBM Cloud Kubernetes Service ou IBM Cloud OpenShift.

Champs à remplir lors de l' KubernetesCluster
Type Nom Description
Implémente Node
Zone id (ID!) Identifiant unique du cluster.
Zone name (String) Nom du cluster.
Zone networkAttachments (NetworkAttachmentConnection)

Connexions réseau pour ce cluster (le cas échéant).
Arguments en faveur de networkAttachments

  • ( after``String ) — Curseur à partir duquel commencer la récupération.
  • first (Int) — Nombre maximal d'éléments à renvoyer.
Zone region (Region) Région du catalogue d’ IBM Cloud s du cluster.

Région

Une région du catalogue d' IBM Cloud.

Champs relatifs à la région
Type Nom Description
Implémente Location
Implémente Node
Zone displayName (String) Nom traduit de cette région.
Zone id (ID!) L'identifiant de cette région.
Zone name (String) Nom de cette région.

ReinitializeKubernetesNodePayload

Type de contenu destiné à reinitializeKubernetesNode.

Champs pour l' ReinitializeKubernetesNodePayload
Type Nom Description
Zone node (KubernetesNode) Réinitialisation du nœud Kubernetes.

RemoveSatelliteConnectorPayload

Type de contenu destiné à removeSatelliteConnector.

Champs à remplir pour l' RemoveSatelliteConnectorPayload
Type Nom Description
Zone satelliteConnector (SatelliteConnector) SatelliteConnector supprimé.

RemoveVirtualNetworkInterfaceFromNodePayload

Contenu de la réponse pour la suppression d'un VNI d'un nœud.

Champs pour l' RemoveVirtualNetworkInterfaceFromNodePayload
Type Nom Description
Zone cluster (KubernetesCluster!) Le cluster duquel le VNI a été supprimé.
Zone node (NetworkAttachable!) Le nœud duquel le VNI a été supprimé.
Zone virtualNetworkInterface (VirtualNetworkInterface!) L'interface réseau virtuelle qui a été supprimée.

ResourceGroup

Une ResourceGroup vous permet d'organiser les ressources de votre compte en groupes personnalisables afin de pouvoir attribuer rapidement à des utilisateurs l'accès à plusieurs ressources à la fois.

Champs pour l' ResourceGroup
Type Nom Description
Implémente Node
Zone externalID (String!) ID d' IBM Cloud ation du groupe de ressources.
Zone id (ID!) ID d' Node ation du groupe de ressources.
Zone name (String) Nom du groupe de ressources.

SatelliteConnector

Un connecteur Satellite assure une connexion sécurisée entre un site distant spécifique et IBM Cloud.

Champs pour l' SatelliteConnector
Type Nom Description
Implémente Node
Zone createdDate (DateTime) Date de création de cette ressource.
Zone crn (CloudResourceName) IBM Cloud e de la ressource : CRN.
Zone id (ID!) Identifiant unique de la ressource.
Zone name (String!) Nom de la ressource.
Zone region (Region) La région à partir de laquelle la ressource est gérée.
Zone resourceGroup (ResourceGroup) Le groupe de ressources contenant cette ressource.
Zone state (SatelliteConnectorState) État actuel de cette ressource.

SatelliteLocation

Un site de l' Satellite.

Champs pour l' SatelliteLocation
Type Nom Description
Implémente Node
Zone description (String) Description de l'emplacement.
Zone id (ID!) Identifiant unique de la ressource.
Zone name (String) Nom du site.

SecurityGroup

Représente un groupe de sécurité VPC.

Champs pour l' SecurityGroup
Type Nom Description
Zone externalID (String!) L'ID de ressource VPC de ce groupe de sécurité.

Sous-réseau

Représente un sous-réseau VPC.

Champs relatifs au sous-réseau
Type Nom Description
Zone externalID (String!) L'ID de ressource VPC de ce sous-réseau.

UpdateSatelliteLocationPayload

Type de contenu destiné à updateSatelliteLocation.

Champs pour l' UpdateSatelliteLocationPayload
Type Nom Description
Zone satelliteLocation (SatelliteLocation) La version mise à jour de l' SatelliteLocation (Guide de conception des applications pour le cloud).

VPCBareMetalKubernetesNode

Représente un nœud de travail bare metal d' Kubernetes dans l' IBM Cloud VPC.

Champs à remplir pour l' VPCBareMetalKubernetesNode
Type Nom Description
Implémente KubernetesNode
Implémente NetworkAttachable
Implémente Node
Zone id (ID!) Identifiant unique au niveau mondial pour ce nœud de travail.
Zone networkAttachments (NetworkAttachmentConnection)

Connexions réseau pour ce nœud bare metal.
Arguments en faveur de networkAttachments

  • ( after``String ) — Curseur à partir duquel commencer la récupération.
  • first (Int) — Nombre maximal d'éléments à renvoyer.
Zone region (Region)

Types d'interface

Les types d'interface définissent des champs communs partagés entre plusieurs types d'objets concrets.

KubernetesNode

Un Kubernetes Node exécute votre charge de travail.

Champs pour l' KubernetesNode
Type Nom Description
Implémentation KubernetesNode
Implémentation VPCBareMetalKubernetesNode
Zone id (ID!) Identifiant unique de la ressource.
Zone region (Region)

Emplacement

Une rubrique du catalogue IBM Cloud.

Champs relatifs à la localisation
Type Nom Description
Implémentation Location
Implémentation Region
Zone displayName (String) Nom traduit de cet emplacement.
Zone id (ID!) L'identifiant de cet emplacement.
Zone name (String) Nom de ce site.

NetworkAttachable

Représente une entité à laquelle des interfaces réseau peuvent être associées.

Champs pour l' NetworkAttachable
Type Nom Description
Implémentation NetworkAttachable
Zone id (ID!) Identifiant unique au monde pour ce nœud.
Zone networkAttachments (NetworkAttachmentConnection)

Connexions réseau associées à ce nœud.
Arguments en faveur de networkAttachments

  • ( after``String ) — Curseur à partir duquel commencer la récupération.
  • first (Int) — Nombre maximal d'éléments à renvoyer.

NetworkAttachment

Représente une connexion d'interface réseau à un nœud.

Champs à remplir pour l' NetworkAttachment
Type Nom Description
Implémentation BareMetalNetworkAttachmentByVLAN
Implémentation NetworkAttachment
Zone attachedTo (NetworkAttachable!) Le nœud auquel cette interface réseau est connectée.
Zone virtualNetworkInterface (VirtualNetworkInterface!) L'interface réseau virtuelle qui est connectée.

Node

Récupère un objet à partir de son ID.

Champs à remplir pour l' Node
Type Nom Description
Implémentation KubernetesCluster
Implémentation KubernetesNode
Implémentation NetworkAttachable
Implémentation Node
Implémentation Region
Implémentation ResourceGroup
Implémentation SatelliteConnector
Implémentation SatelliteLocation
Implémentation VPCBareMetalKubernetesNode
Zone id (ID!) L'identifiant d'objet unique au monde.

VirtualNetworkInterface

Représente une interface réseau virtuelle dans l' IBM Cloud VPC. Peuvent être associés à des instances de serveurs physiques ou virtuels.

Champs pour l' VirtualNetworkInterface
Type Nom Description
Implémentation BareMetalVirtualNetworkInterface
Implémentation VirtualNetworkInterface
Zone autoDelete (Boolean) Le VNI doit-il être automatiquement supprimé lorsqu'il est déconnecté?
Zone externalID (String!) L'ID de ressource VPC de cette interface réseau virtuelle.
Zone macAddress (MACAddress) Adresse MAC attribuée à cette interface réseau.
Zone name (String) Nom lisible par l'utilisateur du VNI.
Zone primaryIPAddress (IPv4Address) Adresse IPv4 principale attribuée à cette interface réseau.
Zone securityGroups (SecurityGroupConnection)

Groupes de sécurité appliqués à cette interface réseau.
Arguments en faveur de securityGroups

  • ( after``String ) — Curseur à partir duquel commencer la récupération.
  • first (Int) — Nombre maximal d'éléments à renvoyer.
Zone subnet (Subnet!) Le sous-réseau VPC auquel cette interface réseau est connectée.

Types de données

Les types d'entrée sont utilisés comme arguments des mutations. Les champs marqués d'un astérisque (obligatoires) doivent être renseignés.

AddVirtualNetworkInterfaceToBareMetalNodeInput

Instructions pour ajouter un VNI à un nœud bare metal.

Champs de saisie pour AddVirtualNetworkInterfaceToBareMetalNodeInput
Type Nom Description
Zone autoDelete (Boolean) Faut-il supprimer automatiquement le VNI du VPC lorsqu'il est détaché? Valeur par défaut : false si non spécifié.
Zone cluster (ID) ID de cluster. Il faut spécifier soit le cluster, soit le nœud, mais pas les deux. Si seul un cluster est fourni, un nœud sera sélectionné automatiquement et la pièce jointe flottera.
Zone node (ID) Node ID. Il faut spécifier soit le cluster, soit le nœud, mais pas les deux. Si cette option est spécifiée, elle crée une pièce jointe non flottante associée à ce nœud spécifique.
Zone virtualNetworkInterfaceID (String!) (obligatoire) L'ID de ressource VPC de l'interface réseau virtuelle à associer.
Zone vlanID (Int!) (obligatoire) ID VLAN de la pièce jointe (2 à 500). Le VLAN 1 est réservé à l'interface réseau principale.

CreateSatelliteConnectorInput

Informations nécessaires à la mise en place d'un connecteur Satellite.

Champs de saisie pour l' CreateSatelliteConnectorInput
Type Nom Description
Zone name (String!) (obligatoire) Nom de la ressource.
Zone regionName (String!) (obligatoire) Nom de la région indiquant d'où le nouveau connecteur doit être géré.
Zone resourceGroupID (String!) (obligatoire) L'ID du groupe de ressources à provisionner.

ReinitializeKubernetesNodeInput

Type de contenu pour reinitializeKubernetesNode.

Champs de saisie pour ReinitializeKubernetesNodeInput
Type Nom Description
Zone bypassUnhealthyControlPlane (Boolean) Définissez cette valeur sur true pour lancer la réinitialisation, même lorsque le plan de contrôle du cluster est défaillant.
Zone id (ID!) (obligatoire) Kubernetes nœud à réinitialiser.

RemoveSatelliteConnectorInput

Type de contenu pour removeSatelliteConnector.

Champs de saisie pour RemoveSatelliteConnectorInput
Type Nom Description
Zone id (ID!) (obligatoire) Satellite ID du connecteur à supprimer.

RemoveVirtualNetworkInterfaceFromNodeInput

Instructions pour supprimer un VNI d'un nœud.

Champs de saisie pour RemoveVirtualNetworkInterfaceFromNodeInput
Type Nom Description
Zone cluster (ID) ID de cluster. Il faut spécifier soit le cluster, soit le nœud, mais pas les deux.
Zone node (ID) Node ID. Il faut spécifier soit le cluster, soit le nœud, mais pas les deux.
Zone virtualNetworkInterfaceID (String!) (obligatoire) L'ID de ressource VPC de l'interface réseau virtuelle à supprimer.

UpdateSatelliteLocationInput

Type de contenu pour updateSatelliteLocation.

Champs de saisie pour l' UpdateSatelliteLocationInput
Type Nom Description
Zone description (String)
Zone id (ID!) (obligatoire) Satellite ID de l'emplacement à mettre à jour.
Zone name (String)

Types énumérés

Les types énumérés définissent l'ensemble des valeurs de chaîne autorisées pour un champ.

SatelliteConnectorState

État administratif d'un connecteur Satellite.

Ces valeurs devraient augmenter à l'avenir. Lors du traitement, vérifiez la présence de valeurs inconnues et consignez-les. Vous pouvez soit interrompre le traitement et signaler l'erreur, soit contourner le connecteur Satellite sur lequel la valeur inattendue a été détectée.

Valeurs d’ SatelliteConnectorState
Type Nom Description
Valeur CREATED Le connecteur a terminé son provisionnement et est prêt à être utilisé.
Valeur CREATING Le connecteur est en cours de provisionnement et n'est peut-être pas encore prêt à être utilisé.
Valeur DELETING Le connecteur est en cours de désactivation et peut ne pas être disponible.
Valeur FAILED La dernière opération du connecteur a échoué et celui-ci doit être supprimé pour pouvoir continuer.

Types scalaires

Les types scalaires sont des valeurs feuilles primitives dans le schéma GraphQL.

CloudResourceName

Un nom de ressource de cloud identifie de manière unique les ressources IBM Cloud. Un nom de ressource de cloud permet de spécifier une ressource sans aucune ambiguïté et de garantir qu'elle est unique.

DateTime

Un DateTime est une combinaison de date et d'heure conforme à la norme RFC3339.

IPv4Address

IPv4 adresse en notation décimale pointée (par exemple, 192.168.1.1 ).

Adresse MAC

Adresse MAC au format hexadécimal séparé par des deux-points (par exemple, 00:1A:2B:3C:4D:5E ).

Demandes internes

Les requêtes suivantes sont réservées à un usage interne et ne sont pas prises en charge pour les appelants externes. Ils sont répertoriés ici par souci d'exhaustivité.

globalSearchSatelliteConnectorAccounts

Résultats consultables à l'échelle mondiale pour le service de recherche globale d' IBM. Usage interne uniquement.

Valeurs de retour et arguments pour globalSearchSatelliteConnectorAccounts
Type Nom Description
Renvoie GlobalSearchSatelliteConnectorAccountsConnection
Argument after (String)
Argument first (Int)
Argument last (Int)
Argument before (String)
Argument regionName (String!) (obligatoire)

Exemple de demande

curl -X POST https://containers.cloud.ibm.com/graphql \
  -H "Authorization: Bearer $IAM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "query globalSearchSatelliteConnectorAccounts($after: String, $first: Int, $last: Int, $before: String, $regionName: String!) {\n  globalSearchSatelliteConnectorAccounts(after: $after, first: $first, last: $last, before: $before, regionName: $regionName) {\n    # ... select your fields here\n  }\n}",
  "variables": {
    "after": "example-value",
    "first": 0,
    "last": 0,
    "before": "example-value",
    "regionName": "example-value"
  }
}'

Exemple de réponse

{
  "data": {
    "globalSearchSatelliteConnectorAccounts": {
      "edges": [
        {
          "cursor": "example-value",
          "node": {
            "externalID": "example-value"
          }
        }
      ],
      "pageInfo": {
        "endCursor": "example-value",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example-value"
      }
    }
  }
}