createCloudMysqlRecoveryInstance

Available in VPC

Add a recovery server instance in a Cloud DB for MySQL instance.

Syntax

The createCloudMysqlRecoveryInstance syntax is as follows:

./ncloud vmysql createCloudMysqlRecoveryInstance \
    --cloudMysqlInstanceNo <instance-no> \
    --cloudMysqlRecoveryServerName <recovery-server-name> \
    --fileName <backup-file-name> | --recoveryTime <recovery-time> \
    [--subnetNo <subnet-no>] \    
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running createCloudMysqlRecoveryInstance.

Required options

The following options are required for createCloudMysqlRecoveryInstance.

Options	Type	Required	Description
`--cloudMysqlInstanceNo`	String	Required	Cloud DB for MySQL instance number See getCloudMysqlInstanceList.
`--cloudMysqlRecoveryServerName`	String	Required	Cloud DB for MySQL recovery server instance name Enter 3-20 characters, including lowercase English letters, numbers, and special character `-`. The string must begin with a lowercase English letter and end with a lowercase English letter or number. A three-digit number is automatically generated after the prefix, and random text is added to prevent hostname duplication. e.g., If the prefix is `test-123`: `test-123-001-4y1v`.
`--fileName`	String	Conditional	Backup file name When restoring the backup file, it restores to the time the backup was completed. Either `fileName` or `recoveryTime` must be entered. See getCloudMysqlBackupDetailList.
`--recoveryTime`	String	Conditional	Time of point-in-time recovery `yyyy-MM-dd HH:mm` format Either `fileName` or `recoveryTime` must be entered. See getCloudMysqlRecoveryTime.
`--subnetNo`	String	Conditional	Subnet number of the default network interface to be used in the Cloud DB for MySQL instance Required for a multi-zone Cloud DB for MySQL. If not multi-zone, the `subnetNo` entry is ignored and it is created in the existing subnet. Subscription to public domains can only be done in a DB server created in public subnet. Subnet migrations are not available after creating the Cloud DB for MySQL instance. See getCloudMysqlTargetSubnetList.

Common options

For information about the options common to all vmysql subcommands, see Cloud DB for MySQL (VPC) options.

Examples

If the request to create a recovery server instance is successful, the configuration information for the Cloud DB for MySQL instance and the creation status of the added recovery server are returned.

Command

The command example is as follows:

./ncloud vmysql createCloudMysqlRecoveryInstance \
    --cloudMysqlInstanceNo 12345678 \
    --cloudMysqlRecoveryServerName testrecovery01 \
    --subnetNo 23456789 \
    --fileName 20260604 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "createCloudMysqlRecoveryInstanceResponse": {
    "totalRows": 1,
    "cloudMysqlInstanceList": [
      {
        "cloudMysqlInstanceNo": "12345678",
        "cloudMysqlServiceName": "test-mysql",
        "cloudMysqlInstanceStatusName": "creating",
        "cloudMysqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE (VPC) Created status"
        },
        "cloudMysqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "cloudMysqlImageProductCode": "SW.VMYSL.OS.LNX64.ROCKY.0810.MYSQL.B050",
        "engineVersion": "MYSQL8.0.36",
        "license": {
          "code": "GPL",
          "codeName": "License code - CLOUD DATABASE (VPC)"
        },
        "cloudMysqlPort": 13306,
        "isHa": true,
        "isMultiZone": true,
        "isBackup": true,
        "backupFileRetentionPeriod": 1,
        "backupTime": "10:30",
        "generationCode": "G2",
        "createDate": "2026-06-04T16:50:56+0900",
        "accessControlGroupNoList": [
          "67890123"
        ],
        "cloudMysqlConfigList": [],
        "cloudMysqlServerInstanceList": [
          {
            "cloudMysqlServerInstanceNo": "34567890",
            "cloudMysqlServerName": "testmysql-001-97mj",
            "cloudMysqlServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudMysqlServerInstanceStatusName": "running",
            "cloudMysqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMysqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMysqlProductCode": "SVR.VDBAS.HICPU.C002.M004.NET.HDD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "98765432",
            "subnetNo": "23456789",
            "isPublicSubnet": false,
            "privateDomain": "db-1a2b3c.vpc-cdb.ntruss.com",
            "privateIp": "10.0.0.6",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": false,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 9234180096,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "uptime": "2026-06-04T16:57:14+0900",
            "createDate": "2026-06-04T16:50:56+0900"
          },
          {
            "cloudMysqlServerInstanceNo": "34567891",
            "cloudMysqlServerName": "testmysql-002-97mk",
            "cloudMysqlServerRole": {
              "code": "H",
              "codeName": "Standby Master"
            },
            "cloudMysqlServerInstanceStatusName": "running",
            "cloudMysqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMysqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMysqlProductCode": "SVR.VDBAS.HICPU.C002.M004.NET.HDD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "98765432",
            "subnetNo": "23456790",
            "isPublicSubnet": false,
            "privateDomain": "db-1a2b3c.vpc-cdb.ntruss.com",
            "privateIp": "10.0.1.6",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": false,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 9234180096,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "uptime": "2026-06-04T16:57:26+0900",
            "createDate": "2026-06-04T16:50:56+0900"
          },
          {
            "cloudMysqlServerInstanceNo": "34567892",
            "cloudMysqlServerName": "testmysql-003-97mu",
            "cloudMysqlServerRole": {
              "code": "S",
              "codeName": "Slave"
            },
            "cloudMysqlServerInstanceStatusName": "running",
            "cloudMysqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMysqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMysqlProductCode": "SVR.VDBAS.HICPU.C002.M004.NET.HDD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "98765432",
            "subnetNo": "23456789",
            "isPublicSubnet": false,
            "privateDomain": "db-1a2b3c.vpc-cdb.ntruss.com",
            "privateIp": "10.0.0.7",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": false,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 9234180096,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "uptime": "2026-06-04T17:30:59+0900",
            "createDate": "2026-06-04T17:26:30+0900"
          },
          {
            "cloudMysqlServerName": "testrecovery01-001-97mx",
            "cloudMysqlServerRole": {
              "code": "R",
              "codeName": "Recovery"
            },
            "cloudMysqlServerInstanceStatusName": "creating",
            "cloudMysqlServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE (VPC) server Pending status"
            },
            "cloudMysqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server 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-04T17:40:59+0900"
          }
        ]
      }
    ],
    "requestId": "f6a7b8c9-d0e1-2345-fabc-678901234567",
    "returnCode": "0",
    "returnMessage": "success"
  }
}