getCloudCacheTargetVpcList

Prev Next

VPC環境で利用できます。

Cloud DB for Cacheで使用可能な VPCリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET, POST /getCloudRedisTargetVpcList

リクエストヘッダ

Cloud DB for Cache APIで共通して使用されるヘッダの詳細は、Cloud DB for Cacheのリクエストヘッダをご参照ください。

リクエストパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional 照会対象の VPCのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/getCloudRedisTargetVpcList
?regionCode=KR'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、TargetVpcListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

  • responseFormatType=jsonの場合

    {
        "getCloudRedisTargetVpcListResponse": {
            "totalRows": 2,
            "targetVpcList": [
                {
                    "vpcNo": "****73",
                    "vpcName": "exer****",
                    "ipv4Cidr": "10.0.0.0/16",
                    "regionCode": "KR",
                    "createdDate": "2024-04-24T09:54:59+0900"
                },
                {
                    "vpcNo": "****83",
                    "vpcName": "te**",
                    "ipv4Cidr": "192.168.0.0/16",
                    "regionCode": "KR",
                    "createdDate": "2021-11-24T13:08:02+0900"
                }
            ],
            "requestId": "ea022053-****-****-****-0a3a4842af11",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • responseFormatType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudRedisTargetVpcListResponse>
        <requestId>ea022053-****-****-****-0a3a4842af11</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>2</totalRows>
        <targetVpcList>
            <targetVpc>
                <vpcNo>****73</vpcNo>
                <vpcName>exer****</vpcName>
                <ipv4Cidr>10.0.0.0/16</ipv4Cidr>
                <regionCode>KR</regionCode>
                <createdDate>2024-04-24T09:54:59+0900</createdDate>
            </targetVpc>
            <targetVpc>
                <vpcNo>****83</vpcNo>
                <vpcName>te**</vpcName>
                <ipv4Cidr>192.168.0.0/16</ipv4Cidr>
                <regionCode>KR</regionCode>
                <createdDate>2021-11-24T13:08:02+0900</createdDate>
            </targetVpc>
        </targetVpcList>
    </getCloudRedisTargetVpcListResponse>