--- title: "createCloudPostgresqlInstance" slug: "database-vpostgresql-createcloudpostgresqlinstance" tags: ["Cloud DB for PostgreSQL"] updated: 2026-09-17T09:57:51Z published: 2026-09-17T09:57:51Z canonical: "api.ncloud-docs.com/database-vpostgresql-createcloudpostgresqlinstance" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # createCloudPostgresqlInstance VPC環境で利用できます。 Cloud DB for PostgreSQLインスタンスを作成します。 ## リクエスト リクエスト形式を説明します。リクエスト形式は次の通りです。 | メソッド | URI | | --- | --- | | GET \| POST | /vpostgresql/v2/createCloudPostgresqlInstance | 参考 ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。 ### リクエストヘッダ Cloud DB for PostgreSQL (VPC) APIで共通して使用されるヘッダの詳細は、[Cloud DB for PostgreSQL (VPC)のリクエストヘッダ](/docs/ja/database-vpostgresql#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。 ### リクエストクエリパラメータ リクエストクエリパラメータの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `regionCode` | String | Optional | リージョンコード - 作成対象の Cloud DB for PostgreSQLインスタンスのリージョンコード - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を通じて確認 - `getRegionList`照会結果の最初のリージョン(デフォルト) | | `vpcNo` | String | Required | Cloud DB for PostgreSQLインスタンス作成対象の VPC番号 - [getCloudPostgresqlTargetVpcList](/docs/ja/database-vpostgresql-getcloudpostgresqltargetvpclist)を通じて確認 | | `subnetNo` | String | Required | Cloud DB for PostgreSQLインスタンスで使用する基本ネットワークインターフェースの Subnet番号 - [getCloudPostgresqlTargetSubnetList](/docs/ja/database-vpostgresql-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](/docs/ja/database-vpostgresql-getcloudpostgresqltargetsubnetlist)を通じて確認 | | `cloudPostgresqlImageProductCode` | String | Optional | Cloud DB for PostgreSQLイメージ商品コード - [getCloudPostgresqlImageProductList](/docs/ja/database-vpostgresql-getcloudpostgresqlimageproductlist)を通じて確認 - NAVERクラウドプラットフォームで自動作成(デフォルト) | | `cloudPostgresqlProductCode` | String | Optional | Cloud DB for PostgreSQL商品コード - 作成対象の Cloud DB for PostgreSQLインスタンスのサーバスペックを決める - [getCloudPostgresqlProductList](/docs/ja/database-vpostgresql-getcloudpostgresqlproductlist)を通じて確認 - 最小スペック(デフォルト) - 最小スペックの基準: 1. メモリ 2. CPUの順で決める | | `dataStorageTypeCode` | String | Optional | データストレージタイプコード - インストール後、データストレージタイプは変更不可 - `SSD` \| `HDD` \| `CB2` - `cloudPostgresqlImageProductCode`の generationCodeに応じてデフォルト値が異なる | | `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` (デフォルト) - 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 | Cloud DB for PostgreSQLインスタンスに適用するエンジンのバージョン - [getCloudPostgresqlImageProductList](/docs/ja/database-vpostgresql-getcloudpostgresqlimageproductlist)を通じて確認 - `cloudPostgresqlImageProductCode`の`generationCode`が`G3`の場合、入力 - 入力しない場合、現在提供中の最新バージョンで作成 | | `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.ROCKY.0810.PGSQL.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](/docs/ja/common-vapidatatype-cloudpostgresqlinstancelist)をご参照ください。 ### レスポンスステータスコード Cloud DB for PostgreSQL (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、[Cloud DB for PostgreSQL (VPC)のレスポンスステータスコード](/docs/ja/database-vpostgresql#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。 ### レスポンス例 レスポンスのサンプルコードは次の通りです。 - `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.ROCKY.0810.PGSQL.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`(デフォルト)の場合 ``` a3ab2112-****-****-****-e8deb543d4c2 0 success 1 ****925 test-**** creating INIT CLOUD DATABASE(VPC) Init State CREAT CLOUD DATABASE(VPC) Creat OP SW.VPGSL.OS.LNX64.ROCKY.0810.PGSQL.B050 PostgreSQL 13.3 PostgreSQL License 15432 true true true 10 02:00 2024-06-03T10:47:11+0900 sample_config=sample_value test-****-001-523a M Primary creating PEND CLOUD DATABASE(VPC) Server Pending State CREAT CLOUD DATABASE(VPC) Server Create OP SVR.VPGSL.DBSVR.STAND.C002.M008.NET.SSD.B050.G002 KR KR-1 ****87 ****49 true SSD SSD true 10737418240 2 8589934592 2024-06-03T10:47:11+0900 test-****-002-523b H Secondary creating PEND CLOUD DATABASE(VPC) Server Pending State CREAT CLOUD DATABASE(VPC) Server Create OP SVR.VPGSL.DBSVR.STAND.C002.M008.NET.SSD.B050.G002 KR KR-2 ****87 ****51 true SSD SSD true 10737418240 2 8589934592 2024-06-03T10:47:11+0900 ```