getCloudMysqlInstanceList
- Print
- PDF
getCloudMysqlInstanceList
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Available in VPC
Cloud DB for MySQL instance list can be viewed.
Commands
The text of the command is as follows.
ncloud vmysql getCloudMysqlInstanceList [regionCode KR] [vpcNo] [subnetNo] [cloudMysqlServiceName] [cloudMysqlInstanceNoList] [cloudMysqlServerName] [cloudMysqlServerInstanceNoList] [generationCode] [pageNo] [pageSize] [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 | - |
zoneCode | String | N | ZONE code - Can be obtained through getZoneList action | - |
vpcNo | String | Y | VPC number - Can be obtained through getCloudMysqlTargetVpcList action | - |
subnetNo | String | N | Subnet number - Can be obtained through getCloudMysqlTargetSubnetList action | - |
cloudMysqlServiceName | String | N | Cloud DB for MySQL service name - Can be obtained through getCloudMysqlInstanceList action | - |
cloudMysqlInstanceNoList | List<String> | N | List of Cloud DB for MySQL instance numbers - Can be obtained through getCloudMysqlInstanceList action <Example> - cloudMysqlInstanceNoList 1234 2345 | - |
cloudMysqlServerName | String | N | Cloud DB for MySQL server name - Can be obtained through getCloudMysqlInstanceList action | - |
cloudMysqlServerInstanceNoList | List<String> | N | List of Cloud DB for MySQL server instance numbers - Can be obtained through getCloudMysqlInstanceList action <Example> -cloudMysqlServerInstanceNoList 1234 2345 | - |
generationCode | String | N | Server generation code - options: G2 | G3 | - |
pageNo | Integer | N | Page number of paged results - The results can be paged using page No. and page size | min: 0 |
pageSize | Integer | N | Size of each page to be shown during paging - The results can be paged using page No. and page size - Must be entered when entering pageNo | min: 1 |
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 getCloudMysqlInstanceList --regionCode KR --zoneCode KR-1 --vpcNo ***83 --subnetNo **91 --cloudMysqlServiceName test-**** --cloudMysqlInstanceNoList ****890 --cloudMysqlServerName test-**** --cloudMysqlServerInstanceNoList ****891 --generationCode G2 --pageNo 0 --pageSize 10
Response examples
The following are examples of responses.
If the response shows that format type (output) is json
{
"getCloudMysqlInstanceListResponse": {
"requestId": "1ae10c76-412d-4050-8911-42fa19a60a31",
"returnCode": 0,
"returnMessage": "success",
"totalRows": 1,
"cloudMysqlInstanceList": {
"cloudMysqlInstance": {
"cloudMysqlInstanceNo": "****890",
"cloudMysqlServiceName": "test-****",
"cloudMysqlInstanceStatusName": "running",
"cloudMysqlInstanceStatus": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Created State"
},
"cloudMysqlInstanceOperation": {
"code": "NULL",
"codeName": "CLOUD DATABASE(VPC) Null OP"
},
"isHa": true,
"isMultiZone": true,
"generationCode": "G2",
"cloudMysqlServerInstanceList": {
"cloudMysqlServerInstance": [
{
"cloudMysqlServerInstanceNo": "****891",
"cloudMysqlServerName": "test-****-001-e04",
"cloudMysqlServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudMysqlServerInstanceStatusName": "running",
"cloudMysqlServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) Server Running State"
},
"cloudMysqlServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) Server Null OP"
},
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"dataStorageSize": 10737418240,
"cpuCount": 2,
"memorySize": 8589934592
},
{
"cloudMysqlServerInstanceNo": "****897",
"cloudMysqlServerName": "test-****-002-e05",
"cloudMysqlServerRole": {
"code": "H",
"codeName": "Standby Master"
},
"cloudMysqlServerInstanceStatusName": "running",
"cloudMysqlServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) Server Running State"
},
"cloudMysqlServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) Server Null OP"
},
"regionCode": "KR",
"zoneCode": "KR-2",
"vpcNo": "****83",
"subnetNo": "****93",
"dataStorageSize": 10737418240,
"cpuCount": 2,
"memorySize": 8589934592
}
]
}
}
}
}
}
If the response shows that format type (output) is xml
<getCloudMysqlInstanceListResponse>
<requestId>1ae10c76-412d-4050-8911-42fa19a60a31</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<cloudMysqlInstanceList>
<cloudMysqlInstance>
<cloudMysqlInstanceNo>****890</cloudMysqlInstanceNo>
<cloudMysqlServiceName>test-****</cloudMysqlServiceName>
<cloudMysqlInstanceStatusName>running</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>
<isHa>true</isHa>
<isMultiZone>true</isMultiZone>
<generationCode>G2</generationCode>
<cloudMysqlServerInstanceList>
<cloudMysqlServerInstance>
<cloudMysqlServerInstanceNo>****891</cloudMysqlServerInstanceNo>
<cloudMysqlServerName>test-****-001-e04</cloudMysqlServerName>
<cloudMysqlServerRole>
<code>M</code>
<codeName>Master</codeName>
</cloudMysqlServerRole>
<cloudMysqlServerInstanceStatusName>running</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>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<vpcNo>****83</vpcNo>
<subnetNo>****91</subnetNo>
<dataStorageSize>10737418240</dataStorageSize>
<cpuCount>2</cpuCount>
<memorySize>8589934592</memorySize>
</cloudMysqlServerInstance>
<cloudMysqlServerInstance>
<cloudMysqlServerInstanceNo>****897</cloudMysqlServerInstanceNo>
<cloudMysqlServerName>test-****-002-e05</cloudMysqlServerName>
<cloudMysqlServerRole>
<code>H</code>
<codeName>Standby Master</codeName>
</cloudMysqlServerRole>
<cloudMysqlServerInstanceStatusName>running</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>
<regionCode>KR</regionCode>
<zoneCode>KR-2</zoneCode>
<vpcNo>****83</vpcNo>
<subnetNo>****93</subnetNo>
<dataStorageSize>10737418240</dataStorageSize>
<cpuCount>2</cpuCount>
<memorySize>8589934592</memorySize>
</cloudMysqlServerInstance>
</cloudMysqlServerInstanceList>
</cloudMysqlInstance>
</cloudMysqlInstanceList>
</getCloudMysqlInstanceListResponse>
Was this article helpful?