Available in VPC
Get the list of subnets available in Cloud DB for Cache.
Cloud DB for Cache API offers two versions based on the supported DBMS range.
- getCloudCacheTargetSubnetList API: Support for Valkey and Redis DBMS
- getCloudRedisTargetSubnetList API: Support for Redis DBMS
getCloudCacheTargetSubnetList API
This section describes the request and response formats for the getCloudCacheTargetSubnetList API.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| GET | POST | /getCloudCacheTargetSubnetList |
This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.
Request headers
For information about the headers common to all Cloud DB for Cache APIs, see Common Cloud DB for Cache headers.
Request query parameters
You can use the following query parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
regionCode |
String | Optional | Region code of the subnet to view
|
vpcNo |
String | Required | Filter by VPC number. |
cloudCacheImageProductCode |
String | Required | Filter by Cloud DB for Cache image product code. |
isPublic |
Boolean | Optional | Filter by public subnet status.
|
responseFormatType |
String | Optional | Format of the response result
|
Request example
The request example is as follows:
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}'
Response
This section describes the response format.
Response body
See TargetSubnetList for the response body.
Response status codes
For information about the HTTP status codes common to all Cloud DB for Cache (VPC) APIs, see Cloud DB for Cache (VPC) response status codes.
Response example
The response example is as follows:
- If
responseFormatType=xml(default)<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
This section describes the request and response formats for the getCloudRedisTargetSubnetList API.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| GET | POST | /vredis/v2/getCloudRedisTargetSubnetList |
This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.
Request headers
For information about the headers common to all Cloud DB for Cache APIs, see Common Cloud DB for Cache headers.
Request query parameters
You can use the following query parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
regionCode |
String | Optional | Region code of the subnet to view
|
vpcNo |
String | Required | Filter by VPC number. |
cloudRedisImageProductCode |
String | Required | Filter by Cloud DB for Cache image product code. |
isPublic |
Boolean | Optional | Filter by public subnet status.
|
responseFormatType |
String | Optional | Format of the response result
|
Request example
The request example is as follows:
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}'
Response
This section describes the response format.
Response body
See TargetSubnetList for the response body.
Response status codes
For information about the HTTP status codes common to all Cloud DB for Cache (VPC) APIs, see Cloud DB for Cache (VPC) response status codes.
Response example
The response example is as follows:
-
If
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" } } -
If
responseFormatType=xml(default)<?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>