Subnet 목록 조회(G3)

Prev Next

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

사용 가능한 Subnet 목록을 조회합니다.

참고

KVM 하이퍼바이저 타입의 3세대 서버 전용 API입니다.

요청

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

메서드 URI
POST /api/v1/cluster/getVpcAvailableSubnetList (한국 리전)
POST /api/sgn-v1/cluster/getVpcAvailableSubnetList (싱가포르 리전)
POST /api/jpn-v1/cluster/getVpcAvailableSubnetList (일본 리전)

요청 헤더

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

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
isPrivate Boolean Optional Private Subnet 여부
  • true | false
    • true: Private Subnet
    • false: Public Subnet
softwareProductCode String Required 운영 체제 타입 코드
vpcNo Integer Required VPC 번호

요청 예시

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

curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getVpcAvailableSubnetList' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "isPrivate": true,
  "softwareProductCode": "SW.VCDSS.OS.LNX64.ROCKY.08.G003",
  "vpcNo": 4***
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
code Integer - 응답 코드
message String - 응답 메시지
result Object - 응답 결과
result.error String - 오류 메시지
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 - 존 번호
actionName String - 서브 계정의 Subnet 사용에 필요한 액션 이름
  • permission이 Deny인 경우, 서브 계정에 getSubnetDetail 권한 부여 시 사용 가능
permission String - 서브 계정의 사용 가능 여부
  • Allow | Deny
    • Allow: 사용 가능
    • Deny: 사용 불가

응답 상태 코드

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

응답 예시

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "error": null,
        "content": [
            {
                "isPublic": false,
                "statusCode": "RUN",
                "subnet": "10.0.20.0/24",
                "subnetName": "sb2",
                "subnetNo": 3****,
                "vpcName": "test-vpc2",
                "vpcNo": 4***,
                "zoneName": "KR-2",
                "zoneNo": 3,
                "actionName": "View/getSubnetDetail",
                "permission": "Allow"
            }
        ]
    },
    "requestId": "a7c59c34-****-****-****-b5706cc6d690"
}