createCloudMysqlRecoveryInstance
- Print
- PDF
createCloudMysqlRecoveryInstance
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Available in VPC
Recovery server instance is generated at Cloud DB for MySQL instance. Recovered using backup files or to a certain point of time.
Commands
The text of the command is as follows.
ncloud vmysql createCloudMysqlRecoveryInstance [regionCode KR] [cloudMysqlInstanceNo] [subnetNo] [fileName] [recoveryTime] [cloudMysqlRecoveryServerName] [output]
Parameter
The following is a description on parameters.
Parameter | Type | Essential parameter (True/False) | Description | Limitations |
---|---|---|---|---|
regionCode | String | N | Region code for which Cloud DB for MySQL instance exists - Can be obtained through getRegionList action - Default: select the first region viewed through getRegionList | - |
cloudMysqlInstanceNo | String | Y | Cloud DB for MySQL instance number - Can be obtained through getCloudMysqlInstanceList action | - |
subnetNo | String | N | Subnet number - Can be obtained through getCloudMysqlTargetSubnetList action - If multi-zone is set at True for Cloud DB for MySQL instance, an entry must be made - If multi-zone for Cloud DB for MySQL instance is set at False, an entry is not received; generated at an existing subnetNo - Public domain can only be used on a DB server generated on Public Subnet - Subnet cannot be transferred after Cloud DB for MySQL Recovery server instance is generated | - |
fileName | String | N | Name of backup file - If fileName is entered, recoveryTime is not entered; either fileName or recoveryTime must be entered - When recovering using backup files, recover to the time when the backup was completed - Can be obtained through getCloudMysqlBackupDetailList action | - |
recoveryTime | String | N | Point of time recovery time - If recoveryTime is entered, fileName is not entered; either fileName or recoveryTime must be entered - Enterable time can be obtained through getCloudMysqlRecoveryTime action | yyyy-MM-dd HH:mm |
cloudMysqlRecoveryServerName | String | Y | Cloud DB for MySQL Recovery server instance name - In order to prevent overlapping host names, random text is added | - Can comprise only lower-case English alphabets, numbers and dash ( - ) - The first letter must be an English alphabet and the last letter must be an English alphabet or a number - min: 3 - max: 25 |
output | String | N | Format type of responses - options: xml | json - default: json | - |
Responses
Response data type
Response data type for command recall is as follows.
- CloudMysqlInstanceList type
CloudMysqlInstanceList extends CommonResponse | Description |
---|---|
private Integer totalRows; | Total number of items viewed |
private List<CloudMysqlInstance> cloudMysqlInstanceList = new ArrayList<>(); |
- CloudMysqlInstance type
CloudMysqlInstance | Description |
---|---|
private String cloudMysqlInstanceNo; | Cloud DB for MySQL instance number |
private String cloudMysqlServiceName; | Cloud DB for MySQL service name |
private String cloudMysqlInstanceStatusName; | Cloud DB for MySQL instance status name - creating - deleted - deleting - pending - recovering - reinstalling - restarting - running - settingup - shuttingdown - stopped - upgrading - downgrading |
private CommonCode cloudMysqlInstanceStatus; | Cloud DB for MySQL instance status code - INIT (init) - CREAT (created) - DEL (deleted) |
private CommonCode cloudMysqlInstanceOperation; | Cloud DB for MySQL instance operation code - CREAT (create) - DEL (delete) - FO (failover) - NULL (no) - SETUP (setup) - UPGD (upgrade) - DWGD (downgrade) - BKP (backup) |
private String cloudMysqlImageProductCode; | Cloud DB for MySQL image product code |
private String engineVersion; | Cloud DB for MySQL engine version |
private CommonCode license; | Cloud DB for MySQL license |
private Integer cloudMysqlPort; | Cloud DB for MySQL port |
private Boolean isHa; | High-availability (True/False) |
private Boolean isMultiZone; | Multi-zone (True/False) |
private Boolean isBackup; | Backup (True/False) |
private Integer backupFileRetentionPeriod; | Backup file storage period |
private String backupTime; | Backup time |
private String generationCode; | Server generation code |
private Date createDate; | Date generated |
private List<String> accessControlGroupNoList; | List of ACG numbers |
private List<String> cloudMysqlConfigList; | Cloud DB for MySQL configuration list |
private List<CloudMysqlServerInstance> cloudMysqlServerInstanceList; | Cloud DB for MySQL server instance list |
- CloudMysqlServerInstance type
CloudMysqlServerInstance | Description |
---|---|
private String cloudMysqlServerInstanceNo; | Cloud DB for MySQL server instance number |
private String cloudMysqlServerName; | Cloud DB for MySQL server name |
private CommonCode cloudMysqlServerRole; | Cloud DB for MySQL server role |
private String cloudMysqlServerInstanceStatusName; | Cloud DB for MySQL server instance status - name - creating - deleted - deleting - downgrading - pending - recovering - reinstalling - restarting - running - settingup - shuttingdown - stopped - upgrading - downgrading |
private CommonCode cloudMysqlServerInstanceStatus; | Cloud DB for MySQL server instance status code - DEL (deleted) - PEND (pending) - RUN (running) - STOP (stopped) - FSTOP (failure stopped) |
private CommonCode cloudMysqlServerInstanceOperation; | Cloud DB for MySQL server instance Operation code - NOOP (no operation) - CREAT (create) - START (start) - RSTRT (restart) - SETUP (setup) - STOP (stop) - FO (failover) - DEL (delete) - UPGD (upgrade) - DWGD (downgrade) - RISTL (서버 reinstall) - MIG (migration) |
private String cloudMysqlProductCode; | Cloud DB for MySQL product code |
private String regionCode; | Region code |
private String zoneCode; | ZONE code |
private String vpcNo; | VPC number |
private String subnetNo; | Subnet number |
private Boolean isPublicSubnet; | Public Subnet (True/False) |
private String publicDomain; | Name of public domain |
private String privateDomain; | Name of private domain |
private CommonCode dataStorageType; | Data storage type |
private Boolean isStorageEncryption; | Whether data storage encryption is applied |
private Long dataStorageSize; | Data storage size |
private Long usedDataStorageSize; | Size of data storage in use |
private Integer cpuCount; | Number of virtual CPUs |
private Long memorySize; | Memory size |
private Date uptime; | VM booting completion time |
private Date createDate; | Date generated |
Examples
Describes examples of recalls and responses.
Recall examples
The following are examples of recalls.
ncloud vmysql createCloudMysqlRecoveryInstance --regionCode KR --cloudMysqlInstanceNo ****890 --fileName 20210722 --cloudMysqlRecoveryServerName test-recovery --subnetNo ****91
Response examples
The following are examples of responses.
If the response shows that format type (output) is json
{
"createCloudMysqlRecoveryInstanceResponse": {
"requestId": "ec3580e6-2cc8-487b-bc61-f4ff52ffebc0",
"returnCode": 0,
"returnMessage": "success",
"totalRows": 1,
"cloudMysqlInstanceList": {
"cloudMysqlInstance": {
"cloudMysqlInstanceNo": "****890",
"cloudMysqlServiceName": "test-****",
"cloudMysqlInstanceStatusName": "pending",
"cloudMysqlInstanceStatus": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Created State"
},
"cloudMysqlInstanceOperation": {
"code": "NULL",
"codeName": "CLOUD DATABASE(VPC) Null OP"
},
"cloudMysqlImageProductCode": "SW.VDBAS.DBAAS.LNX64.CNTOS.0708.MYSQL.5732.B050",
"engineVersion": "MYSQL5.7.32",
"license": {
"code": "GPL",
"codeName": "General Public License"
},
"cloudMysqlPort": 13306,
"isHa": true,
"isMultiZone": true,
"isBackup": true,
"backupFileRetentionPeriod": 10,
"backupTime": "02:00",
"generationCode": "G2",
"createDate": "2021-05-27T18:00:00+0900",
"accessControlGroupNoList": [
"****58"
],
"cloudMysqlConfigList": [
"autocommit=ON",
"default-time-zone=+09:00",
"wait_timeout=28800"
],
"cloudMysqlServerInstanceList": {
"cloudMysqlServerInstance": [
{
"cloudMysqlServerInstanceNo": "****891",
"cloudMysqlServerName": "test-****-001-e04",
"cloudMysqlServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudMysqlServerInstanceStatusName": "deleting",
"cloudMysqlServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) Server Running State"
},
"cloudMysqlServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) Server Null OP"
},
"cloudMysqlProductCode": "SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002",
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"isPublicSubnet": true,
"publicDomain": "db-****.vpc-pub-cdb.ntruss.com",
"privateDomain": "db-****.vpc-cdb.ntruss.com",
"dataStorageType": {
"code": "SSD",
"codeName": "SSD"
},
"isStorageEncryption": true,
"dataStorageSize": 10737418240,
"usedDataStorageSize": 2791728640,
"cpuCount": 2,
"memorySize": 8589934592,
"uptime": "2021-05-27T18:10:00+0900",
"createDate": "2021-05-27T18:00:00+0900"
},
{
"cloudMysqlServerInstanceNo": "****897",
"cloudMysqlServerName": "test-****-002-e05",
"cloudMysqlServerRole": {
"code": "H",
"codeName": "Standby Master"
},
"cloudMysqlServerInstanceStatusName": "deleting",
"cloudMysqlServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) Server Running State"
},
"cloudMysqlServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) Server Null OP"
},
"cloudMysqlProductCode": "SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002",
"regionCode": "KR",
"zoneCode": "KR-2",
"vpcNo": "****83",
"subnetNo": "****93",
"isPublicSubnet": true,
"privateDomain": "db-****.vpc-cdb.ntruss.com",
"dataStorageType": {
"code": "SSD",
"codeName": "SSD"
},
"isStorageEncryption": true,
"dataStorageSize": 10737418240,
"usedDataStorageSize": 2791728640,
"cpuCount": 2,
"memorySize": 8589934592,
"uptime": "2021-05-27T18:10:00+0900",
"createDate": "2021-05-27T18:00:00+0900"
},
{
"cloudMysqlServerName": "test-recovery-001-exr",
"cloudMysqlServerRole": {
"code": "R",
"codeName": "Recovery"
},
"cloudMysqlServerInstanceStatusName": "pending",
"cloudMysqlServerInstanceStatus": {
"code": "PEND",
"codeName": "CLOUD DATABASE(VPC) Server Pending State"
},
"cloudMysqlServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) Server Null OP"
},
"cloudMysqlProductCode": "SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002",
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"isPublicSubnet": true,
"privateDomain": "db-****.vpc-cdb.ntruss.com",
"dataStorageType": {
"code": "SSD",
"codeName": "SSD"
},
"isStorageEncryption": true,
"dataStorageSize": 10737418240,
"usedDataStorageSize": 2791728640,
"cpuCount": 2,
"memorySize": 8589934592,
"uptime": "2021-07-22T18:10:00+0900",
"createDate": "2021-07-22T18:00:00+0900"
}
]
}
}
}
}
}
If the response shows that format type (output) is xml
<createCloudMysqlRecoveryInstanceResponse>
<requestId>ec3580e6-2cc8-487b-bc61-f4ff52ffebc0</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<cloudMysqlInstanceList>
<cloudMysqlInstance>
<cloudMysqlInstanceNo>****890</cloudMysqlInstanceNo>
<cloudMysqlServiceName>test-****</cloudMysqlServiceName>
<cloudMysqlInstanceStatusName>pending</cloudMysqlInstanceStatusName>
<cloudMysqlInstanceStatus>
<code>CREAT</code>
<codeName>CLOUD DATABASE(VPC) Created State</codeName>
</cloudMysqlInstanceStatus>
<cloudMysqlInstanceOperation>
<code>NULL</code>
<codeName>CLOUD DATABASE(VPC) Null OP</codeName>
</cloudMysqlInstanceOperation>
<cloudMysqlImageProductCode>SW.VDBAS.DBAAS.LNX64.CNTOS.0708.MYSQL.5732.B050</cloudMysqlImageProductCode>
<engineVersion>MYSQL5.7.32</engineVersion>
<license>
<code>GPL</code>
<codeName>General Public License</codeName>
</license>
<cloudMysqlPort>13306</cloudMysqlPort>
<isHa>true</isHa>
<isMultiZone>true</isMultiZone>
<isBackup>true</isBackup>
<backupFileRetentionPeriod>10</backupFileRetentionPeriod>
<backupTime>02:00</backupTime>
<generationCode>G2</generationCode>
<createDate>2021-05-27T18:00:00+0900</createDate>
<accessControlGroupNoList>
<accessControlGroupNo>****58</accessControlGroupNo>
</accessControlGroupNoList>
<cloudMysqlConfigList>
<cloudMysqlConfig>autocommit=ON</cloudMysqlConfig>
<cloudMysqlConfig>default-time-zone=+09:00</cloudMysqlConfig>
<cloudMysqlConfig>wait_timeout=28800</cloudMysqlConfig>
</cloudMysqlConfigList>
<cloudMysqlServerInstanceList>
<cloudMysqlServerInstance>
<cloudMysqlServerInstanceNo>****891</cloudMysqlServerInstanceNo>
<cloudMysqlServerName>test-****-001-e04</cloudMysqlServerName>
<cloudMysqlServerRole>
<code>M</code>
<codeName>Master</codeName>
</cloudMysqlServerRole>
<cloudMysqlServerInstanceStatusName>deleting</cloudMysqlServerInstanceStatusName>
<cloudMysqlServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudMysqlServerInstanceStatus>
<cloudMysqlServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
</cloudMysqlServerInstanceOperation>
<cloudMysqlProductCode>SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002</cloudMysqlProductCode>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<vpcNo>****83</vpcNo>
<subnetNo>****91</subnetNo>
<isPublicSubnet>true</isPublicSubnet>
<publicDomain>db-****.vpc-pub-cdb.ntruss.com</publicDomain>
<privateDomain>db-****.vpc-cdb.ntruss.com</privateDomain>
<dataStorageType>
<code>SSD</code>
<codeName>SSD</codeName>
</dataStorageType>
<isStorageEncryption>true</isStorageEncryption>
<dataStorageSize>10737418240</dataStorageSize>
<usedDataStorageSize>2791728640</usedDataStorageSize>
<cpuCount>2</cpuCount>
<memorySize>8589934592</memorySize>
<uptime>2021-05-27T18:10:00+0900</uptime>
<createDate>2021-05-27T18:00:00+0900</createDate>
</cloudMysqlServerInstance>
<cloudMysqlServerInstance>
<cloudMysqlServerInstanceNo>****897</cloudMysqlServerInstanceNo>
<cloudMysqlServerName>test-****-002-e05</cloudMysqlServerName>
<cloudMysqlServerRole>
<code>H</code>
<codeName>Standby Master</codeName>
</cloudMysqlServerRole>
<cloudMysqlServerInstanceStatusName>deleting</cloudMysqlServerInstanceStatusName>
<cloudMysqlServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudMysqlServerInstanceStatus>
<cloudMysqlServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
</cloudMysqlServerInstanceOperation>
<cloudMysqlProductCode>SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002</cloudMysqlProductCode>
<regionCode>KR</regionCode>
<zoneCode>KR-2</zoneCode>
<vpcNo>****83</vpcNo>
<subnetNo>****93</subnetNo>
<isPublicSubnet>true</isPublicSubnet>
<privateDomain>db-****.vpc-cdb.ntruss.com</privateDomain>
<dataStorageType>
<code>SSD</code>
<codeName>SSD</codeName>
</dataStorageType>
<isStorageEncryption>true</isStorageEncryption>
<dataStorageSize>10737418240</dataStorageSize>
<usedDataStorageSize>2791728640</usedDataStorageSize>
<cpuCount>2</cpuCount>
<memorySize>8589934592</memorySize>
<uptime>2021-05-27T18:10:00+0900</uptime>
<createDate>2021-05-27T18:00:00+0900</createDate>
</cloudMysqlServerInstance>
<cloudMysqlServerInstance>
<cloudMysqlServerName>test-recovery-001-exr</cloudMysqlServerName>
<cloudMysqlServerRole>
<code>R</code>
<codeName>Recovery</codeName>
</cloudMysqlServerRole>
<cloudMysqlServerInstanceStatusName>pending</cloudMysqlServerInstanceStatusName>
<cloudMysqlServerInstanceStatus>
<code>PEND</code>
<codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
</cloudMysqlServerInstanceStatus>
<cloudMysqlServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
</cloudMysqlServerInstanceOperation>
<cloudMysqlProductCode>SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002</cloudMysqlProductCode>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<vpcNo>****83</vpcNo>
<subnetNo>****91</subnetNo>
<isPublicSubnet>true</isPublicSubnet>
<privateDomain>db-****.vpc-cdb.ntruss.com</privateDomain>
<dataStorageType>
<code>SSD</code>
<codeName>SSD</codeName>
</dataStorageType>
<isStorageEncryption>true</isStorageEncryption>
<dataStorageSize>10737418240</dataStorageSize>
<usedDataStorageSize>2791728640</usedDataStorageSize>
<cpuCount>2</cpuCount>
<memorySize>8589934592</memorySize>
<uptime>2021-07-22T18:10:00+0900</uptime>
<createDate>2021-07-22T18:00:00+0900</createDate>
</cloudMysqlServerInstance>
</cloudMysqlServerInstanceList>
</cloudMysqlInstance>
</cloudMysqlInstanceList>
</createCloudMysqlRecoveryInstanceResponse>
Was this article helpful?