---
title: "CloudMysqlInstance"
slug: "common-vapidatatype-cloudmysqlinstance"
updated: 2026-09-17T09:25:15Z
published: 2026-09-17T09:25:15Z
canonical: "api.ncloud-docs.com/common-vapidatatype-cloudmysqlinstance"
---

> ## 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.

# CloudMysqlInstance

Available in VPC

This is a Cloud DB for MySQL instance.

## Syntax

The syntax is as follows.

```
private String cloudMysqlInstanceNo;
private String cloudMysqlServiceName;
private String cloudMysqlInstanceStatusName;
private CommonCode cloudMysqlInstanceStatus;
private CommonCode cloudMysqlInstanceOperation;
private String cloudMysqlImageProductCode;
private String engineVersion;
private CommonCode license;
private Integer cloudMysqlPort;
private Boolean isHa;
private Boolean isMultiZone;
private Boolean isBackup;
private Integer backupFileRetentionPeriod;
private String backupTime;
private String generationCode;
private Date createDate;
private List<String> accessControlGroupNoList;
private List<String> cloudMysqlConfigList;
private List<CloudMysqlServerInstance> cloudMysqlServerInstanceList;
```

## Field

The following describes the fields.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `cloudMysqlInstanceNo` | String | Required | Cloud DB for MySQL instance number |
| `cloudMysqlServiceName` | String | Required | Cloud DB for MySQL service name |
| `cloudMysqlInstanceStatusName` | String | Required | Cloud DB for MySQL instance status name - `creating` \| `deleted` \| `deleting` \| `pending` \| `recovering` \| `reinstalling` \| `restarting` \| `running` \| `settingup` \| `shuttingdown` \| `stopped` \| `upgrading` \| `downgrading` |
| `cloudMysqlInstanceStatus` | [CommonCode](/docs/en/common-vapidatatype-commoncode) | Required | Cloud DB for MySQL instance status - `INIT` \| `CREAT` \| `DEL` - `INIT`: initiated - `CREAT`: created - `DEL`: deleted |
| `cloudMysqlInstanceOperation` | [CommonCode](/docs/en/common-vapidatatype-commoncode) | Required | Cloud DB for MySQL instance operation status - `CREAT` \| `DEL` \| `FO` \| `NULL` \| `SETUP` \| `UPGD` \| `DWGD` \| `BKP` - `CREAT`: create - `DEL`: delete - `FO`: failover - `NULL`: no operation - `SETUP`: setup - `UPGD`: upgrade - `DWGD`: downgrade - `BKP`: backup |
| `cloudMysqlImageProductCode` | String | Optional | Cloud DB for MySQL image product code |
| `engineVersion` | String | Optional | Cloud DB for MySQL engine version |
| `license` | [CommonCode](/docs/en/common-vapidatatype-commoncode) | Optional | Cloud DB for MySQL license |
| `cloudMysqlPort` | Integer | Optional | Cloud DB for MySQL port |
| `isHa` | Boolean | Required | High availability status - `true` \| `false` |
| `isMultiZone` | Boolean | Required | Multi-zone status - `true` \| `false` |
| `isBackup` | Boolean | Optional | Backup status - `true` \| `false` |
| `backupFileRetentionPeriod` | Integer | Optional | Backup file retention period |
| `backupTime` | String | Optional | Backup time |
| `generationCode` | String | Required | Server generation code |
| `createDate` | Date | Required | Creation date and time |
| `accessControlGroupNoList` | List<String> | Optional | ACG number list |
| `cloudMysqlConfigList` | List<String> | Optional | Cloud DB for MySQL config list |
| `cloudMysqlServerInstanceList` | List<[CloudMysqlServerInstance](/docs/en/common-vapidatatype-cloudmysqlserverinstance)> | Required | Cloud DB for MySQL server instance list |