---
title: "getBlockStorageInstanceList"
slug: "cli-server-getblockstorageinstancelist"
tags: ["Block Storage", "Server"]
updated: 2026-09-17T10:08:35Z
published: 2026-09-17T10:08:35Z
canonical: "cli.ncloud-docs.com/cli-server-getblockstorageinstancelist"
---

> ## 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.

# getBlockStorageInstanceList

## Overview

Searching a block storage instance list

## Description

Search a block storage instance list.

## Request Parameters

| Parameter Name | Requiredness | Type | Limitation | Description |
| --- | --- | --- | --- | --- |
| serverInstanceNo | No | String |  | It is used to search a block storage attached to server instance. |
| blockStorageInstanceNoList | No | List |  | Search a block storage matching to the block storage instance No. list. |
| searchFilterName | No | String |  | Block storage name (blockStorageName) \| Attachment information (attachmentInformation) [Do not distinguish between uppercase and lowercase.] You should enter attachment information in the following manner: Block storage name [Blank] attachment information, or Block storage name:attachement information. |
| searchFilterValue | No | String |  | Value to search |
| blockStorageTypeCodeList | No | String | Min : 1, Max : 5 | You can search a block storage which is in the block storage code list only. Basic block storage (BASIC) \| Additional block storage (SVRBS) Default : asic block storage (BASIC), Additional block storage (SVRBS) |
| blockStorageInstanceStatusCode | No | String | Min : 1, Max : 5 | You can search each state of block storage instances. To know the state in which input is possible, refer to blockStorageInstanceStatus values of the block storage instance data type (BlockStorageInstance). |
| diskTypeCode | No | String |  | Disk type code Network storage (NET) \| Local storage (LOCAL) |
| diskDetailTypeCode | No | String |  | Detailed code of disk type Hard disk(HDD) \| SSD(SSD) |
| regionNo | No | String |  | You can reach a state in which input is possible by calling getRegionList. |
| zoneNo | No | String |  | You can get BlockStorage instnace if you configure filters of Zone No. All will be selected if you do not configure filters. |
| pageNo | No | Integer | Min : 0, Max : 2147483647 | Page No. for each page size when there are multiple cases |
| pageSize | No | Integer | Min : 0, Max : 2147483647 | Page size for one search page |
| sortedBy | No | String |  | You can set sorting columns for list results. Block storage name (blockStorageName) \| Block storage instance No.(blockStorageInstanceNo) [Do not distinguish between uppercase and lowercase.] Default : Block storage instance No.(blockStorageInstanceNo) |
| sortingOrder | No | String |  | You can set ordering for list results in ascending or descending order. ascending \| descending [Do not distinguish between uppercase and lowercase.] Default : ascending |

## Response Data Type

- BlockStorageInstanceList type

| BlockStorageInstanceList extends CommonResponse |
| --- |
| private Integer totalRows; |
| private List<blockstorageinstance data-tomark-pass=""> blockStorageInstanceList = new ArrayList<blockstorageinstance data-tomark-pass="">();</blockstorageinstance></blockstorageinstance> |

| BlockStorageInstance |
| --- |
| private String blockStorageInstanceNo; |
| private String serverInstanceNo; |
| private String serverName; |
| private CommonCode blockStorageType; |
| private String blockStorageName; |
| private Long blockStorageSize; |
| private String deviceName; |
| private String blockStorageProductCode; |
| private CommonCode blockStorageInstanceStatus; |
| private CommonCode blockStorageInstanceOperation; |
| private String blockStorageInstanceStatusName; |
| private Date createDate; |
| private String blockStorageInstanceDescription; |
| private CommonCode diskTypeCode; |
| private CommonCode diskType; |
| private CommonCode diskDetailType; |
| private Integer maxIopsThroughput; |
| private Region region; |
| private Zone zone; |

## Eamples

### Request

```
ncloud server getBlockStorageInstanceList --diskTypeCode NET --diskDetailTypeCode SSD --blockStorageTypeCodeList BASIC --pageSize 2 --pageNo 1
```

### Response

```
{
  "getBlockStorageInstanceListResponse": {
    "requestId": "28e08ca2-a988-4856-800f-daff05999ff1",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 56,
    "blockStorageInstanceList": [
      {
        "blockStorageInstanceNo": "324388",
        "serverInstanceNo": "324387",
        "serverName": "eco-test-2",
        "blockStorageType": {
          "code": "BASIC",
          "codeName": "Basic BS"
        },
        "blockStorageName": "eco-test-2",
        "blockStorageSize": 53687091200,
        "deviceName": "/dev/xvda",
        "blockStorageProductCode": "SPBSTBSTBS000005",
        "blockStorageInstanceStatus": {
          "code": "ATTAC",
          "codeName": "Block storage ATTACHED state"
        },
        "blockStorageInstanceOperation": {
          "code": "TERMT",
          "codeName": "Block Storage TERMINATE OP"
        },
        "blockStorageInstanceStatusName": "terminating",
        "createDate": "2017-05-19T11:04:03+0900",
        "blockStorageInstanceDescription": "compact-ssd\u0027s basic storage",
        "diskType": {
          "code": "NET",
          "codeName": "Network Storage"
        },
        "diskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "zone": {
          "zoneNo": "2",
          "zoneName": "KR-1",
          "zoneCode": "KR-1",
          "zoneDescription": "KR-1 zone",
          "regionNo": "1"
        }
      },
      {
        "blockStorageInstanceNo": "342436",
        "serverInstanceNo": "342435",
        "serverName": "x0811",
        "blockStorageType": {
          "code": "BASIC",
          "codeName": "Basic BS"
        },
        "blockStorageName": "x0811",
        "blockStorageSize": 53687091200,
        "deviceName": "/dev/xvda",
        "blockStorageProductCode": "SPBSTBSTBS000005",
        "blockStorageInstanceStatus": {
          "code": "ATTAC",
          "codeName": "Block storage ATTACHED state"
        },
        "blockStorageInstanceOperation": {
          "code": "NULL",
          "codeName": "Block Storage NULL OP"
        },
        "blockStorageInstanceStatusName": "attached",
        "createDate": "2017-08-11T15:44:28+0900",
        "blockStorageInstanceDescription": "x0811\u0027s basic storage",
        "diskType": {
          "code": "NET",
          "codeName": "Network Storage"
        },
        "diskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "maxIopsThroughput": 4000,
        "zone": {
          "zoneNo": "2",
          "zoneName": "KR-1",
          "zoneCode": "KR-1",
          "zoneDescription": "KR-1 zone",
          "regionNo": "1"
        }
      }
    ]
  }
}
```

```
<?xml version="1.0" encoding="UTF-8" ?>
<getBlockStorageInstanceListResponse>
  <requestId>28e08ca2-a988-4856-800f-daff05999ff1</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>56</totalRows>
  <blockStorageInstanceList>
    <blockStorageInstanceNo>324388</blockStorageInstanceNo>
    <serverInstanceNo>324387</serverInstanceNo>
    <serverName>eco-test-2</serverName>
    <blockStorageType>
      <code>BASIC</code>
      <codeName>Basic BS</codeName>
    </blockStorageType>
    <blockStorageName>eco-test-2</blockStorageName>
    <blockStorageSize>53687091200</blockStorageSize>
    <deviceName>/dev/xvda</deviceName>
    <blockStorageProductCode>SPBSTBSTBS000005</blockStorageProductCode>
    <blockStorageInstanceStatus>
      <code>ATTAC</code>
      <codeName>Block storage ATTACHED state</codeName>
    </blockStorageInstanceStatus>
    <blockStorageInstanceOperation>
      <code>TERMT</code>
      <codeName>Block Storage TERMINATE OP</codeName>
    </blockStorageInstanceOperation>
    <blockStorageInstanceStatusName>terminating</blockStorageInstanceStatusName>
    <createDate>2017-05-19T11:04:03+0900</createDate>
    <blockStorageInstanceDescription>compact-ssd&#x27;s basic storage</blockStorageInstanceDescription>
    <diskType>
      <code>NET</code>
      <codeName>Network Storage</codeName>
    </diskType>
    <diskDetailType>
      <code>SSD</code>
      <codeName>SSD</codeName>
    </diskDetailType>
    <zone>
      <zoneNo>2</zoneNo>
      <zoneName>KR-1</zoneName>
      <zoneCode>KR-1</zoneCode>
      <zoneDescription>KR-1 zone</zoneDescription>
      <regionNo>1</regionNo>
    </zone>
  </blockStorageInstanceList>
  <blockStorageInstanceList>
    <blockStorageInstanceNo>342436</blockStorageInstanceNo>
    <serverInstanceNo>342435</serverInstanceNo>
    <serverName>x0811</serverName>
    <blockStorageType>
      <code>BASIC</code>
      <codeName>Basic BS</codeName>
    </blockStorageType>
    <blockStorageName>x0811</blockStorageName>
    <blockStorageSize>53687091200</blockStorageSize>
    <deviceName>/dev/xvda</deviceName>
    <blockStorageProductCode>SPBSTBSTBS000005</blockStorageProductCode>
    <blockStorageInstanceStatus>
      <code>ATTAC</code>
      <codeName>Block storage ATTACHED state</codeName>
    </blockStorageInstanceStatus>
    <blockStorageInstanceOperation>
      <code>NULL</code>
      <codeName>Block Storage NULL OP</codeName>
    </blockStorageInstanceOperation>
    <blockStorageInstanceStatusName>attached</blockStorageInstanceStatusName>
    <createDate>2017-08-11T15:44:28+0900</createDate>
    <blockStorageInstanceDescription>x0811&#x27;s basic storage</blockStorageInstanceDescription>
    <diskType>
      <code>NET</code>
      <codeName>Network Storage</codeName>
    </diskType>
    <diskDetailType>
      <code>SSD</code>
      <codeName>SSD</codeName>
    </diskDetailType>
    <maxIopsThroughput>4000</maxIopsThroughput>
    <zone>
      <zoneNo>2</zoneNo>
      <zoneName>KR-1</zoneName>
      <zoneCode>KR-1</zoneCode>
      <zoneDescription>KR-1 zone</zoneDescription>
      <regionNo>1</regionNo>
    </zone>
  </blockStorageInstanceList>
</getBlockStorageInstanceListResponse>
```