createCloudPostgresqlInstance

Prev Next

VPC環境で利用できます。

Cloud DB for PostgreSQLインスタンスを作成します。

リクエスト

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

メソッド URI
GET, POST /createCloudPostgresqlInstance

リクエストヘッダ

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

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • 作成対象の Cloud DB for PostgreSQLインスタンスのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
vpcNo String Required Cloud DB for PostgreSQLインスタンス作成対象の VPC番号
subnetNo String Required Cloud DB for PostgreSQLインスタンスで使用する基本ネットワークインターフェースの Subnet番号
  • getCloudPostgresqlTargetSubnetListを通じて確認
  • Publicドメインは、Public Subnetに作成された DBサーバでのみ申し込み可能
  • Cloud DB for PostgreSQLインスタンス作成後に Subnetの移転はできない
secondarySubnetNo String Conditional Secondaryサーバの Subnet番号
  • Multi Zoneの CloudDB for PostgreSQLの場合、必ず入力
  • Primaryサーバの Subnetとは Zoneが異なるように、Publicまたは Privateは同じようにする
  • getCloudPostgresqlTargetSubnetListを通じて確認
cloudPostgresqlImageProductCode String Optional Cloud DB for PostgreSQLイメージ商品コード
cloudPostgresqlProductCode String Optional Cloud DB for PostgreSQL商品コード
  • 作成対象の Cloud DB for PostgreSQLインスタンスのサーバスペックを決める
  • getCloudPostgresqlProductListを通じて確認
  • 最小スペック(デフォルト)
  • 最小スペックの基準: 1. メモリ 2. CPUの順で決める
dataStorageTypeCode String Optional データストレージタイプコード
  • インストール後にデータストレージタイプは変更不可
  • SSD (デフォルト) | HDD
isHa Boolean Optional 高可用性の有無
  • true (デフォルト) | false
    • true(高可用性を選択)の場合、Secondaryサーバを含めて2台のサーバが作成され、追加料金が発生
    • falseの場合、isMultiZone、standbyMasterSubnetNoパラメータは使用されない
isMultiZone Boolean Conditional Multi Zoneかどうか
  • true | false (デフォルト)
  • 高可用性の有無(isHa)がtrueの場合、必ず入力
    • trueの場合、Primaryサーバと Secondaryサーバを異なる Zoneに作成してより高い可用性を提供
    • Neurocloud環境では利用不可
isStorageEncryption Boolean Optional データストレージ暗号化の適用有無(今後適用)
  • true | false (デフォルト)
    • 暗号化を適用すると、DBデータは暗号化されストレージに保存
  • Cloud DB for PostgreSQLインスタンスの作成後、ストレージ暗号化の設定は変更不可
  • Neurocloud環境では利用不可
isBackup Boolean Optional PostgreSQLのバックアップ設定の有無
  • true (デフォルト) | false
  • 高可用性の有無(isHa)がtrueの場合、バックアップの有無(isBackup)はtrueに固定
backupFileRetentionPeriod Integer Optional バックアップファイルの保管期間(日)
  • 1 (デフォルト)
  • バックアップは毎日行われ、バックアップファイルは別途ストレージに保存
  • 料金は使用する容量だけ課金
backupTime String Conditional バックアップ時点を設定
  • true (デフォルト) | false
  • バックアップの有無(isBackup)がtrue、バックアップ時間自動設定の有無(isAutomaticBackup)がfalseの場合、必ず入力
  • <例>01:15
backupFileStorageCount Integer Optional 保管するバックアップファイル数
  • 1~30
isBackupFileCompression Boolean Optional バックアップファイルの圧縮有無
  • true (デフォルト) | false
isAutomaticBackup Boolean Optional バックアップ時点を自動設定するかどうか
  • true(デフォルト) | false
  • 設定値がtrueの場合、backupTimeは入力不可
cloudPostgresqlServiceName String Required 作成する Cloud DB for PostgreSQLサービス名
  • 英数字、ハングル、記号の「-」のみ使用して3~30文字以内で入力
cloudPostgresqlServerNamePrefix String Required 作成する Cloud DB for PostgreSQLサーバ名の接頭辞
  • 英字の小文字、数字、記号の「-」を使用して3~20文字以内で入力、先頭文字は英字に、末尾文字は英字または数字にする
  • 接頭辞の末尾に3桁の数字が自動で付き、ホスト名の重複防止のために任意のテキストが追加され作成される
  • <例> 接頭辞が test-123の場合: test-123-001-523a
cloudPostgresqlUserName String Required DB Userアカウント ID
  • 英字の小文字、数字、記号の「_」を使用して4~16文字以内で入力、先頭文字は英字にする
  • あらかじめ定義した roleと予約語は使用不可
cloudPostgresqlUserPassword String Required DB Userアカウントパスワード
  • 英数字、記号をそれぞれ1文字以上含めて8~20文字以内で入力
  • 記号の「` & + \ " ' /」とスペースは使用不可
  • User IDは含めないこと
clientCidr String Required アクセスする Clientの CIDR(アクセス制御)を入力
  • <例>
    • すべてのアクセスを許可: 0.0.0.0/0
    • 特定の IPアドレスからのアクセスを許可: 192.168.1.1/32
    • IPアドレス帯域からのアクセスを許可: 192.168.1.0/24
cloudPostgresqlPort Integer Optional Cloud DB for PostgreSQLインスタンスアクセス用 TCPポート番号
  • 5432 (デフォルト)
  • 指定範囲: 10000~20000
  • 一度指定したポート番号は変更不可
cloudPostgresqlDatabaseName String Required Cloud DB for PostgreSQLインスタンスにデフォルトで作成する DB名
  • 英字の小文字、数字、記号の「-」を使用して1~30文字以内で入力、先頭文字は英字にする
engineVersionCode String Optional
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vpostgresql/v2/createCloudPostgresqlInstance
?regionCode=KR
&vpcNo=****87
&subnetNo=****49
&secondarySubnetNo=****51
&cloudPostgresqlImageProductCode=SW.VPGSL.OS.LNX64.CNTOS.0708.PGSQL.133.B050
&cloudPostgresqlProductCode=SVR.VPGSL.DBSVR.STAND.C002.M008.NET.SSD.B050.G002
&dataStorageTypeCode=SSD
&isHa=true
&isMultiZone=true
&isStorageEncryption=true
&isBackup=true
&backupFileRetentionPeriod=10
&backupFileStorageCount=5
&backupTime=02:00
&isBackupFileCompression=true
&isAutomaticBackup=false
&cloudPostgresqlServiceName=test-****
&cloudPostgresqlServerNamePrefix=test-****
&cloudPostgresqlUserName=test****
&cloudPostgresqlUserPassword=********
&clientCidr=0.0.0.0/0
&cloudPostgresqlPort=15432
&engineVersionCode=13.15
&cloudPostgresqlDatabaseName=test****'
--header 'x-ncp-apigw-timestamp: {Timestamp}' 
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

  • responseFormatType=jsonの場合
{
    "createCloudPostgresqlInstanceResponse": {
        "totalRows": 1,
        "cloudPostgresqlInstanceList": [
            {
                "cloudPostgresqlInstanceNo": "****925",
                "cloudPostgresqlServiceName": "test-****",
                "cloudPostgresqlInstanceStatusName": "creating",
                "cloudPostgresqlInstanceStatus": {
                    "code": "INIT",
                    "codeName": "CLOUD DATABASE(VPC) Init State"
                },
                "cloudPostgresqlInstanceOperation": {
                    "code": "CREAT",
                    "codeName": "CLOUD DATABASE(VPC) Creat OP"
                },
                "cloudPostgresqlImageProductCode": "SW.VPGSL.OS.LNX64.CNTOS.0708.PGSQL.133.B050",
                "engineVersion": "PostgreSQL 13.3",
                "license": "PostgreSQL License",
                "cloudPostgresqlPort": 15432,
                "isHa": true,
                "isMultiZone": true,
                "isBackup": true,
                "backupFileRetentionPeriod": 10,
                "backupTime": "02:00",
                "createDate": "2024-06-03T10:47:11+0900",
                "accessControlGroupNoList": [],
                "cloudPostgresqlConfigList": [
                    "sample_config=sample_value"
                ],
                "cloudPostgresqlServerInstanceList": [
                    {
                        "cloudPostgresqlServerName": "test-****-001-523a",
                        "cloudPostgresqlServerRole": {
                            "code": "M",
                            "codeName": "Primary"
                        },
                        "cloudPostgresqlServerInstanceStatusName": "creating",
                        "cloudPostgresqlServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC) Server Pending State"
                        },
                        "cloudPostgresqlServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC) Server Create OP"
                        },
                        "cloudPostgresqlProductCode": "SVR.VPGSL.DBSVR.STAND.C002.M008.NET.SSD.B050.G002",
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "****87",
                        "subnetNo": "****49",
                        "isPublicSubnet": true,
                        "dataStorageType": {
                            "code": "SSD",
                            "codeName": "SSD"
                        },
                        "isStorageEncryption": true,
                        "dataStorageSize": 10737418240,
                        "cpuCount": 2,
                        "memorySize": 8589934592,
                        "createDate": "2024-06-03T10:47:11+0900"
                    },
                    {
                        "cloudPostgresqlServerName": "test-****-002-523b",
                        "cloudPostgresqlServerRole": {
                            "code": "H",
                            "codeName": "Secondary"
                        },
                        "cloudPostgresqlServerInstanceStatusName": "creating",
                        "cloudPostgresqlServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC) Server Pending State"
                        },
                        "cloudPostgresqlServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC) Server Create OP"
                        },
                        "cloudPostgresqlProductCode": "SVR.VPGSL.DBSVR.STAND.C002.M008.NET.SSD.B050.G002",
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "****87",
                        "subnetNo": "****51",
                        "isPublicSubnet": true,
                        "dataStorageType": {
                            "code": "SSD",
                            "codeName": "SSD"
                        },
                        "isStorageEncryption": true,
                        "dataStorageSize": 10737418240,
                        "cpuCount": 2,
                        "memorySize": 8589934592,
                        "createDate": "2024-06-03T10:47:11+0900"
                    }
                ]
            }
        ],
        "requestId": "a3ab2112-****-****-****-e8deb543d4c2",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
  • responseFormatType=xml(デフォルト)の場合
<?xml version="1.0" encoding="UTF-8"?>
<createCloudPostgresqlInstanceResponse>
    <requestId>a3ab2112-****-****-****-e8deb543d4c2</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudPostgresqlInstanceList>
        <cloudPostgresqlInstance>
            <cloudPostgresqlInstanceNo>****925</cloudPostgresqlInstanceNo>
            <cloudPostgresqlServiceName>test-****</cloudPostgresqlServiceName>
            <cloudPostgresqlInstanceStatusName>creating</cloudPostgresqlInstanceStatusName>
            <cloudPostgresqlInstanceStatus>
                <code>INIT</code>
                <codeName>CLOUD DATABASE(VPC) Init State</codeName>
            </cloudPostgresqlInstanceStatus>
            <cloudPostgresqlInstanceOperation>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Creat OP</codeName>
            </cloudPostgresqlInstanceOperation>
            <cloudPostgresqlImageProductCode>SW.VPGSL.OS.LNX64.CNTOS.0708.PGSQL.133.B050</cloudPostgresqlImageProductCode>
            <engineVersion>PostgreSQL 13.3</engineVersion>
            <license>PostgreSQL License</license>
            <cloudPostgresqlPort>15432</cloudPostgresqlPort>
            <isHa>true</isHa>
            <isMultiZone>true</isMultiZone>
            <isBackup>true</isBackup>
            <backupFileRetentionPeriod>10</backupFileRetentionPeriod>
            <backupTime>02:00</backupTime>
            <createDate>2024-06-03T10:47:11+0900</createDate>
            <accessControlGroupNoList/>
            <cloudPostgresqlConfigList>
                <cloudPostgresqlConfig>sample_config=sample_value</cloudPostgresqlConfig>
            </cloudPostgresqlConfigList>
            <cloudPostgresqlServerInstanceList>
                <cloudPostgresqlServerInstance>
                    <cloudPostgresqlServerName>test-****-001-523a</cloudPostgresqlServerName>
                    <cloudPostgresqlServerRole>
                        <code>M</code>
                        <codeName>Primary</codeName>
                    </cloudPostgresqlServerRole>
                    <cloudPostgresqlServerInstanceStatusName>creating</cloudPostgresqlServerInstanceStatusName>
                    <cloudPostgresqlServerInstanceStatus>
                        <code>PEND</code>
                        <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                    </cloudPostgresqlServerInstanceStatus>
                    <cloudPostgresqlServerInstanceOperation>
                        <code>CREAT</code>
                        <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                    </cloudPostgresqlServerInstanceOperation>
                    <cloudPostgresqlProductCode>SVR.VPGSL.DBSVR.STAND.C002.M008.NET.SSD.B050.G002</cloudPostgresqlProductCode>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****87</vpcNo>
                    <subnetNo>****49</subnetNo>
                    <isPublicSubnet>true</isPublicSubnet>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                    <isStorageEncryption>true</isStorageEncryption>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>8589934592</memorySize>
                    <createDate>2024-06-03T10:47:11+0900</createDate>
                </cloudPostgresqlServerInstance>
                <cloudPostgresqlServerInstance>
                    <cloudPostgresqlServerName>test-****-002-523b</cloudPostgresqlServerName>
                    <cloudPostgresqlServerRole>
                        <code>H</code>
                        <codeName>Secondary</codeName>
                    </cloudPostgresqlServerRole>
                    <cloudPostgresqlServerInstanceStatusName>creating</cloudPostgresqlServerInstanceStatusName>
                    <cloudPostgresqlServerInstanceStatus>
                        <code>PEND</code>
                        <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                    </cloudPostgresqlServerInstanceStatus>
                    <cloudPostgresqlServerInstanceOperation>
                        <code>CREAT</code>
                        <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                    </cloudPostgresqlServerInstanceOperation>
                    <cloudPostgresqlProductCode>SVR.VPGSL.DBSVR.STAND.C002.M008.NET.SSD.B050.G002</cloudPostgresqlProductCode>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-2</zoneCode>
                    <vpcNo>****87</vpcNo>
                    <subnetNo>****51</subnetNo>
                    <isPublicSubnet>true</isPublicSubnet>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                    <isStorageEncryption>true</isStorageEncryption>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>8589934592</memorySize>
                    <createDate>2024-06-03T10:47:11+0900</createDate>
                </cloudPostgresqlServerInstance>
            </cloudPostgresqlServerInstanceList>
        </cloudPostgresqlInstance>
    </cloudPostgresqlInstanceList>
</createCloudPostgresqlInstanceResponse>