getBlockStorageSnapshotInstanceList

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`blockStorageSnapshotInstanceNoList.N`	Array	Optional	スナップショットインスタンス番号リストスナップショットインスタンス番号で絞り込み <例> `blockStorageSnapshotInstanceNoList.1=1234&blockStorageSnapshotInstanceNoList.2=2345`
`blockStorageSnapshotName`	String	Optional	スナップショット名で絞り込み
`blockStorageSnapshotInstanceStatusCode`	String	Optional	スナップショットインスタンスの状態コードで絞り込み `INIT` \| `CREAT` `INIT`: 作成中 `CREAT`: 使用可能
`originalBlockStorageInstanceNoList.N`	Array	Optional	ソースストレージ番号リストソースストレージ番号で絞り込み getBlockStorageInstanceListを参照 <例> `originalBlockStorageInstanceNoList.1=1234&originalBlockStorageInstanceNoList.2=2345`
`blockStorageSnapshotVolumeSize`	Integer	Optional	スナップショットサイズで絞り込み入力したサイズ(GB)以下のスナップショットを照会可能
`isEncryptedOriginalBlockStorageVolume`	Boolean	Optional	ソースストレージは暗号化するかで絞り込み `true` \| `false` `true`: 暗号化 `false`: 暗号化しない
`hypervisorTypeCodeList.N`	Array	Optional	ハイパーバイザタイプコードリスト `XEN` \| `KVM` ハイパーバイザタイプコードで絞り込み <例> `hypervisorTypeCodeList.1=KVM`
`isBootable`	Boolean	Optional	マイサーバイメージが作成可能かどうかで絞り込み `true` \| `false` `true`: 可能 `false`: 不可
`pageNo`	Integer	Optional	ページ番号 0~N (デフォルト: 0) 最初のページ: `0`または`1`を入力
`pageSize`	Integer	Conditional	ページごとの項目数 1~1000 (デフォルト: 1) `pageNo`入力時、必ず入力
`sortedBy`	String	Optional	ソート基準 `blockStorageSnapshotName`: スナップショット名 (有効値)
`sortingOrder`	String	Optional	ソート順序 `ASC` (デフォルト) \| `DESC` `ASC`: 昇順 `DESC`: 降順
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getBlockStorageSnapshotInstanceList
?regionCode=KR
&originalBlockStorageInstanceNoList.1=10*****19
&blockStorageSnapshotInstanceStatusCode=CREAT
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "getBlockStorageSnapshotInstanceListResponse": {
    "totalRows": 1,
    "blockStorageSnapshotInstanceList": [
      {
        "blockStorageSnapshotInstanceNo": "10*****50",
        "blockStorageSnapshotName": "snapshot1",
        "blockStorageSnapshotVolumeSize": 53687091200,
        "originalBlockStorageInstanceNo": "10*****19",
        "blockStorageSnapshotInstanceStatus": {
          "code": "CREAT",
          "codeName": "ブロックストレージ CREATED状態"
        },
        "blockStorageSnapshotInstanceOperation": {
          "code": "NULL",
          "codeName": "ブロックストレージ NULL OP"
        },
        "blockStorageSnapshotInstanceStatusName": "created",
        "createDate": "2025-06-20T14:05:34+0900",
        "isEncryptedOriginalBlockStorageVolume": false,
        "snapshotType": {
          "code": "FULL",
          "codeName": "Full Storage Snapshot"
        },
        "snapshotChainDepth": 0,
        "isBootable": false,
        "hypervisorType": {
          "code": "XEN",
          "codeName": "XEN"
        },
        "blockStorageVolumeType": {
          "code": "SSD",
          "codeName": "SSD"
        }
      }
    ],
    "requestId": "2c5c9b1d-****-****-****-70bf191962eb",
    "returnCode": "0",
    "returnMessage": "success"
  }
}