getCloudPostgresqlTargetSubnetList

Prev Next

VPC環境で利用できます。

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

リクエスト

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

メソッド URI
GET, POST /getCloudPostgresqlTargetSubnetList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • 照会対象の Subnetのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
vpcNo String Required VPC番号で絞り込み
cloudPostgresqlImageProductCode String Required Cloud DB for PostgreSQLイメージ商品コードで絞り込み
isPublic Boolean Optional Public Subnetかどうかで絞り込み
  • true | false
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vpostgresql/v2/getCloudPostgresqlTargetSubnetList
?regionCode=KR
&vpcNo=****87
&cloudPostgresqlImageProductCode=SW.VPGSL.OS.LNX64.CNTOS.0708.PGSQL.133.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の場合
{
    "getCloudPostgresqlTargetSubnetListResponse": {
        "totalRows": 2,
        "targetSubnetList": [
            {
                "subnetNo": "****49",
                "subnetName": "test-****-public-kr1",
                "vpcNo": "****87",
                "vpcName": "test-****",
                "zoneCode": "KR-1",
                "subnet": "192.168.*.0/24",
                "isPublic": true,
                "createdDate": "2024-06-03T08:53:40+0900"
            },
            {
                "subnetNo": "****51",
                "subnetName": "test-****-private-kr1",
                "vpcNo": "****87",
                "vpcName": "test-****",
                "zoneCode": "KR-2",
                "subnet": "192.168.*.0/24",
                "isPublic": false,
                "createdDate": "2022-03-30T10:01:13+0900"
            }
        ],
        "requestId": "1514cc5b-****-****-****-30161feb43b1",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
  • responseFormatType=xml(デフォルト)の場合
<?xml version="1.0" encoding="UTF-8"?>
<getCloudPostgresqlTargetSubnetListResponse>
    <requestId>1514cc5b-****-****-****-30161feb43b1</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <targetSubnetList>
        <targetSubnet>
            <subnetNo>****49</subnetNo>
            <subnetName>test-****-public-kr1</subnetName>
            <vpcNo>****87</vpcNo>
            <vpcName>test-****</vpcName>
            <zoneCode>KR-1</zoneCode>
            <subnet>192.168.*.0/24</subnet>
            <isPublic>true</isPublic>
            <createdDate>2024-06-03T08:53:40+0900</createdDate>
        </targetSubnet>
        <targetSubnet>
            <subnetNo>****51</subnetNo>
            <subnetName>test-****-private-kr1</subnetName>
            <vpcNo>****87</vpcNo>
            <vpcName>test-****</vpcName>
            <zoneCode>KR-2</zoneCode>
            <subnet>192.168.*.0/24</subnet>
            <isPublic>true</isPublic>
            <createdDate>2022-03-30T10:01:13+0900</createdDate>
        </targetSubnet>
    </targetSubnetList>
</getCloudPostgresqlTargetSubnetListResponse>