リクエスト

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

メソッド	URI
GET	/clusters/{uuid}

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://nks.apigw.ntruss.com/vnks/v2/clusters/****a20e-e0fb-4dc9-af1b-97fd3f8d****' \
--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'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "cluster": {
        "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": 1600009,
        "capacity": "vCPU 2EA, Memory 8GB",
        "createdAt": "2024-03-28T07:30:59.000Z",
        "updatedAt": "2024-03-28T08:26:33.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": "-",
        "lbPublicSubnetNo": 139000,
        "lbPublicSubnetName": "-",
        "vpcName": "k8s-vpc | 10.0.0.0/16",
        "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": true,
        "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
                }
            }
        ]
    }
}

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

リクエスト
レスポンス