---
title: "getBlockStorageInstanceDetail"
slug: "compute-vserver-storage-getblockstorageinstancedetail"
updated: 2026-09-17T09:57:39Z
published: 2026-09-17T09:57:39Z
canonical: "api.ncloud-docs.com/compute-vserver-storage-getblockstorageinstancedetail"
---

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

# getBlockStorageInstanceDetail

VPC環境で利用できます。

ブロックストレージインスタンスの詳細情報を照会します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET \| POST | /vserver/v2/getBlockStorageInstanceDetail |

              参考

              

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

### リクエストヘッダ

Server APIで共通して使用されるヘッダの詳細は、[Serverのリクエストヘッダ](/docs/ja/compute-vserver#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

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

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | リージョンコード - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を参照 - 照会結果の最初のリージョン(デフォルト) |
| `blockStorageInstanceNo` | String | Required | ブロックストレージインスタンス番号 - [getBlockStorageInstanceList](/docs/ja/compute-vserver-storage-getblockstorageinstancelist)を参照 |
| `responseFormatType` | String | Optional | レスポンスデータの形式 - `xml`(デフォルト) \| `json` |

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getBlockStorageInstanceDetail
?regionCode=KR
&blockStorageInstanceNo=10*****19
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## レスポンス

レスポンス形式を説明します。

### レスポンスボディ

レスポンスボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `getBlockStorageInstanceDetailResponse` | Object | - | レスポンス結果 - [BlockStorageInstanceList](/docs/ja/common-vapidatatype-blockstorageinstancelist)を参照 |
| `getBlockStorageInstanceDetailResponse.requestId` | String | - | リクエスト ID - UUID形式 |
| `getBlockStorageInstanceDetailResponse.returnCode` | String | - | レスポンスコード |
| `getBlockStorageInstanceDetailResponse.returnMessage` | String | - | レスポンスメッセージ |

### レスポンスステータスコード

Server APIで共通して使用されるレスポンスステータスコードの詳細は、[Serverのレスポンスステータスコード](/docs/ja/compute-vserver#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
{
  "getBlockStorageInstanceDetailResponse": {
    "totalRows": 1,
    "blockStorageInstanceList": [
      {
        "blockStorageInstanceNo": "10*****19",
        "serverInstanceNo": "10*****18",
        "blockStorageName": "s-65gu4d2is312u",
        "blockStorageType": {
          "code": "BASIC",
          "codeName": "基本 BS"
        },
        "blockStorageSize": 53687091200,
        "deviceName": "/dev/xvda",
        "blockStorageProductCode": "SPBSTBSTBS000005",
        "blockStorageInstanceStatus": {
          "code": "ATTAC",
          "codeName": "ブロックストレージ ATTACHED状態"
        },
        "blockStorageInstanceOperation": {
          "code": "NULL",
          "codeName": "ブロックストレージ NULL OP"
        },
        "blockStorageInstanceStatusName": "attached",
        "createDate": "2025-06-18T09:42:04+0900",
        "blockStorageDescription": "s-65gu4d2is312u's basic storage",
        "blockStorageDiskType": {
          "code": "NET",
          "codeName": "ネットワークストレージ"
        },
        "blockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "maxIopsThroughput": 4000,
        "isEncryptedVolume": false,
        "zoneCode": "KR-2",
        "regionCode": "KR",
        "isReturnProtection": false,
        "blockStorageVolumeType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "hypervisorType": {
          "code": "XEN",
          "codeName": "XEN"
        }
      }
    ],
    "requestId": "3e659354-****-****-****-ff1193b1381d",
    "returnCode": "0",
    "returnMessage": "success"
  }
}
```