Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getCloudMysqlInstanceDetail

Prev Next

Available in VPC

Get Cloud DB for MySQL instance details.

Syntax

The getCloudMysqlInstanceDetail syntax is as follows:

./ncloud vmysql getCloudMysqlInstanceDetail \
    --cloudMysqlInstanceNo <instance-no> \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getCloudMysqlInstanceDetail.

Required options

The following options are required for getCloudMysqlInstanceDetail.

Options Type Required Description
--cloudMysqlInstanceNo String Required Cloud DB for MySQL instance number

Common options

For information about the options common to all vmysql subcommands, see Cloud DB for MySQL (VPC) options.

Examples

If the request to retrieve detailed information about a Cloud DB for MySQL instance is successful, the instance's configuration information and details for each server instance are returned.

Command

The command example is as follows:

./ncloud vmysql getCloudMysqlInstanceDetail \
    --cloudMysqlInstanceNo 12345678 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getCloudMysqlInstanceDetailResponse": {
    "totalRows": 1,
    "cloudMysqlInstanceList": [
      {
        "cloudMysqlInstanceNo": "12345678",
        "cloudMysqlServiceName": "test-mysql",
        "cloudMysqlInstanceStatusName": "running",
        "cloudMysqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE (VPC) Created status"
        },
        "cloudMysqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "cloudMysqlImageProductCode": "SW.VMYSL.OS.LNX64.ROCKY.0810.MYSQL.B050",
        "engineVersion": "MYSQL8.0.36",
        "license": {
          "code": "GPL",
          "codeName": "License code - CLOUD DATABASE (VPC)"
        },
        "cloudMysqlPort": 13306,
        "isHa": true,
        "isMultiZone": true,
        "isBackup": true,
        "backupFileRetentionPeriod": 1,
        "backupTime": "10:30",
        "generationCode": "G2",
        "createDate": "2026-06-04T16:50:56+0900",
        "accessControlGroupNoList": [
          "67890123"
        ],
        "cloudMysqlConfigList": [],
        "cloudMysqlServerInstanceList": [
          {
            "cloudMysqlServerInstanceNo": "34567890",
            "cloudMysqlServerName": "testmysql-001-97mj",
            "cloudMysqlServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudMysqlServerInstanceStatusName": "running",
            "cloudMysqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMysqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMysqlProductCode": "SVR.VDBAS.HICPU.C002.M004.NET.HDD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "98765432",
            "subnetNo": "23456789",
            "isPublicSubnet": false,
            "privateDomain": "db-1a2b3c.vpc-cdb.ntruss.com",
            "privateIp": "10.0.0.6",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": false,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 9198388224,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "uptime": "2026-06-04T16:57:14+0900",
            "createDate": "2026-06-04T16:50:56+0900"
          },
          {
            "cloudMysqlServerInstanceNo": "34567891",
            "cloudMysqlServerName": "testmysql-002-97mk",
            "cloudMysqlServerRole": {
              "code": "H",
              "codeName": "Standby Master"
            },
            "cloudMysqlServerInstanceStatusName": "running",
            "cloudMysqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMysqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMysqlProductCode": "SVR.VDBAS.HICPU.C002.M004.NET.HDD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "98765432",
            "subnetNo": "23456790",
            "isPublicSubnet": false,
            "privateDomain": "db-1a2b3c.vpc-cdb.ntruss.com",
            "privateIp": "10.0.1.6",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": false,
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 9207335936,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "uptime": "2026-06-04T16:57:26+0900",
            "createDate": "2026-06-04T16:50:56+0900"
          }
        ]
      }
    ],
    "requestId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "returnCode": "0",
    "returnMessage": "success"
  }
}