getCloudPostgresqlTargetVpcList

Prev Next

VPC環境で利用できます。

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

リクエスト

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

メソッド URI
GET, POST /getCloudPostgresqlTargetVpcList

リクエストヘッダ

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

リクエストパラメータ

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

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

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vpostgresql/v2/getCloudPostgresqlTargetVpcList
?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の場合
{
    "getCloudPostgresqlTargetVpcListResponse": {
        "totalRows": 1,
        "targetVpcList": [
            {
                "vpcNo": "****87",
                "vpcName": "test-***",
                "ipv4Cidr": "192.168.0.0/16",
                "regionCode": "KR",
                "createdDate": "2021-11-24T13:08:02+0900"
            }
        ],
        "requestId": "1ee00e6a-****-****-****-2d8158f0b75e",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
  • responseFormatType=xml(デフォルト)の場合
<?xml version="1.0" encoding="UTF-8"?>
<getCloudPostgresqlTargetVpcListResponse>
    <requestId>1ee00e6a-****-****-****-2d8158f0b75e</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <targetVpcList>
        <targetVpc>
            <vpcNo>25****</vpcNo>
            <vpcName>test-****</vpcName>
            <ipv4Cidr>192.168.0.0/16</ipv4Cidr>
            <regionCode>KR</regionCode>
            <createdDate>2021-11-24T13:08:02+0900</createdDate>
        </targetVpc>
    </targetVpcList>
</getCloudPostgresqlTargetVpcListResponse>