VPC 목록 조회

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

사용할 수 있는 VPC 목록을 조회합니다.

요청

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

메서드	URI
GET	/api/v2/cluster/getVpcList (수도권)
GET	/api/krs-v2/cluster/getVpcList (남부권)

요청 헤더

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

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`code`	Integer	-	응답 코드
`message`	String	-	응답 메시지
`result`	Object	-	응답 결과
`result.content`	Array	-	VPC 목록
`requestId`	String	-	요청에 대한 아이디 UUID 형식

`result.content`

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

필드	타입	필수 여부	설명
`createdDate`	Object	-	생성 일시
`createdDate.formattedDate`	String	-	생성 일자 yyyy-MM-dd 형식
`createdDate.formattedDateTime`	String	-	생성 일시 yyyy-MM-dd HH:mm:ss SSSSSS 형식
`createdDate.utc`	Integer	-	생성 일시(밀리초) Unix Timestamp 형식
`ipv4Cidr`	String	-	VPC의 IPv4 CIDR 블록
`regionNo`	String	-	리전 번호
`statusCode`	String	-	VPC 상태
`vpcName`	String	-	VPC 이름
`vpcNo`	Integer	-	VPC 번호
`permission`	String	-	서브 계정의 사용 가능 여부 `Allow` \| `Deny` `Allow`: 사용 가능 `Deny`: 사용 불가 `Deny`인 경우, 서브 계정에 getVPCDetail 권한 부여 시 사용 가능

응답 상태 코드

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

응답 예시

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "content": [
            {
                "createdDate": {
                    "formattedDate": "2025-02-18",
                    "formattedDateTime": "2025-02-18 11:22:39 000936",
                    "utc": 1739845359936
                },
                "ipv4Cidr": "10.0.0.0/16",
                "regionNo": "1",
                "statusCode": "RUN",
                "vpcName": "myvpc",
                "vpcNo": 9****,
                "permission": "Allow"
            }
        ]
    },
    "requestId": "52bd6303-****-****-****-4e97b5af00f7"
}