getBlockStorageInstanceList

VPC環境で利用できます。

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

リクエスト

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

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

参考

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

リクエストヘッダ

Server APIで共通して使用されるヘッダの詳細は、Serverのリクエストヘッダをご参照ください。

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン (デフォルト)
`zoneCode`	String	Optional	ゾーンコード getZoneListを参照
`blockStorageInstanceNoList.N`	Array	Optional	ブロックストレージインスタンス番号リストブロックストレージインスタンス番号で絞り込み getBlockStorageInstanceListを参照 <例> `blockStorageInstanceNoList.1=1234&blockStorageInstanceNoList.2=2345`
`blockStorageInstanceStatusCode`	String	Optional	ブロックストレージインスタンスの状態コードで絞り込み `INIT` \| `CREAT` \| `ATTAC` `INIT`: 作成中 `CREAT`: 使用可能 `ATTAC`: 使用中
`blockStorageDiskTypeCode`	String	Optional	ブロックストレージディスクタイプコードで絞り込み `NET`: ネットワークディスク (有効値)
`blockStorageDiskDetailTypeCode`	String	Optional	ブロックストレージディスクの詳細タイプコードで絞り込み `HDD` \| `SSD`
`blockStorageSize`	Integer	Optional	ブロックストレージ容量で絞り込み入力した容量(GB)以下のブロックストレージを照会可能
`blockStorageTypeCodeList.N`	Array	Optional	ブロックストレージタイプコードリスト `BASIC` \| `SVRBS` `BASIC`: 基本ストレージ `SVRBS`: 追加ストレージブロックストレージタイプコードで絞り込み <例> `blockStorageTypeCodeList.1=BASIC&blockStorageTypeCodeList.2=SVRBS`
`serverInstanceNo`	String	Optional	サーバインスタンス番号で絞り込み getServerInstanceListを参照
`blockStorageName`	String	Optional	ブロックストレージ名で絞り込み `blockStorageName`、`serverName`、`connectionInfo`のうち、1つだけ使用
`serverName`	String	Optional	ブロックストレージ接続サーバ名で絞り込み `blockStorageName`、`serverName`、`connectionInfo`のうち、1つだけ使用
`connectionInfo`	String	Optional	ブロックストレージ接続情報で絞り込み `{サーバ名} {デバイス名}`または`{サーバ名}:{デバイス名}`形式で入力 <例> `s173dc67dc2e /dev/xvda`、`s173dc67dc2e:/dev/xvda` `blockStorageName`、`serverName`、`connectionInfo`のうち、1つだけ使用
`blockStorageVolumeTypeCodeList.N`	Array	Optional	ブロックストレージボリュームタイプコードリスト `HDD` \| `SSD` \| `FB1` \| `CB1` ブロックストレージボリュームタイプコードで絞り込み <例> `blockStorageVolumeTypeCodeList.1=SSD&blockStorageVolumeTypeCode.2=CB1`
`hypervisorTypeCodeList.N`	Array	Optional	ハイパーバイザタイプコードリスト `XEN` \| `KVM` ハイパーバイザタイプコードで絞り込み <例> `hypervisorTypeCodeList.1=XEN`
`pageNo`	Integer	Optional	ページ番号 0~N (デフォルト: 0) 最初のページ: `0`または`1`を入力
`pageSize`	Integer	Conditional	ページごとの項目数 1~1000 (デフォルト: 1) `pageNo`入力時、必ず入力
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getBlockStorageInstanceList
?regionCode=KR
&blockStorageTypeCodeList.1=SVRBS
&blockStorageInstanceStatusCode=CREAT
&hypervisorTypeCodeList.1=KVM
&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}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`getBlockStorageInstanceListResponse`	Object	-	レスポンス結果 BlockStorageInstanceListを参照
`getBlockStorageInstanceListResponse.requestId`	String	-	リクエスト ID UUID形式
`getBlockStorageInstanceListResponse.returnCode`	String	-	レスポンスコード
`getBlockStorageInstanceListResponse.returnMessage`	String	-	レスポンスメッセージ

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

Server APIで共通して使用されるレスポンスステータスコードの詳細は、Serverのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
  "getBlockStorageInstanceListResponse": {
    "totalRows": 1,
    "blockStorageInstanceList": [
      {
        "blockStorageInstanceNo": "10*****68",
        "blockStorageName": "storageX",
        "blockStorageType": {
          "code": "SVRBS",
          "codeName": "サーバ BS"
        },
        "blockStorageSize": 10737418240,
        "blockStorageProductCode": "BST.CB.CB1.V001",
        "blockStorageInstanceStatus": {
          "code": "CREAT",
          "codeName": "ブロックストレージ CREATED状態"
        },
        "blockStorageInstanceOperation": {
          "code": "NULL",
          "codeName": "ブロックストレージ NULL OP"
        },
        "blockStorageInstanceStatusName": "detached",
        "createDate": "2025-06-20T15:35:25+0900",
        "blockStorageDiskType": {
          "code": "NET",
          "codeName": "ネットワークストレージ"
        },
        "blockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "maxIopsThroughput": 100,
        "isEncryptedVolume": false,
        "zoneCode": "KR-2",
        "regionCode": "KR",
        "isReturnProtection": true,
        "blockStorageVolumeType": {
          "code": "CB1",
          "codeName": "Common BlockStorage 1"
        },
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "throughput": 104857600,
        "iops": 100
      }
    ],
    "requestId": "4c0c5ebb-****-****-****-fb47d14bd21a",
    "returnCode": "0",
    "returnMessage": "success"
  }
}