IBM Cloud Kubernetes Service GraphQL Riferimento API
L'API " IBM Cloud Kubernetes Service " ( GraphQL ) è disponibile all'indirizzo https://containers.cloud.ibm.com/graphql. Utilizza questa API per gestire in modo programmatico i connettori di Satellite, i cluster di Kubernetes
e i nodi di lavoro bare metal.
Questa pagina è generata automaticamente dallo schema in tempo reale.
Query
Le query recuperano i dati senza modificare alcuna risorsa. Invia una richiesta POST all'indirizzo https://containers.cloud.ibm.com/graphql, inserendo la tua richiesta nel corpo della richiesta.
node
Trova un " Node " corrispondente all'ID specificato. Utilizza i frammenti per selezionare campi aggiuntivi.
| Immettere | Nome | Descrizione |
|---|---|---|
| Restituzioni | Node |
|
| Argomento | id (ID!) (obbligatorio) |
L'identificatore univoco a livello globale del nodo. |
Richiesta di esempio
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"
}
}'
Risposta di esempio
{
"data": {
"node": "<Node>"
}
}
satelliteConnectors
Elenca i connettori di Satellite a cui hai accesso.
| Immettere | Nome | Descrizione |
|---|---|---|
| Restituzioni | SatelliteConnectorConnection |
|
| Argomento | after (String) |
Restituisce i connettori " Satellite " dopo questo cursore. |
| Argomento | first (Int) |
Restituisce i primi N connettori “ Satellite ”. |
| Argomento | last (Int) |
Restituisce gli ultimi N connettori " Satellite ". |
| Argomento | before (String) |
Restituisce i connettori " Satellite " presenti prima di questo cursore. |
Richiesta di esempio
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"
}
}'
Risposta di esempio
{
"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"
}
}
}
}
Mutazioni
Le mutazioni creano, aggiornano o eliminano risorse. Ogni mutazione richiede un token IAM nell'intestazione " Authorization ".
addVirtualNetworkInterfaceToBareMetalNode
Aggiunge un'interfaccia di rete virtuale (VNI) a un nodo di lavoro bare metal di Kubernetes.
| Immettere | Nome | Descrizione |
|---|---|---|
| Restituzioni | AddVirtualNetworkInterfaceToBareMetalNodePayload |
|
| Argomento | input (AddVirtualNetworkInterfaceToBareMetalNodeInput!) (obbligatorio) |
Parametri di input per l'aggiunta del VNI a un nodo bare metal. |
Richiesta di esempio
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>"
}
}'
Risposta di esempio
{
"data": {
"addVirtualNetworkInterfaceToBareMetalNode": {
"networkAttachment": "<NetworkAttachment>"
}
}
}
createSatelliteConnector
Creare un connettore Satellite.
| Immettere | Nome | Descrizione |
|---|---|---|
| Restituzioni | CreateSatelliteConnectorPayload |
|
| Argomento | input (CreateSatelliteConnectorInput) |
Richiesta di esempio
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>"
}
}'
Risposta di esempio
{
"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
Reinizializza un nodo Kubernetes. Al momento non è supportato sulle istanze di server virtuali VPC.
| Immettere | Nome | Descrizione |
|---|---|---|
| Restituzioni | ReinitializeKubernetesNodePayload |
|
| Argomento | input (ReinitializeKubernetesNodeInput) |
Richiesta di esempio
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>"
}
}'
Risposta di esempio
{
"data": {
"reinitializeKubernetesNode": {
"node": "<KubernetesNode>"
}
}
}
removeSatelliteConnector
Rimuovere un connettore " Satellite ".
| Immettere | Nome | Descrizione |
|---|---|---|
| Restituzioni | RemoveSatelliteConnectorPayload |
|
| Argomento | input (RemoveSatelliteConnectorInput) |
Richiesta di esempio
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>"
}
}'
Risposta di esempio
{
"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
Rimuove un'interfaccia di rete virtuale da un nodo di lavoro di un cluster Kubernetes.
| Immettere | Nome | Descrizione |
|---|---|---|
| Restituzioni | RemoveVirtualNetworkInterfaceFromNodePayload |
|
| Argomento | input (RemoveVirtualNetworkInterfaceFromNodeInput!) (obbligatorio) |
Parametri di input per la rimozione del VNI da un nodo. |
Richiesta di esempio
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>"
}
}'
Risposta di esempio
{
"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
Aggiornare una sede di Satellite.
| Immettere | Nome | Descrizione |
|---|---|---|
| Restituzioni | UpdateSatelliteLocationPayload |
|
| Argomento | input (UpdateSatelliteLocationInput) |
Richiesta di esempio
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>"
}
}'
Risposta di esempio
{
"data": {
"updateSatelliteLocation": {
"satelliteLocation": {
"description": "example-value",
"id": "abc123",
"name": "example-value"
}
}
}
}
Tipi di oggetto
I tipi di oggetto rappresentano le risorse concrete e i payload di risposta restituiti dall'API.
Account
Un account IBM Cloud.
| Immettere | Nome | Descrizione |
|---|---|---|
| Campo | externalID (String!) |
L'ID IBM Cloud dell'account. |
AddVirtualNetworkInterfaceToBareMetalNodePayload
Payload di risposta per l'aggiunta di un VNI a un nodo bare metal.
| Immettere | Nome | Descrizione |
|---|---|---|
| Campo | networkAttachment (NetworkAttachment!) |
Il collegamento di rete creato con le relative proprietà. |
BareMetalNetworkAttachmentByVLAN
Collegamento alla rete per nodi bare metal tramite tagging VLAN.
| Immettere | Nome | Descrizione |
|---|---|---|
| Implementa | NetworkAttachment |
|
| Campo | attachedTo (NetworkAttachable!) |
Il nodo bare metal a cui è collegata questa interfaccia. |
| Campo | canFloat (Boolean!) |
Se questo allegato possa passare da un nodo all'altro all'interno del cluster. |
| Campo | virtualNetworkInterface (VirtualNetworkInterface!) |
L'interfaccia di rete virtuale collegata. |
| Campo | vlanID (Int) |
ID VLAN utilizzato per questa connessione (2-500). Null se non è stato ancora assegnato. |
BareMetalVirtualNetworkInterface
Interfaccia di rete virtuale collegata a un server bare metal.
| Immettere | Nome | Descrizione |
|---|---|---|
| Implementa | VirtualNetworkInterface |
|
| Campo | autoDelete (Boolean) |
Se il VNI debba essere eliminato automaticamente quando viene scollegato. |
| Campo | externalID (String!) |
L'ID della risorsa VPC di questo VNI. |
| Campo | macAddress (MACAddress) |
Indirizzo MAC assegnato a questa interfaccia di rete. |
| Campo | name (String) |
Nome leggibile dal utente del VNI. |
| Campo | primaryIPAddress (IPv4Address) |
Indirizzo IPv4 primario assegnato a questa interfaccia di rete. |
| Campo | securityGroups (SecurityGroupConnection) |
Gruppi di sicurezza applicati a questa interfaccia di rete.
|
| Campo | subnet (Subnet!) |
La sottorete VPC a cui è collegata questa interfaccia di rete. |
CreateSatelliteConnectorPayload
Tipo di output per createSatelliteConnector.
| Immettere | Nome | Descrizione |
|---|---|---|
| Campo | satelliteConnector (SatelliteConnector) |
Il nuovo SatelliteConnector. |
KubernetesCluster
Un cluster di servizi IBM Cloud Kubernetes Service o IBM Cloud OpenShift.
| Immettere | Nome | Descrizione |
|---|---|---|
| Implementa | Node |
|
| Campo | id (ID!) |
L'identificatore univoco del cluster. |
| Campo | name (String) |
Il nome del cluster. |
| Campo | networkAttachments (NetworkAttachmentConnection) |
Connessioni di rete per questo cluster (se presenti).
|
| Campo | region (Region) |
La regione del catalogo " IBM Cloud " del cluster. |
Regione
Una regione del catalogo “ IBM Cloud ”.
| Immettere | Nome | Descrizione |
|---|---|---|
| Implementa | Location |
|
| Implementa | Node |
|
| Campo | displayName (String) |
Il nome tradotto di questa regione. |
| Campo | id (ID!) |
L'ID di questa regione. |
| Campo | name (String) |
Il nome di questa regione. |
ReinitializeKubernetesNodePayload
Tipo di output per reinitializeKubernetesNode.
| Immettere | Nome | Descrizione |
|---|---|---|
| Campo | node (KubernetesNode) |
Il nodo Kubernetes in fase di reinizializzazione. |
RemoveSatelliteConnectorPayload
Tipo di output per removeSatelliteConnector.
| Immettere | Nome | Descrizione |
|---|---|---|
| Campo | satelliteConnector (SatelliteConnector) |
Il sito SatelliteConnector è stato rimosso. |
RemoveVirtualNetworkInterfaceFromNodePayload
Payload di risposta per la rimozione di un VNI da un nodo.
| Immettere | Nome | Descrizione |
|---|---|---|
| Campo | cluster (KubernetesCluster!) |
Il cluster da cui è stato rimosso il VNI. |
| Campo | node (NetworkAttachable!) |
Il nodo dal quale è stato rimosso il VNI. |
| Campo | virtualNetworkInterface (VirtualNetworkInterface!) |
L'interfaccia di rete virtuale che è stata rimossa. |
ResourceGroup
Un " ResourceGroup " è uno strumento che ti permette di organizzare le risorse del tuo account in gruppi personalizzabili, in modo da poter assegnare rapidamente agli utenti l'accesso a più risorse contemporaneamente.
| Immettere | Nome | Descrizione |
|---|---|---|
| Implementa | Node |
|
| Campo | externalID (String!) |
L'ID " IBM Cloud " del gruppo di risorse. |
| Campo | id (ID!) |
L'ID " Node " del gruppo di risorse. |
| Campo | name (String) |
Il nome del gruppo di risorse. |
SatelliteConnector
Un connettore " Satellite " garantisce una connessione sicura tra una specifica postazione remota e IBM Cloud.
| Immettere | Nome | Descrizione |
|---|---|---|
| Implementa | Node |
|
| Campo | createdDate (DateTime) |
La data di creazione di questa risorsa. |
| Campo | crn (CloudResourceName) |
Il codice CRN della risorsa: IBM Cloud. |
| Campo | id (ID!) |
L'identificatore univoco della risorsa. |
| Campo | name (String!) |
Il nome della risorsa. |
| Campo | region (Region) |
La regione da cui viene gestita la risorsa. |
| Campo | resourceGroup (ResourceGroup) |
Il gruppo di risorse che contiene questa risorsa. |
| Campo | state (SatelliteConnectorState) |
Lo stato attuale di questa risorsa. |
SatelliteLocation
Una sede di " Satellite ".
| Immettere | Nome | Descrizione |
|---|---|---|
| Implementa | Node |
|
| Campo | description (String) |
Descrizione della località. |
| Campo | id (ID!) |
L'identificatore univoco della risorsa. |
| Campo | name (String) |
Il nome della località. |
SecurityGroup
Rappresenta un gruppo di sicurezza VPC.
| Immettere | Nome | Descrizione |
|---|---|---|
| Campo | externalID (String!) |
L'ID della risorsa VPC di questo gruppo di sicurezza. |
Sottorete
Rappresenta una sottorete VPC.
| Immettere | Nome | Descrizione |
|---|---|---|
| Campo | externalID (String!) |
L'ID della risorsa VPC di questa sottorete. |
UpdateSatelliteLocationPayload
Tipo di output per updateSatelliteLocation.
| Immettere | Nome | Descrizione |
|---|---|---|
| Campo | satelliteLocation (SatelliteLocation) |
La versione aggiornata di SatelliteLocation. |
VPCBareMetalKubernetesNode
Rappresenta un nodo di lavoro "bare metal" di Kubernetes in IBM Cloud VPC.
| Immettere | Nome | Descrizione |
|---|---|---|
| Implementa | KubernetesNode |
|
| Implementa | NetworkAttachable |
|
| Implementa | Node |
|
| Campo | id (ID!) |
Identificatore univoco a livello globale per questo nodo di lavoro. |
| Campo | networkAttachments (NetworkAttachmentConnection) |
Connessioni di rete per questo nodo bare metal.
|
| Campo | region (Region) |
Tipi di interfaccia
I tipi di interfaccia definiscono campi comuni condivisi da più tipi di oggetti concreti.
KubernetesNode
Un Kubernetes Node gestisce il tuo carico di lavoro.
| Immettere | Nome | Descrizione |
|---|---|---|
| Implementazione | KubernetesNode |
|
| Implementazione | VPCBareMetalKubernetesNode |
|
| Campo | id (ID!) |
L'identificatore univoco della risorsa. |
| Campo | region (Region) |
Posizione
Una sede del catalogo “ IBM Cloud ”.
| Immettere | Nome | Descrizione |
|---|---|---|
| Implementazione | Location |
|
| Implementazione | Region |
|
| Campo | displayName (String) |
Nome tradotto di questa località. |
| Campo | id (ID!) |
L'ID di questa posizione. |
| Campo | name (String) |
Nome di questa località. |
NetworkAttachable
Rappresenta un'entità a cui possono essere collegate delle interfacce di rete.
| Immettere | Nome | Descrizione |
|---|---|---|
| Implementazione | NetworkAttachable |
|
| Campo | id (ID!) |
Identificatore univoco a livello globale per questo nodo. |
| Campo | networkAttachments (NetworkAttachmentConnection) |
Connessioni di rete associate a questo nodo.
|
NetworkAttachment
Rappresenta il collegamento di un'interfaccia di rete a un nodo.
| Immettere | Nome | Descrizione |
|---|---|---|
| Implementazione | BareMetalNetworkAttachmentByVLAN |
|
| Implementazione | NetworkAttachment |
|
| Campo | attachedTo (NetworkAttachable!) |
Il nodo a cui è collegata questa interfaccia di rete. |
| Campo | virtualNetworkInterface (VirtualNetworkInterface!) |
L'interfaccia di rete virtuale collegata. |
Node
Recupera un oggetto in base al suo ID.
| Immettere | Nome | Descrizione |
|---|---|---|
| Implementazione | KubernetesCluster |
|
| Implementazione | KubernetesNode |
|
| Implementazione | NetworkAttachable |
|
| Implementazione | Node |
|
| Implementazione | Region |
|
| Implementazione | ResourceGroup |
|
| Implementazione | SatelliteConnector |
|
| Implementazione | SatelliteLocation |
|
| Implementazione | VPCBareMetalKubernetesNode |
|
| Campo | id (ID!) |
L'ID univoco dell'oggetto a livello globale. |
VirtualNetworkInterface
Rappresenta un'interfaccia di rete virtuale in IBM Cloud VPC. Può essere associato a istanze su server fisici o virtuali.
| Immettere | Nome | Descrizione |
|---|---|---|
| Implementazione | BareMetalVirtualNetworkInterface |
|
| Implementazione | VirtualNetworkInterface |
|
| Campo | autoDelete (Boolean) |
Se il VNI debba essere eliminato automaticamente quando viene scollegato. |
| Campo | externalID (String!) |
L'ID della risorsa VPC di questa interfaccia di rete virtuale. |
| Campo | macAddress (MACAddress) |
Indirizzo MAC assegnato a questa interfaccia di rete. |
| Campo | name (String) |
Nome leggibile dal utente del VNI. |
| Campo | primaryIPAddress (IPv4Address) |
Indirizzo IPv4 primario assegnato a questa interfaccia di rete. |
| Campo | securityGroups (SecurityGroupConnection) |
Gruppi di sicurezza applicati a questa interfaccia di rete.
|
| Campo | subnet (Subnet!) |
La sottorete VPC a cui è collegata questa interfaccia di rete. |
Tipi di input
I tipi di input vengono utilizzati come argomenti delle mutazioni. I campi contrassegnati con (obbligatorio) devono essere compilati.
AddVirtualNetworkInterfaceToBareMetalNodeInput
Dati di input per l'aggiunta di un VNI a un nodo bare metal.
| Immettere | Nome | Descrizione |
|---|---|---|
| Campo | autoDelete (Boolean) |
Se eliminare automaticamente il VNI dal VPC quando viene scollegato. Se non specificato, il valore predefinito è false. |
| Campo | cluster (ID) |
L'ID cluster. È necessario specificare o il cluster o il nodo, ma non entrambi. Se viene specificato solo il cluster, verrà selezionato automaticamente un nodo e l'attaccamento risulterà fluttuante. |
| Campo | node (ID) |
Node ID. È necessario specificare o il cluster o il nodo, ma non entrambi. Se specificato, crea un collegamento non mobile a questo nodo specifico. |
| Campo | virtualNetworkInterfaceID (String!) (obbligatorio) |
L'ID della risorsa VPC dell'interfaccia di rete virtuale da collegare. |
| Campo | vlanID (Int!) (obbligatorio) |
ID VLAN per la connessione (2-500). La VLAN 1 è riservata all'interfaccia di rete primaria. |
CreateSatelliteConnectorInput
Dati necessari per la configurazione di un connettore Satellite.
| Immettere | Nome | Descrizione |
|---|---|---|
| Campo | name (String!) (obbligatorio) |
Il nome della risorsa. |
| Campo | regionName (String!) (obbligatorio) |
Il nome della regione che indica da dove deve essere gestito il nuovo connettore. |
| Campo | resourceGroupID (String!) (obbligatorio) |
L'ID del gruppo di risorse da configurare al suo interno. |
ReinitializeKubernetesNodeInput
Tipo di input per reinitializeKubernetesNode.
| Immettere | Nome | Descrizione |
|---|---|---|
| Campo | bypassUnhealthyControlPlane (Boolean) |
Impostare su "true" per procedere con la reinizializzazione, anche quando il piano di controllo del cluster non è in condizioni ottimali. |
| Campo | id (ID!) (obbligatorio) |
Kubernetes nodo da reinizializzare. |
RemoveSatelliteConnectorInput
Tipo di input per removeSatelliteConnector.
| Immettere | Nome | Descrizione |
|---|---|---|
| Campo | id (ID!) (obbligatorio) |
Satellite ID del connettore da rimuovere. |
RemoveVirtualNetworkInterfaceFromNodeInput
Dati di input per la rimozione di un VNI da un nodo.
| Immettere | Nome | Descrizione |
|---|---|---|
| Campo | cluster (ID) |
L'ID cluster. È necessario specificare o il cluster o il nodo, ma non entrambi. |
| Campo | node (ID) |
Node ID. È necessario specificare o il cluster o il nodo, ma non entrambi. |
| Campo | virtualNetworkInterfaceID (String!) (obbligatorio) |
L'ID della risorsa VPC dell'interfaccia di rete virtuale da rimuovere. |
UpdateSatelliteLocationInput
Tipo di input per updateSatelliteLocation.
| Immettere | Nome | Descrizione |
|---|---|---|
| Campo | description (String) |
|
| Campo | id (ID!) (obbligatorio) |
Satellite ID posizione da aggiornare. |
| Campo | name (String) |
Tipi enum
I tipi enum definiscono l'insieme dei valori stringa consentiti per un campo.
SatelliteConnectorState
Lo stato amministrativo di un Connector di Satellite.
Si prevede che tali valori aumentino in futuro. Durante l'elaborazione, verificare la presenza di valori sconosciuti e registrarli. A scelta, interrompere l'elaborazione e segnalare l'errore, oppure bypassare il connettore “ Satellite ” in cui è stato rilevato il valore inatteso.
| Immettere | Nome | Descrizione |
|---|---|---|
| Valore | CREATED |
Il connettore ha completato la configurazione ed è pronto per l'uso. |
| Valore | CREATING |
Il connettore è in fase di configurazione e potrebbe non essere ancora pronto per l'uso. |
| Valore | DELETING |
Il connettore è in fase di disattivazione e potrebbe non essere disponibile. |
| Valore | FAILED |
L'ultima operazione eseguita sul connettore non è andata a buon fine ed è necessario eliminarlo per poter proseguire. |
Tipi scalari
I tipi scalari sono valori foglia primitivi nello schema GraphQL.
CloudResourceName
Un CRN (Cloud Resource Name) identifica in modo univoco le risorse IBM Cloud . Un CRN viene utilizzato per specificare una risorsa in un modo non ambiguo che è garantito essere globalmente univoco.
DateTime
Un " DateTime " è una combinazione di data e ora conforme allo standard " RFC3339 ".
IPv4Address
IPv4 indirizzo in notazione decimale con punti (ad es., 192.168.1.1 ).
Indirizzo MAC
Indirizzo MAC in notazione esadecimale con due punti (ad es., 00:1A:2B:3C:4D:5E ).
Richieste interne
Le seguenti query sono destinate esclusivamente all'uso interno e non sono supportate per gli utenti esterni. Sono riportati qui per completezza.
globalSearchSatelliteConnectorAccounts
Risultati ricercabili a livello globale per il servizio di ricerca globale " IBM ". Solo per uso interno.
| Immettere | Nome | Descrizione |
|---|---|---|
| Restituzioni | GlobalSearchSatelliteConnectorAccountsConnection |
|
| Argomento | after (String) |
|
| Argomento | first (Int) |
|
| Argomento | last (Int) |
|
| Argomento | before (String) |
|
| Argomento | regionName (String!) (obbligatorio) |
Richiesta di esempio
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"
}
}'
Risposta di esempio
{
"data": {
"globalSearchSatelliteConnectorAccounts": {
"edges": [
{
"cursor": "example-value",
"node": {
"externalID": "example-value"
}
}
],
"pageInfo": {
"endCursor": "example-value",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "example-value"
}
}
}
}