IBM Cloud Kubernetes Service GraphQL API-Referenz
Die IBM Cloud Kubernetes Service ( GraphQL )-API ist unter https://containers.cloud.ibm.com/graphql … verfügbar. Verwenden Sie diese API, um Satellite-Konnektoren, Kubernetes-Cluster und Bare-Metal-Worker-Knoten programmgesteuert
zu verwalten.
Diese Seite wird automatisch aus dem Live-Schema generiert.
Abfragen
Abfragen rufen Daten ab, ohne dabei Ressourcen zu verändern. Senden Sie eine Anfrage POST an mit https://containers.cloud.ibm.com/graphql Ihrer Anfrage im Anfragetext.
node
Finde einen Node für die angegebene ID. Verwenden Sie Fragmente, um zusätzliche Felder auszuwählen.
| Typ | Name | Beschreibung |
|---|---|---|
| Rückgabe | Node |
|
| Argument | id (ID!) (erforderlich) |
Die weltweit eindeutige Knotenkennung. |
Beispielanforderung
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"
}
}'
Beispielantwort
{
"data": {
"node": "<Node>"
}
}
satelliteConnectors
Listen Sie die Satellite-Konnektoren auf, auf die Sie Zugriff haben.
| Typ | Name | Beschreibung |
|---|---|---|
| Rückgabe | SatelliteConnectorConnection |
|
| Argument | after (String) |
Fügen Sie nach diesem Cursor Satellite-Konnektoren ein. |
| Argument | first (Int) |
Gibt die ersten N Satellite-Konnektoren zurück. |
| Argument | last (Int) |
Gibt die letzten N Satellite-Konnektoren zurück. |
| Argument | before (String) |
Satellite-Konnektoren vor diesem Cursor zurückgeben. |
Beispielanforderung
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"
}
}'
Beispielantwort
{
"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"
}
}
}
}
Mutationen
Mutationen dienen zum Anlegen, Aktualisieren oder Löschen von Ressourcen. Jede Mutation erfordert ein IAM-Bearer-Token im Authorization Header.
addVirtualNetworkInterfaceToBareMetalNode
Fügt einem Worker-Knoten des Bare-Metal- Kubernetes s eine virtuelle Netzwerkschnittstelle (VNI) hinzu.
| Typ | Name | Beschreibung |
|---|---|---|
| Rückgabe | AddVirtualNetworkInterfaceToBareMetalNodePayload |
|
| Argument | input (AddVirtualNetworkInterfaceToBareMetalNodeInput!) (erforderlich) |
Eingabeparameter zum Hinzufügen der VNI zu einem Bare-Metal-Knoten. |
Beispielanforderung
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>"
}
}'
Beispielantwort
{
"data": {
"addVirtualNetworkInterfaceToBareMetalNode": {
"networkAttachment": "<NetworkAttachment>"
}
}
}
createSatelliteConnector
Erstellen Sie einen Satellite-Connector.
| Typ | Name | Beschreibung |
|---|---|---|
| Rückgabe | CreateSatelliteConnectorPayload |
|
| Argument | input (CreateSatelliteConnectorInput) |
Beispielanforderung
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>"
}
}'
Beispielantwort
{
"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
Kubernetes-Knoten neu initialisieren. Derzeit nicht auf virtuellen VPC-Serverinstanzen unterstützt.
| Typ | Name | Beschreibung |
|---|---|---|
| Rückgabe | ReinitializeKubernetesNodePayload |
|
| Argument | input (ReinitializeKubernetesNodeInput) |
Beispielanforderung
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>"
}
}'
Beispielantwort
{
"data": {
"reinitializeKubernetesNode": {
"node": "<KubernetesNode>"
}
}
}
removeSatelliteConnector
Satellite-Konnektor entfernen.
| Typ | Name | Beschreibung |
|---|---|---|
| Rückgabe | RemoveSatelliteConnectorPayload |
|
| Argument | input (RemoveSatelliteConnectorInput) |
Beispielanforderung
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>"
}
}'
Beispielantwort
{
"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
Entfernt eine virtuelle Netzwerkschnittstelle von einem Worker-Knoten des Kubernetes.
| Typ | Name | Beschreibung |
|---|---|---|
| Rückgabe | RemoveVirtualNetworkInterfaceFromNodePayload |
|
| Argument | input (RemoveVirtualNetworkInterfaceFromNodeInput!) (erforderlich) |
Eingabeparameter zum Entfernen der VNI aus einem Knoten. |
Beispielanforderung
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>"
}
}'
Beispielantwort
{
"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
Einen Satellite-Standort aktualisieren.
| Typ | Name | Beschreibung |
|---|---|---|
| Rückgabe | UpdateSatelliteLocationPayload |
|
| Argument | input (UpdateSatelliteLocationInput) |
Beispielanforderung
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>"
}
}'
Beispielantwort
{
"data": {
"updateSatelliteLocation": {
"satelliteLocation": {
"description": "example-value",
"id": "abc123",
"name": "example-value"
}
}
}
}
Objekttypen
Objekttypen stellen die konkreten Ressourcen und die von der API zurückgegebenen Antwortdaten dar.
Konto
Ein IBM Cloud-Konto.
| Typ | Name | Beschreibung |
|---|---|---|
| Feld | externalID (String!) |
Die IBM Cloud-ID des Kontos. |
AddVirtualNetworkInterfaceToBareMetalNodePayload
Antwortdaten zum Hinzufügen einer VNI zu einem Bare-Metal-Knoten.
| Typ | Name | Beschreibung |
|---|---|---|
| Feld | networkAttachment (NetworkAttachment!) |
Die erstellte Netzwerkverbindung mit ihren Eigenschaften. |
BareMetalNetworkAttachmentByVLAN
Netzwerkanbindung für Bare-Metal-Knoten mithilfe von VLAN-Tagging.
| Typ | Name | Beschreibung |
|---|---|---|
| Implementiert | NetworkAttachment |
|
| Feld | attachedTo (NetworkAttachable!) |
Der Bare-Metal-Knoten, an den diese Schnittstelle angeschlossen ist. |
| Feld | canFloat (Boolean!) |
Ob diese Anhangsdatei zwischen den Knoten im Cluster verschoben werden kann. |
| Feld | virtualNetworkInterface (VirtualNetworkInterface!) |
Die angeschlossene virtuelle Netzwerkschnittstelle. |
| Feld | vlanID (Int) |
Für diesen Anhang verwendete VLAN-ID (2-500). Null, falls noch nicht zugewiesen. |
BareMetalVirtualNetworkInterface
Virtuelle Netzwerkschnittstelle, die an einen Bare-Metal-Server angeschlossen ist.
| Typ | Name | Beschreibung |
|---|---|---|
| Implementiert | VirtualNetworkInterface |
|
| Feld | autoDelete (Boolean) |
Sollte die VNI beim Trennen automatisch gelöscht werden? |
| Feld | externalID (String!) |
Die VPC-Ressourcen-ID dieses VNI. |
| Feld | macAddress (MACAddress) |
Dieser Netzwerkschnittstelle zugewiesene MAC-Adresse. |
| Feld | name (String) |
Für Menschen lesbarer Name des VNI. |
| Feld | primaryIPAddress (IPv4Address) |
Der dieser Netzwerkschnittstelle zugewiesene primäre IPv4-Adresse. |
| Feld | securityGroups (SecurityGroupConnection) |
Auf diese Netzwerkschnittstelle angewendete Sicherheitsgruppen.
|
| Feld | subnet (Subnet!) |
Das VPC-Subnetz, mit dem diese Netzwerkschnittstelle verbunden ist. |
CreateSatelliteConnectorPayload
Ausgabeformat für createSatelliteConnector.
| Typ | Name | Beschreibung |
|---|---|---|
| Feld | satelliteConnector (SatelliteConnector) |
Das neue SatelliteConnector. |
KubernetesCluster
Ein IBM Cloud Kubernetes Service- oder IBM Cloud- OpenShift-Service-Cluster.
| Typ | Name | Beschreibung |
|---|---|---|
| Implementiert | Node |
|
| Feld | id (ID!) |
Die eindeutige Kennung des Clusters. |
| Feld | name (String) |
Der Name des Clusters. |
| Feld | networkAttachments (NetworkAttachmentConnection) |
Netzwerkverbindungen für diesen Cluster (falls zutreffend).
|
| Feld | region (Region) |
Die Katalogregion IBM Cloud des Clusters. |
Bereich
Eine Region des IBM Cloud-Katalogs.
| Typ | Name | Beschreibung |
|---|---|---|
| Implementiert | Location |
|
| Implementiert | Node |
|
| Feld | displayName (String) |
Der übersetzte Name dieser Region. |
| Feld | id (ID!) |
Die ID dieser Region. |
| Feld | name (String) |
Der Name dieser Region. |
ReinitializeKubernetesNodePayload
Ausgabetyp für reinitializeKubernetesNode.
| Typ | Name | Beschreibung |
|---|---|---|
| Feld | node (KubernetesNode) |
Der Knoten Kubernetes wird neu initialisiert. |
RemoveSatelliteConnectorPayload
Ausgabetyp für removeSatelliteConnector.
| Typ | Name | Beschreibung |
|---|---|---|
| Feld | satelliteConnector (SatelliteConnector) |
Der entfernte Text: SatelliteConnector. |
RemoveVirtualNetworkInterfaceFromNodePayload
Antwortdaten zum Entfernen einer VNI aus einem Knoten.
| Typ | Name | Beschreibung |
|---|---|---|
| Feld | cluster (KubernetesCluster!) |
Der Cluster, aus dem der VNI entfernt wurde. |
| Feld | node (NetworkAttachable!) |
Der Knoten, von dem die VNI entfernt wurde. |
| Feld | virtualNetworkInterface (VirtualNetworkInterface!) |
Die virtuelle Netzwerkschnittstelle, die entfernt wurde. |
ResourceGroup
Mit einer ResourceGroup können Sie Ihre Kontoressourcen in individuell anpassbaren Gruppen organisieren, sodass Sie Benutzern schnell Zugriff auf mehrere Ressourcen gleichzeitig gewähren können.
| Typ | Name | Beschreibung |
|---|---|---|
| Implementiert | Node |
|
| Feld | externalID (String!) |
Die IBM Cloud-ID der Ressourcengruppe. |
| Feld | id (ID!) |
Die Node-ID der Ressourcengruppe. |
| Feld | name (String) |
Der Name der Ressourcengruppe. |
SatelliteConnector
Ein Satellite-Konnektor stellt eine sichere Verbindung zwischen einem bestimmten Remote-Standort und IBM Cloud her.
| Typ | Name | Beschreibung |
|---|---|---|
| Implementiert | Node |
|
| Feld | createdDate (DateTime) |
Das Erstellungsdatum dieser Ressource. |
| Feld | crn (CloudResourceName) |
Die Ressource IBM Cloud von CRN. |
| Feld | id (ID!) |
Die eindeutige Kennung der Ressource. |
| Feld | name (String!) |
Der Name der Ressource. |
| Feld | region (Region) |
Die Region, von der aus die Ressource verwaltet wird. |
| Feld | resourceGroup (ResourceGroup) |
Die Ressourcengruppe, zu der diese Ressource gehört. |
| Feld | state (SatelliteConnectorState) |
Der aktuelle Stand dieser Ressource. |
SatelliteLocation
Ein Standort von Satellite.
| Typ | Name | Beschreibung |
|---|---|---|
| Implementiert | Node |
|
| Feld | description (String) |
Die Standortbeschreibung. |
| Feld | id (ID!) |
Die eindeutige Kennung der Ressource. |
| Feld | name (String) |
Der Name des Standorts. |
SecurityGroup
Stellt eine VPC-Sicherheitsgruppe dar.
| Typ | Name | Beschreibung |
|---|---|---|
| Feld | externalID (String!) |
Die VPC-Ressourcen-ID dieser Sicherheitsgruppe. |
Teilnetz
Stellt ein VPC-Subnetz dar.
| Typ | Name | Beschreibung |
|---|---|---|
| Feld | externalID (String!) |
Die VPC-Ressourcen-ID dieses Subnetzes. |
UpdateSatelliteLocationPayload
Ausgabetyp für updateSatelliteLocation.
| Typ | Name | Beschreibung |
|---|---|---|
| Feld | satelliteLocation (SatelliteLocation) |
Die aktualisierte SatelliteLocation. |
VPCBareMetalKubernetesNode
Stellt einen Bare-Metal- Kubernetes-Worker-Knoten in IBM Cloud VPC dar.
| Typ | Name | Beschreibung |
|---|---|---|
| Implementiert | KubernetesNode |
|
| Implementiert | NetworkAttachable |
|
| Implementiert | Node |
|
| Feld | id (ID!) |
Global eindeutige Kennung für diesen Worker-Knoten. |
| Feld | networkAttachments (NetworkAttachmentConnection) |
Netzwerkverbindungen für diesen Bare-Metal-Knoten.
|
| Feld | region (Region) |
Schnittstellentypen
Schnittstellentypen definieren gemeinsame Felder, die von mehreren konkreten Objekttypen gemeinsam genutzt werden.
KubernetesNode
Ein Kubernetes Node führt Ihre Workloads aus.
| Typ | Name | Beschreibung |
|---|---|---|
| Bereitstellung | KubernetesNode |
|
| Bereitstellung | VPCBareMetalKubernetesNode |
|
| Feld | id (ID!) |
Die eindeutige Kennung der Ressource. |
| Feld | region (Region) |
Standort
Ein Eintrag im IBM Cloud-Katalog.
| Typ | Name | Beschreibung |
|---|---|---|
| Bereitstellung | Location |
|
| Bereitstellung | Region |
|
| Feld | displayName (String) |
Übersetzter Name dieses Standorts. |
| Feld | id (ID!) |
Die ID dieses Standorts. |
| Feld | name (String) |
Name dieses Standorts. |
NetworkAttachable
Stellt eine Entität dar, an die Netzwerkschnittstellen angeschlossen werden können.
| Typ | Name | Beschreibung |
|---|---|---|
| Bereitstellung | NetworkAttachable |
|
| Feld | id (ID!) |
Global eindeutige Kennung für diesen Knoten. |
| Feld | networkAttachments (NetworkAttachmentConnection) |
Mit diesem Knoten verbundene Netzwerkverbindungen.
|
NetworkAttachment
Stellt eine Netzwerk-Schnittstellenverbindung zu einem Knoten dar.
| Typ | Name | Beschreibung |
|---|---|---|
| Bereitstellung | BareMetalNetworkAttachmentByVLAN |
|
| Bereitstellung | NetworkAttachment |
|
| Feld | attachedTo (NetworkAttachable!) |
Der Knoten, an den diese Netzwerkschnittstelle angeschlossen ist. |
| Feld | virtualNetworkInterface (VirtualNetworkInterface!) |
Die angeschlossene virtuelle Netzwerkschnittstelle. |
Node
Ruft ein Objekt anhand seiner ID ab.
| Typ | Name | Beschreibung |
|---|---|---|
| Bereitstellung | KubernetesCluster |
|
| Bereitstellung | KubernetesNode |
|
| Bereitstellung | NetworkAttachable |
|
| Bereitstellung | Node |
|
| Bereitstellung | Region |
|
| Bereitstellung | ResourceGroup |
|
| Bereitstellung | SatelliteConnector |
|
| Bereitstellung | SatelliteLocation |
|
| Bereitstellung | VPCBareMetalKubernetesNode |
|
| Feld | id (ID!) |
Die weltweit eindeutige Objekt-ID. |
VirtualNetworkInterface
Stellt eine virtuelle Netzwerkschnittstelle in IBM Cloud VPC dar. Können an Bare-Metal- oder virtuelle Serverinstanzen angehängt werden.
| Typ | Name | Beschreibung |
|---|---|---|
| Bereitstellung | BareMetalVirtualNetworkInterface |
|
| Bereitstellung | VirtualNetworkInterface |
|
| Feld | autoDelete (Boolean) |
Sollte die VNI beim Trennen automatisch gelöscht werden? |
| Feld | externalID (String!) |
Die VPC-Ressourcen-ID dieser virtuellen Netzwerkschnittstelle. |
| Feld | macAddress (MACAddress) |
Dieser Netzwerkschnittstelle zugewiesene MAC-Adresse. |
| Feld | name (String) |
Für Menschen lesbarer Name des VNI. |
| Feld | primaryIPAddress (IPv4Address) |
Der dieser Netzwerkschnittstelle zugewiesene primäre IPv4-Adresse. |
| Feld | securityGroups (SecurityGroupConnection) |
Auf diese Netzwerkschnittstelle angewendete Sicherheitsgruppen.
|
| Feld | subnet (Subnet!) |
Das VPC-Subnetz, mit dem diese Netzwerkschnittstelle verbunden ist. |
Eingabetypen
Eingabetypen werden als Argumente für Mutationen verwendet. Mit (erforderlich) gekennzeichnete Felder müssen ausgefüllt werden.
AddVirtualNetworkInterfaceToBareMetalNodeInput
Anleitung zum Hinzufügen einer VNI zu einem Bare-Metal-Knoten.
| Typ | Name | Beschreibung |
|---|---|---|
| Feld | autoDelete (Boolean) |
Soll die VNI automatisch aus der VPC gelöscht werden, wenn sie getrennt wird? Standardwert ist false, sofern nicht anders angegeben. |
| Feld | cluster (ID) |
Cluster-ID. Es muss entweder Cluster oder Knoten angegeben werden, jedoch nicht beides. Wenn nur ein Cluster angegeben wird, wird automatisch ein Knoten ausgewählt und der Anhang wird nicht einem bestimmten Knoten zugeordnet. |
| Feld | node (ID) |
Node ID. Es muss entweder Cluster oder Knoten angegeben werden, jedoch nicht beides. Falls angegeben, wird ein nicht schwebender Anhang zu diesem bestimmten Knoten erstellt. |
| Feld | virtualNetworkInterfaceID (String!) (erforderlich) |
Die VPC-Ressourcen-ID der virtuellen Netzwerkschnittstelle, die verbunden werden soll. |
| Feld | vlanID (Int!) (erforderlich) |
VLAN-ID für den Anhang (2–500). VLAN 1 ist für die primäre Netzwerkschnittstelle reserviert. |
CreateSatelliteConnectorInput
Erforderliche Angaben zur Bereitstellung eines Satellite-Konnektors.
| Typ | Name | Beschreibung |
|---|---|---|
| Feld | name (String!) (erforderlich) |
Der Name der Ressource. |
| Feld | regionName (String!) (erforderlich) |
Der Name der Region, aus der heraus der neue Konnektor verwaltet werden soll. |
| Feld | resourceGroupID (String!) (erforderlich) |
Die ID der Ressourcengruppe, die bereitgestellt werden soll. |
ReinitializeKubernetesNodeInput
Eingabetyp für reinitializeKubernetesNode.
| Typ | Name | Beschreibung |
|---|---|---|
| Feld | bypassUnhealthyControlPlane (Boolean) |
Setzen Sie diesen Wert auf true, um die Neuinitialisierung fortzusetzen, auch wenn die Steuerungsebene des Clusters nicht funktionsfähig ist. |
| Feld | id (ID!) (erforderlich) |
Kubernetes Knoten neu initialisieren. |
RemoveSatelliteConnectorInput
Eingabetyp für removeSatelliteConnector.
| Typ | Name | Beschreibung |
|---|---|---|
| Feld | id (ID!) (erforderlich) |
Satellite Zu entfernende Connector-ID. |
RemoveVirtualNetworkInterfaceFromNodeInput
Eingabe zum Entfernen einer VNI aus einem Knoten.
| Typ | Name | Beschreibung |
|---|---|---|
| Feld | cluster (ID) |
Cluster-ID. Es muss entweder Cluster oder Knoten angegeben werden, jedoch nicht beides. |
| Feld | node (ID) |
Node ID. Es muss entweder Cluster oder Knoten angegeben werden, jedoch nicht beides. |
| Feld | virtualNetworkInterfaceID (String!) (erforderlich) |
Die VPC-Ressourcen-ID der virtuellen Netzwerkschnittstelle, die entfernt werden soll. |
UpdateSatelliteLocationInput
Eingabetyp für updateSatelliteLocation.
| Typ | Name | Beschreibung |
|---|---|---|
| Feld | description (String) |
|
| Feld | id (ID!) (erforderlich) |
Satellite Zu aktualisierende Standort-ID. |
| Feld | name (String) |
Enum-Typen
Enum-Typen definieren die Menge der zulässigen Zeichenfolgenwerte für ein Feld.
SatelliteConnectorState
Der Verwaltungsstatus eines Satellite-Konnektors.
Es wird erwartet, dass diese Werte in Zukunft weiter steigen werden. Bei der Verarbeitung auf unbekannte Werte prüfen und diese protokollieren. Optional kann die Verarbeitung angehalten und der Fehler angezeigt werden, oder der Satellite-Konnektor, bei dem der unerwartete Wert aufgetreten ist, kann umgangen werden.
| Typ | Name | Beschreibung |
|---|---|---|
| Wert | CREATED |
Die Bereitstellung des Connectors ist abgeschlossen, und er ist einsatzbereit. |
| Wert | CREATING |
Der Konnektor wird gerade bereitgestellt und ist möglicherweise noch nicht einsatzbereit. |
| Wert | DELETING |
Der Konnektor wird gerade deaktiviert und ist möglicherweise nicht verfügbar. |
| Wert | FAILED |
Der letzte Vorgang des Konnektors ist fehlgeschlagen und muss gelöscht werden, um fortfahren zu können. |
Skalare Typen
Skalare Typen sind primitive Blattwerte im Schema GraphQL.
CloudResourceName
Ein Cloudressourcenname (CRN) ermöglicht die eindeutige Identifizierung von IBM Cloud-Ressourcen. Eine CRN wird verwendet, um eine Ressource auf eine eindeutige Weise zu spezifizieren, die garantiert global eindeutig ist.
DateTime
Ein DateTime ist eine mit dem RFC3339 konforme Kombination aus Datum und Uhrzeit.
IPv4Address
IPv4 Adresse in Dezimalpunktnotation (z. B. 192.168.1.1 ).
MAC-Adresse
MAC-Adresse in Doppelpunkt-Hexadezimal-Notation (z. B. 00:1A:2B:3C:4D:5E ).
Interne Anfragen
Die folgenden Abfragen sind ausschließlich für den internen Gebrauch bestimmt und werden für externe Nutzer nicht unterstützt. Sie sind hier der Vollständigkeit halber dokumentiert.
globalSearchSatelliteConnectorAccounts
Weltweit durchsuchbare Ergebnisse für den IBM Global Search-Dienst. Nur interne Verwendung.
| Typ | Name | Beschreibung |
|---|---|---|
| Rückgabe | GlobalSearchSatelliteConnectorAccountsConnection |
|
| Argument | after (String) |
|
| Argument | first (Int) |
|
| Argument | last (Int) |
|
| Argument | before (String) |
|
| Argument | regionName (String!) (erforderlich) |
Beispielanforderung
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"
}
}'
Beispielantwort
{
"data": {
"globalSearchSatelliteConnectorAccounts": {
"edges": [
{
"cursor": "example-value",
"node": {
"externalID": "example-value"
}
}
],
"pageInfo": {
"endCursor": "example-value",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "example-value"
}
}
}
}