VPC環境で利用できます。
Cloud DB for Cacheで使用可能な Subnetリストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET, POST | /getCloudRedisTargetSubnetList |
リクエストヘッダ
Cloud DB for Cache APIで共通して使用されるヘッダの詳細は、Cloud DB for Cacheの共通ヘッダをご参照ください。
リクエストパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
regionCode |
String | Optional | 照会対象の Subnetのリージョンコード
|
vpcNo |
String | Required | VPC番号で絞り込み |
cloudRedisImageProductCode |
String | Required | Cloud DB for Cacheイメージ商品コードで絞り込み |
isPublic |
Boolean | Optional | Public Subnetかどうかで絞り込み
|
responseFormatType |
String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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をご参照ください。
レスポンスステータスコード
NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
-
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>