IBM Cloud Kubernetes Service GraphQL Referência da API

A API do IBM Cloud Kubernetes Service GraphQL está disponível em https://containers.cloud.ibm.com/graphql. Use esta API para gerenciar conectores do Satellite, clusters do Kubernetes e nós de trabalho bare metal por meio de programação.

Esta página foi gerada automaticamente a partir do esquema ativo.

Consultas

As consultas recuperam dados sem modificar nenhum recurso. Envie uma solicitação do tipo POST para https://containers.cloud.ibm.com/graphql , incluindo sua consulta no corpo da solicitação.

node

Encontre um Node para o ID fornecido. Use fragmentos para selecionar campos adicionais.

Tipo Nome Descrição
Retorno Node
Argumento id (ID!) (obrigatório) O identificador globalmente único do nó.
{: caption="Retornos e argumentos da função node" caption-side="bottom"}

Exemplo de solicitação

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

Exemplo de resposta

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

satelliteConnectors

Liste os conectores do Satellite aos quais você tem acesso.

Retornos e argumentos para satelliteConnectors
Tipo Nome Descrição
Retorno SatelliteConnectorConnection
Argumento after (String) Retorne os conectores Satellite após este cursor.
Argumento first (Int) Retorne os primeiros N conectores do tipo “ Satellite ”.
Argumento last (Int) Retorna os últimos N conectores “ Satellite ”.
Argumento before (String) Retorne os conectores Satellite anteriores a este cursor.

Exemplo de solicitação

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

Exemplo de resposta

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

Mutações

As mutações criam, atualizam ou excluem recursos. Cada mutação requer um token de portador IAM no cabeçalho Authorization .

addVirtualNetworkInterfaceToBareMetalNode

Adiciona uma interface de rede virtual (VNI) a um nó de trabalho do Kubernetes em bare metal.

Retornos e argumentos para addVirtualNetworkInterfaceToBareMetalNode
Tipo Nome Descrição
Retorno AddVirtualNetworkInterfaceToBareMetalNodePayload
Argumento input (AddVirtualNetworkInterfaceToBareMetalNodeInput!) (obrigatório) Parâmetros de entrada para adicionar o VNI a um nó bare metal.

Exemplo de solicitação

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

Exemplo de resposta

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

createSatelliteConnector

Crie um conector do Satellite.

Retornos e argumentos para createSatelliteConnector
Tipo Nome Descrição
Retorno CreateSatelliteConnectorPayload
Argumento input (CreateSatelliteConnectorInput)

Exemplo de solicitação

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

Exemplo de resposta

{
  "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 um nó do Kubernetes. Atualmente, não é compatível com instâncias de servidor virtual VPC.

Retornos e argumentos para reinitializeKubernetesNode
Tipo Nome Descrição
Retorno ReinitializeKubernetesNodePayload
Argumento input (ReinitializeKubernetesNodeInput)

Exemplo de solicitação

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

Exemplo de resposta

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

removeSatelliteConnector

Remova um conector “ Satellite ”.

Retornos e argumentos para removeSatelliteConnector
Tipo Nome Descrição
Retorno RemoveSatelliteConnectorPayload
Argumento input (RemoveSatelliteConnectorInput)

Exemplo de solicitação

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

Exemplo de resposta

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

Remove uma interface de rede virtual de um nó de trabalho do Kubernetes.

Retornos e argumentos para removeVirtualNetworkInterfaceFromNode
Tipo Nome Descrição
Retorno RemoveVirtualNetworkInterfaceFromNodePayload
Argumento input (RemoveVirtualNetworkInterfaceFromNodeInput!) (obrigatório) Parâmetros de entrada para remover o VNI de um nó.

Exemplo de solicitação

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

Exemplo de resposta

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

Atualizar um local no Satellite.

Retornos e argumentos para updateSatelliteLocation
Tipo Nome Descrição
Retorno UpdateSatelliteLocationPayload
Argumento input (UpdateSatelliteLocationInput)

Exemplo de solicitação

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

Exemplo de resposta

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

Tipos de objeto

Os tipos de objeto representam os recursos concretos e as cargas úteis das respostas retornadas pela API.

Conta

Uma conta do IBM Cloud.

Campos da conta
Tipo Nome Descrição
Campo externalID (String!) O ID do IBM Cloud da conta.

AddVirtualNetworkInterfaceToBareMetalNodePayload

Carga útil da resposta para adicionar um VNI a um nó bare metal.

Campos para AddVirtualNetworkInterfaceToBareMetalNodePayload
Tipo Nome Descrição
Campo networkAttachment (NetworkAttachment!) A conexão de rede criada, com suas propriedades.

BareMetalNetworkAttachmentByVLAN

Conexão de rede para nós bare metal por meio de marcação de VLAN.

Campos para BareMetalNetworkAttachmentByVLAN
Tipo Nome Descrição
Implementa NetworkAttachment
Campo attachedTo (NetworkAttachable!) O nó bare metal ao qual essa interface está conectada.
Campo canFloat (Boolean!) Se esse anexo pode flutuar entre os nós do cluster.
Campo virtualNetworkInterface (VirtualNetworkInterface!) A interface de rede virtual que está conectada.
Campo vlanID (Int) ID da VLAN utilizada para esta conexão (2-500). Nulo se ainda não tiver sido atribuído.

BareMetalVirtualNetworkInterface

Interface de rede virtual conectada a um servidor bare metal.

Campos para BareMetalVirtualNetworkInterface
Tipo Nome Descrição
Implementa VirtualNetworkInterface
Campo autoDelete (Boolean) Se o VNI deve ser excluído automaticamente ao ser desconectado.
Campo externalID (String!) O ID do recurso VPC deste VNI.
Campo macAddress (MACAddress) Endereço MAC atribuído a esta interface de rede.
Campo name (String) Nome legível para o ser humano do VNI.
Campo primaryIPAddress (IPv4Address) Endereço primário de “ IPv4 ” atribuído a esta interface de rede.
Campo securityGroups (SecurityGroupConnection)

Grupos de segurança aplicados a esta interface de rede.
Argumentos para securityGroups

  • after (String) — Cursor a partir do qual iniciar a recuperação.
  • first (Int) — Número máximo de itens a serem retornados.
Campo subnet (Subnet!) A sub-rede VPC à qual esta interface de rede está conectada.

CreateSatelliteConnectorPayload

Tipo de saída para createSatelliteConnector.

Campos para CreateSatelliteConnectorPayload
Tipo Nome Descrição
Campo satelliteConnector (SatelliteConnector) O novo SatelliteConnector.

KubernetesCluster

Um cluster de serviços do IBM Cloud Kubernetes Service ou IBM Cloud OpenShift.

Campos para KubernetesCluster
Tipo Nome Descrição
Implementa Node
Campo id (ID!) O identificador exclusivo do cluster.
Campo name (String) O nome do cluster.
Campo networkAttachments (NetworkAttachmentConnection)

Conexões de rede para este cluster (se aplicável).
Argumentos para networkAttachments

  • after (String) — Cursor a partir do qual iniciar a recuperação.
  • first (Int) — Número máximo de itens a serem retornados.
Campo region (Region) A região do catálogo “ IBM Cloud ” do cluster.

Região

Uma região do catálogo “ IBM Cloud ”.

Campos para a região
Tipo Nome Descrição
Implementa Location
Implementa Node
Campo displayName (String) O nome traduzido desta região.
Campo id (ID!) O ID desta região.
Campo name (String) O nome dessa região.

ReinitializeKubernetesNodePayload

Tipo de saída para reinitializeKubernetesNode.

Campos para ReinitializeKubernetesNodePayload
Tipo Nome Descrição
Campo node (KubernetesNode) Reinicializando o nó Kubernetes.

RemoveSatelliteConnectorPayload

Tipo de saída para removeSatelliteConnector.

Campos para RemoveSatelliteConnectorPayload
Tipo Nome Descrição
Campo satelliteConnector (SatelliteConnector) O link removido SatelliteConnector.

RemoveVirtualNetworkInterfaceFromNodePayload

Carga útil da resposta para remover um VNI de um nó.

Campos para RemoveVirtualNetworkInterfaceFromNodePayload
Tipo Nome Descrição
Campo cluster (KubernetesCluster!) O cluster do qual o VNI foi removido.
Campo node (NetworkAttachable!) O nó do qual o VNI foi removido.
Campo virtualNetworkInterface (VirtualNetworkInterface!) A interface de rede virtual que foi removida.

ResourceGroup

Um “ ResourceGroup ” é uma forma de organizar os recursos da sua conta em grupos personalizáveis, para que você possa atribuir rapidamente aos usuários acesso a vários recursos de uma só vez.

Campos para ResourceGroup
Tipo Nome Descrição
Implementa Node
Campo externalID (String!) O ID “ IBM Cloud ” do grupo de recursos.
Campo id (ID!) O ID “ Node ” do grupo de recursos.
Campo name (String) O nome do grupo de recursos.

SatelliteConnector

Um conector do Satellite fornece uma conexão segura entre um local remoto específico e IBM Cloud.

Campos para SatelliteConnector
Tipo Nome Descrição
Implementa Node
Campo createdDate (DateTime) A data em que este recurso foi criado.
Campo crn (CloudResourceName) O CRN do recurso: IBM Cloud.
Campo id (ID!) O identificador exclusivo do recurso.
Campo name (String!) O nome do recurso.
Campo region (Region) A região a partir da qual o recurso é administrado.
Campo resourceGroup (ResourceGroup) O grupo de recursos que contém este recurso.
Campo state (SatelliteConnectorState) A situação atual deste recurso.

SatelliteLocation

Uma unidade da rede “ Satellite ”.

Campos para SatelliteLocation
Tipo Nome Descrição
Implementa Node
Campo description (String) Descrição do local.
Campo id (ID!) O identificador exclusivo do recurso.
Campo name (String) O nome do local.

SecurityGroup

Representa um grupo de segurança da VPC.

Campos para SecurityGroup
Tipo Nome Descrição
Campo externalID (String!) O ID do recurso VPC deste grupo de segurança.

Sub-rede

Representa uma sub-rede da VPC.

Campos para sub-rede
Tipo Nome Descrição
Campo externalID (String!) O ID do recurso VPC desta sub-rede.

UpdateSatelliteLocationPayload

Tipo de saída para updateSatelliteLocation.

Campos para UpdateSatelliteLocationPayload
Tipo Nome Descrição
Campo satelliteLocation (SatelliteLocation) A versão atualizada do SatelliteLocation.

VPCBareMetalKubernetesNode

Representa um nó de trabalho “bare metal” do Kubernetes no IBM Cloud VPC.

Campos para VPCBareMetalKubernetesNode
Tipo Nome Descrição
Implementa KubernetesNode
Implementa NetworkAttachable
Implementa Node
Campo id (ID!) Identificador global único para este nó de trabalho.
Campo networkAttachments (NetworkAttachmentConnection)

Conexões de rede para este nó bare metal.
Argumentos para networkAttachments

  • after (String) — Cursor a partir do qual iniciar a recuperação.
  • first (Int) — Número máximo de itens a serem retornados.
Campo region (Region)

Tipos de interface

Os tipos de interface definem campos comuns que são compartilhados entre vários tipos de objetos concretos.

KubernetesNode

Um servidor Kubernetes Node executa sua carga de trabalho.

Campos para KubernetesNode
Tipo Nome Descrição
implementação KubernetesNode
implementação VPCBareMetalKubernetesNode
Campo id (ID!) O identificador exclusivo do recurso.
Campo region (Region)

Local

Um local do catálogo da IBM Cloud.

Campos para localização
Tipo Nome Descrição
implementação Location
implementação Region
Campo displayName (String) Nome traduzido deste local.
Campo id (ID!) O ID deste local.
Campo name (String) Nome deste local.

NetworkAttachable

Representa uma entidade à qual podem estar conectadas interfaces de rede.

Campos para NetworkAttachable
Tipo Nome Descrição
implementação NetworkAttachable
Campo id (ID!) Identificador global único para este nó.
Campo networkAttachments (NetworkAttachmentConnection)

Conexões de rede associadas a este nó.
Argumentos para networkAttachments

  • after (String) — Cursor a partir do qual iniciar a recuperação.
  • first (Int) — Número máximo de itens a serem retornados.

NetworkAttachment

Representa uma conexão de interface de rede a um nó.

Campos para NetworkAttachment
Tipo Nome Descrição
implementação BareMetalNetworkAttachmentByVLAN
implementação NetworkAttachment
Campo attachedTo (NetworkAttachable!) O nó ao qual esta interface de rede está conectada.
Campo virtualNetworkInterface (VirtualNetworkInterface!) A interface de rede virtual que está conectada.

Node

Recupera um objeto a partir de seu ID.

Campos para Node
Tipo Nome Descrição
implementação KubernetesCluster
implementação KubernetesNode
implementação NetworkAttachable
implementação Node
implementação Region
implementação ResourceGroup
implementação SatelliteConnector
implementação SatelliteLocation
implementação VPCBareMetalKubernetesNode
Campo id (ID!) O ID do objeto, único em todo o mundo.

VirtualNetworkInterface

Representa uma interface de rede virtual no IBM Cloud VPC. Pode ser conectado a instâncias de servidor físico ou virtual.

Campos para VirtualNetworkInterface
Tipo Nome Descrição
implementação BareMetalVirtualNetworkInterface
implementação VirtualNetworkInterface
Campo autoDelete (Boolean) Se o VNI deve ser excluído automaticamente ao ser desconectado.
Campo externalID (String!) O ID do recurso VPC desta interface de rede virtual.
Campo macAddress (MACAddress) Endereço MAC atribuído a esta interface de rede.
Campo name (String) Nome legível para o ser humano do VNI.
Campo primaryIPAddress (IPv4Address) Endereço primário de “ IPv4 ” atribuído a esta interface de rede.
Campo securityGroups (SecurityGroupConnection)

Grupos de segurança aplicados a esta interface de rede.
Argumentos para securityGroups

  • after (String) — Cursor a partir do qual iniciar a recuperação.
  • first (Int) — Número máximo de itens a serem retornados.
Campo subnet (Subnet!) A sub-rede VPC à qual esta interface de rede está conectada.

Tipos de entrada

Os tipos de entrada são usados como argumentos para mutações. Os campos marcados (obrigatórios) devem ser preenchidos.

AddVirtualNetworkInterfaceToBareMetalNodeInput

Dados necessários para adicionar um VNI a um nó bare metal.

Campos de entrada para AddVirtualNetworkInterfaceToBareMetalNodeInput
Tipo Nome Descrição
Campo autoDelete (Boolean) Se o VNI deve ser excluído automaticamente da VPC quando for desanexado. O valor padrão é “false” se não for especificado.
Campo cluster (ID) ID do cluster. É necessário especificar o cluster ou o nó, mas não ambos. Se apenas o cluster for especificado, um nó será selecionado automaticamente e o anexo ficará flutuante.
Campo node (ID) Node ID. É necessário especificar o cluster ou o nó, mas não ambos. Se especificado, cria um anexo não flutuante a este nó específico.
Campo virtualNetworkInterfaceID (String!) (obrigatório) O ID do recurso VPC da interface de rede virtual a ser conectada.
Campo vlanID (Int!) (obrigatório) ID da VLAN para a conexão (2-500). A VLAN 1 está reservada para a interface de rede principal.

CreateSatelliteConnectorInput

Informações necessárias para configurar um Conector do Satellite.

Campos de entrada para CreateSatelliteConnectorInput
Tipo Nome Descrição
Campo name (String!) (obrigatório) O nome do recurso.
Campo regionName (String!) (obrigatório) O nome da região que indica de onde o novo conector deve ser gerenciado.
Campo resourceGroupID (String!) (obrigatório) O ID do grupo de recursos a ser provisionado.

ReinitializeKubernetesNodeInput

Tipo de entrada para reinitializeKubernetesNode.

Campos de entrada para ReinitializeKubernetesNodeInput
Tipo Nome Descrição
Campo bypassUnhealthyControlPlane (Boolean) Defina como “true” para prosseguir com a reinicialização, mesmo quando o plano de controle do cluster estiver com falhas.
Campo id (ID!) (obrigatório) Kubernetes nó a ser reinicializado.

RemoveSatelliteConnectorInput

Tipo de entrada para removeSatelliteConnector.

Campos de entrada para RemoveSatelliteConnectorInput
Tipo Nome Descrição
Campo id (ID!) (obrigatório) Satellite ID do conector a ser removido.

RemoveVirtualNetworkInterfaceFromNodeInput

Entrada para remover um VNI de um nó.

Campos de entrada para RemoveVirtualNetworkInterfaceFromNodeInput
Tipo Nome Descrição
Campo cluster (ID) ID do cluster. É necessário especificar o cluster ou o nó, mas não ambos.
Campo node (ID) Node ID. É necessário especificar o cluster ou o nó, mas não ambos.
Campo virtualNetworkInterfaceID (String!) (obrigatório) O ID do recurso VPC da interface de rede virtual a ser removida.

UpdateSatelliteLocationInput

Tipo de entrada para updateSatelliteLocation.

Campos de entrada para UpdateSatelliteLocationInput
Tipo Nome Descrição
Campo description (String)
Campo id (ID!) (obrigatório) Satellite ID do local a ser atualizado.
Campo name (String)

Tipos de enumeração

Os tipos de enumeração definem o conjunto de valores de string permitidos para um campo.

SatelliteConnectorState

O estado administrativo de um Conector do Satellite.

Espera-se que esses valores aumentem no futuro. Durante o processamento, verifique se há valores desconhecidos e registre-os. Opcionalmente, interrompa o processamento e exiba o erro, ou ignore o conector “ Satellite ” no qual o valor inesperado foi encontrado.

Valores para SatelliteConnectorState
Tipo Nome Descrição
Valor CREATED O conector concluiu o provisionamento e está pronto para uso.
Valor CREATING O conector está em processo de provisionamento e pode não estar pronto para uso.
Valor DELETING O conector está sendo desativado e pode ficar indisponível.
Valor FAILED A operação mais recente do conector falhou e ele precisa ser excluído para que seja possível continuar.

Tipos escalares

Os tipos escalares são valores folha primitivos no esquema GraphQL.

CloudResourceName

Um Cloud Resource Name (CRN) identifica com exclusividade os recursos da IBM Cloud. Um CRN é usado para especificar um recurso de maneira inequívoca, garantindo que seja globalmente exclusivo.

DateTime

Um DateTime é uma combinação de data e hora em conformidade com a norma RFC3339.

IPv4Address

IPv4 endereço na notação decimal com pontos (por exemplo, 192.168.1.1 ).

MACAddress

Endereço MAC na notação hexadecimal com dois pontos (por exemplo, 00:1A:2B:3C:4D:5E ).

Consultas internas

As consultas a seguir destinam-se exclusivamente ao uso interno e não são oferecidas a usuários externos. Eles estão documentados aqui para fins de exaustividade.

globalSearchSatelliteConnectorAccounts

Resultados pesquisáveis globalmente para o serviço de Pesquisa Global do IBM. Somente utilização interno.

Retornos e argumentos para globalSearchSatelliteConnectorAccounts
Tipo Nome Descrição
Retorno GlobalSearchSatelliteConnectorAccountsConnection
Argumento after (String)
Argumento first (Int)
Argumento last (Int)
Argumento before (String)
Argumento regionName (String!) (obrigatório)

Exemplo de solicitação

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

Exemplo de resposta

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