Subnet 목록 조회

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

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

요청

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

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

요청 헤더

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

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`softwareProductCode`	String	Required	운영 체제 타입 코드 운영 체제 타입 조회 참조
`vpcNo`	Integer	Required	VPC 번호 VPC 목록 조회 참조

요청 예시

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

curl --location --request GET 'https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/cluster/getSubnetList?softwareProductCode=SW.VELST.OS.LNX64.ROCKY.0808.B050&vpcNo=93***' \
--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	-	Subnet 목록
`requestId`	String	-	요청에 대한 아이디 UUID 형식

`result.content`

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

필드	타입	필수 여부	설명
`isPublic`	Boolean	-	Public Subnet 여부 `true` \| `false` `true`: Public Subnet `false`: Private Subnet
`statusCode`	String	-	Subnet 상태
`subnet`	String	-	Subnet의 IPv4 CIDR 블록
`subnetName`	String	-	Subnet 이름
`subnetNo`	Integer	-	Subnet 번호
`vpcName`	String	-	VPC 이름
`vpcNo`	Integer	-	VPC 번호
`zoneName`	String	-	존 이름
`zoneNo`	Integer	-	존 번호
`permission`	String	-	서브 계정의 사용 가능 여부 `Allow` \| `Deny` `Allow`: 사용 가능 `Deny`: 사용 불가 `Deny`인 경우, 서브 계정에 getSubnetDetail 권한 부여 시 사용 가능

응답 상태 코드

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

응답 예시

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "content": [
            {
                "isPublic": false,
                "statusCode": "RUN",
                "subnet": "10.0.20.0/24",
                "subnetName": "s1-hd-pri",
                "subnetNo": 20****,
                "vpcName": "myvpc",
                "vpcNo": 9****,
                "zoneName": "KR-2",
                "zoneNo": 3,
                "permission": "Allow"
            },
            {
                "isPublic": true,
                "statusCode": "RUN",
                "subnet": "10.0.0.0/24",
                "subnetName": "s1-hd-pub",
                "subnetNo": 20****,
                "vpcName": "myvpc",
                "vpcNo": 9****,
                "zoneName": "KR-2",
                "zoneNo": 3,
                "permission": "Allow"
            }
        ]
    },
    "requestId": "b4765a66-****-****-****-0adc09cb2cc7"
}