NodePoolの照会

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

クラスタ内にノードを作成するために設定したノードプールのリストを照会します。

リクエスト

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

メソッド	URI
GET	/clusters/{uuid}/node-pool

リクエストヘッダ

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

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

パラメータの説明は次の通りです。

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

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

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`hypervisorCode`	String	Optional	サーバのハイパーバイザタイプ `XEN` (デフォルト) \| `KVM`

リクエスト例

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

curl --location 'https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/node-pool?hypervisorCode=XEN' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {API gateway signature}' \

レスポンス

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

レスポンス構文

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

{
    "nodePool": [
        {
            "instanceNo": "integer",
            "k8sVersion": "string",
            "labels": [
                {
                    "key": "string",
                    "value": "string"
                }
            ],
            "name": "string",
            "nodeCount": "integer",
            "serverSpecCode": "string",
            "softwareCode": "string",
            "status": "string",
            "subnets": [],
            "taints": [
                {
                    "key": "string",
                    "effect": "string",
                    "value": "string"
                }
            ],
            "storageSize": "integer",
            "productCode": "string",
            "subnetNameList": [],
            "subnetNoList": [],
            "autoscale": {
                "enabled": "boolean"
            }
        },
        {
            "instanceNo": "integer",
            "k8sVersion": "string",
            "labels": [
                {
                    "key": "string",
                    "value": "string"
                }
            ],
            "name": "string",
            "nodeCount": "integer",
            "serverSpecCode": "string",
            "softwareCode": "string",
            "status": "string",
            "subnets": [],
            "taints": [
                {
                    "key": "string",
                    "effect": "string",
                    "value": "string"
                }
            ],
            "storageSize": "integer",
            "productCode": "string",
            "subnetNameList": [],
            "subnetNoList": [],
            "autoscale": {
                "enabled": "boolean"
            }
        }
    ]
}

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`nodePool[]`	Array	-	ノードプールリスト
`nodePool[].instanceNo`	Integer	-	ノードプールのインスタンス番号
`nodePool[].k8sVersion`	String	-	Kubernetesバージョン
`nodePool[].labels[]`	String	-	ノードプールの識別のためのラベル
`nodePool[].labels[].key`	String	-	ラベルのキー
`nodePool[].labels[].value`	String	-	ラベルの値
`nodePool[].name`	String	-	ノードプールの名前
`nodepool.nodeCount`	String	-	ノード数 1~250
`nodePool[].serverSpecCode`	String	-	ノードプールサーバのスペックコードサーバのハイパーバイザタイプが`KVM`の場合に表示
`nodePool[].softwareCode`	String	-	サーバイメージ情報
`nodePool[].status`	String	-	ノードプールの現在の状態
`nodePool[].subnets`	Array	-	ノードプールに属するサブネットリスト
`nodePool[].taints[]`	Array	-	スケジューラのノード管理のために設定された Taintリスト
`nodePool[].taints[].key`	String	-	Taintのキー
`nodePool[].taints[].effect`	String	-	スケジューラの管理方式 `NoSchedule` \| `PreferNoSchedule` \| `NoExecute`
`nodePool[].taints[].value`	String	-	Taintの値
`nodePool[].storageSize`	Integer	-	ノードプールサーバのストレージ容量
`nodePool[].productCode`	String	-	ノードプールサーバのスペックコードサーバのハイパーバイザタイプが`ZEN`の場合に表示
`nodePool[].subnetNameList[]`	Array	-	サブネットの名前リスト
`nodePool[].subnetNoList[]`	Array	-	サブネットの番号リスト
`nodePool[].autoscale`	Array	-	オートスケール情報
`nodePool[].autoscale.enabled`	Boolean	-	オートスケール可能かどうか `true` \| `false`
`nodePool[].autoscale.min`	Integer	-	最小ノード数
`nodePool[].autoscale.max`	Integer	-	最大ノード数

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

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

レスポンス例

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

{
    "nodePool": [
        {
            "instanceNo": 00000000,
            "k8sVersion": "1.27.9-nks.2",
            "labels": [
                {
                    "key": "key",
                    "value": "value"
                }
            ],
            "name": "name",
            "serverSpecCode": "s2-g3",
            "softwareCode": "SW.VSVR.OS.LNX64.UBNTU.SVR22.WRKND.G003",
            "status": "RUN",
            "subnets": [],
            "taints": [
                {
                    "key": "key",
                    "effect": "NoExecute",
                    "value": "value"
                }
            ],
            "storageSize": 100,
            "productCode": "SVR.VSVR.STAND.C002.M008.G003",
            "subnetNameList": [],
            "subnetNoList": [],
            "autoscale": {
                "enabled": false
            }
        },
        {
            "instanceNo": 00000000,
            "k8sVersion": "1.27.9-nks.2",
            "labels": [
                {
                    "key": "key",
                    "value": "value"
                }
            ],
            "name": "name",
            "nodeCount": 3,
            "serverSpecCode": "s2-g3",
            "softwareCode": "SW.VSVR.OS.LNX64.UBNTU.SVR22.WRKND.G003",
            "status": "RUN",
            "subnets": [],
            "taints": [
                {
                    "key": "key",
                    "effect": "NoExecute",
                    "value": "value"
                }
            ],
            "storageSize": 100,
            "productCode": "SVR.VSVR.STAND.C002.M008.G003",
            "subnetNameList": [],
            "subnetNoList": [],
            "autoscale": {
                "enabled": true,
                "min": 1,
                "max": 3
            }
        }
    ]
}

この記事は役に立ちましたか?

What's Next

NodePoolの作成

リクエスト
レスポンス