getCloudCacheTargetSubnetList

Prev Next

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

Cloud DB for Cache에서 사용할 수 있는 Subnet 리스트를 조회합니다.

참고

Cloud DB for Cache API는 지원하는 DBMS 범위에 따라 두 가지 버전을 제공합니다.

  • getCloudCacheTargetSubnetList API: Valkey, Redis DBMS 이용 가능
  • getCloudRedisTargetSubnetList API: Redis DBMS 이용 가능

getCloudCacheTargetSubnetList API

getCloudCacheTargetSubnetList API의 요청, 응답 형식을 설명합니다.

요청

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

메서드 URI
GET | POST /getCloudCacheTargetSubnetList
참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

Cloud DB for Cache API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud DB for Cache 공통 헤더를 참조해 주십시오.

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
regionCode String Optional 조회할 Subnet의 리전 코드
  • getRegionList 참조
  • getRegionList 조회 결과의 첫 번째 리전(기본값)
vpcNo String Required VPC 번호로 필터링
cloudCacheImageProductCode String Required Cloud DB for Cache 이미지 상품 코드로 필터링
isPublic Boolean Optional Public Subnet 여부로 필터링
  • true | false
responseFormatType String Optional 응답 결과의 형식
  • xml (기본값) | json

요청 예시

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vcache/v2/getCloudCacheTargetSubnetList
?regionCode=KR
&vpcNo=39**
&cloudCacheImageProductCode=SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디는 TargetSubnetList를 참조해 주십시오.

응답 상태 코드

Cloud DB for Cache (VPC) API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud DB for Cache (VPC) 응답 상태 코드를 참조해 주십시오.

응답 예시

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

  • responseFormatType=xml (기본값) 일 때
    
    <getCloudCacheTargetSubnetListResponse>
        <requestId>3d4f057b-fa19-4baa-9cbc-d49074665ae9</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <targetSubnetList>
            <targetSubnet>
                <subnetNo>57**</subnetNo>
                <subnetName>f**</subnetName>
                <vpcNo>39**</vpcNo>
                <vpcName>exercise2</vpcName>
                <zoneCode>KR-1</zoneCode>
                <subnet>10.2.1.0/24</subnet>
                <isPublic>false</isPublic>
                <createdDate>2022-03-24T18:00:00+0900</createdDate>
            </targetSubnet>
        </targetSubnetList>
    </getCloudCacheTargetSubnetListResponse>
    

getCloudRedisTargetSubnetList API

getCloudRedisTargetSubnetList API의 요청, 응답 형식을 설명합니다.

요청

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

메서드 URI
GET | POST /vredis/v2/getCloudRedisTargetSubnetList
참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

Cloud DB for Cache API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud DB for Cache 공통 헤더를 참조해 주십시오.

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
regionCode String Optional 조회할 Subnet의 리전 코드
  • getRegionList 참조
  • getRegionList 조회 결과의 첫 번째 리전(기본값)
vpcNo String Required VPC 번호로 필터링
cloudRedisImageProductCode String Required Cloud DB for Cache 이미지 상품 코드로 필터링
isPublic Boolean Optional Public Subnet 여부로 필터링
  • true | false
responseFormatType String Optional 응답 결과의 형식
  • xml (기본값) | json

요청 예시

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/getCloudRedisTargetSubnetList
?regionCode=KR
?vpcNo=****83
?cloudRedisImageProductCode=SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.B050' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디는 TargetSubnetList를 참조해 주십시오.

응답 상태 코드

Cloud DB for Cache (VPC) API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud DB for Cache (VPC) 응답 상태 코드를 참조해 주십시오.

응답 예시

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

  • responseFormatType=json 일 때

    {
        "getCloudRedisTargetSubnetListResponse": {
            "totalRows": 3,
            "targetSubnetList": [
                {
                    "subnetNo": "****91",
                    "subnetName": "f**",
                    "vpcNo": "****83",
                    "vpcName": "te**",
                    "zoneCode": "KR-1",
                    "subnet": "192.168.1.0/28",
                    "isPublic": false,
                    "createdDate": "2024-05-28T09:44:21+0900"
                }
            ],
            "requestId": "7c37c61d-****-****-****-ae81a5bc3e9a",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • responseFormatType=xml (기본값) 일 때

    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudRedisTargetSubnetListResponse>
        <requestId>7c37c61d-****-****-****-ae81a5bc3e9a</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <targetSubnetList>
            <targetSubnet>
                <subnetNo>****91</subnetNo>
                <subnetName>f**</subnetName>
                <vpcNo>39**</vpcNo>
                <vpcName>te**</vpcName>
                <zoneCode>KR-1</zoneCode>
                <subnet>192.168.1.0/28</subnet>
                <isPublic>false</isPublic>
                <createdDate>2024-05-28T09:44:21+0900</createdDate>
            </targetSubnet>
        </targetSubnetList>
    </getCloudRedisTargetSubnetListResponse>