IBM Cloud Kubernetes Service GraphQL API 참조
IBM Cloud Kubernetes Service GraphQL API는 https://containers.cloud.ibm.com/graphql 에서 이용할 수 있습니다. 이 API를 사용하여 Satellite 커넥터, Kubernetes 클러스터 및 베어 메탈 워커 노드를 프로그래밍 방식으로 관리할 수 있습니다.
이 페이지는 라이브 스키마를 기반으로 자동 생성되었습니다.
쿼리
쿼리는 리소스를 수정하지 않고 데이터를 가져옵니다. 요청 본문에 쿼리를 포함하여 https://containers.cloud.ibm.com/graphql 으로 ‘ POST ’ 요청을 보내세요.
node
주어진 ID에 해당하는 ‘ Node ’를 찾으세요. 프래그먼트를 사용하여 추가 필드를 선택하세요.
| 유형 | 이름 | 설명 |
|---|---|---|
| 리턴 | Node |
|
| 인수 | id (ID!) (필수) |
전 세계적으로 고유한 노드 식별자. |
요청 예제
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"
}
}'
응답 예
{
"data": {
"node": "<Node>"
}
}
satelliteConnectors
사용 권한이 있는 ‘ Satellite ’ 커넥터를 나열해 주세요.
| 유형 | 이름 | 설명 |
|---|---|---|
| 리턴 | SatelliteConnectorConnection |
|
| 인수 | after (String) |
이 커서 뒤의 ‘ Satellite ’ 커넥터를 반환합니다. |
| 인수 | first (Int) |
첫 번째 N개의 Satellite 커넥터를 반환합니다. |
| 인수 | last (Int) |
마지막 N개의 Satellite 커넥터를 반환합니다. |
| 인수 | before (String) |
이 커서 앞의 ‘ Satellite ’ 커넥터를 반환합니다. |
요청 예제
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"
}
}'
응답 예
{
"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"
}
}
}
}
돌연변이
뮤테이션은 리소스를 생성, 업데이트 또는 삭제합니다. 각 뮤테이션은 ‘ Authorization ’ 헤더에 IAM 베어러 토큰을 포함해야 합니다.
addVirtualNetworkInterfaceToBareMetalNode
베어 메탈 Kubernetes 작업자 노드에 가상 네트워크 인터페이스(VNI)를 추가합니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 리턴 | AddVirtualNetworkInterfaceToBareMetalNodePayload |
|
| 인수 | input (AddVirtualNetworkInterfaceToBareMetalNodeInput!) (필수) |
베어 메탈 노드에 VNI를 추가하기 위한 입력 매개변수. |
요청 예제
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>"
}
}'
응답 예
{
"data": {
"addVirtualNetworkInterfaceToBareMetalNode": {
"networkAttachment": "<NetworkAttachment>"
}
}
}
createSatelliteConnector
Satellite 커넥터를 작성하십시오.
| 유형 | 이름 | 설명 |
|---|---|---|
| 리턴 | CreateSatelliteConnectorPayload |
|
| 인수 | input (CreateSatelliteConnectorInput) |
요청 예제
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>"
}
}'
응답 예
{
"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 노드를 다시 초기화합니다. 현재 VPC 가상 서버 인스턴스에서는 지원되지 않습니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 리턴 | ReinitializeKubernetesNodePayload |
|
| 인수 | input (ReinitializeKubernetesNodeInput) |
요청 예제
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>"
}
}'
응답 예
{
"data": {
"reinitializeKubernetesNode": {
"node": "<KubernetesNode>"
}
}
}
removeSatelliteConnector
Satellite 커넥터를 제거합니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 리턴 | RemoveSatelliteConnectorPayload |
|
| 인수 | input (RemoveSatelliteConnectorInput) |
요청 예제
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>"
}
}'
응답 예
{
"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
Kubernetes 작업자 노드에서 가상 네트워크 인터페이스를 제거합니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 리턴 | RemoveVirtualNetworkInterfaceFromNodePayload |
|
| 인수 | input (RemoveVirtualNetworkInterfaceFromNodeInput!) (필수) |
노드에서 VNI를 제거하기 위한 입력 매개변수. |
요청 예제
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>"
}
}'
응답 예
{
"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
Satellite 의 위치를 업데이트합니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 리턴 | UpdateSatelliteLocationPayload |
|
| 인수 | input (UpdateSatelliteLocationInput) |
요청 예제
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>"
}
}'
응답 예
{
"data": {
"updateSatelliteLocation": {
"satelliteLocation": {
"description": "example-value",
"id": "abc123",
"name": "example-value"
}
}
}
}
오브젝트 유형
객체 유형은 API가 반환하는 구체적인 리소스와 응답 페이로드를 나타냅니다.
계정
IBM Cloud 계정.
| 유형 | 이름 | 설명 |
|---|---|---|
| 필드 | externalID (String!) |
해당 계정의 IBM Cloud ID. |
AddVirtualNetworkInterfaceToBareMetalNodePayload
베어 메탈 노드에 VNI를 추가하기 위한 응답 페이로드.
| 유형 | 이름 | 설명 |
|---|---|---|
| 필드 | networkAttachment (NetworkAttachment!) |
생성된 네트워크 연결 및 해당 속성. |
BareMetalNetworkAttachmentByVLAN
VLAN 태깅을 이용한 베어 메탈 노드의 네트워크 연결.
| 유형 | 이름 | 설명 |
|---|---|---|
| 구현 | NetworkAttachment |
|
| 필드 | attachedTo (NetworkAttachable!) |
이 인터페이스가 연결된 베어 메탈 노드. |
| 필드 | canFloat (Boolean!) |
이 첨부 파일이 클러스터 내의 노드들 사이를 이동할 수 있는지 여부. |
| 필드 | virtualNetworkInterface (VirtualNetworkInterface!) |
연결된 가상 네트워크 인터페이스. |
| 필드 | vlanID (Int) |
이 연결에 사용된 VLAN ID (2-500). 아직 할당되지 않은 경우 null입니다. |
BareMetalVirtualNetworkInterface
베어 메탈 서버에 연결된 가상 네트워크 인터페이스.
| 유형 | 이름 | 설명 |
|---|---|---|
| 구현 | VirtualNetworkInterface |
|
| 필드 | autoDelete (Boolean) |
VNI를 분리할 때 자동으로 삭제해야 하는지 여부. |
| 필드 | externalID (String!) |
이 VNI의 VPC 리소스 ID입니다. |
| 필드 | macAddress (MACAddress) |
이 네트워크 인터페이스에 할당된 MAC 주소. |
| 필드 | name (String) |
VNI의 사람이 읽기 쉬운 이름. |
| 필드 | primaryIPAddress (IPv4Address) |
이 네트워크 인터페이스에 할당된 기본 IPv4 주소. |
| 필드 | securityGroups (SecurityGroupConnection) |
이 네트워크 인터페이스에 적용된 보안 그룹입니다.
|
| 필드 | subnet (Subnet!) |
이 네트워크 인터페이스가 연결된 VPC 서브넷. |
CreateSatelliteConnectorPayload
createSatelliteConnector 의 출력 유형.
| 유형 | 이름 | 설명 |
|---|---|---|
| 필드 | satelliteConnector (SatelliteConnector) |
새로운 SatelliteConnector. |
KubernetesCluster
IBM Cloud Kubernetes Service 또는 IBM Cloud OpenShift 서비스 클러스터.
| 유형 | 이름 | 설명 |
|---|---|---|
| 구현 | Node |
|
| 필드 | id (ID!) |
클러스터의 고유 식별자. |
| 필드 | name (String) |
클러스터의 이름. |
| 필드 | networkAttachments (NetworkAttachmentConnection) |
이 클러스터에 연결된 네트워크(해당하는 경우).
|
| 필드 | region (Region) |
이 클러스터의 ‘ IBM Cloud ’ 카탈로그 영역. |
지역
IBM Cloud 의 카탈로그 영역.
| 유형 | 이름 | 설명 |
|---|---|---|
| 구현 | Location |
|
| 구현 | Node |
|
| 필드 | displayName (String) |
이 지역의 번역된 이름. |
| 필드 | id (ID!) |
이 지역의 ID입니다. |
| 필드 | name (String) |
이 지역의 이름. |
ReinitializeKubernetesNodePayload
reinitializeKubernetesNode 의 출력 유형.
| 유형 | 이름 | 설명 |
|---|---|---|
| 필드 | node (KubernetesNode) |
Kubernetes 노드를 다시 초기화하고 있습니다. |
RemoveSatelliteConnectorPayload
removeSatelliteConnector 의 출력 유형.
| 유형 | 이름 | 설명 |
|---|---|---|
| 필드 | satelliteConnector (SatelliteConnector) |
삭제된 SatelliteConnector. |
RemoveVirtualNetworkInterfaceFromNodePayload
노드에서 VNI를 제거하기 위한 응답 페이로드.
| 유형 | 이름 | 설명 |
|---|---|---|
| 필드 | cluster (KubernetesCluster!) |
VNI가 제거된 클러스터. |
| 필드 | node (NetworkAttachable!) |
VNI가 제거된 노드. |
| 필드 | virtualNetworkInterface (VirtualNetworkInterface!) |
제거된 가상 네트워크 인터페이스. |
ResourceGroup
ResourceGroup 는 계정 리소스를 사용자 정의 가능한 그룹으로 구성하여, 한 번에 여러 리소스에 대한 액세스 권한을 사용자에게 신속하게 할당할 수 있게 해주는 기능입니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 구현 | Node |
|
| 필드 | externalID (String!) |
리소스 그룹의 IBM Cloud ID. |
| 필드 | id (ID!) |
리소스 그룹의 Node ID. |
| 필드 | name (String) |
리소스 그룹의 이름. |
SatelliteConnector
Satellite 커넥터는 특정 원격 위치와 IBM Cloud 간에 안전한 연결을 제공합니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 구현 | Node |
|
| 필드 | createdDate (DateTime) |
이 리소스가 생성된 날짜입니다. |
| 필드 | crn (CloudResourceName) |
해당 리소스의 CRN( IBM Cloud ). |
| 필드 | id (ID!) |
리소스의 고유 식별자. |
| 필드 | name (String!) |
리소스의 이름. |
| 필드 | region (Region) |
해당 자원이 관리되는 지역. |
| 필드 | resourceGroup (ResourceGroup) |
이 리소스를 포함하는 리소스 그룹. |
| 필드 | state (SatelliteConnectorState) |
이 리소스의 현재 상태. |
SatelliteLocation
Satellite 의 지점입니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 구현 | Node |
|
| 필드 | description (String) |
장소 설명. |
| 필드 | id (ID!) |
리소스의 고유 식별자. |
| 필드 | name (String) |
장소 이름. |
SecurityGroup
VPC 보안 그룹을 나타냅니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 필드 | externalID (String!) |
이 보안 그룹의 VPC 리소스 ID입니다. |
서브넷
VPC 서브넷을 나타냅니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 필드 | externalID (String!) |
이 서브넷의 VPC 리소스 ID입니다. |
UpdateSatelliteLocationPayload
updateSatelliteLocation 의 출력 유형.
| 유형 | 이름 | 설명 |
|---|---|---|
| 필드 | satelliteLocation (SatelliteLocation) |
업데이트된 SatelliteLocation. |
VPCBareMetalKubernetesNode
IBM Cloud VPC 에서 베어 메탈 Kubernetes 워커 노드를 나타냅니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 구현 | KubernetesNode |
|
| 구현 | NetworkAttachable |
|
| 구현 | Node |
|
| 필드 | id (ID!) |
이 워커 노드에 대한 전역 고유 식별자입니다. |
| 필드 | networkAttachments (NetworkAttachmentConnection) |
이 베어 메탈 노드의 네트워크 연결 정보.
|
| 필드 | region (Region) |
인터페이스 유형
인터페이스 유형은 여러 구체적인 객체 유형에 공통적으로 적용되는 필드를 정의합니다.
KubernetesNode
Kubernetes Node 가 워크로드를 실행합니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 구현 | KubernetesNode |
|
| 구현 | VPCBareMetalKubernetesNode |
|
| 필드 | id (ID!) |
리소스의 고유 식별자. |
| 필드 | region (Region) |
위치
IBM Cloud 의 카탈로그 위치.
| 유형 | 이름 | 설명 |
|---|---|---|
| 구현 | Location |
|
| 구현 | Region |
|
| 필드 | displayName (String) |
이 장소의 번역된 이름. |
| 필드 | id (ID!) |
이 위치의 ID입니다. |
| 필드 | name (String) |
이 장소의 이름. |
NetworkAttachable
네트워크 인터페이스가 연결될 수 있는 엔티티를 나타냅니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 구현 | NetworkAttachable |
|
| 필드 | id (ID!) |
이 노드에 대한 전 세계적으로 고유한 식별자입니다. |
| 필드 | networkAttachments (NetworkAttachmentConnection) |
이 노드와 연결된 네트워크 연결.
|
NetworkAttachment
노드에 연결된 네트워크 인터페이스를 나타냅니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 구현 | BareMetalNetworkAttachmentByVLAN |
|
| 구현 | NetworkAttachment |
|
| 필드 | attachedTo (NetworkAttachable!) |
이 네트워크 인터페이스가 연결된 노드입니다. |
| 필드 | virtualNetworkInterface (VirtualNetworkInterface!) |
연결된 가상 네트워크 인터페이스. |
Node
ID를 기반으로 객체를 가져옵니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 구현 | KubernetesCluster |
|
| 구현 | KubernetesNode |
|
| 구현 | NetworkAttachable |
|
| 구현 | Node |
|
| 구현 | Region |
|
| 구현 | ResourceGroup |
|
| 구현 | SatelliteConnector |
|
| 구현 | SatelliteLocation |
|
| 구현 | VPCBareMetalKubernetesNode |
|
| 필드 | id (ID!) |
전 세계적으로 고유한 객체 ID입니다. |
VirtualNetworkInterface
IBM Cloud VPC 에서 가상 네트워크 인터페이스를 나타냅니다. 베어 메탈 또는 가상 서버 인스턴스에 연결할 수 있습니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 구현 | BareMetalVirtualNetworkInterface |
|
| 구현 | VirtualNetworkInterface |
|
| 필드 | autoDelete (Boolean) |
VNI를 분리할 때 자동으로 삭제해야 하는지 여부. |
| 필드 | externalID (String!) |
이 가상 네트워크 인터페이스의 VPC 리소스 ID입니다. |
| 필드 | macAddress (MACAddress) |
이 네트워크 인터페이스에 할당된 MAC 주소. |
| 필드 | name (String) |
VNI의 사람이 읽기 쉬운 이름. |
| 필드 | primaryIPAddress (IPv4Address) |
이 네트워크 인터페이스에 할당된 기본 IPv4 주소. |
| 필드 | securityGroups (SecurityGroupConnection) |
이 네트워크 인터페이스에 적용된 보안 그룹입니다.
|
| 필드 | subnet (Subnet!) |
이 네트워크 인터페이스가 연결된 VPC 서브넷. |
입력 유형
입력 유형은 변형 함수의 인자로 사용됩니다. (필수) 로 표시된 항목은 반드시 입력해야 합니다.
AddVirtualNetworkInterfaceToBareMetalNodeInput
베어 메탈 노드에 VNI를 추가하기 위한 입력 사항.
| 유형 | 이름 | 설명 |
|---|---|---|
| 필드 | autoDelete (Boolean) |
VNI가 분리될 때 VPC에서 해당 VNI를 자동으로 삭제할지 여부. 명시되지 않은 경우 기본값은 false입니다. |
| 필드 | cluster (ID) |
클러스터 ID. 클러스터와 노드 중 하나는 반드시 지정해야 하며, 둘 다 지정해서는 안 됩니다. 클러스터만 지정된 경우, 노드가 자동으로 선택되며 연결은 플로팅 상태가 됩니다. |
| 필드 | node (ID) |
Node ID. 클러스터와 노드 중 하나는 반드시 지정해야 하며, 둘 다 지정해서는 안 됩니다. 지정된 경우, 이 특정 노드에 고정된 첨부 파일을 생성합니다. |
| 필드 | virtualNetworkInterfaceID (String!) (필수) |
연결할 가상 네트워크 인터페이스의 VPC 리소스 ID. |
| 필드 | vlanID (Int!) (필수) |
해당 연결에 대한 VLAN ID (2-500). VLAN 1은 주 네트워크 인터페이스용으로 예약되어 있습니다. |
CreateSatelliteConnectorInput
Satellite 커넥터를 프로비저닝하는 데 필요한 세부 정보.
| 유형 | 이름 | 설명 |
|---|---|---|
| 필드 | name (String!) (필수) |
리소스의 이름. |
| 필드 | regionName (String!) (필수) |
새 커넥터를 어디에서 관리해야 하는지를 나타내는 지역 이름입니다. |
| 필드 | resourceGroupID (String!) (필수) |
내부에 프로비저닝할 리소스 그룹 ID입니다. |
ReinitializeKubernetesNodeInput
reinitializeKubernetesNode 의 입력 유형.
| 유형 | 이름 | 설명 |
|---|---|---|
| 필드 | bypassUnhealthyControlPlane (Boolean) |
클러스터의 제어 플레인이 비정상 상태인 경우에도 재초기화를 진행하려면 이 값을 true로 설정하십시오. |
| 필드 | id (ID!) (필수) |
Kubernetes 재초기화할 노드. |
RemoveSatelliteConnectorInput
removeSatelliteConnector 의 입력 유형.
| 유형 | 이름 | 설명 |
|---|---|---|
| 필드 | id (ID!) (필수) |
Satellite 제거할 커넥터 ID. |
RemoveVirtualNetworkInterfaceFromNodeInput
노드에서 VNI를 제거하기 위한 입력.
| 유형 | 이름 | 설명 |
|---|---|---|
| 필드 | cluster (ID) |
클러스터 ID. 클러스터와 노드 중 하나는 반드시 지정해야 하며, 둘 다 지정해서는 안 됩니다. |
| 필드 | node (ID) |
Node ID. 클러스터와 노드 중 하나는 반드시 지정해야 하며, 둘 다 지정해서는 안 됩니다. |
| 필드 | virtualNetworkInterfaceID (String!) (필수) |
제거할 가상 네트워크 인터페이스의 VPC 리소스 ID입니다. |
UpdateSatelliteLocationInput
updateSatelliteLocation 의 입력 유형.
| 유형 | 이름 | 설명 |
|---|---|---|
| 필드 | description (String) |
|
| 필드 | id (ID!) (필수) |
Satellite 업데이트할 위치 ID. |
| 필드 | name (String) |
열거형
열거형(Enum)은 필드에 허용되는 문자열 값의 집합을 정의합니다.
SatelliteConnectorState
Satellite 커넥터의 관리 상태.
이 수치는 앞으로 더 늘어날 것으로 예상됩니다. 처리 과정에서 알 수 없는 값이 있는지 확인하고 이를 기록하십시오. 선택적으로 처리를 중지하고 오류를 표시하거나, 예기치 않은 값이 발견된 ‘ Satellite ’ 커넥터를 건너뛸 수 있습니다.
| 유형 | 이름 | 설명 |
|---|---|---|
| 값 | CREATED |
커넥터의 프로비저닝이 완료되었으며, 이제 사용할 준비가 되었습니다. |
| 값 | CREATING |
커넥터가 프로비저닝 중이므로 아직 사용할 수 없을 수 있습니다. |
| 값 | DELETING |
해당 커넥터의 프로비저닝이 해제되고 있으므로 사용할 수 없을 수 있습니다. |
| 값 | FAILED |
해당 커넥터의 최근 작업이 실패했으므로, 계속 진행하려면 이를 삭제해야 합니다. |
스칼라 유형
스칼라 유형은 ‘ GraphQL ’ 스키마에서 기본 리프 값입니다.
CloudResourceName
CRN(Cloud Resource Name)은 IBM Cloud 리소스를 고유하게 식별합니다. CRN을 사용하면 전역적으로 고유성이 보장되는 명료한 방식으로 리소스를 지정합니다.
DateTime
DateTime 는 RFC3339 규격을 준수하는 날짜와 시간의 조합입니다.
IPv4Address
IPv4 점 구분 십진수 표기법의 주소 (예: 192.168.1.1 ).
MAC 주소
콜론-16진수 표기법의 MAC 주소(예: 00:1A:2B:3C:4D:5E ).
내부 조회
다음 쿼리는 내부 용도로만 사용되며, 외부 사용자에게는 지원되지 않습니다. 완전성을 기하기 위해 여기에 기록해 두었습니다.
globalSearchSatelliteConnectorAccounts
IBM 글로벌 검색 서비스의 전 세계 검색 결과. 내부 사용 전용.
| 유형 | 이름 | 설명 |
|---|---|---|
| 리턴 | GlobalSearchSatelliteConnectorAccountsConnection |
|
| 인수 | after (String) |
|
| 인수 | first (Int) |
|
| 인수 | last (Int) |
|
| 인수 | before (String) |
|
| 인수 | regionName (String!) (필수) |
요청 예제
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"
}
}'
응답 예
{
"data": {
"globalSearchSatelliteConnectorAccounts": {
"edges": [
{
"cursor": "example-value",
"node": {
"externalID": "example-value"
}
}
],
"pageInfo": {
"endCursor": "example-value",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "example-value"
}
}
}
}