getCloudMysqlInstanceList
    • PDF

    getCloudMysqlInstanceList

    • PDF

    Article summary

    Available in VPC

    View the list of Cloud DB for MySQL instances.

    Commands

    The command statement is as follows.

    ncloud vmysql getCloudMysqlInstanceList [regionCode KR] [vpcNo] [subnetNo] [cloudMysqlServiceName] [cloudMysqlInstanceNoList] [cloudMysqlServerName] [cloudMysqlServerInstanceNoList] [generationCode] [pageNo] [pageSize] [output]
    

    Parameter

    The following describes the parameters.

    ParameterTypeRequiredDescriptionRestrictions
    regionCodeStringNRegion 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
    -
    zoneCodeStringNZone code
    - It can be obtained through the getZoneList action
    -
    vpcNoStringNVPC number
    - It can be obtained through the getCloudMysqlTargetVpcList action
    -
    subnetNoStringNSubnet number
    - It can be obtained through the getCloudMysqlTargetSubnetList action
    -
    cloudMysqlServiceNameStringNCloud DB for MySQL service name
    - It can be obtained through the getCloudMysqlInstanceList action
    -
    cloudMysqlInstanceNoListList<String>NCloud DB for MySQL instance number list
    - It can be obtained through the getCloudMysqlInstanceList action
    <Example>
    - cloudMysqlInstanceNoList 1234 2345
    -
    cloudMysqlServerNameStringNCloud DB for MySQL server name
    - It can be obtained through the getCloudMysqlInstanceList action
    -
    cloudMysqlServerInstanceNoListList<String>NCloud DB for MySQL server instance number list
    - It can be obtained through the getCloudMysqlInstanceList action
    <Example>
    -cloudMysqlServerInstanceNoList 1234 2345
    -
    generationCodeStringNServer generation code
    - options: G2 | G3
    -
    pageNoIntegerNPage number of the paged results
    - The results can be paged using pageNo and pageSize
    min: 0
    pageSizeIntegerNSize of each page to be displayed when paging
    - The results can be paged using pageNo and pageSize
    - This field must be entered when pageNo is entered
    min: 1
    outputStringNFormat 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 CommonResponseDescription
    private Integer totalRows;Total number of lists searched
    private List<CloudMysqlInstance> cloudMysqlInstanceList = new ArrayList<>();
    • CloudMysqlInstance type
    CloudMysqlInstanceDescription
    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
    CloudMysqlServerInstanceDescription
    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 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 example

    The following is a response example.

    When the response result 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"
                  },
                  "privateIp": "***.***.***.***",
                  "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"
                  },
                  "privateIp": "***.***.***.***",
                  "regionCode": "KR",
                  "zoneCode": "KR-2",
                  "vpcNo": "****83",
                  "subnetNo": "****93",
                  "dataStorageSize": 10737418240,
                  "cpuCount": 2,
                  "memorySize": 8589934592
                }
              ]
            }
          }
        }
      }
    }
    

    When the response result 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>
                        <privateIp>***.***.***.***</privateIp>
                        <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>
                        <privateIp>***.***.***.***</privateIp>
                        <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?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.