Kubernetes Service 클러스터 목록 조회

VPC 환경에서 이용 가능합니다.

사용 가능한 Ncloud Kubernetes Service 클러스터 목록을 조회합니다.

참고

Kubernetes 클러스터 목록을 조회하려면 먼저 Ncloud Kubernetes Service 서비스에서 클러스터를 생성해야 합니다. 클러스터 생성 방법은 다음을 참조해 주십시오.

네이버 클라우드 플랫폼 콘솔에서 생성: Ncloud Kubernetes Service 사용 가이드 참조
API를 사용하여 생성: Ncloud Kubernetes Service API 가이드 참조

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/api/v1/kubernetes/cluster

요청 헤더

SourceDeploy API에서 공통으로 사용하는 헤더에 대한 정보는 SourceDeploy 요청 헤더를 참조해 주십시오.

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://vpcsourcedeploy.apigw.gov-ntruss.com/api/v1/kubernetes/cluster' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`result`	Object	-	응답 결과
`result.clusterList`	Array	-	클러스터 목록

`clusterList`

clusterList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`id`	Number	-	클러스터 번호
`name`	String	-	클러스터 이름
`permission`	String	-	상세 정보 조회 권한 소유 여부 `Allow` \| `Deny` `Allow`: 소유 `Deny`: 소유 안 함
`actionName`	String	-	상세 정보 조회 권한 이름

응답 상태 코드

SourceDeploy API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 SourceDeploy 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "result": {
        "clusterList": [
            {
                "id": 4***,
                "name": "cluster1",
                "permission": "Allow",
                "actionName": "View/getKubernetesClusterDetail"
            }
        ]
    }
}