リクエスト

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

メソッド	URI
GET	/clusters

リクエストヘッダ

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

リクエスト例

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

curl --location --request GET 'https://nks.apigw.ntruss.com/vnks/v2/clusters' \
--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}' \
--header 'Content-Type: application/json'

レスポンス

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

レスポンス構文

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

{
    "clusters": [
        {
            "cpuCount": "Integer",
            "memorySize": "Integer",
            "status": "String",
            "nodeCount": "Integer",
            "nodeMaxCount": "Integer",
            "clusterType": "String",
            "hypervisorCode": "String",
            "instanceNo": "Integer",
            "id": "Integer",
            "acgName": "String",
            "acgNo": "Integer",
            "capacity": "String",
            "createdAt": "String",
            "updatedAt": "String",
            "endpoint": "String",
            "uuid": "String",
            "name": "String",
            "k8sVersion": "String",
            "regionCode": "String",
            "kubeNetworkPlugin": "String",
            "vpcNo": "Integer",
            "subnetNoList": [
                "Integer"
            ],
            "subnetLbNo": "Integer",
            "lbPrivateSubnetNo": "Integer",
            "lbPrivateSubnetName": "String",
            "lbPublicSubnetNo": "Integer",
            "lbPublicSubnetName": "String",
            "vpcName": "String",
            "subnetName": "String",
            "subnetNameList": [
                "String"
            ],
            "subnetLbName": "String",
            "loginKeyName": "String",
            "zoneCode": "String",
            "zoneNo": "Integer",
            "log": {
                "audit": "Boolean"
            },
            "publicNetwork": "Boolean",
            "iamAuth": "Boolean",
            "isDefaultIamAuth": "Boolean",
            "returnProtection": "Boolean",
            "kmsKeyTag": "String",
            "nodePool": [
                {
                    "instanceNo": "Integer",
                    "k8sVersion": "String",
                    "name": "String",
                    "nodeCount": "Integer",
                    "subnetNoList": [],
                    "subnetNameList": [],
                    "softwareCode": "String",
                    "productCode": "String",
                    "serverSpecCode": "String",
                    "storageSize": "Integer",
                    "status": "String",
                    "autoscale": {
                        "enabled": "Boolean",
                        "min": "Integer",
                        "max": "Integer"
                    }
                }
            ]
        }
    ]
}

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`clusters[]`	Array	-	クラスタリスト
`clusters[].cpuCount`	Integer	-	CPU数
`clusters[].memorySize`	Integer	-	メモリの総容量
`clusters[].status`	String	-	クラスタの状態
`clusters[].nodeCount`	Integer	-	登録されたノードの総数
`clusters[].nodeMaxCount`	Integer	-	使用可能なノードの最大数
`clusters[].clusterType`	String	-	クラスタのタイプ
`clusters[].hypervisorCode`	String	-	ハイパーバイザコード
`clusters[].instanceNo`	Integer	-	インスタンス番号
`clusters[].id`	Integer	-	クラスタ ID
`clusters[].acgName`	String	-	ACG名
`clusters[].acgNo`	Integer	-	ACG番号
`clusters[].capacity`	String	-	クラスタの容量
`clusters[].createdAt`	String	-	クラスタの作成日時
`clusters[].updatedAt`	String	-	最終更新日時
`clusters[].endpoint`	String	-	Control Plane APIアドレス
`clusters[].uuid`	String	-	クラスタの UUID
`clusters[].name`	String	-	クラスタ名
`clusters[].k8sVersion`	String	-	Kubernetesバージョン
`clusters[].regionCode`	String	-	リージョンコード
`clusters[].kuberNetworkPlugin`	String	-	CNIプラグインコード
`clusters[].vpcNo`	Integer	-	VPC ID
`clusters[].subnetNoList[]`	Array	-	サブネット IDリスト
`clusters[].subnetLbNo`	Integer	-	@deprecated Load Balancer専用のサブネット ID
`clusters[].lbPivateSubnetNo`	Integer	-	ロードバランサのプライベート Subnet ID
`clusters[].lbPivateSubnetName`	String	-	ロードバランサのプライベート Subnet名
`clusters[].lbPublicSubnetNo`	Integer	-	ロードバランサのプライベート Subnet番号
`clusters[].lbPublicSubnetName`	String	-	ロードバランサのプライベート Subnet名
`clusters[].vpcName`	String	-	VPC名
`clusters[].subnetName`	String	-	@deprecated Subnet名
`clusters[].subentNameList[]`	Array	-
`clusters[].subnetLbName`	String	-	@deprecated Load Balancer専用の Subnet名
`clusters[].loginKeyName`	String	-	認証キー名
`clusters[].zoneCode`	String	-	ゾーンコード
`clusters[].zoneNo`	Integer	-	ゾーン番号
`clusters[].log`	Array	-	ログリスト
`clusters[].log.audit`	Boolean	-	Audit Logを設定
`clusters[].publicNetwork`	Boolean	-	Public Network
`clusters[].iamAuth`	Boolean	-
`clusters[].isDefaultIamAuth`	Boolean	-
`clusters[].returnProtection`	Boolean	-
`clusters[].kmsKeyTag`	String	-
`clusters[].nodePool[]`	Array	-	ノードプールリスト
`clusters[].nodePool[].instanceNo`	Integer	-	ノードプールインスタンス番号
`clusters[].nodePool[].k8sVersion`	String	-	ノードプール Kubernetesバージョン
`clusters[].nodePool[].name`	String	-	ノードプール名
`clusters[].nodePool[].nodeCount`	Integer	-	ノード数
`clusters[].nodePool[].subnetNoList[]`	Array	-	ノードプール Subnet番号リスト
`clusters[].nodePool[].subnetNameList[]`	Array	-	@deprecated ノードプール Subnet名リスト
`clusters[].nodePool[].softwareCode`	String	-	ソフトウェアコード
`clusters[].nodePool[].productCode`	String	-	商品コード
`clusters[].nodePool[].serverSpecCode`	String	-	サーバスペックコード
`clusters[].nodePool[].storageSize`	Integer	-	ストレージ容量
`clusters[].nodePool[].status`	String	-	ノードプールの状態
`clusters[].nodePool[].autoscale`	Array	-	オートスケールリスト
`clusters[].nodePool[].autoscale.enabled`	Boolean	-
`clusters[].nodePool[].autoscale.min`	Integer	-
`clusters[].nodePool[].autoscale.max`	Integer	-
`clusters[].nodePool[].serverRoleId`	String	-	IAMサーバの Role ID

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

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

レスポンス例

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

{
    "clusters": [
        {
            "cpuCount": 2,
            "memorySize": 8,
            "status": "RUNNING",
            "nodeCount": 1,
            "nodeMaxCount": 1,
            "clusterType": "AAA.VNKS.STAND.C002.M008.G000",
            "hypervisorCode": "KVM",
            "instanceNo": 23320000,
            "id": 14000,
            "acgName": "nks-14000-acgname",
            "acgNo": 160009,
            "capacity": "vCPU 2EA, Memory 8GB",
            "createdAt": "2024-03-28T07:30:59.000Z",
            "updatedAt": "2024-03-28T07:47:53.000Z",
            "endpoint": "https://****a20e-e0fb-4dc9-af1b-97fd3f8d****.kr.vnks.ntruss.com",
            "uuid": "****a20e-e0fb-4dc9-af1b-97fd3f8d****",
            "name": "cluster00",
            "k8sVersion": "1.27.9-nks.2",
            "regionCode": "KR",
            "kubeNetworkPlugin": "cilium",
            "vpcNo": 59000,
            "subnetNoList": [
                139000
            ],
            "subnetLbNo": 139000,
            "lbPrivateSubnetNo": 139000,
            "lbPrivateSubnetName": "k8s-lbsubnet2 | KR-1 | 0.0.0.0/0 | Private",
            "lbPublicSubnetNo": 139000,
            "lbPublicSubnetName": "k8s-lbsubnet | KR-1 | 0.0.0.0/0 | Public",
            "vpcName": "k8s-vpc | 0.0.0.0/0",
            "subnetName": "k8s-subnet",
            "subnetNameList": [
                "k8s-subnet | KR-1 | 0.0.0.0/0 | Public"
            ],
            "subnetLbName": "k8s-lbsubnet2 | KR-1 | 0.0.0.0/0 | Private",
            "loginKeyName": "a123",
            "zoneCode": "KR-1",
            "zoneNo": 2,
            "log": {
                "audit": false
            },
            "publicNetwork": true,
            "iamAuth": true,
            "isDefaultIamAuth": true,
            "returnProtection": false,
            "kmsKeyTag": "****83e65495374b9cf590a783f442fd50eb48c54eb56774de1ff62bcda4****",
            "nodePool": [
                {
                    "instanceNo": 23320000,
                    "k8sVersion": "1.27.9",
                    "name": "nodepool",
                    "nodeCount": 1,
                    "subnetNoList": [],
                    "subnetNameList": [],
                    "softwareCode": "SW.AAAA.OS.LNX64.UBNTU.SVR22.WRKND.AAAA",
                    "productCode": "SVR.AAAA.STAND.C002.M008.AAAA",
                    "serverSpecCode": "s2-g3",
                    "storageSize": 100,
                    "status": "RUN",
                    "serverRoleId": "***1fdc0-eb90-11ec-a2d9-246e966eb***",
                    "autoscale": {
                        "enabled": false,
                        "min": 0,
                        "max": 0
                    }
                }
            ]
        }
    ]
}

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

リクエスト
- リクエストヘッダ
- リクエスト例
レスポンス