getCloudMysqlInstanceDetail

Available in VPC

Search Cloud DB for MySQL instance details.

Commands

The command statement is as follows.

ncloud vmysql getCloudMysqlInstanceDetail [regionCode KR] [cloudMysqlInstanceNo] [output]

Parameter

The following describes the parameters.

Parameter	Type	Required	Description	Restrictions
regionCode	String	N	Region code where the Cloud DB for MySQL instance exists - It can be obtained through the getRegionList action - default: It selects the first Region of the getRegionList search results	-
cloudMysqlInstanceNo	String	Y	Cloud DB for MySQL instance number - It can be obtained through the getCloudMysqlInstanceList action	-
output	String	N	Format type of the response result - options: xml \| json - default: json	-

Responses

Response data type

The response data types for command calls are as follows.

CloudMysqlInstanceList type

CloudMysqlInstanceList extends CommonResponse	Description
private Integer totalRows;	Total number of lists searched
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 status
private Boolean isMultiZone;	Multi-zone status
private Boolean isBackup;	Backup status
private Integer backupFileRetentionPeriod;	Backup file retention period
private String backupTime;	Backup time
private String generationCode;	Server generation code
private Date createDate;	Issuance date
private List<String> accessControlGroupNoList;	ACG number list
private List<String> cloudMysqlConfigList;	Cloud DB for MySQL config 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 (server 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 status
private String publicDomain;	Public domain name
private String privateDomain;	Private domain name
private String privateIp;	Internal IP
private CommonCode dataStorageType;	Data storage type
private Boolean isStorageEncryption;	Data storage encryption status
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;	Issuance date

Examples

It describes call and response examples.

Call examples

The following is a call example.

ncloud vmysql getCloudMysqlInstanceDetail --regionCode KR --cloudMysqlInstanceNo ****890

Response example

The following is a response example.

When the response result format type (output) is JSON

{
  "getCloudMysqlInstanceDetailResponse": {
    "requestId": "871cc26b-dd0d-48aa-8324-888e85eeb60d",
    "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"
        },
        "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": "running",
              "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",
              "privateIp": "***.***.***.***",
              "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": "running",
              "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",
              "privateIp": "***.***.***.***",
              "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"
            }
          ]
        }
      }
    }
  }
}

When the response result format type (output) is XML


<getCloudMysqlInstanceDetailResponse>
    <requestId>871cc26b-dd0d-48aa-8324-888e85eeb60d</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>
            <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>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>
                    <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>
                    <privateIp>***.***.***.***</privateIp>
                    <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>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>
                    <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>
                    <privateIp>***.***.***.***</privateIp>
                    <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>
            </cloudMysqlServerInstanceList>
        </cloudMysqlInstance>
    </cloudMysqlInstanceList>
</getCloudMysqlInstanceDetailResponse>