---
title: "getBlockStorageInstanceList"
slug: "compute-server-getblockstorageinstancelist"
updated: 2026-09-17T09:57:42Z
published: 2026-09-17T09:57:42Z
canonical: "api.ncloud-docs.com/compute-server-getblockstorageinstancelist"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# getBlockStorageInstanceList

## 概要

ブロックストレージインスタンスリストを照会します。

## リクエスト

### リクエストパラメータ

| パラメータ名 | 必須の有無 | タイプ | 制限事項 | 説明 |
| --- | --- | --- | --- | --- |
| serverInstanceNo | No | String |  | - サーバインスタンス番号 サーバインスタンスに attachされたブロックストレージの照会に使用 serverInstanceNoは getServerInstanceListアクションを通じて取得可能 |
| blockStorageInstanceNoList.N | No | List<String> |  | - ブロックストレージインスタンス番号リスト ブロックストレージインスタンス番号リストに対応するブロックストレージを照会できる 例) blockStorageInstanceNoList.1=1021004&blockStorageInstanceNoList.2=937508 |
| searchFilterName | No | String |  | - 検索時に適用するフィルタ名 ブロックストレージ名(blockStorageName)と接続情報(attachmentInformation)で絞り込み検索可能 オプション: blockStorageName \| attachmentInformation `[&#x5927;&#x6587;&#x5B57;&#x5C0F;&#x6587;&#x5B57;&#x3092;&#x533A;&#x5225;&#x3057;&#x306A;&#x3044;]` 接続情報の場合、ブロックストレージ名`[&#x30B9;&#x30DA;&#x30FC;&#x30B9;]`接続情報またはブロックストレージ名: 接続情報形式で入力 入力可能な状態は、ブロックストレージインスタンスデータタイプ(BlockStorageInstance)のデバイス名(deviceName)を参照 searchFilterNameは、以下の searchFilterValueとmappingして使用 例) searchFilterName=blockStorageName&searchFilterValue=s1669aa4e78c 例) searchFilterName=attachmentInformation&searchFilterValue=s1669aa4e78c:/dev |
| searchFilterValue | No | String |  | - 検索時に適用するフィルタの値 上記の searchFilterName値と mappingする値を入力 |
| blockStorageTypeCodeList.N | No | List<String> | 最小: 1, 最大: 5 | - ブロックストレージ区分コードリスト ブロックストレージ区分コードリストに対応するブロックストレージのみ照会可能 オプション: BASIC (基本ブロックストレージ) \| SVRBS (追加ブロックストレージ) デフォルト: BASIC blockStorageTypeCodeList.1=SVRBS |
| blockStorageInstanceStatusCode | No | String | 最小: 1, 最大: 5 | - ブロックストレージインスタンスの状態コード ブロックストレージインスタンスの状態別に照会可能 入力可能な状態は、ブロックストレージインスタンスデータタイプ(BlockStorageInstance)のブロックストレージインスタンス状態(blockStorageInstanceStatus)値を参考 |
| diskTypeCode | No | String |  | - ディスクタイプ区分コード オプション: NET (ネットワークストレージ) \| LOCAL (ローカルストレージ) |
| diskDetailTypeCode | No | String |  | - ディスクタイプ詳細タイプコード Optinos : HDD \| SSD |
| regionNo | No | String |  | - リージョン番号 ブロックストレージインスタンスリストをリージョン(Region)を使用して絞り込みできる regionNoは getRegionListアクションを通じて取得可能 |
| zoneNo | No | String |  | - ZONE番号 ブロックストレージインスタンスリストをゾーン(zone)を使用して絞り込みできる フィルタを設定しないと、そのリージョンの ZONEが全選択される |
| pageNo | No | Integer | 最小: 0, 最大: 2147483647 | - ページングされた結果のページ番号 結果値は pageNoを利用してページング処理できる |
| pageSize | No | Integer | 最小: 0, 最大: 2147483647 | - ページング時に表示する各ページサイズ 結果値は pageSizeを利用してページング処理できる |
| sortedBy | No | String |  | - ソート対象 ブロックストレージ名とブロックストレージインスタンス番号でソート可能 オプション: blockStorageName (ブロックストレージ名) \| blockStorageInstanceNo (ブロックストレージインスタンス番号) `[&#x5927;&#x6587;&#x5B57;&#x5C0F;&#x6587;&#x5B57;&#x3092;&#x533A;&#x5225;&#x3057;&#x306A;&#x3044;]` デフォルト: blockStorageInstanceNo sortedByは、以下の sortingOrderと mappingして使用 例: sortedBy=blockStorageName&sortingOrder=ascending sortedBy=blockStorageInstanceNo&sortingOrder=descending |
| sortingOrder | No | String |  | - ソート順序 上記で設定した sortedByの昇順/降順ソート設定 ascending (昇順) \| descending (降順) `[&#x5927;&#x6587;&#x5B57;&#x5C0F;&#x6587;&#x5B57;&#x3092;&#x533A;&#x5225;&#x3057;&#x306A;&#x3044;]` ascending |
| responseFormatType | No | String |  | - レスポンス結果の形式タイプ オプション: xml \| json デフォルト: xml |

## レスポンス

### レスポンスボディ

- [BlockStorageInstanceList](/docs/ja/common-apidatatype-blockstorageinstancelist)

## 例

### リクエスト例

```
GET {SERVER_API_URL}/getBlockStorageInstanceList
?searchFilterName=blockStorageName
&searchFilterValue=s1669aa4e78c
```

### レスポンス例

```
<getBlockStorageInstanceListResponse>
  <requestId>c8172d4a-5486-4d34-9331-dfec6a747abf</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <blockStorageInstanceList>
    <blockStorageInstance>
      <blockStorageInstanceNo>1021004</blockStorageInstanceNo>
      <serverInstanceNo>1021003</serverInstanceNo>
      <serverName>s1669aa4e78c</serverName>
      <blockStorageType>
        <code>BASIC</code>
        <codeName>Basic BS</codeName>
      </blockStorageType>
      <blockStorageName>s1669aa4e78c</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 NULLOP</codeName>
      </blockStorageInstanceOperation>
      <blockStorageInstanceStatusName>attached</blockStorageInstanceStatusName>
      <createDate>2018-10-22T16:19:51+0900</createDate>
      <blockStorageInstanceDescription>s1669aa4e78c&apos;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>3</zoneNo>
        <zoneName>KR-2</zoneName>
        <zoneCode>KR-2</zoneCode>
        <zoneDescription>坪村ゾーン</zoneDescription>
        <regionNo>1</regionNo>
      </zone>
    </blockStorageInstance>
  </blockStorageInstanceList>
</getBlockStorageInstanceListResponse>
```