WorkerNodeの照会

VPC環境で利用できます。

クラスタ内に登録されている WorkerNodeリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/vnks/v2/clusters/{uuid}/nodes (韓国リージョン)
GET	/vnks/sgn-v2/clusters/{uuid}/nodes (シンガポールリージョン)
GET	/vnks/jpn-v2/clusters/{uuid}/nodes (日本リージョン)

リクエストヘッダ

Ncloud Kubernetes Service APIリクエストで共通して使用されるヘッダの詳細は、Ncloud Kubernetes Serviceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`uuid`	String	Required	クラスタの UUID クラスタリストの照会を参照

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://nks.apigw.ntruss.com/vnks/v2/clusters/0000a20e-e0fb-4dc9-af1b-97fd3f8d0000/nodes' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンス構文

レスポンス構文は次の通りです。

{
    "nodes": [
        {
            "id": "Integer",
            "name": "String",
            "serverName": "String",
            "serverSpec": "String",
            "privateIp": "String",
            "publicIp": "String",
            "returnProtectionYn": "String",
            "status": "String",
            "statusCode": "String",
            "statusColor": "String",
            "statusName": "String",
            "serverImageName": "String",
            "cpuCount": "Integer",
            "memorySize": "Integer",
            "softwareCode": "String",
            "productCode": "String",
            "specCode": "String",
            "loginKeyName": "String",
            "k8sStatus": "String",
            "dockerVersion": "String",
            "kernelVersion": "String",
            "nodePoolName": "String",
            "nodePoolId": "Integer",
            "providerID": "String"
        }
    ]
}

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`nodes[]`	Array	-	WorkerNodeリスト: nodes

`nodes`

nodesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`id`	Integer	-	WorkerNode ID
`name`	String	-	WorkerNode名前
`serverName`	String	-	サーバ名
`serverSpec`	String	-	サーバスペック
`privateIp`	String	-	プライベート IPアドレス
`publicIp`	String	-	グローバル IPアドレス
`returnProtectionYn`	String	-	返却保護設定をするかどうか
`status`	String	-	現在のステータス
`statusCode`	String	-	ステータスコード
`statusColor`	String	-	ステータスカラー
`statusName`	String	-	ステータス名
`serverImageName`	String	-	サーバイメージ名
`cpuCount`	Integer	-	CPU数
`memorySize`	Integer	-	メモリの総容量
`softwareCode`	String	-	サーバイメージコード
`productCode`	String	-	商品コード
`specCode`	String	-	@deprecated スペックコード
`loginKeyName`	String	-	認証キー名
`k8sStatus`	String	-	Kubernetesの状態
`dockerVersion`	String	-	Dockerバージョン
`kernelVersion`	String	-	カーネルバージョン
`nodePoolName`	String	-	ノードプール名
`nodePoolId`	Integer	-	ノードプール ID
`providerID`	String	-	プロバイダ ID

レスポンスステータスコード

Ncloud Kubernetes Service APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Kubernetes Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "nodes": [
        {
            "id": 23430000,
            "name": "nodepool01-w-4mnv",
            "serverName": "nodepool01-w-4mnv",
            "serverSpec": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
            "privateIp": "10.0.0.0",
            "publicIp": "223.0.0.0",
            "returnProtectionYn": "Y",
            "status": "RUN",
            "statusCode": "RUN",
            "statusColor": "green",
            "statusName": "Running",
            "serverImageName": "Ubuntu Server 20.04 (64-bit)",
            "cpuCount": 2,
            "memorySize": 8589934592,
            "softwareCode": "SW.VSVR.OS.LNX64.UBNTU.SVR2004.WRKND.0000",
            "productCode": "SVR.VSVR.STAND.C002.M008.NET.SSD.B050.0000",
            "specCode": "SVR.VSVR.STAND.C002.M008.NET.SSD.B050.0000",
            "loginKeyName": "a123",
            "k8sStatus": "Ready",
            "dockerVersion": "containerd://1.7.12",
            "kernelVersion": "5.4.0-99-generic",
            "nodePoolName": "nodepool01",
            "nodePoolId": 23430000,
            "providerID": "navercloudplatform://23430000"
        }
    ]
}