createCloudPostgresqlInstance

Prev Next

VPC環境で利用できます。

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

コマンド

コマンド構文は次の通りです。

ncloud vpostgresql createCloudPostgresqlInstance [regionCode] [vpcNo] [subnetNo] [secondarySubnetNo] [cloudPostgresqlImageProductCode] [cloudPostgresqlProductCode] [dataStorageTypeCode] [isHa] [isMultiZone] [isStorageEncryption] [isBackup] [backupFileRetentionPeriod] [backupTime] [isAutomaticBackup] [cloudPostgresqlServiceName] [cloudPostgresqlServerNamePrefix] [cloudPostgresqlUserName] [cloudPostgresqlUserPassword] [clientCidr] [cloudPostgresqlPort] [cloudPostgresqlDatabaseName] [engineVersionCode] [output]

パラメータ

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

パラメータ タイプ 必須の有無 説明 制限事項
regionCode String N リージョンコード
- regionCodeはgetRegionListアクションを通じて取得
- デフォルト: getRegionList照会結果の最初のリージョンを選択
-
vpcNo String Y VPC番号
- vpcNoはgetCloudPostgresqlTargetVpcListアクションを通じて取得
-
subnetNo String Y Subnet番号
- subnetNoはgetCloudPostgresqlTargetSubnetListアクションを通じて取得
- Publicドメインは Public Subnetに作成された DBサーバでのみ申し込み可能
- Cloud DB for PostgreSQLインスタンス作成後に Subnetの移転はできない
-
secondarySubnetNo String N Secondaryサーバの Subnet番号
- マルチゾーンの有無(isMultiZone)が falseの場合は入力せず、マルチゾーンの有無(isMultiZone)が trueの場合、必ず入力
- Primaryサーバの Subnetとは Zoneが異なる必要があり、同じ Publicか Privateでなければならない
- secondarySubnetNoはgetCloudPostgresqlTargetSubnetListアクションを通じて取得
-
cloudPostgresqlImageProductCode String N Cloud DB for PostgreSQLイメージ商品コード
- cloudPostgresqlImageProductCodeはgetCloudPostgresqlImageProductListアクションの productCodeで取得
- 入力しない場合、デフォルト値で作成
-
cloudPostgresqlProductCode String N Cloud DB for PostgreSQL商品コード
- 作成する Cloud DB for PostgreSQLインスタンスのサーバスペックを決める
- cloudPostgresqlProductCodeはgetCloudPostgresqlProductListアクションの productCodeで取得
- デフォルト: 最低スペックを選択。最低スペックの基準は、1. メモリ、2. CPU
-
dataStorageTypeCode String N データストレージのタイプコード
- インストール後にデータストレージタイプは変更不可
- オプション: SSD | HDD
- デフォルト: SSD
-
isHa Boolean N 高可用性の有無
- 高可用性を選択すると Secondaryサーバを含めて2台のサーバが作成され、追加料金が発生
- 高可用性の有無(isHa)が falseの場合、isMultiZone、secondarySubnetNoパラメータは使用不可
- デフォルト: true
-
isMultiZone Boolean N マルチゾーンの有無
- 高可用性の有無(isHa)が trueの場合、マルチゾーンの有無を選択可能
- マルチゾーンを選択すると、Primaryサーバと Secondaryサーバを異なる Zoneに作成してより高い可用性を提供
- 高可用性の有無(isHa)が trueの場合、必ず入力
- Neurocloud環境では利用不可
- デフォルト: false
-
isStorageEncryption Boolean N データストレージ暗号化の適用有無(今後適用)
- 暗号化適用時、DBデータは暗号化されてストレージに保存
- Cloud DB for PostgreSQLインスタンスの作成後、ストレージ暗号化の設定は変更不可
- Neurocloud環境では利用不可
- デフォルト: false
-
isBackup Boolean N バックアップの有無
- 高可用性の有無(isHa)が trueの場合、バックアップの有無(isBackup)は trueに固定
- デフォルト: true
-
backupFileRetentionPeriod Integer N バックアップファイルの保管期間
- バックアップは毎日行われ、バックアップファイルは別途バックアップストレージに保存
- 料金は使用する容量だけ課金
- デフォルト: 1(1日)
-
backupTime String N バックアップ時間
- バックアップが実行される時間を設定。バックアップの有無(isBackup)が trueで、自動バックアップの有無(isAutomaticBackup)が falseの場合、必ず入力
- 01:15
-
backupFileStorageCount Integer N 保管するバックアップファイル数
- 保管するバックアップファイル数の範囲は1~30
-
isBackupFileCompression Boolean N バックアップファイルの圧縮有無
- デフォルト: true
-
isAutomaticBackup Boolean N バックアップ時間の自動有無
- 自動でバックアップ時間を設定するかどうかを選択、バックアップ時間自動設定の有無(isAutomaticBackup)が trueの場合、backupTimeは入力不可
- デフォルト: true
-
cloudPostgresqlServiceName String Y Cloud DB for PostgreSQLサービス名 - 英数字、ハイフン「-」、ハングルのみ入力可能
- 最小: 3
- 最大: 30
cloudPostgresqlServerNamePrefix String Y Cloud DB for PostgreSQLサーバ名の接頭辞
- ホスト名の重複を防ぐため、渡された cloudPostgresqlServerNamePrefixの末尾に任意の textが追加されて作成
- DB Server名には英字の小文字、数字、ハイフン「-」のみ使用
- 先頭文字は英字のみを、末尾文字は英字または数字のみ使用
- 最小: 3
- 最大: 20
cloudPostgresqlUserName String Y 管理者 ID
- DB管理者用として使用するユーザー名を入力
- 英字の小文字、数字、記号の「_」のみ使用可能で、先頭文字は英字
- 最小: 4
- 最大: 16
cloudPostgresqlUserPassword String Y 管理者パスワード
- DB管理者用として使用するユーザーのパスワードを入力
- 8文字以上で、英字、数字、記号の3つの項目をそれぞれ1文字以上必ず含める
- ` & + \ " ' /とスペースはパスワードに使用不可
- User IDは含めないこと
- 最小: 8
- 最大: 20
clientCidr String Y アクセス制御
- アクセスしようとするクライアントの CIDRを入力
- すべてのアクセスを許可: 0.0.0.0/0
- 特定の IPアドレスからのアクセスを許可: 192.168.1.1/32
- IPアドレス帯域からのアクセスを許可: 192.168.1.0/24
cloudPostgresqlPort Integer N Cloud DB for PostgreSQLポート
- PostgreSQLアクセス用 TCPポート番号を入力
- デフォルト: 5432
5432
or
- 最小: 10000
- 最大: 20000
cloudPostgresqlDatabaseName String Y Cloud DB for PostgreSQLの DB名
- デフォルトで作成する DB名を入力
- 英字の小文字、数字、記号の「_」のみ使用可能で、先頭文字は英字
- 最小: 1
- 最大: 30
engineVersionCode String N エンジンバージョン
- getCloudPostgresqlImageProductListを通じて確認
- cloudPostgresqlImageProductCodeの generationCodeが G3の場合、入力
入力しない場合、現在提供中の最新バージョンで作成
-
output String N レスポンス結果の形式タイプ
- オプション: xml | json
- デフォルト: json
-

レスポンス

レスポンスデータタイプ

  • CloudPostgresqlInstanceListタイプ
CloudPostgresqlInstanceList extends CommonResponse 説明
private Integer totalRows; 照会されたリストの総数
private List<CloudPostgresqlInstance> cloudPostgresqlInstanceList = new ArrayList<>(); Cloud DB for PostgreSQLインスタンスリスト
  • CloudPostgresqlInstanceタイプ
CloudPostgresqlInstance 説明
private String cloudPostgresqlInstanceNo; Cloud DB for PostgreSQLインスタンス番号
private String cloudPostgresqlServiceName; Cloud DB for PostgreSQLサービス名
private String cloudPostgresqlInstanceStatusName; Cloud DB for PostgreSQLインスタンスの状態名
- creating
- deleted
- deleting
- downgrading
- pending
- recovering
- reinstalling
- restarting
- running
- settingup
- shuttingdown
- stopped
- upgrading
private CommonCode cloudPostgresqlInstanceStatus; Cloud DB for PostgreSQLインスタンスの状態コード
- INIT (initiate)
- CREAT (created)
- DEL (deleted)
private CommonCode cloudPostgresqlInstanceOperation; Cloud DB for PostgreSQLインスタンスの Operationコード
- CREAT (create)
- DEL (delete)
- FO (failover)
- NULL (no operation)
- SETUP (setup)
- UPGD (upgrade)
- DWGD (downgrade)
- BKP (backup)
private String cloudPostgresqlImageProductCode; Cloud DB for PostgreSQLイメージ商品コード
private String engineVersion; Cloud DB for PostgreSQLエンジンバージョン
private String generationCode; 世代コード
private String license; Cloud DB for PostgreSQLライセンス
private Integer cloudPostgresqlPort; Cloud DB for PostgreSQLポート
private Boolean isHa; 高可用性の有無
private Boolean isMultiZone; マルチゾーンの有無
private Boolean isBackup; バックアップの有無
private Integer backupFileRetentionPeriod; バックアップファイルの保管期間
private String backupTime; バックアップ時間
private Date createDate; 作成日
private AccessControlGroupNoList accessControlGroupNoList; ACG番号リスト
private CloudPostgresqlConfigList cloudPostgresqlConfigList; Cloud DB for PostgreSQL Configリスト
private List<CloudPostgresqlServerInstance> cloudPostgresqlServerInstanceList; Cloud DB for PostgreSQLサーバインスタンスリスト
  • AccessControlGroupNoListタイプ
AccessControlGroupNoList 説明
private List<String> accessControlGroupNoList = new ArrayList<>(); ACG番号リスト
  • CloudPostgresqlConfigListタイプ
CloudPostgresqlConfigList 説明
private List<String> cloudPostgresqlConfigList = new ArrayList<>(); Cloud DB for PostgreSQL Configリスト
  • CloudPostgresqlServerInstanceタイプ
CloudPostgresqlServerInstance 説明
private String cloudPostgresqlServerInstanceNo; Cloud DB for PostgreSQLサーバインスタンス番号
private String cloudPostgresqlServerName; Cloud DB for PostgreSQLサーバ名
private CommonCode cloudPostgresqlServerRole; Cloud DB for PostgreSQLサーバのロール
private String cloudPostgresqlServerInstanceStatusName; Cloud DB for PostgreSQLサーバインスタンスの状態名
- creating
- deleted
- deleting
- downgrading
- pending
- recovering
- reinstalling
- restarting
- running
- settingup
- shuttingdown
- stopped
- upgrading
- downgrading
private CommonCode cloudPostgresqlServerInstanceStatus; Cloud DB for PostgreSQLサーバインスタンスの状態コード
- DEL (deleted)
- PEND (pending)
- RUN (running)
- STOP (stopped)
- FSTOP (failure stopped)
private CommonCode cloudPostgresqlServerInstanceOperation; Cloud DB for PostgreSQLサーバインスタンスの Operationコード
- NOOP (no operation)
- CREAT (create)
- START (start)
- RSTRT (restart)
- SETUP (setup)
- STOP (stop)
- FO (failover)
- DEL (delete)
- UPGD (upgrade)
- DWGD (downgrade)
- RISTL (reinstall)
private String cloudPostgresqlProductCode; Cloud DB for PostgreSQL商品コード
private String regionCode; リージョンコード
private String zoneCode; Zoneコード
private String vpcNo; VPC番号
private String subnetNo; Subnet番号
private Boolean isPublicSubnet; Public Subnetかどうか
private String publicDomain; グローバルドメイン名
private String privateDomain; プライベートドメイン名
private String privateIp; プライベート IPアドレス
private CommonCode dataStorageType; データストレージタイプ
private Boolean isStorageEncryption; データストレージ暗号化の有無
private Long dataStorageSize; データストレージ容量
private Long usedDataStorageSize; 使用中のデータストレージ容量
private Integer cpuCount; CPU数
private Long memorySize; メモリ容量
private Date uptime; VMの起動完了時間
private Date createDate; 作成日

呼び出しとレスポンスの例を説明します。

呼び出し例

呼び出しのサンプルコードは次の通りです。

ncloud vpostgresql 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.M004.NET.SSD.B050.G001 --dataStorageTypeCode SSD --isHa true --isMultiZone true --isStorageEncryption true --isBackup true --backupFileRetentionPeriod 10 --backupTime 02:00 --isAutomaticBackup false --cloudPostgresqlServiceName test-**** --cloudPostgresqlServerNamePrefix test-**** --cloudPostgresqlUserName test**** --cloudPostgresqlUserPassword ******** --clientCidr 0.0.0.0/0 --cloudPostgresqlPort 15432 --cloudPostgresqlDatabaseName test**** --backupFileStorageCount=5 --isBackupFileCompression=true --engineVersionCode=13.15

レスポンス例

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

レスポンス結果の形式タイプ(output)が jsonの場合

{
  "createCloudPostgresqlInstanceResponse": {
    "requestId": "9f76fa24-67a4-4cdf-bf70-f62f251d5138",
    "returnCode": 0,
    "returnMessage": "success",
    "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",
        "generationCode": "G2",
        "license": "PostgreSQL License",
        "cloudPostgresqlPort": 15432,
        "isHa": true,
        "isMultiZone": true,
        "isBackup": true,
        "backupFileRetentionPeriod": 10,
        "backupTime": "02:00",
        "createDate": "2021-09-16T18:00:00+0900",
        "accessControlGroupNoList": [],
        "cloudPostgresqlConfigList": [
            "sample_config=sample_value"
        ],
        "cloudPostgresqlServerInstanceList": [
          {
            "cloudPostgresqlServerName": "test-****-001-gcb",
            "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.M004.NET.SSD.B050.G001",
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "****87",
            "subnetNo": "****49",
            "isPublicSubnet": true,
            "privateIp": "***.***.***.***",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": true,
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "createDate": "2021-09-16T18:00:00+0900"
          },
          {
            "cloudPostgresqlServerName": "test-****-002-gcc",
            "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.M004.NET.SSD.B050.G001",
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "****87",
            "subnetNo": "****51",
            "isPublicSubnet": true,
            "privateIp": "***.***.***.***",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": true,
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "createDate": "2021-09-16T18:00:00+0900"
          }
        ]
      }
    ]
  }
}

レスポンス結果の形式タイプ(output)が xmlの場合

<createCloudPostgresqlInstanceResponse>
    <requestId>9f76fa24-67a4-4cdf-bf70-f62f251d5138</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>
            <generationCode>G2</generationCode>
            <license>PostgreSQL License</license>
            <cloudPostgresqlPort>15432</cloudPostgresqlPort>
            <isHa>true</isHa>
            <isMultiZone>true</isMultiZone>
            <isBackup>true</isBackup>
            <backupFileRetentionPeriod>10</backupFileRetentionPeriod>
            <backupTime>02:00</backupTime>
            <createDate>2021-09-16T18:00:00+0900</createDate>
            <accessControlGroupNoList/>
            <cloudPostgresqlConfigList>
                <cloudPostgresqlConfig>sample_config=sample_value</cloudPostgresqlConfig>
            </cloudPostgresqlConfigList>
            <cloudPostgresqlServerInstanceList>
                <cloudPostgresqlServerInstance>
                    <cloudPostgresqlServerName>test-****-001-gcb</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.M004.NET.SSD.B050.G001</cloudPostgresqlProductCode>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****87</vpcNo>
                    <subnetNo>****49</subnetNo>
                    <isPublicSubnet>true</isPublicSubnet>
                    <privateIp>***.***.***.***</privateIp>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                    <isStorageEncryption>true</isStorageEncryption>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                    <createDate>2021-09-16T18:00:00+0900</createDate>
                </cloudPostgresqlServerInstance>
                <cloudPostgresqlServerInstance>
                    <cloudPostgresqlServerName>test-****-002-gcc</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.M004.NET.SSD.B050.G001</cloudPostgresqlProductCode>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-2</zoneCode>
                    <vpcNo>****87</vpcNo>
                    <subnetNo>****51</subnetNo>
                    <isPublicSubnet>true</isPublicSubnet>
                    <privateIp>***.***.***.***</privateIp>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                    <isStorageEncryption>true</isStorageEncryption>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                    <createDate>2021-09-16T18:00:00+0900</createDate>
                </cloudPostgresqlServerInstance>
            </cloudPostgresqlServerInstanceList>
        </cloudPostgresqlInstance>
    </cloudPostgresqlInstanceList>
</createCloudPostgresqlInstanceResponse>