Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

createCloudMysqlInstance

Prev Next

VPC環境で利用できます。

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

構文

createCloudMysqlInstance構文は次の通りです。

./ncloud vmysql createCloudMysqlInstance \
    --vpcNo <vpc-no> \
    --subnetNo <subnet-no> \
    --cloudMysqlServiceName <service-name> \
    --cloudMysqlServerNamePrefix <server-name-prefix> \
    --cloudMysqlDatabaseName <database-name> \
    --cloudMysqlUserName <user-name> \
    --cloudMysqlUserPassword <user-password> \
    --hostIp <host-ip> \
    [--cloudMysqlImageProductCode <image-product-code>] \
    [--cloudMysqlProductCode <product-code>] \
    [--engineVersionCode <engine-version-code>] \
    [--dataStorageTypeCode <SSD|HDD|CB2>] \
    [--isStorageEncryption <true|false>] \
    [--isHa <true|false>] \
    [--isMultiZone <true|false>] \
    [--standbyMasterSubnetNo <standby-subnet-no>] \
    [--isBackup <true|false>] \
    [--isAutomaticBackup <true|false>] \
    [--backupTime <hh:mm>] \
    [--backupFileRetentionPeriod <retention-days>] \
    [--cloudMysqlPort <port>] \
    [--isPrivateSubDomain <true|false>] \
    [--privateSubDomainPrefix <private-sub-domain-prefix>] \
    [--isDeleteProtection <true|false>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

createCloudMysqlInstanceの実行時に指定できるオプションについて説明します。

必須オプション

createCloudMysqlInstanceの必須オプションです。

オプション タイプ 必須の有無 説明
--vpcNo String Required Cloud DB for MySQLインスタンス作成対象の VPC番号
--subnetNo String Required Cloud DB for MySQLインスタンスで使用する基本ネットワークインターフェースの Subnet番号
  • Publicドメインは、Public Subnetに作成された DBサーバでのみ申し込み可能
  • Cloud DB for MySQLインスタンス作成後に Subnetの移転はできない
  • getCloudMysqlTargetSubnetListを参照
--cloudMysqlServiceName String Required Cloud DB for MySQLサービス名
  • 英字、ハングル、数字、記号の-を組み合わせて3~30文字以内で入力
--cloudMysqlServerNamePrefix String Required Cloud DB for MySQLサーバ名の接頭辞
  • 英字の小文字、数字、記号の-を組み合わせて3~20文字以内で入力
  • 先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用
  • 接頭辞の末尾に3桁の数字が自動で付き、ホスト名の重複防止のために任意のテキストが追加され作成される
  • 例: 接頭辞がtest-123の場合、test-123-001-4y1v
--cloudMysqlDatabaseName String Required Cloud DB for MySQLインスタンスにデフォルトで作成する DBの名前
  • 英字、数字、記号の_ -を組み合わせて1~30文字以内で入力
  • 先頭文字は英字のみ使用
--cloudMysqlUserName String Required DB Userアカウント ID
  • 英字、数字、記号の- _を組み合わせて3~16文字以内で入力
  • 先頭文字は英字のみ使用
--cloudMysqlUserPassword String Required DB Userアカウントパスワード
  • 英字、記号、数字をそれぞれ1文字以上含めて8~20文字以内で入力
  • 記号の` & + \ " ' /とスペースは使用不可
  • Password pluginが有効になっている状態では、pluginで設定したポリシーにも従わなければならない
--hostIp String Required MySQLサーバへの接続を許可するホスト IPアドレス
  • すべて許可: %
  • 特定の IPアドレス: 1.1.1.1
  • IPアドレス範囲: 1.1.1.%
  • CIDR: 1.1.1.0/24
--isMultiZone Boolean Conditional マルチゾーンかどうか
  • true | false (デフォルト)
    • true: Masterサーバと Standby Masterを異なるゾーンに作成してより高い可用性を提供
    • false: マルチゾーンを使用しない
  • isHa=trueの場合、必ず入力
--standbyMasterSubnetNo String Conditional Standby Masterサーバの Subnet番号
  • Cloud DB for MySQLがマルチゾーンの場合、必ず入力
  • Masterサーバの Subnetとはゾーンが異なるように、Publicまたは Privateは同じようにする
  • getCloudMysqlTargetSubnetListを参照
--backupTime String Conditional バックアップ時点を設定 (HH:MM)
  • isBackup=trueisAutomaticBackup=falseの場合、必ず入力
  • 例: 01:15 (選択した時間 + 15分の間に Backupが開始)
--privateSubDomainPrefix String Conditional Privateドメインに追加する Subドメインを入力
  • 英字、数字、記号の-を組み合わせて3~15文字以内で入力
  • 先頭文字は英字、末尾文字は英字または数字のみ使用可能
  • isPrivateSubDomain=trueの場合、必ず入力
  • Slave、Recoveryの追加時にも同じ Subドメインポリシーが追加される

任意オプション

createCloudMysqlInstanceの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション タイプ 必須の有無 説明
--cloudMysqlImageProductCode String Optional Cloud DB for MySQLイメージ商品コード
--cloudMysqlProductCode String Optional Cloud DB for MySQL商品コード
  • Cloud DB for MySQLインスタンスのサーバスペックを決める
  • デフォルト: 最小スペック(メモリ、CPUの順)
  • getCloudMysqlProductListを参照
--engineVersionCode String Optional DBエンジンのバージョン
--dataStorageTypeCode String Optional データストレージタイプコード
  • cloudMysqlImageProductCodegenerationCodeに応じて有効な値が異なる
    • G2: SSD (デフォルト) | HDD
    • G3: CB2 (デフォルト)
  • インストール後、データストレージタイプは変更不可
--isStorageEncryption Boolean Optional データストレージ暗号化の適用有無(今後適用)
  • true | false (デフォルト)
  • 暗号化を適用すると、DBデータは暗号化されストレージに保存
  • isHa=trueの場合にのみ暗号化を適用可能
  • Cloud DB for MySQLインスタンスの作成後、ストレージ暗号化の設定は変更不可
--isHa Boolean Optional 高可用性の有無
  • true (デフォルト) | false
    • true: Standby Masterサーバを含めて2台のサーバが作成され、追加料金が発生
    • false: isMultiZonestandbyMasterSubnetNoは使用不可
--isBackup Boolean Optional MySQLのバックアップを設定するか
  • true (デフォルト) | false
  • isHa=trueの場合、trueに固定される
--isAutomaticBackup Boolean Optional バックアップ時点を自動設定するか
  • true (デフォルト) | false
  • trueの場合、backupTimeは入力不可
--backupFileRetentionPeriod Integer Optional バックアップファイルの保管期間(日)
  • 1 (デフォルト)
  • バックアップは毎日行われ、バックアップファイルは別途ストレージに保存
  • InnoDBエンジンで作成されたテーブルのみバックアップをサポート
--cloudMysqlPort Integer Optional Cloud DB for MySQLインスタンスアクセス用 TCPポート番号
  • 10000~20000 (デフォルト: 3306)
  • 一度指定したポート番号は変更不可
--isPrivateSubDomain Boolean Optional Private Subドメインの使用有無
  • true | false
  • trueの場合、privateSubDomainPrefixを指定可能
--isDeleteProtection Boolean Optional クラスタ返却保護するかどうか
  • true | false (デフォルト)
  • trueの場合、クラスタは返却できない

共通オプション

vmysqlコマンドで共通して使用するオプションについては、Cloud DB for MySQL (VPC)のオプションを参照してください。

Cloud DB for MySQLインスタンスの作成リクエストが成功すると、インスタンスの構成情報と作成状態が返されます。

コマンド

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

./ncloud vmysql createCloudMysqlInstance \
    --vpcNo 98765432 \
    --subnetNo 23456789 \
    --cloudMysqlServiceName test-mysql \
    --cloudMysqlServerNamePrefix testmysql \
    --cloudMysqlDatabaseName testdb \
    --cloudMysqlUserName testuser \
    --cloudMysqlUserPassword Examplepw123! \
    --hostIp % \
    --cloudMysqlImageProductCode SW.VMYSL.OS.LNX64.ROCKY.0810.MYSQL.B050 \
    --cloudMysqlProductCode SVR.VDBAS.HICPU.C002.M004.NET.HDD.B050.G002 \
    --engineVersionCode 8.0.36 \
    --isHa true \
    --isMultiZone true \
    --standbyMasterSubnetNo 23456790 \
    --cloudMysqlPort 13306 \
    --regionCode KR \
    --output json

出力

出力の例は次の通りです。

{
  "createCloudMysqlInstanceResponse": {
    "totalRows": 1,
    "cloudMysqlInstanceList": [
      {
        "cloudMysqlInstanceNo": "12345678",
        "cloudMysqlServiceName": "test-mysql",
        "cloudMysqlInstanceStatusName": "creating",
        "cloudMysqlInstanceStatus": {
          "code": "INIT",
          "codeName": "CLOUD DATABASE(VPC) Init状態"
        },
        "cloudMysqlInstanceOperation": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Creat OP"
        },
        "cloudMysqlImageProductCode": "SW.VMYSL.OS.LNX64.ROCKY.0810.MYSQL.B050",
        "engineVersion": "MYSQL8.0.36",
        "license": {
          "code": "GPL",
          "codeName": "ライセンスコード-CLOUD DATABASE(VPC)"
        },
        "cloudMysqlPort": 13306,
        "isHa": true,
        "isMultiZone": true,
        "isBackup": true,
        "backupFileRetentionPeriod": 1,
        "backupTime": "00:00",
        "generationCode": "G2",
        "createDate": "2026-06-04T16:50:56+0900",
        "accessControlGroupNoList": [],
        "cloudMysqlConfigList": [],
        "cloudMysqlServerInstanceList": [
          {
            "cloudMysqlServerName": "testmysql-001-97mj",
            "cloudMysqlServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudMysqlServerInstanceStatusName": "creating",
            "cloudMysqlServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC)サーバ Pending状態"
            },
            "cloudMysqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC)サーバ Create OP"
            },
            "cloudMysqlProductCode": "SVR.VDBAS.HICPU.C002.M004.NET.HDD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "98765432",
            "subnetNo": "23456789",
            "isPublicSubnet": false,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": false,
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "createDate": "2026-06-04T16:50:56+0900"
          },
          {
            "cloudMysqlServerName": "testmysql-002-97mk",
            "cloudMysqlServerRole": {
              "code": "H",
              "codeName": "Standby Master"
            },
            "cloudMysqlServerInstanceStatusName": "creating",
            "cloudMysqlServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC)サーバ Pending状態"
            },
            "cloudMysqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC)サーバ Create OP"
            },
            "cloudMysqlProductCode": "SVR.VDBAS.HICPU.C002.M004.NET.HDD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "98765432",
            "subnetNo": "23456790",
            "isPublicSubnet": false,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": false,
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "createDate": "2026-06-04T16:50:56+0900"
          }
        ]
      }
    ],
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}