Login
      내용 x
      API V2 가이드
        • 인쇄
        • PDF
        내용

        API V2 가이드

          • 인쇄
          • PDF
          Article Summary

          기본 정보

          API URL

          https://nks.apigw.ntruss.com/vnks

          API Header

          항목Mandatory설명
          Content-TypeMandatory요청 Body Content Type을 application/json으로 지정
          x-ncp-apigw-timestampMandatory1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타냄
          API Gateway 서버와 시간차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
          x-ncp-iam-access-keyMandatory포탈 또는 Sub Account에서 발급받은 Access Key ID
          x-ncp-apigw-signature-v2Mandatory위 예제의 Body를 Access Key Id와 맵핑되는 SecretKey로 암호화한 서명
          HMAC 암호화 알고리즘은 HmacSHA256 사용

          Ncloud Kubernetes Service API V2

          Cluster 목록 조회

          Cluster 목록을 조회합니다.

          요청 URL

          GET https://nks.apigw.ntruss.com/vnks/v2/clusters [KR]
GET https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters [SGN]
GET https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters [JPN]

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          응답 Body

          {
  "clusters": [
    {
      "uuid": "string",
      "acgName": "string",
      "acgNo": "integer",
      "name": "string",
      "capacity": "string",
      "clusterType": "string",
      "hypervisorCode": "string",
      "nodeCount": "integer",
      "nodeMaxCount": "integer",
      "cpuCount": "integer",
      "memorySize": "integer",
      "createdAt": "string",
      "endpoint": "string",
      "k8sVersion": "string",
      "regionCode": "string",
      "status": "string",
      "kubeNetworkPlugin": "string",
      "subnetLbName": "string",
      "subnetLbNo": "integer",
      "lbPrivateSubnetNo": "integer",
      "lbPublicSubnetNo": "integer",
      "subnetName": "string",
      "subnetNoList": [
        "integer"
      ],
      "updatedAt": "string",
      "vpcName": "string",
      "vpcNo": "integer",
      "zoneCode": "string",
      "zoneNo": "integer",
      "initScriptNo": "integer",
      "initScriptName": "string",
      "podSecurityPolicyEnabled": "boolean",
      "loginKeyName": "string",
      "nodePool": [
        {
          "instanceNo": "integer",
          "isDefault": "boolean",
          "name": "string",
          "nodeCount": "integer",
          "subnetNoList": [
            "integer"
          ],
          "subnetNameList": [
            "string"
          ],
          "status": "string",
          "autoscale": {
            "enabled": "boolean",
            "max": "integer",
            "min": "integer"
          },
          "softwareCode": "string",
          "productCode": "string",
          "k8sVersion": "string",
          "serverSpecCode": "string",
          "storageSize": "integer",
          "labels": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "taints": [
            {
              "key": "string",
              "value": "string",
              "effect": "string"
            }
          ],
          "serverRoleId": "string"
        }
      ],
      "log": {
        "audit": "boolean"
      },
      "publicNetwork": "boolean",
      "returnProtection": "boolean"
    }
  ]
}
          CategoryTypeDescriptionNote
          clusters[]array클러스터 목록
          clusters[].uuidstring클러스터 uuid
          clusters[].acgNamestring클러스터 acg 이름
          clusters[].acgNointeger클러스터 acg no
          clusters[].namestring클러스터 이름
          clusters[].capacitystring클러스터 용량
          clusters[].clusterTypestring클러스터 타입
          clusters[].hypervisorCodestringHypervisor Code
          clusters[].nodeCountinteger등록된 노드 총 개수
          clusters[].nodeMaxCountinteger사용할 수 있는 노드의 최대 개수
          clusters[].cpuCountintegercpu 개수
          clusters[].memorySizeinteger메모리 용량
          clusters[].createdAtstring생성 일자
          clusters[].endpointstringControl Plane API 주소
          clusters[].k8sVersionstring쿠버네티스 버전
          clusters[].regionCodestringregion의 코드
          clusters[].statusstring클러스터 상태
          clusters[].kubeNetworkPluginstringCNI Plugin Code
          clusters[].subnetLbNamestring@deprecated 로드밸런서 전용 서브넷 이름
          clusters[].subnetLbNointeger@deprecated 로드밸런서 전용 Private Subnet No
          clusters[].lbPrivateSubnetNointeger로드밸런서 전용 Private Subnet No
          clusters[].lbPublicSubnetNointeger로드밸런서 전용 Public Subnet No
          clusters[].subnetNamestring@deprecated 서브넷 이름
          clusters[].subnetNoList[]array서브넷 No 목록
          clusters[].updatedAtstring최근 업데이트 일자
          clusters[].vpcNamestringvpc 이름
          clusters[].vpcNointegervpc 번호
          clusters[].zoneCodestringzone 코드
          clusters[].zoneNointegerzone 번호
          clusters[].initScriptNointeger@deprecated InitScript 번호
          clusters[].initScriptNamestring@deprecated InitScript 이름
          clusters[].podSecurityPolicyEnabledboolean@deprecated Pod Security Policy 설정 여부
          clusters[].loginKeyNamestring로그인 키 이름
          clusters[].nodePool[]array노드풀
          clusters[].nodePool[].instanceNointeger인스턴스 번호
          clusters[].nodePool[].isDefaultboolean@deprecated default pool 여부
          clusters[].nodePool[].namestring노드풀 이름
          clusters[].nodePool[].nodeCountinteger노드 개수
          clusters[].nodePool[].subnetNoList[]arraySubnet 번호 목록
          clusters[].nodePool[].subnetNameList[]array@deprecated Subnet 이름 목록
          clusters[].nodePool[].statusstring노드풀 상태
          clusters[].nodePool[].autoscale오토스케일
          clusters[].nodePool[].autoscale.enabledboolean오토스케일 가능여부
          clusters[].nodePool[].autoscale.maxinteger오토스케일 가능 최대 노드 수
          clusters[].nodePool[].autoscale.mininteger오토스케일 가능 최소 노드 수
          clusters[].nodePool[].softwareCodestringSoftware Code(OS)
          clusters[].nodePool[].productCodestring상품 코드
          clusters[].nodePool[].k8sVersionstring쿠버네티스 버전
          clusters[].nodePool[].serverSpecCodestring서버 스펙 코드
          clusters[].nodePool[].storageSizeinteger스토리지 크기
          clusters[].nodePool[].labels[]array
          clusters[].nodePool[].labels[].keystring
          clusters[].nodePool[].labels[].valuestring
          clusters[].nodePool[].taints[]array
          clusters[].nodePool[].taints[].keystring
          clusters[].nodePool[].taints[].valuestring
          clusters[].nodePool[].taints[].effectstring
          clusters[].nodePool[].serverRoleIdstring
          clusters[].log
          clusters[].log.auditbooleanAudit Log 설정
          clusters[].publicNetworkbooleanPublic Network
          clusters[].returnProtectionboolean

          응답 Status

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          500Internal Server Error

          Cluster 조회

          단일 Cluster 조회합니다.

          요청 URL

          GET https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid} [KR]
GET https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid} [SGN]
GET https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid} [JPN]

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          항목MandatoryType설명비고
          uuidMandatorystringcluster uuid조회할 클러스터의 uuid

          Headers

          응답 Body

          {
  "cluster": {
    "uuid": "string",
    "acgName": "string",
    "acgNo": "integer",
    "name": "string",
    "capacity": "string",
    "clusterType": "string",
    "hypervisorCode": "string",
    "nodeCount": "integer",
    "nodeMaxCount": "integer",
    "cpuCount": "integer",
    "memorySize": "integer",
    "createdAt": "string",
    "endpoint": "string",
    "k8sVersion": "string",
    "regionCode": "string",
    "status": "string",
    "kubeNetworkPlugin": "string",
    "subnetLbName": "string",
    "subnetLbNo": "integer",
    "lbPrivateSubnetNo": "integer",
    "lbPublicSubnetNo": "integer",
    "subnetName": "string",
    "subnetNoList": [
      "integer"
    ],
    "updatedAt": "string",
    "vpcName": "string",
    "vpcNo": "integer",
    "zoneCode": "string",
    "zoneNo": "integer",
    "initScriptNo": "integer",
    "initScriptName": "string",
    "podSecurityPolicyEnabled": "boolean",
    "loginKeyName": "string",
    "nodePool": [
      {
        "instanceNo": "integer",
        "isDefault": "boolean",
        "name": "string",
        "nodeCount": "integer",
        "subnetNoList": [
          "integer"
        ],
        "subnetNameList": [
          "string"
        ],
        "status": "string",
        "autoscale": {
          "enabled": "boolean",
          "max": "integer",
          "min": "integer"
        },
        "softwareCode": "string",
        "productCode": "string",
        "k8sVersion": "string",
        "serverSpecCode": "string",
        "storageSize": "integer",
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "taints": [
          {
            "key": "string",
            "value": "string",
            "effect": "string"
          }
        ],
        "serverRoleId": "string"
      }
    ],
    "log": {
      "audit": "boolean"
    },
    "publicNetwork": "boolean",
    "returnProtection": "boolean"
  }
}
          CategoryTypeDescriptionNote
          cluster클러스터
          cluster.uuidstring클러스터 uuid
          cluster.acgNamestring클러스터 acg 이름
          cluster.acgNointeger클러스터 acg no
          cluster.namestring클러스터 이름
          cluster.capacitystring클러스터 용량
          cluster.clusterTypestring클러스터 타입
          cluster.hypervisorCodestringHypervisor Code
          cluster.nodeCountinteger등록된 노드 총 개수
          cluster.nodeMaxCountinteger사용할 수 있는 노드의 최대 개수
          cluster.cpuCountintegercpu 개수
          cluster.memorySizeinteger메모리 용량
          cluster.createdAtstring생성 일자
          cluster.endpointstringControl Plane API 주소
          cluster.k8sVersionstring쿠버네티스 버전
          cluster.regionCodestringregion의 코드
          cluster.statusstring클러스터 상태
          cluster.kubeNetworkPluginstringCNI Plugin Code
          cluster.subnetLbNamestring@deprecated 로드밸런서 전용 서브넷 이름
          cluster.subnetLbNointeger@deprecated 로드밸런서 전용 Private Subnet No
          cluster.lbPrivateSubnetNointeger로드밸런서 전용 Private Subnet No
          cluster.lbPublicSubnetNointeger로드밸런서 전용 Public Subnet No
          cluster.subnetNamestring@deprecated 서브넷 이름
          cluster.subnetNoList[]array서브넷 No 목록
          cluster.updatedAtstring최근 업데이트 일자
          cluster.vpcNamestringvpc 이름
          cluster.vpcNointegervpc 번호
          cluster.zoneCodestringzone 코드
          cluster.zoneNointegerzone 번호
          cluster.initScriptNointeger@deprecated InitScript 번호
          cluster.initScriptNamestring@deprecated InitScript 이름
          cluster.podSecurityPolicyEnabledboolean@deprecated Pod Security Policy 설정 여부
          cluster.loginKeyNamestring로그인 키 이름
          cluster.nodePool[]array노드풀
          cluster.nodePool[].instanceNointeger인스턴스 번호
          cluster.nodePool[].isDefaultboolean@deprecated default pool 여부
          cluster.nodePool[].namestring노드풀 이름
          cluster.nodePool[].nodeCountinteger노드 개수
          cluster.nodePool[].subnetNoList[]arraySubnet 번호 목록
          cluster.nodePool[].subnetNameList[]array@deprecated Subnet 이름 목록
          cluster.nodePool[].statusstring노드풀 상태
          cluster.nodePool[].autoscale오토스케일
          cluster.nodePool[].autoscale.enabledboolean오토스케일 가능여부
          cluster.nodePool[].autoscale.maxinteger오토스케일 가능 최대 노드 수
          cluster.nodePool[].autoscale.mininteger오토스케일 가능 최소 노드 수
          cluster.nodePool[].softwareCodestringSoftware Code(OS)
          cluster.nodePool[].productCodestring상품 코드
          cluster.nodePool[].k8sVersionstring쿠버네티스 버전
          cluster.nodePool[].serverSpecCodestring서버 스펙 코드
          cluster.nodePool[].storageSizeinteger스토리지 크기
          cluster.nodePool[].labels[]array
          cluster.nodePool[].labels[].keystring
          cluster.nodePool[].labels[].valuestring
          cluster.nodePool[].taints[]array
          cluster.nodePool[].taints[].keystring
          cluster.nodePool[].taints[].valuestring
          cluster.nodePool[].taints[].effectstring
          cluster.nodePool[].serverRoleIdstring
          cluster.log
          cluster.log.auditbooleanAudit Log 설정
          cluster.publicNetworkbooleanPublic Network
          cluster.returnProtectionboolean

          응답 Status

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          500Internal Server Error

          Cluster 생성

          Cluster를 생성합니다.

          요청 URL

          POST https://nks.apigw.ntruss.com/vnks/v2/clusters [KR]
POST https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters [SGN]
POST https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 Body

          {
  "name": "string",
  "clusterType": "string",
  "k8sVersion": "string",
  "loginKeyName": "string",
  "hypervisorCode": "string",
  "regionCode": "string",
  "zoneCode": "string",
  "zoneNo": "integer",
  "publicNetwork": "boolean",
  "kubeNetworkPlugin": "string",
  "vpcNo": "integer",
  "subnetNoList": [
    "integer"
  ],
  "subnetLbNo": "integer",
  "lbPrivateSubnetNo": "integer",
  "lbPublicSubnetNo": "integer",
  "log": {
    "audit": "boolean"
  },
  "defaultNodePool": {
    "name": "string",
    "nodeCount": "integer",
    "subnetNo": "integer",
    "subnetNoList": [
      "integer"
    ],
    "softwareCode": "string",
    "productCode": "string",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "taints": [
      {
        "key": "string",
        "value": "string",
        "effect": "string"
      }
    ],
    "serverSpecCode": "string",
    "storageSize": "integer",
    "serverRoleId": "string"
  },
  "nodePool": [
    {
      "name": "string",
      "nodeCount": "integer",
      "subnetNo": "integer",
      "subnetNoList": [
        "integer"
      ],
      "softwareCode": "string",
      "productCode": "string",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "taints": [
        {
          "key": "string",
          "value": "string",
          "effect": "string"
        }
      ],
      "serverSpecCode": "string",
      "storageSize": "integer",
      "serverRoleId": "string"
    }
  ]
}
          CategoryMandatoryTypeDescriptionNote
          nameMandatorystring클러스터 이름
          clusterTypeMandatorystring클러스터 타입
          k8sVersionstring쿠버네티스 버전 Version 조회 API
          loginKeyNameMandatorystring로그인 키 이름
          hypervisorCodestringHypervisor Code
          regionCodeMandatorystringRegion의 코드
          zoneCodestringZone 코드
          zoneNointegerZone 번호
          publicNetworkbooleanPublic network
          kubeNetworkPluginstringCNI Plugin Code (ncloud-vpc-cni or cilium)
          vpcNoMandatoryintegerVPC 번호
          subnetNoList[]Mandatoryarray서브넷 번호 목록
          subnetLbNointeger@deprecated 로드밸런서 전용 Private Subnet 번호
          lbPrivateSubnetNointeger로드밸런서 전용 Private Subnet 번호
          lbPublicSubnetNointeger로드밸런서 전용 Public Subnet 번호
          loglog
          log.auditbooleanAudit Log 설정
          defaultNodePool@deprecated 기본 노드풀
          defaultNodePool.namestring노드풀 이름
          defaultNodePool.nodeCountinteger노드 개수
          defaultNodePool.subnetNointeger@deprecated Subnet 번호
          defaultNodePool.subnetNoList[]arraySubnet 번호
          defaultNodePool.softwareCodestringServer image code
          defaultNodePool.productCodestring상품 코드
          defaultNodePool.labels[]array
          defaultNodePool.labels[].keystring
          defaultNodePool.labels[].valuestring
          defaultNodePool.taints[]array
          defaultNodePool.taints[].keystring
          defaultNodePool.taints[].valuestring
          defaultNodePool.taints[].effectstring
          defaultNodePool.serverSpecCodestringServer spec code
          defaultNodePool.storageSizeintegerStorage size
          defaultNodePool.serverRoleIdstring
          nodePool[]array추가 노드풀
          nodePool[].namestring노드풀 이름
          nodePool[].nodeCountinteger노드 개수
          nodePool[].subnetNointeger@deprecated Subnet 번호
          nodePool[].subnetNoList[]arraySubnet 번호
          nodePool[].softwareCodestringServer image code
          nodePool[].productCodestring상품 코드
          nodePool[].labels[]array
          nodePool[].labels[].keystring
          nodePool[].labels[].valuestring
          nodePool[].taints[]array
          nodePool[].taints[].keystring
          nodePool[].taints[].valuestring
          nodePool[].taints[].effectstring
          nodePool[].serverSpecCodestringServer spec code
          nodePool[].storageSizeintegerStorage size
          nodePool[].serverRoleIdstring
          참고
          • vpcNo, subnetNoList, subnetLbNo 파라미터는 각 리소스에 상세 페이지에서 ID 값을 확인할 수 있습니다.
          • loginKeyName 파라미터는 서버 관리 및 설정 > 인증키 관리메뉴에서 인증키 이름을 확인할 수 있습니다.

          응답 Body

          {
  "uuid": "string"
}

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          409Conflict
          500Internal Server Error

          Cluster 업그레이드

          Cluster를 업그레이드합니다.

          요청 URL

          PATCH https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/upgrade [KR]
PATCH https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/upgrade [SGN]
PATCH https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/upgrade [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 파라미터

          항목위치필수여부타입설명
          uuidpathYstringcluster uuid
          k8sVersionqueryYstringkubernetes version
          maxSurgequeryNintegermaxSurge
          maxUnavailablequeryNintegermaxUnavailable

          응답 Body

          {
  "uuid": "string"
}
          항목Type설명비고
          uuidstring클러스터 uuid

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          409Conflict
          500Internal Server Error

          Cluster Audit Log 설정

          Cluster의 Audit Log를 설정합니다.

          요청 URL

          PATCH https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/log [KR]
PATCH https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/log [SGN]
PATCH https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/log [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 파라미터

          항목위치필수여부타입설명
          uuidpathYstringcluster uuid

          요청 Body

          {
  "audit": "boolean"
}
          CategoryMandatoryTypeDescriptionNote
          auditMandatoryboolean

          응답 Body

          {
  "uuid": "string"
}
          항목Type설명비고
          uuidstring클러스터 uuid

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          409Conflict
          500Internal Server Error

          Cluster Subnet 추가

          Cluster의 Subnet을 추가합니다.

          요청 URL

          PATCH https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/add-subnet [KR]
PATCH https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/add-subnet [SGN]
PATCH https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/add-subnet [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 파라미터

          항목위치필수여부타입설명
          uuidpathYstringcluster uuid

          요청 Body

          {
  "subnets": [
    {
      "number": "integer"
    }
  ]
}
          CategoryMandatoryTypeDescriptionNote
          subnets[]Mandatoryarray
          subnets[].numberinteger
          참고
          • Subnet은 최대 5개까지 설정할 수 있습니다.

          응답 Body

          {
  "uuid": "string"
}
          항목Type설명비고
          uuidstring클러스터 uuid

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          409Conflict
          500Internal Server Error

          Cluster OIDC 설정

          Cluster의 OIDC를 설정합니다.

          요청 URL

          PATCH https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/oidc [KR]
PATCH https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/oidc [SGN]
PATCH https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/oidc [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 파라미터

          항목위치필수여부타입설명
          uuidpathYstringcluster uuid

          요청 Body

          {
  "clientId": "string",
  "issuerURL": "string",
  "status": "boolean",
  "groupsClaim": "string",
  "groupsPrefix": "string",
  "usernameClaim": "string",
  "usernamePrefix": "string",
  "requiredClaim": "string"
}
          CategoryMandatoryTypeDescriptionNote
          clientIdMandatorystring
          issuerURLMandatorystring
          statusMandatoryboolean
          groupsClaimstring
          groupsPrefixstring
          usernameClaimstring
          usernamePrefixstring
          requiredClaimstring

          응답 Body

          {
  "uuid": "string"
}
          항목Type설명비고
          uuidstring클러스터 uuid

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          409Conflict
          500Internal Server Error

          Cluster OIDC 조회

          Cluster의 OIDC 설정을 조회합니다.

          요청 URL

          GET https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/oidc [KR]
GET https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/oidc [SGN]
GET https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/oidc [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 파라미터

          항목위치필수여부타입설명
          uuidpathYstringcluster uuid

          응답 Body

          {
  "clientId": "string",
  "groupsClaim": "string",
  "groupsPrefix": "string",
  "issuerURL": "string",
  "requiredClaim": "string",
  "status": "boolean",
  "usernameClaim": "string",
  "usernamePrefix": "string"
}
          CategoryTypeDescriptionNote
          clientIdstring
          groupsClaimstring
          groupsPrefixstring
          issuerURLstring
          requiredClaimstring
          statusboolean
          usernameClaimstring
          usernamePrefixstring

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          409Conflict
          500Internal Server Error

          Cluster IP ACL 설정

          Cluster의 IP ACL를 설정합니다.

          요청 URL

          PATCH https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/ip-acl [KR]
PATCH https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/ip-acl [SGN]
PATCH https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/ip-acl [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 파라미터

          항목위치필수여부타입설명
          uuidpathYstringcluster uuid

          요청 Body

          {
  "defaultAction": "string",
  "entries": [
    {
      "action": "string",
      "address": "string",
      "comment": "string"
    }
  ]
}
          CategoryMandatoryTypeDescriptionNote
          defaultActionMandatorystring
          entries[]array
          entries[].actionstring
          entries[].addressstring
          entries[].commentstring

          응답 Body

          {
  "uuid": "string"
}
          항목Type설명비고
          uuidstring클러스터 uuid

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          409Conflict
          500Internal Server Error

          Cluster IP ACL 조회

          Cluster의 IP ACL 설정을 조회합니다.

          요청 URL

          GET https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/ip-acl [KR]
GET https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/ip-acl [SGN]
GET https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/ip-acl [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 파라미터

          항목위치필수여부타입설명
          uuidpathYstringcluster uuid

          응답 Body

          {
  "defaultAction": "string",
  "entries": [
    {
      "action": "string",
      "address": "string",
      "comment": "string"
    }
  ]
}
          CategoryTypeDescriptionNote
          defaultActionstring
          entries[]array
          entries[].actionstring
          entries[].addressstring
          entries[].commentstring

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          409Conflict
          500Internal Server Error

          Cluster Load Balancer Subnet 수정

          클러스터 내 Load Balancer Subnet이 삭제된 경우 이 설정을 수정합니다.

          요청 URL

          PATCH https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/lb-subnet [KR]
PATCH https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/lb-subnet [SGN]
PATCH https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/lb-subnet [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 파라미터

          ItemLocationRequiredTypeDescription
          uuidpathstringCluster uuid-
          lbSubnetNoqueryintegerLoad Balancer Subnet Instance No.-

          요청 Body

          없음

          응답 Body

          {
  "uuid": "string"
}

          응답 Status

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Cluster 반납보호 설정

          Cluster의 반납보호를 설정합니다.

          요청 URL

          PATCH https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/return-protection [KR]
PATCH https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/return-protection [SGN]
PATCH https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/return-protection [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 파라미터

          항목위치필수여부타입설명
          uuidpathYstringcluster uuid

          요청 Body

          {
  "returnProtection": "boolean"
}
          CategoryMandatoryTypeDescriptionNote
          returnProtectionMandatoryboolean

          응답 Body

          {
  "uuid": "string"
}

          응답 Status

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          409Conflict
          500Internal Server Error

          Cluster 삭제

          특정 Cluster를 삭제합니다.

          요청 URL

          DELETE https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid} [KR]
DELETE https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid} [SGN]
DELETE https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid} [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          항목MandatoryType설명비고
          uuidMandatorystringcluster uuid삭제할 클러스터의 uuid

          Headers

          요청 Body

          없음

          응답 Body

          없음

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          WorkerNode 조회

          Cluster 내 등록된 WorkerNode들의 목록을 반환합니다.

          요청 URL

          GET https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/nodes [KR]
GET https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/nodes [SGN]
GET https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/nodes [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          항목MandatoryType설명비고
          uuidMandatorystringcluster uuid클러스터의 uuid

          Headers

          요청 Body

          없음

          응답 Body

          {
  "nodes": [
    {
      "id": "integer",
      "name": "string",
      "serverName": "string",
      "serverSpec": "string",
      "privateIp": "string",
      "publicIp": "string",
      "returnProtectionYn": "string",
      "status": "string",
      "statusCode": "string",
      "statusIcon": "string",
      "statusColor": "string",
      "statusName": "string",
      "serverImageName": "string",
      "cpuCount": "integer",
      "memorySize": "integer",
      "softwareCode": "string",
      "specCode": "string",
      "productCode": "string",
      "loginKeyName": "string",
      "k8sStatus": "string",
      "dockerVersion": "string",
      "kernelVersion": "string",
      "providerID": "string",
      "nodePoolId": "integer",
      "nodePoolName": "string"
    }
  ]
}
          CategoryTypeDescriptionNote
          nodes[]array워커노드 목록
          nodes[].idinteger워커노드 id
          nodes[].namestring워커노드 이름
          nodes[].serverNamestring워커노드 서버이름
          nodes[].serverSpecstring워커노드 서버 스펙
          nodes[].privateIpstring비 공인 IP
          nodes[].publicIpstring공인 IP
          nodes[].returnProtectionYnstring반납 보호 설정
          nodes[].statusstring워커노드 현재 상태
          nodes[].statusCodestring상태 코드
          nodes[].statusIconstring상태 아이콘
          nodes[].statusColorstring상태 색깔
          nodes[].statusNamestring상태 이름
          nodes[].serverImageNamestring서버 이미지 이름
          nodes[].cpuCountintegercpu 수
          nodes[].memorySizeinteger총 메모리 용량
          nodes[].softwareCodestring서버 이미지 코드
          nodes[].specCodestring@deprecated 스펙 코드
          nodes[].productCodestring스펙 코드
          nodes[].loginKeyNamestring로그인 키 이름
          nodes[].k8sStatusstring쿠버네티스 상태
          nodes[].dockerVersionstring도커 버전
          nodes[].kernelVersionstring커널 버전
          nodes[].providerIDstringproviderID
          nodes[].nodePoolIdinteger노드풀 ID
          nodes[].nodePoolNamestring노드풀 이름

          응답 Status

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          WorkerNode 삭제

          WorkerNode를 삭제합니다.

          요청 URL

          DELETE https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/nodes/{instanceNo} [KR]
DELETE https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/nodes/{instanceNo} [SGN]
DELETE https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/nodes/{instanceNo} [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          항목MandatoryType설명비고
          uuidMandatorystring제거할 WorkerNode의 클러스터 uuid-
          instanceNoMandatoryintegerWorkerNode instance 번호-

          Headers

          요청 Body

          없음

          응답 Body

          없음

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          NodePool 조회

          클러스터 내 등록 된 NodePool을 조회합니다.

          요청 URL

          GET https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/node-pool [KR]
GET https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/node-pool [SGN]
GET https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/node-pool [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          항목MandatoryType설명비고
          uuidMandatorystringcluster uuid조회할 노드풀의 클러스터 uuid

          Headers

          요청 Body

          없음

          응답 Body

          {
  "nodePool": [
    {
      "instanceNo": "integer",
      "isDefault": "boolean",
      "name": "string",
      "nodeCount": "integer",
      "subnetNoList": [
        "integer"
      ],
      "subnetNameList": [
        "string"
      ],
      "status": "string",
      "autoscale": {
        "enabled": "boolean",
        "max": "integer",
        "min": "integer"
      },
      "softwareCode": "string",
      "productCode": "string",
      "k8sVersion": "string",
      "serverSpecCode": "string",
      "storageSize": "integer",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "taints": [
        {
          "key": "string",
          "value": "string",
          "effect": "string"
        }
      ],
      "serverRoleId": "string"
    }
  ]
}
          CategoryTypeDescriptionNote
          nodePool[]array노드풀
          nodePool[].instanceNointeger인스턴스 번호
          nodePool[].isDefaultboolean@deprecated default pool 여부
          nodePool[].namestring노드풀 이름
          nodePool[].nodeCountinteger노드 개수
          nodePool[].subnetNoList[]arraySubnet 번호 목록
          nodePool[].subnetNameList[]array@deprecated Subnet 이름 목록
          nodePool[].statusstring노드풀 상태
          nodePool[].autoscale오토스케일
          nodePool[].autoscale.enabledboolean오토스케일 가능여부
          nodePool[].autoscale.maxinteger오토스케일 가능 최대 노드 수
          nodePool[].autoscale.mininteger오토스케일 가능 최소 노드 수
          nodePool[].softwareCodestringSoftware Code(OS)
          nodePool[].productCodestring상품 코드
          nodePool[].k8sVersionstring쿠버네티스 버전
          nodePool[].serverSpecCodestring서버 스펙 코드
          nodePool[].storageSizeinteger스토리지 크기
          nodePool[].labels[]array
          nodePool[].labels[].keystring
          nodePool[].labels[].valuestring
          nodePool[].taints[]array
          nodePool[].taints[].keystring
          nodePool[].taints[].valuestring
          nodePool[].taints[].effectstring
          nodePool[].serverRoleIdstring

          응답 Status

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          NodePool 생성

          Cluster 내에 NodePool을 생성합니다.

          요청 URL

          POST https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/node-pool [KR]
POST https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/node-pool [SGN]
POST https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/node-pool [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          항목MandatoryType설명비고
          uuidMandatorystringcluster uuid생성할 노드풀의 클러스터 uuid

          Headers

          요청 Body

          {
  "name": "string",
  "nodeCount": "integer",
  "subnetNo": "integer",
  "subnetNoList": [
    "integer"
  ],
  "softwareCode": "string",
  "productCode": "string",
  "serverSpecCode": "string",
  "storageSize": "integer",
  "autoscale": {
    "enabled": "boolean",
    "max": "integer",
    "min": "integer"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "taints": [
    {
      "key": "string",
      "value": "string",
      "effect": "string"
    }
  ],
  "serverRoleId": "string"
}
          CategoryMandatoryTypeDescriptionNote
          nameMandatorystring노드풀 이름
          nodeCountMandatoryinteger등록 될 노드 개수
          subnetNointegerSubnet 번호
          subnetNoList[]arraySubnet 번호
          softwareCodestringServer image code
          productCodestring상품 코드 서버 스펙 목록
          serverSpecCodestringServer spec code
          storageSizeintegerStorage size
          autoscale오토스케일
          autoscale.enabledboolean오토스케일 가능여부
          autoscale.maxinteger오토스케일 가능 최대 노드 수
          autoscale.mininteger오토스케일 가능 최소 노드 수
          labels[]array
          labels[].keystring
          labels[].valuestring
          taints[]array
          taints[].keystring
          taints[].valuestring
          taints[].effectstring
          serverRoleIdstring

          응답 Body

          없음

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          NodePool 수정

          클러스터 내 등록된 NodePool을 update합니다.

          요청 URL

          PATCH https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/node-pool/{instanceNo} [KR]
PATCH https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/node-pool/{instanceNo} [SGN]
PATCH https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/node-pool/{instanceNo} [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          항목MandatoryType설명비고
          uuidMandatorystring갱신할 노드풀의 클러스터 uuid-
          instanceNoMandatoryinteger노드풀 instance 번호-

          Headers

          요청 Body

          {
  "nodeCount": "integer",
  "autoscale": {
    "enabled": "boolean",
    "max": "integer",
    "min": "integer"
  }
}
          CategoryMandatoryTypeDescriptionNote
          nodeCountMandatoryinteger노드 개수
          autoscale오토스케일
          autoscale.enabledboolean오토스케일 가능여부
          autoscale.maxinteger오토스케일 가능 최대 노드 수
          autoscale.mininteger오토스케일 가능 최소 노드 수

          응답 Body

          없음

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          NodePool Subnet 수정

          클러스터 내 등록된 NodePool의 Subnet을 수정합니다.
          NodePool의 Subnet 설정이 자동할당이 아닌 1개 이상 Subnet이 지정된 경우만 사용할 수 있습니다.

          요청 URL

          PATCH https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/node-pool/{instanceNo}/subnets [KR]
PATCH https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/node-pool/{instanceNo}/subnets [SGN]
PATCH https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/node-pool/{instanceNo}/subnets [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 파라미터

          ItemLocationRequiredTypeDescription
          uuidpathstringCluster uuid-
          instanceNopathstringNodePool Instance No.-

          요청 Body

          {
  "subnets": [
    "integer"
  ]
}
          CategoryMandatoryTypeDescriptionNote
          subnets[]Mandatoryarray

          응답 Body

          {
  "uuid": "string",
  "instanceNo": "integer"
}

          응답 Status

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          NodePool Label 수정

          클러스터 내 등록된 NodePool의 Label를 수정합니다.

          요청 URL

          PUT https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/node-pool/{instanceNo}/labels [KR]
PUT https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/node-pool/{instanceNo}/labels [SGN]
PUT https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/node-pool/{instanceNo}/labels [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 파라미터

          ItemLocationRequiredTypeDescription
          uuidpathstringCluster uuid-
          instanceNopathstringNodePool Instance No.-

          요청 Body

          {
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
          CategoryMandatoryTypeDescriptionNote
          labels[]Mandatoryarray
          labels[].keystring
          labels[].valuestring

          응답 Body

          {
  "uuid": "string",
  "instanceNo": "integer"
}

          응답 Status

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          NodePool Taint 수정

          클러스터 내 등록된 NodePool의 Taint를 수정합니다.

          요청 URL

          PUT https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/node-pool/{instanceNo}/taints [KR]
PUT https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/node-pool/{instanceNo}/taints [SGN]
PUT https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/node-pool/{instanceNo}/taints [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 파라미터

          ItemLocationRequiredTypeDescription
          uuidpathstringCluster uuid-
          instanceNopathstringNodePool Instance No.-

          요청 Body

          {
  "taints": [
    {
      "key": "string",
      "value": "string",
      "effect": "string"
    }
  ]
}
          CategoryMandatoryTypeDescriptionNote
          taints[]Mandatoryarray
          taints[].keystring
          taints[].valuestring
          taints[].effectstring

          응답 Body

          {
  "uuid": "string",
  "instanceNo": "integer"
}

          응답 Status

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          NodePool 업그레이드

          NodePool를 업그레이드합니다.

          요청 URL

          PATCH https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/node-pool/{instanceNo}/upgrade [KR]
PATCH https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/node-pool/{instanceNo}/upgrade [SGN]
PATCH https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/node-pool/{instanceNo}/upgrade [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 파라미터

          항목위치필수여부타입설명
          uuidpathYstringcluster uuid
          instanceNopathYintegernodepool instanceNo
          k8sVersionqueryYstringkubernetes version
          maxSurgequeryNintegermaxSurge
          maxUnavailablequeryNintegermaxUnavailable
          참고
          • NodePool의 k8sVersion 정보는 클러스터의 k8sVersion 이내에서만 가능합니다.

          응답 Body

          {
  "uuid": "string",
  "instanceNo": "integer"
}
          항목Type설명비고
          uuidstring클러스터 uuid
          instanceNointegerNodePool instanceNo

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          409Conflict
          500Internal Server Error

          NodePool 삭제

          NodePool을 삭제합니다.

          요청 URL

          DELETE https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/node-pool/{instanceNo} [KR]
DELETE https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/node-pool/{instanceNo} [SGN]
DELETE https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/node-pool/{instanceNo} [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          항목MandatoryType설명비고
          uuidMandatorystring제거할 노드풀의 클러스터 uuid-
          instanceNoMandatoryinteger노드풀 instance 번호-

          Headers

          요청 Body

          없음

          응답 Body

          없음

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Kubeconfig 조회

          Cluster의 kubeconfig를 조회합니다.

          참고

          2022.02.13 이후에 생성된 클러스터는 IAM 인증이 자동으로 적용됩니다.
          IAM 인증이 적용된 클러스터는 해당 API를 통해 kubeconfig를 조회할 수 없습니다.
          ncp-iam-authenticator를 사용하여 kubeconfig를 구성하면 IAM 인증을 통해 IAM 서비스(SubAccounts) 계정별로 클러스터 권한을 제어할 수 있습니다.

          요청 URL

          GET https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/kubeconfig [KR]
GET https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/kubeconfig [SGN]
GET https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/kubeconfig [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          항목MandatoryType설명비고
          uuidMandatorystringcluster uuidkubeconfig의 클러스터 uuid

          Headers

          요청 Body

          없음

          응답 Body

          {
  "kubeconfig": "string"
}
          항목Type설명비고
          kubeconfigstringkubeconfig의 json값

          응답 Status

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Kubeconfig 재설정

          Cluster 의 kubeconfig를 재설정합니다.

          요청 URL

          PATCH https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/kubeconfig/reset [KR]
PATCH https://nks.apigw.ntruss.com/vnks/sgn-v2/clusters/{uuid}/kubeconfig/reset [SGN]
PATCH https://nks.apigw.ntruss.com/vnks/jpn-v2/clusters/{uuid}/kubeconfig/reset [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          항목MandatoryType설명비고
          uuidMandatorystringcluster uuidkubeconfig를 재설정 할 클러스터 uuid

          Headers

          요청 Body

          없음

          응답 Body

          없음

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          k8s 지원 버전 조회

          Cluster 생성 가능한 k8s 버전을 조회합니다.

          요청 URL

          GET https://nks.apigw.ntruss.com/vnks/v2/option/version [KR]
GET https://nks.apigw.ntruss.com/vnks/sgn-v2/option/version [SGN]
GET https://nks.apigw.ntruss.com/vnks/jpn-v2/option/version [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 Body

          없음

          응답 Body

          [
  {
    "label": "string",
    "value": "string"
  }
]

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          서버 이미지 조회

          Cluster 생성 시 사용 가능한 서버 이미지를 조회합니다.

          요청 URL

          GET https://nks.apigw.ntruss.com/vnks/v2/option/server-image [KR]
GET https://nks.apigw.ntruss.com/vnks/sgn-v2/option/server-image [SGN]
GET https://nks.apigw.ntruss.com/vnks/jpn-v2/option/server-image [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 Body

          없음

          응답 Body

          [
  {
    "label": "string",
    "value": "string"
  }
]

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          서버 스펙 조회

          Cluster/노드풀 생성 시 사용 가능한 서버 스펙을 조회합니다.

          요청 URL

          GET https://nks.apigw.ntruss.com/vnks/v2/option/server-product-code [KR]
GET https://nks.apigw.ntruss.com/vnks/sgn-v2/option/server-product-code [SGN]
GET https://nks.apigw.ntruss.com/vnks/jpn-v2/option/server-product-code [JPN]

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          요청 파라미터

          항목위치필수여부타입설명
          softwareCodequeryYstringzoneNo
          zoneCodequeryNstringzoneCode
          zoneNoqueryNstringzoneNo

          응답 Body

          {
  "label": "string",
  "value": "string",
  "disabled": "boolean"
}

          응답 Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error
          이 문서가 도움이 되었습니까?
          What's Next
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          First name must have atleast 2 characters. Numbers and special characters are not allowed.
          Last name must have atleast 1 characters. Numbers and special characters are not allowed.
          Enter a valid email
          Enter a valid password
          Your profile has been successfully updated.
          Logout