---
title: "CloudMysqlInstance"
slug: "common-vapidatatype-cloudmysqlinstance"
updated: 2026-09-17T09:57:01Z
published: 2026-09-17T09:57:01Z
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

VPC環境で利用できます。

Cloud DB for MySQLインスタンスです。

## 構文

構文は次の通りです。

```
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;
```

## フィールド

フィールドの詳細は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `cloudMysqlInstanceNo` | String | Required | Cloud DB for MySQLのインスタンス番号 |
| `cloudMysqlServiceName` | String | Required | Cloud DB for MySQLサービス名 |
| `cloudMysqlInstanceStatusName` | String | Required | Cloud DB for MySQLインスタンスの状態名 - `creating` \| `deleted` \| `deleting` \| `pending` \| `recovering` \| `reinstalling` \| `restarting` \| `running` \| `settingup` \| `shuttingdown` \| `stopped` \| `upgrading` \| `downgrading` |
| `cloudMysqlInstanceStatus` | [CommonCode](/docs/ja/common-vapidatatype-commoncode) | Required | Cloud DB for MySQLインスタンスの状態 - `INIT` \| `CREAT` \| `DEL` - `INIT`: Initiated - `CREAT`: Created - `DEL`: Deleted |
| `cloudMysqlInstanceOperation` | [CommonCode](/docs/ja/common-vapidatatype-commoncode) | Required | Cloud DB for MySQLインスタンスの運用状態 - `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イメージ商品コード |
| `engineVersion` | String | Optional | Cloud DB for MySQLエンジンバージョン |
| `license` | [CommonCode](/docs/ja/common-vapidatatype-commoncode) | Optional | Cloud DB for MySQLライセンス |
| `cloudMysqlPort` | Integer | Optional | Cloud DB for MySQLポート |
| `isHa` | Boolean | Required | 高可用性かどうか - `true` \| `false` |
| `isMultiZone` | Boolean | Required | マルチゾーンかどうか - `true` \| `false` |
| `isBackup` | Boolean | Optional | バックアップの有無 - `true` \| `false` |
| `backupFileRetentionPeriod` | Integer | Optional | バックアップファイルの保管期間 |
| `backupTime` | String | Optional | バックアップ時間 |
| `generationCode` | String | Required | サーバの世代コード |
| `createDate` | Date | Required | 作成日時 |
| `accessControlGroupNoList` | List<String> | Optional | ACG番号リスト |
| `cloudMysqlConfigList` | List<String> | Optional | Cloud DB for MySQL Configリスト |
| `cloudMysqlServerInstanceList` | List<[CloudMysqlServerInstance](/docs/ja/common-vapidatatype-cloudmysqlserverinstance)> | Required | Cloud DB for MySQLサーバインスタンスリスト |