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.

getCloudCacheInstanceDetail

Prev Next

Available in VPC

Get Cloud DB for Cache instance details.

Note

Cloud DB for Cache CLI offers two versions based on the supported DBMS range.

  • getCloudCacheInstanceDetail CLI: Support for Valkey and Redis DBMS
  • getCloudRedisInstanceDetail CLI: Support for Redis DBMS

getCloudCacheInstanceDetail CLI

This section describes the command syntax, options, commands, and output examples for the getCloudCacheInstanceDetail CLI.

Syntax

The getCloudCacheInstanceDetail syntax is as follows:

./ncloud vcache getCloudCacheInstanceDetail \
    --cloudCacheInstanceNo <instance-no> \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getCloudCacheInstanceDetail.

Required options

The following options are required for getCloudCacheInstanceDetail.

Options Type Required Description
--cloudCacheInstanceNo String Required Cloud DB for Cache instance number

Common options

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

Examples

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

Command

The command example is as follows:

./ncloud vcache getCloudCacheInstanceDetail \
    --cloudCacheInstanceNo 34567890 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getCloudCacheInstanceDetailResponse": {
    "totalRows": 1,
    "cloudCacheInstanceList": [
      {
        "cloudCacheInstanceNo": "34567890",
        "cloudCacheServiceName": "test-cache-01",
        "cloudCacheInstanceStatusName": "running",
        "cloudCacheInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE (VPC) Created status"
        },
        "cloudCacheInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "cloudCacheImageProductCode": "SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050",
        "engineVersion": "VALKEY 7.2.11",
        "license": {
          "code": "BSD",
          "codeName": "License code - CLOUD DATABASE (VPC)"
        },
        "cloudCachePort": 13306,
        "isHa": true,
        "isBackup": true,
        "backupTime": "01:45",
        "backupFileRetentionPeriod": 1,
        "backupSchedule": "AUTO",
        "cloudCacheServerPrefix": "testcache",
        "generationCode": "G2",
        "role": {
          "code": "CLUSTER",
          "codeName": "Cluster Role-CLOUD Cache(VPC)"
        },
        "createDate": "2026-06-10T14:46:18+0900",
        "accessControlGroupNoList": [
          "67890123"
        ],
        "masterNodeCount": 3,
        "slaveNodeCount": 3,
        "configGroupNo": "11099",
        "configGroupName": "test-cfg-01",
        "cloudCacheServerInstanceList": [
          {
            "cloudCacheServerInstanceNo": "45678901",
            "cloudCacheServerName": "testcache-001-001-98g5",
            "cloudCacheServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudCacheServerInstanceStatusName": "running",
            "cloudCacheServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "privateDomain": "cache-a1b2c1.vpc-cdb.ntruss.com",
            "cpuCount": 4,
            "memorySize": 1610612736,
            "osMemorySize": 2147483648,
            "uptime": "2026-06-10T14:52:02+0900",
            "createDate": "2026-06-10T14:46:18+0900",
            "slotName": "0-5460"
          },
          {
            "cloudCacheServerInstanceNo": "45678902",
            "cloudCacheServerName": "testcache-002-001-98g6",
            "cloudCacheServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudCacheServerInstanceStatusName": "running",
            "cloudCacheServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "privateDomain": "cache-a1b2c2.vpc-cdb.ntruss.com",
            "cpuCount": 4,
            "memorySize": 1610612736,
            "osMemorySize": 2147483648,
            "uptime": "2026-06-10T14:51:32+0900",
            "createDate": "2026-06-10T14:46:18+0900",
            "slotName": "5461-10922"
          },
          {
            "cloudCacheServerInstanceNo": "45678903",
            "cloudCacheServerName": "testcache-003-001-98g7",
            "cloudCacheServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudCacheServerInstanceStatusName": "running",
            "cloudCacheServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "privateDomain": "cache-a1b2c3.vpc-cdb.ntruss.com",
            "cpuCount": 4,
            "memorySize": 1610612736,
            "osMemorySize": 2147483648,
            "uptime": "2026-06-10T14:51:57+0900",
            "createDate": "2026-06-10T14:46:18+0900",
            "slotName": "10923-16383"
          },
          {
            "cloudCacheServerInstanceNo": "45678904",
            "cloudCacheServerName": "testcache-001-002-98g8",
            "cloudCacheServerRole": {
              "code": "S",
              "codeName": "Slave"
            },
            "cloudCacheServerInstanceStatusName": "running",
            "cloudCacheServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "privateDomain": "cache-a1b2c4.vpc-cdb.ntruss.com",
            "cpuCount": 4,
            "memorySize": 1610612736,
            "osMemorySize": 2147483648,
            "uptime": "2026-06-10T14:52:22+0900",
            "createDate": "2026-06-10T14:46:18+0900",
            "slotName": "0-5460"
          },
          {
            "cloudCacheServerInstanceNo": "45678905",
            "cloudCacheServerName": "testcache-002-002-98g9",
            "cloudCacheServerRole": {
              "code": "S",
              "codeName": "Slave"
            },
            "cloudCacheServerInstanceStatusName": "running",
            "cloudCacheServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "privateDomain": "cache-a1b2c5.vpc-cdb.ntruss.com",
            "cpuCount": 4,
            "memorySize": 1610612736,
            "osMemorySize": 2147483648,
            "uptime": "2026-06-10T14:51:46+0900",
            "createDate": "2026-06-10T14:46:18+0900",
            "slotName": "5461-10922"
          },
          {
            "cloudCacheServerInstanceNo": "45678906",
            "cloudCacheServerName": "testcache-003-002-98ga",
            "cloudCacheServerRole": {
              "code": "S",
              "codeName": "Slave"
            },
            "cloudCacheServerInstanceStatusName": "running",
            "cloudCacheServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "privateDomain": "cache-a1b2c6.vpc-cdb.ntruss.com",
            "cpuCount": 4,
            "memorySize": 1610612736,
            "osMemorySize": 2147483648,
            "uptime": "2026-06-10T14:52:12+0900",
            "createDate": "2026-06-10T14:46:18+0900",
            "slotName": "10923-16383"
          }
        ]
      }
    ],
    "requestId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

getCloudRedisInstanceDetail CLI

This section describes the command syntax, options, commands, and output examples for the getCloudRedisInstanceDetail CLI.

Syntax

The getCloudRedisInstanceDetail syntax is as follows:

./ncloud vredis getCloudRedisInstanceDetail \
    --cloudRedisInstanceNo <instance-no> \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getCloudRedisInstanceDetail.

Required options

The following options are required for getCloudRedisInstanceDetail.

Options Type Required Description
--cloudRedisInstanceNo String Required Cloud DB for Cache instance number

Common options

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

Examples

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

Command

The command example is as follows:

./ncloud vredis getCloudRedisInstanceDetail \
    --cloudRedisInstanceNo 34567890 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getCloudRedisInstanceDetailResponse": {
    "totalRows": 1,
    "cloudRedisInstanceList": [
      {
        "cloudRedisInstanceNo": "34567890",
        "cloudRedisServiceName": "test-redis-01",
        "cloudRedisInstanceStatusName": "running",
        "cloudRedisInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE (VPC) Created status"
        },
        "cloudRedisInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "cloudRedisImageProductCode": "SW.VRDS.OS.LNX64.ROCKY.0810.REDIS.B050",
        "engineVersion": "REDIS 7.2.11",
        "license": {
          "code": "BSD",
          "codeName": "License code - CLOUD DATABASE (VPC)"
        },
        "cloudRedisPort": 6379,
        "isHa": false,
        "isBackup": false,
        "backupTime": "00:00",
        "backupFileRetentionPeriod": 1,
        "backupSchedule": "AUTO",
        "cloudRedisServerPrefix": "testredis",
        "generationCode": "G2",
        "role": {
          "code": "SIMPLE",
          "codeName": "Cluster Role-CLOUD Cache(VPC)"
        },
        "createDate": "2026-07-01T11:43:48+0900",
        "accessControlGroupNoList": [
          "67890123"
        ],
        "masterNodeCount": 1,
        "slaveNodeCount": 0,
        "configGroupNo": "10001",
        "configGroupName": "test-redis-cfg",
        "cloudRedisServerInstanceList": [
          {
            "cloudRedisServerInstanceNo": "34567891",
            "cloudRedisServerName": "testredis-001-9c4s",
            "cloudRedisServerRole": {
              "code": "A",
              "codeName": "Stand Alone"
            },
            "cloudRedisServerInstanceStatusName": "running",
            "cloudRedisServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudRedisServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "privateDomain": "cache-47vd5e.vpc-cdb.ntruss.com",
            "cpuCount": 4,
            "memorySize": 1610612736,
            "osMemorySize": 2147483648,
            "uptime": "2026-07-01T13:26:30+0900",
            "createDate": "2026-07-01T11:43:48+0900"
          }
        ]
      }
    ],
    "requestId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "returnCode": "0",
    "returnMessage": "success"
  }
}