IBM Cloud Kubernetes Service GraphQL Referencia de la API

La API de IBM Cloud Kubernetes Service ( GraphQL ) está disponible en https://containers.cloud.ibm.com/graphql. Utiliza esta API para gestionar mediante programación los conectores de Satellite, los clústeres de Kubernetes y los nodos de trabajo bare metal.

Esta página se ha generado automáticamente a partir del esquema en tiempo real.

Consultas

Las consultas recuperan datos sin modificar ningún recurso. Envía una solicitud POST a con https://containers.cloud.ibm.com/graphql tu consulta en el cuerpo de la solicitud.

node

Busca un Node para el ID indicado. Utilice fragmentos para seleccionar campos adicionales.

Valores devueltos y argumentos de la función node
Tipo Nombre Descripción
Devuelve Node
Argumento id (ID!) (obligatorio) El identificador de nodo único a nivel mundial.

Solicitud de ejemplo

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"
  }
}'

Respuesta de ejemplo

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

satelliteConnectors

Enumera los conectores de Satellite a los que tienes acceso.

Valores devueltos y argumentos de satelliteConnectors
Tipo Nombre Descripción
Devuelve SatelliteConnectorConnection
Argumento after (String) Introduce Satellite Connectors después de este cursor.
Argumento first (Int) Devuelve los primeros N conectores de Satellite.
Argumento last (Int) Devuelve los últimos N conectores de Satellite.
Argumento before (String) Devuelve los conectores Satellite que se encuentren antes de este cursor.

Solicitud de ejemplo

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"
  }
}'

Respuesta de ejemplo

{
  "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"
      }
    }
  }
}

Mutaciones

Las mutaciones crean, actualizan o eliminan recursos. Cada mutación requiere un token de portador de IAM en el Authorization encabezado.

addVirtualNetworkInterfaceToBareMetalNode

Añade una interfaz de red virtual (VNI) a un nodo de trabajo bare metal de Kubernetes.

Valores devueltos y argumentos de addVirtualNetworkInterfaceToBareMetalNode
Tipo Nombre Descripción
Devuelve AddVirtualNetworkInterfaceToBareMetalNodePayload
Argumento input (AddVirtualNetworkInterfaceToBareMetalNodeInput!) (obligatorio) Parámetros de entrada para añadir el VNI a un nodo bare metal.

Solicitud de ejemplo

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>"
  }
}'

Respuesta de ejemplo

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

createSatelliteConnector

Cree un conector de Satellite.

Valores devueltos y argumentos de createSatelliteConnector
Tipo Nombre Descripción
Devuelve CreateSatelliteConnectorPayload
Argumento input (CreateSatelliteConnectorInput)

Solicitud de ejemplo

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>"
  }
}'

Respuesta de ejemplo

{
  "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

Reinicializar un nodo de Kubernetes. Actualmente no es compatible con instancias de servidor virtual VPC.

Valores devueltos y argumentos de reinitializeKubernetesNode
Tipo Nombre Descripción
Devuelve ReinitializeKubernetesNodePayload
Argumento input (ReinitializeKubernetesNodeInput)

Solicitud de ejemplo

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>"
  }
}'

Respuesta de ejemplo

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

removeSatelliteConnector

Eliminar un conector de Satellite.

Valores devueltos y argumentos de removeSatelliteConnector
Tipo Nombre Descripción
Devuelve RemoveSatelliteConnectorPayload
Argumento input (RemoveSatelliteConnectorInput)

Solicitud de ejemplo

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>"
  }
}'

Respuesta de ejemplo

{
  "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

Elimina una interfaz de red virtual de un nodo de trabajo de Kubernetes.

Valores devueltos y argumentos de removeVirtualNetworkInterfaceFromNode
Tipo Nombre Descripción
Devuelve RemoveVirtualNetworkInterfaceFromNodePayload
Argumento input (RemoveVirtualNetworkInterfaceFromNodeInput!) (obligatorio) Parámetros de entrada para eliminar el VNI de un nodo.

Solicitud de ejemplo

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>"
  }
}'

Respuesta de ejemplo

{
  "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

Actualizar una ubicación de Satellite.

Valores devueltos y argumentos de updateSatelliteLocation
Tipo Nombre Descripción
Devuelve UpdateSatelliteLocationPayload
Argumento input (UpdateSatelliteLocationInput)

Solicitud de ejemplo

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>"
  }
}'

Respuesta de ejemplo

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

Tipos de objetos

Los tipos de objeto representan los recursos concretos y las cargas útiles de respuesta devueltas por la API.

Cuenta

Una cuenta de IBM Cloud.

Campos de la cuenta
Tipo Nombre Descripción
Campo externalID (String!) El ID de IBM Cloud de la cuenta.

AddVirtualNetworkInterfaceToBareMetalNodePayload

Datos de la respuesta para añadir un VNI a un nodo bare metal.

Campos para AddVirtualNetworkInterfaceToBareMetalNodePayload
Tipo Nombre Descripción
Campo networkAttachment (NetworkAttachment!) La conexión de red creada con sus propiedades.

BareMetalNetworkAttachmentByVLAN

Conexión de red para nodos bare metal mediante etiquetado VLAN.

Campos para BareMetalNetworkAttachmentByVLAN
Tipo Nombre Descripción
Implementaciones NetworkAttachment
Campo attachedTo (NetworkAttachable!) El nodo bare metal al que está conectada esta interfaz.
Campo canFloat (Boolean!) Si este archivo adjunto puede desplazarse entre los nodos del clúster.
Campo virtualNetworkInterface (VirtualNetworkInterface!) La interfaz de red virtual que está conectada.
Campo vlanID (Int) ID de VLAN utilizado para este archivo adjunto (2-500). Nulo si aún no se ha asignado.

BareMetalVirtualNetworkInterface

Interfaz de red virtual conectada a un servidor bare metal.

Campos para BareMetalVirtualNetworkInterface
Tipo Nombre Descripción
Implementaciones VirtualNetworkInterface
Campo autoDelete (Boolean) Si la VNI debe eliminarse automáticamente al desconectarse.
Campo externalID (String!) El identificador de recurso VPC de este VNI.
Campo macAddress (MACAddress) Dirección MAC asignada a esta interfaz de red.
Campo name (String) Nombre legible para el usuario del VNI.
Campo primaryIPAddress (IPv4Address) Dirección IPv4 principal asignada a esta interfaz de red.
Campo securityGroups (SecurityGroupConnection)

Grupos de seguridad aplicados a esta interfaz de red.
Argumentos a favor de securityGroups

  • ( after``String ) — Cursor desde el que comenzar la recuperación.
  • first (Int) — Número máximo de elementos que se van a devolver.
Campo subnet (Subnet!) La subred de VPC a la que está conectada esta interfaz de red.

CreateSatelliteConnectorPayload

Tipo de contenido para createSatelliteConnector.

Campos para CreateSatelliteConnectorPayload
Tipo Nombre Descripción
Campo satelliteConnector (SatelliteConnector) El nuevo SatelliteConnector.

KubernetesCluster

Un clúster de IBM Cloud Kubernetes Service o IBM Cloud OpenShift Service.

Campos para KubernetesCluster
Tipo Nombre Descripción
Implementaciones Node
Campo id (ID!) El identificador único del clúster.
Campo name (String) El nombre del clúster.
Campo networkAttachments (NetworkAttachmentConnection)

Conexiones de red para este clúster (si procede).
Argumentos a favor de networkAttachments

  • ( after``String ) — Cursor desde el que comenzar la recuperación.
  • first (Int) — Número máximo de elementos que se van a devolver.
Campo region (Region) La región del catálogo IBM Cloud del clúster.

Región

Una región del catálogo de IBM Cloud.

Campos para la región
Tipo Nombre Descripción
Implementaciones Location
Implementaciones Node
Campo displayName (String) El nombre traducido de esta región.
Campo id (ID!) El ID de esta región.
Campo name (String) El nombre de esta región.

ReinitializeKubernetesNodePayload

Tipo de salida para reinitializeKubernetesNode.

Campos para ReinitializeKubernetesNodePayload
Tipo Nombre Descripción
Campo node (KubernetesNode) Reinicialización del nodo Kubernetes.

RemoveSatelliteConnectorPayload

Tipo de contenido para removeSatelliteConnector.

Campos para RemoveSatelliteConnectorPayload
Tipo Nombre Descripción
Campo satelliteConnector (SatelliteConnector) Se ha eliminado SatelliteConnector.

RemoveVirtualNetworkInterfaceFromNodePayload

Datos de la respuesta para eliminar un VNI de un nodo.

Campos para RemoveVirtualNetworkInterfaceFromNodePayload
Tipo Nombre Descripción
Campo cluster (KubernetesCluster!) El clúster del que se ha eliminado el VNI.
Campo node (NetworkAttachable!) El nodo del que se ha eliminado el VNI.
Campo virtualNetworkInterface (VirtualNetworkInterface!) La interfaz de red virtual que se ha eliminado.

ResourceGroup

Un ResourceGroup es una forma de organizar los recursos de tu cuenta en grupos personalizables, de modo que puedas asignar rápidamente a los usuarios acceso a varios recursos a la vez.

Campos para ResourceGroup
Tipo Nombre Descripción
Implementaciones Node
Campo externalID (String!) El identificador IBM Cloud del grupo de recursos.
Campo id (ID!) El identificador Node del grupo de recursos.
Campo name (String) El nombre del grupo de recursos.

SatelliteConnector

Un conector Satellite proporciona una conexión segura entre una ubicación remota específica y IBM Cloud.

Campos para SatelliteConnector
Tipo Nombre Descripción
Implementaciones Node
Campo createdDate (DateTime) Fecha de creación de este recurso.
Campo crn (CloudResourceName) IBM Cloud, de CRN, sobre este recurso.
Campo id (ID!) Identificador único del recurso.
Campo name (String!) Nombre del recurso.
Campo region (Region) La región desde la que se gestiona el recurso.
Campo resourceGroup (ResourceGroup) El grupo de recursos que contiene este recurso.
Campo state (SatelliteConnectorState) Estado actual de este recurso.

SatelliteLocation

Una ubicación de Satellite.

Campos para SatelliteLocation
Tipo Nombre Descripción
Implementaciones Node
Campo description (String) Descripción de la ubicación.
Campo id (ID!) Identificador único del recurso.
Campo name (String) El nombre de la ubicación.

SecurityGroup

Representa un grupo de seguridad de VPC.

Campos para SecurityGroup
Tipo Nombre Descripción
Campo externalID (String!) El ID de recurso VPC de este grupo de seguridad.

Subred

Representa una subred de VPC.

Campos para la subred
Tipo Nombre Descripción
Campo externalID (String!) El ID de recurso VPC de esta subred.

UpdateSatelliteLocationPayload

Tipo de contenido para updateSatelliteLocation.

Campos para UpdateSatelliteLocationPayload
Tipo Nombre Descripción
Campo satelliteLocation (SatelliteLocation) La guía SatelliteLocation actualizada.

VPCBareMetalKubernetesNode

Representa un nodo de trabajo bare metal de Kubernetes en IBM Cloud VPC.

Campos para VPCBareMetalKubernetesNode
Tipo Nombre Descripción
Implementaciones KubernetesNode
Implementaciones NetworkAttachable
Implementaciones Node
Campo id (ID!) Identificador único a nivel mundial para este nodo de trabajo.
Campo networkAttachments (NetworkAttachmentConnection)

Conexiones de red para este nodo bare metal.
Argumentos a favor de networkAttachments

  • ( after``String ) — Cursor desde el que comenzar la recuperación.
  • first (Int) — Número máximo de elementos que se van a devolver.
Campo region (Region)

Tipos de interfaz

Los tipos de interfaz definen campos comunes que se comparten entre varios tipos de objetos concretos.

KubernetesNode

Un servidor Kubernetes Node ejecuta tu carga de trabajo.

Campos para KubernetesNode
Tipo Nombre Descripción
Implementación KubernetesNode
Implementación VPCBareMetalKubernetesNode
Campo id (ID!) Identificador único del recurso.
Campo region (Region)

Ubicación

Una sección del catálogo de IBM Cloud.

Campos de ubicación
Tipo Nombre Descripción
Implementación Location
Implementación Region
Campo displayName (String) Nombre traducido de esta ubicación.
Campo id (ID!) El identificador de esta ubicación.
Campo name (String) Nombre de esta ubicación.

NetworkAttachable

Representa una entidad a la que se le pueden conectar interfaces de red.

Campos para NetworkAttachable
Tipo Nombre Descripción
Implementación NetworkAttachable
Campo id (ID!) Identificador único a nivel mundial para este nodo.
Campo networkAttachments (NetworkAttachmentConnection)

Conexiones de red asociadas a este nodo.
Argumentos a favor de networkAttachments

  • ( after``String ) — Cursor desde el que comenzar la recuperación.
  • first (Int) — Número máximo de elementos que se van a devolver.

NetworkAttachment

Representa una conexión de interfaz de red a un nodo.

Campos para NetworkAttachment
Tipo Nombre Descripción
Implementación BareMetalNetworkAttachmentByVLAN
Implementación NetworkAttachment
Campo attachedTo (NetworkAttachable!) El nodo al que está conectada esta interfaz de red.
Campo virtualNetworkInterface (VirtualNetworkInterface!) La interfaz de red virtual que está conectada.

Node

Recupera un objeto a partir de su ID.

Campos para Node
Tipo Nombre Descripción
Implementación KubernetesCluster
Implementación KubernetesNode
Implementación NetworkAttachable
Implementación Node
Implementación Region
Implementación ResourceGroup
Implementación SatelliteConnector
Implementación SatelliteLocation
Implementación VPCBareMetalKubernetesNode
Campo id (ID!) El identificador de objeto único a nivel mundial.

VirtualNetworkInterface

Representa una interfaz de red virtual en IBM Cloud VPC. Se pueden asociar a instancias de servidor físico o virtual.

Campos para VirtualNetworkInterface
Tipo Nombre Descripción
Implementación BareMetalVirtualNetworkInterface
Implementación VirtualNetworkInterface
Campo autoDelete (Boolean) Si la VNI debe eliminarse automáticamente al desconectarse.
Campo externalID (String!) El ID de recurso VPC de esta interfaz de red virtual.
Campo macAddress (MACAddress) Dirección MAC asignada a esta interfaz de red.
Campo name (String) Nombre legible para el usuario del VNI.
Campo primaryIPAddress (IPv4Address) Dirección IPv4 principal asignada a esta interfaz de red.
Campo securityGroups (SecurityGroupConnection)

Grupos de seguridad aplicados a esta interfaz de red.
Argumentos a favor de securityGroups

  • ( after``String ) — Cursor desde el que comenzar la recuperación.
  • first (Int) — Número máximo de elementos que se van a devolver.
Campo subnet (Subnet!) La subred de VPC a la que está conectada esta interfaz de red.

Tipos de entrada

Los tipos de entrada se utilizan como argumentos para las mutaciones. Los campos marcados como (obligatorios) deben rellenarse.

AddVirtualNetworkInterfaceToBareMetalNodeInput

Instrucciones para añadir un VNI a un nodo bare metal.

Campos de entrada para AddVirtualNetworkInterfaceToBareMetalNodeInput
Tipo Nombre Descripción
Campo autoDelete (Boolean) Si se debe eliminar automáticamente el VNI de la VPC cuando se desvincula. El valor predeterminado es false si no se especifica.
Campo cluster (ID) ID de clúster. Se debe especificar o bien el clúster o bien el nodo, pero no ambos. Si solo se especifica el clúster, se seleccionará automáticamente un nodo y el archivo adjunto quedará sin asignar.
Campo node (ID) Node ID. Se debe especificar o bien el clúster o bien el nodo, pero no ambos. Si se especifica, crea un archivo adjunto no flotante a este nodo concreto.
Campo virtualNetworkInterfaceID (String!) (obligatorio) El ID de recurso VPC de la interfaz de red virtual que se va a conectar.
Campo vlanID (Int!) (obligatorio) ID de VLAN del archivo adjunto (2-500). La VLAN 1 está reservada para la interfaz de red principal.

CreateSatelliteConnectorInput

Datos necesarios para configurar un conector de Satellite.

Campos de entrada para CreateSatelliteConnectorInput
Tipo Nombre Descripción
Campo name (String!) (obligatorio) Nombre del recurso.
Campo regionName (String!) (obligatorio) El nombre de la región que indica desde dónde debe gestionarse el nuevo conector.
Campo resourceGroupID (String!) (obligatorio) El ID del grupo de recursos en el que se va a realizar el aprovisionamiento.

ReinitializeKubernetesNodeInput

Tipo de contenido para reinitializeKubernetesNode.

Campos de entrada para ReinitializeKubernetesNodeInput
Tipo Nombre Descripción
Campo bypassUnhealthyControlPlane (Boolean) Establece este valor en true para continuar con la reinicialización, incluso cuando el plano de control del clúster no esté en buen estado.
Campo id (ID!) (obligatorio) Kubernetes nodo que se debe reiniciar.

RemoveSatelliteConnectorInput

Tipo de contenido para removeSatelliteConnector.

Campos de entrada para RemoveSatelliteConnectorInput
Tipo Nombre Descripción
Campo id (ID!) (obligatorio) Satellite ID del conector que se va a eliminar.

RemoveVirtualNetworkInterfaceFromNodeInput

Instrucciones para eliminar un VNI de un nodo.

Campos de entrada para RemoveVirtualNetworkInterfaceFromNodeInput
Tipo Nombre Descripción
Campo cluster (ID) ID de clúster. Se debe especificar o bien el clúster o bien el nodo, pero no ambos.
Campo node (ID) Node ID. Se debe especificar o bien el clúster o bien el nodo, pero no ambos.
Campo virtualNetworkInterfaceID (String!) (obligatorio) El ID de recurso VPC de la interfaz de red virtual que se va a eliminar.

UpdateSatelliteLocationInput

Tipo de contenido para updateSatelliteLocation.

Campos de entrada para UpdateSatelliteLocationInput
Tipo Nombre Descripción
Campo description (String)
Campo id (ID!) (obligatorio) Satellite ID de ubicación que se debe actualizar.
Campo name (String)

Tipos de enumeración

Los tipos enum definen el conjunto de valores de cadena permitidos para un campo.

SatelliteConnectorState

El estado administrativo de un conector de Satellite.

Se prevé que estos valores aumenten en el futuro. Durante el procesamiento, comprueba si hay valores desconocidos y regístralos. Opcionalmente, detener el procesamiento y mostrar el error, o bien omitir el conector Satellite en el que se ha detectado el valor inesperado.

Valores de SatelliteConnectorState
Tipo Nombre Descripción
Valor CREATED El conector ha finalizado el proceso de aprovisionamiento y está listo para su uso.
Valor CREATING El conector se está configurando y es posible que aún no esté listo para su uso.
Valor DELETING El conector se está desactivando y es posible que no esté disponible.
Valor FAILED La última operación del conector ha fallado y es necesario eliminarlo para continuar.

Tipos escalares

Los tipos escalares son valores hoja primitivos en el esquema GraphQL.

CloudResourceName

Un nombre de recurso de nube (CRN) identifica de forma exclusiva los recursos de IBM Cloud. Un CRN se utiliza para especificar un recurso de forma inequívoca y con garantía de que es globalmente exclusivo.

DateTime

Un DateTime es una combinación de fecha y hora que cumple con la norma RFC3339.

IPv4Address

IPv4 Dirección en notación decimal con puntos (p. ej., 192.168.1.1 ).

Dirección MAC

Dirección MAC en notación hexadecimal con dos puntos (p. ej., 00:1A:2B:3C:4D:5E ).

Consultas internas

Las siguientes consultas son solo para uso interno y no están disponibles para usuarios externos. Se recogen aquí con el fin de completar la información.

globalSearchSatelliteConnectorAccounts

Resultados de búsqueda global para el servicio de búsqueda global de IBM. Solo para uso interno.

Valores devueltos y argumentos de globalSearchSatelliteConnectorAccounts
Tipo Nombre Descripción
Devuelve GlobalSearchSatelliteConnectorAccountsConnection
Argumento after (String)
Argumento first (Int)
Argumento last (Int)
Argumento before (String)
Argumento regionName (String!) (obligatorio)

Solicitud de ejemplo

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"
  }
}'

Respuesta de ejemplo

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