getCloudCacheInstanceList

Cloud DB for Cache 인스턴스 목록을 조회합니다.

참고

Cloud DB for Cache CLI는 지원하는 DBMS 범위에 따라 두 가지 버전을 제공합니다.

getCloudCacheInstanceList CLI: Valkey, Redis DBMS 이용 가능
getCloudRedisInstanceList CLI: Redis DBMS 이용 가능

getCloudCacheInstanceList CLI

getCloudCacheInstanceList CLI의 명령 구문과 옵션, 명령 및 출력 예시를 설명합니다.

구문

getCloudCacheInstanceList 구문은 다음과 같습니다.

./ncloud vcache getCloudCacheInstanceList \
    [--zoneCode <zone-code>] \
    [--vpcNo <vpc-no>] \
    [--subnetNo <subnet-no>] \
    [--cloudCacheServiceName <service-name>] \
    [--cloudCacheInstanceNoList <instance-no-list>] \
    [--cloudCacheServerName <server-name>] \
    [--cloudCacheServerInstanceNoList <server-instance-no-list>] \
    [--generationCode <G2] \
    [--cloudCacheDbmsCode <Redis|Valkey>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <FKR>] \
    [--output <json|xml>]

옵션

getCloudCacheInstanceList 실행 시 지정할 수 있는 옵션을 설명합니다.

필수 옵션

getCloudCacheInstanceList의 필수 옵션입니다.

옵션	타입	필수 여부	설명
`--pageSize`	Integer	Conditional	페이지당 항목 수 `1`~N `pageNo` 입력 시 필수 입력

선택 옵션

getCloudCacheInstanceList의 선택 옵션입니다. 지정하지 않은 옵션에는 기본값이 적용됩니다.

옵션	타입	필수 여부	설명
`--zoneCode`	String	Optional	존 코드 getZoneList 참조
`--vpcNo`	String	Optional	VPC 번호 getCloudCacheTargetVpcList 참조
`--subnetNo`	String	Optional	Subnet 번호 getCloudCacheTargetSubnetList 참조
`--cloudCacheServiceName`	String	Optional	Cloud DB for Cache 서비스 이름
`--cloudCacheInstanceNoList`	List	Optional	Cloud DB for Cache 인스턴스 번호 목록 공백으로 구분하여 여러 개 입력 가능 (예시: `--cloudCacheInstanceNoList 1234 2345`)
`--cloudCacheServerName`	String	Optional	Cloud DB for Cache 서버 이름
`--cloudCacheServerInstanceNoList`	List	Optional	Cloud DB for Cache 서버 인스턴스 번호 목록 공백으로 구분하여 여러 개 입력 가능 (예시: `--cloudCacheServerInstanceNoList 1234 2345`)
`--generationCode`	String	Optional	서버 세대 코드 `G2`
`--cloudCacheDbmsCode`	String	Optional	Cloud DB for Cache 인스턴스의 DBMS 코드 `Redis` \| `Valkey`
`--pageNo`	Integer	Optional	페이지 번호 `0`~N

공통 옵션

vcache 명령에서 공통으로 사용하는 옵션에 대한 정보는 Cloud DB for Cache 옵션을 참조해 주십시오.

예시

Cloud DB for Cache 인스턴스 목록 조회 요청이 성공하면 각 인스턴스의 구성 정보와 상태가 반환됩니다.

명령

명령 예시는 다음과 같습니다.

./ncloud vcache getCloudCacheInstanceList \
    --zoneCode FKR-1 \
    --vpcNo 12345678 \
    --subnetNo 23456789 \
    --cloudCacheServiceName test-cache-01 \
    --cloudCacheInstanceNoList 34567890 \
    --generationCode G2 \
    --cloudCacheDbmsCode Valkey \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode FKR \
    --output json

출력

출력 예시는 다음과 같습니다.

{
  "getCloudCacheInstanceListResponse": {
    "totalRows": 1,
    "cloudCacheInstanceList": [
      {
        "cloudCacheInstanceNo": "34567890",
        "cloudCacheServiceName": "test-cache-01",
        "cloudCacheInstanceStatusName": "running",
        "cloudCacheInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created 상태"
        },
        "cloudCacheInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "isHa": true,
        "generationCode": "G2",
        "role": {
          "code": "CLUSTER",
          "codeName": "Cluster Role-CLOUD Cache(VPC)"
        },
        "cloudCacheServerInstanceList": [
          {
            "cloudCacheServerInstanceNo": "34567891",
            "cloudCacheServerName": "testcache-001-001-3oo5",
            "cloudCacheServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudCacheServerInstanceStatusName": "running",
            "cloudCacheServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
            },
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736
          },
          {
            "cloudCacheServerInstanceNo": "34567892",
            "cloudCacheServerName": "testcache-002-001-3oo6",
            "cloudCacheServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudCacheServerInstanceStatusName": "running",
            "cloudCacheServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
            },
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736
          },
          {
            "cloudCacheServerInstanceNo": "34567893",
            "cloudCacheServerName": "testcache-003-001-3oo7",
            "cloudCacheServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudCacheServerInstanceStatusName": "running",
            "cloudCacheServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
            },
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736
          },
          {
            "cloudCacheServerInstanceNo": "34567894",
            "cloudCacheServerName": "testcache-001-002-3oo8",
            "cloudCacheServerRole": {
              "code": "S",
              "codeName": "Slave"
            },
            "cloudCacheServerInstanceStatusName": "running",
            "cloudCacheServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
            },
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736
          },
          {
            "cloudCacheServerInstanceNo": "34567895",
            "cloudCacheServerName": "testcache-002-002-3oo9",
            "cloudCacheServerRole": {
              "code": "S",
              "codeName": "Slave"
            },
            "cloudCacheServerInstanceStatusName": "running",
            "cloudCacheServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
            },
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736
          },
          {
            "cloudCacheServerInstanceNo": "34567896",
            "cloudCacheServerName": "testcache-003-002-3ooa",
            "cloudCacheServerRole": {
              "code": "S",
              "codeName": "Slave"
            },
            "cloudCacheServerInstanceStatusName": "running",
            "cloudCacheServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
            },
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736
          }
        ]
      }
    ],
    "requestId": "04edddb9-6dd2-4893-bfe4-0faf09f02d39",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

getCloudRedisInstanceList CLI

getCloudRedisInstanceList CLI의 명령 구문과 옵션, 명령 및 출력 예시를 설명합니다.

구문

getCloudRedisInstanceList 구문은 다음과 같습니다.

./ncloud vredis getCloudRedisInstanceList \
    [--zoneCode <zone-code>] \
    [--vpcNo <vpc-no>] \
    [--subnetNo <subnet-no>] \
    [--cloudRedisServiceName <service-name>] \
    [--cloudRedisInstanceNoList <instance-no-list>] \
    [--cloudRedisServerName <server-name>] \
    [--cloudRedisServerInstanceNoList <server-instance-no-list>] \
    [--generationCode <G2>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <FKR>] \
    [--output <json|xml>]

옵션

getCloudRedisInstanceList 실행 시 지정할 수 있는 옵션을 설명합니다.

필수 옵션

getCloudRedisInstanceList의 필수 옵션입니다.

옵션	타입	필수 여부	설명
`--pageSize`	Integer	Conditional	페이지당 항목 수 `1`~N `pageNo` 입력 시 필수 입력

선택 옵션

getCloudRedisInstanceList의 선택 옵션입니다. 지정하지 않은 옵션에는 기본값이 적용됩니다.

옵션	타입	필수 여부	설명
`--zoneCode`	String	Optional	존 코드 getZoneList 참조
`--vpcNo`	String	Optional	VPC 번호 getCloudCacheTargetVpcList 참조
`--subnetNo`	String	Optional	Subnet 번호 getCloudCacheTargetSubnetList 참조
`--cloudRedisServiceName`	String	Optional	Cloud DB for Cache 서비스 이름
`--cloudRedisInstanceNoList`	List	Optional	Cloud DB for Cache 인스턴스 번호 목록 공백으로 구분하여 여러 개 입력 가능 (예시: `--cloudRedisInstanceNoList 1234 2345`)
`--cloudRedisServerName`	String	Optional	Cloud DB for Cache 서버 이름
`--cloudRedisServerInstanceNoList`	List	Optional	Cloud DB for Cache 서버 인스턴스 번호 목록 공백으로 구분하여 여러 개 입력 가능 (예시: `--cloudRedisServerInstanceNoList 1234 2345`)
`--generationCode`	String	Optional	서버 세대 코드 `G2`
`--pageNo`	Integer	Optional	페이지 번호 `0`~N

공통 옵션

vredis 명령에서 공통으로 사용하는 옵션에 대한 정보는 Cloud DB for Cache 옵션을 참조해 주십시오.

예시

Cloud DB for Cache 인스턴스 목록 조회 요청이 성공하면 각 인스턴스의 구성 정보와 상태가 반환됩니다.

명령

명령 예시는 다음과 같습니다.

./ncloud vredis getCloudRedisInstanceList \
    --zoneCode FKR-1 \
    --vpcNo 12345678 \
    --subnetNo 23456789 \
    --cloudRedisServiceName test-redis-01 \
    --cloudRedisInstanceNoList 34567890 \
    --generationCode G2 \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode FKR \
    --output json

출력

출력 예시는 다음과 같습니다.

{
  "getCloudRedisInstanceListResponse": {
    "totalRows": 1,
    "cloudRedisInstanceList": [
      {
        "cloudRedisInstanceNo": "34567890",
        "cloudRedisServiceName": "test-redis-01",
        "cloudRedisInstanceStatusName": "running",
        "cloudRedisInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created 상태"
        },
        "cloudRedisInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "isHa": true,
        "generationCode": "G2",
        "role": {
          "code": "CLUSTER",
          "codeName": "Cluster Role-CLOUD Cache(VPC)"
        },
        "cloudRedisServerInstanceList": [
          {
            "cloudRedisServerInstanceNo": "34567891",
            "cloudRedisServerName": "testredis-001-001-3ox8",
            "cloudRedisServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudRedisServerInstanceStatusName": "running",
            "cloudRedisServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
            },
            "cloudRedisServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
            },
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736
          },
          {
            "cloudRedisServerInstanceNo": "34567892",
            "cloudRedisServerName": "testredis-002-001-3ox9",
            "cloudRedisServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudRedisServerInstanceStatusName": "running",
            "cloudRedisServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
            },
            "cloudRedisServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
            },
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736
          },
          {
            "cloudRedisServerInstanceNo": "34567893",
            "cloudRedisServerName": "testredis-003-001-3oxa",
            "cloudRedisServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudRedisServerInstanceStatusName": "running",
            "cloudRedisServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
            },
            "cloudRedisServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
            },
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736
          },
          {
            "cloudRedisServerInstanceNo": "34567894",
            "cloudRedisServerName": "testredis-001-002-3oxb",
            "cloudRedisServerRole": {
              "code": "S",
              "codeName": "Slave"
            },
            "cloudRedisServerInstanceStatusName": "running",
            "cloudRedisServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
            },
            "cloudRedisServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
            },
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736
          },
          {
            "cloudRedisServerInstanceNo": "34567895",
            "cloudRedisServerName": "testredis-002-002-3oxc",
            "cloudRedisServerRole": {
              "code": "S",
              "codeName": "Slave"
            },
            "cloudRedisServerInstanceStatusName": "running",
            "cloudRedisServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
            },
            "cloudRedisServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
            },
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736
          },
          {
            "cloudRedisServerInstanceNo": "34567896",
            "cloudRedisServerName": "testredis-003-002-3oxd",
            "cloudRedisServerRole": {
              "code": "S",
              "codeName": "Slave"
            },
            "cloudRedisServerInstanceStatusName": "running",
            "cloudRedisServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
            },
            "cloudRedisServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
            },
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736
          }
        ]
      }
    ],
    "requestId": "5746160d-a0f7-455c-8633-28ce88d7dae4",
    "returnCode": "0",
    "returnMessage": "success"
  }
}