VPC環境で利用できます。

概要

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

リクエスト

リクエストパラメータ

パラメータ名	必須の有無	タイプ	説明
regionCode	No	String	リージョンコードブロックストレージスナップショットインスタンスリスト照会対象のリージョン(Region)を決定可能 regionCodeはgetRegionListアクションを通じて取得可能デフォルト: getRegionList照会結果の最初のリージョンを選択
blockStorageSnapshotInstanceNoList.N	No	List<String>	ブロックストレージスナップショットインスタンス番号リストブロックストレージスナップショットインスタンス番号で絞り込んで検索可能 blockStorageSnapshotInstanceNoはgetBlockStorageSnapshotInstanceListアクションを通じて取得可能例) --blockStorageSnapshotInstanceNoList 1234 2345
blockStorageSnapshotName	No	String	ブロックストレージスナップショット名ブロックストレージスナップショット名で絞り込んで検索可能
blockStorageSnapshotInstanceStatusCode	No	String	ブロックストレージスナップショットインスタンスの状態コードブロックストレージスナップショットインスタンスの状態コードで絞り込んで検索可能オプション: INIT \| CREAT
originalBlockStorageInstanceNoList.N	No	List<String>	ソースブロックストレージインスタンス番号リストソースブロックストレージインスタンス番号で絞り込んで検索可能 originalBlockStorageInstanceNoはgetBlockStorageInstanceListアクションを通じて取得可能例) --originalBlockStorageInstanceNoList 1234 2345
blockStorageSnapshotVolumeSize	No	Integer	ブロックストレージスナップショットボリュームサイズ入力した GB単位サイズ以下のブロックストレージスナップショットを絞り込んで検索可能
isEncryptedOriginalBlockStorageVolume	No	Boolean	ソースブロックストレージボリュームの暗号化有無ソースブロックストレージボリュームの暗号化有無で絞り込んで検索可能オプション: true \| false
hypervisorTypeCodeList	No	List<String>	ハイパーバイザタイプコードリストハイパーバイザタイプで絞り込んで検索可能オプション: XEN \| KVM 例) --hypervisorTypeCodeList KVM XEN
isBootable	No	Boolean	マイサーバイメージが作成可能かどうかマイサーバイメージが作成可能かどうかで絞り込んで検索可能オプション: true \| false
pageNo	No	Integer	ページングされた結果のページ番号結果値を pageNo、pageSizeを利用してページング処理可能
pageSize	Conditional	Integer	ページング時に表示する各ページサイズ結果値を pageNo、pageSizeを利用してページング処理可能 pageNo入力時、必ず入力
sortedBy	No	String	ソート対象結果値をブロックストレージスナップショット名でソート可能オプション: blockStorageSnapshotName
sortingOrder	No	String	ソート順序 sortedByの利用時、昇順または降順のソートを設定オプション: ASC (昇順) \| DESC (降順) デフォルト: ASC
responseFormatType	No	String	レスポンス結果の形式タイプオプション: xml \| json デフォルト: xml

レスポンス

レスポンスデータタイプ

BlockStorageSnapshotInstanceListタイプ

BlockStorageSnapshotInstanceList extends CommonResponse
private Integer totalRows;
private List<BlockStorageSnapshotInstance> blockStorageSnapshotInstanceList = new ArrayList<>();

BlockStorageSnapshotInstance
private String blockStorageSnapshotInstanceNo;
private String blockStorageSnapshotName;
private Long blockStorageSnapshotVolumeSize;
private String originalBlockStorageInstanceNo;
private CommonCode blockStorageSnapshotInstanceStatus;
private CommonCode blockStorageSnapshotInstanceOperation;
private String blockStorageSnapshotInstanceStatusName;
private Date createDate;
private Boolean isEncryptedOriginalBlockStorageVolume;
private String blockStorageSnapshotDescription;
private CommonCode snapshotType;
private String baseSnapshotInstanceNo;
private Integer snapshotChainDepth;
private CommonCode hypervisorType;
private Boolean isBootable;
private CommonCode blockStorageVolumeType;

例

リクエスト例

ncloud vserver getBlockStorageSnapshotInstanceList --regionCode KR --blockStorageSnapshotInstanceNoList ***1951 --blockStorageSnapshotName test-*** --blockStorageSnapshotInstanceStatusCode CREAT --originalBlockStorageInstanceNoList ***7746 --blockStorageSnapshotVolumeSize 50 --isEncryptedOriginalBlockStorageVolume false --hypervisorTypeCodeList KVM --isBootable true

レスポンス例

<getBlockStorageSnapshotInstanceListResponse>
  <requestId>08cacedf-cfd7-4a8d-a495-89aa0d72f7ca</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <blockStorageSnapshotInstanceList>
    <blockStorageSnapshotInstance>
      <blockStorageSnapshotInstanceNo>***1951</blockStorageSnapshotInstanceNo>
      <blockStorageSnapshotName>test-***</blockStorageSnapshotName>
      <blockStorageSnapshotVolumeSize>53687091200</blockStorageSnapshotVolumeSize>
      <originalBlockStorageInstanceNo>***7746</originalBlockStorageInstanceNo>
      <blockStorageSnapshotInstanceStatus>
        <code>CREAT</code>
        <codeName>Block storage CREATED state</codeName>
      </blockStorageSnapshotInstanceStatus>
      <blockStorageSnapshotInstanceOperation>
        <code>NULL</code>
        <codeName>Block Storage NULLOP</codeName>
      </blockStorageSnapshotInstanceOperation>
      <blockStorageSnapshotInstanceStatusName>created</blockStorageSnapshotInstanceStatusName>
      <createDate>2020-08-25T10:18:15+0900</createDate>
      <isEncryptedOriginalBlockStorageVolume>false</isEncryptedOriginalBlockStorageVolume>
      <blockStorageSnapshotDescription></blockStorageSnapshotDescription>
      <snapshotType>
        <code>FULL</code>
        <codeName>Full Storage Snapshot</codeName>
      </snapshotType>
      <baseSnapshotInstanceNo/>
      <snapshotChainDepth>0</snapshotChainDepth>
      <isBootable>true</isBootable>
      <hypervisorType>
        <code>KVM</code>
        <codeName>KVM</codeName>
      </hypervisorType>
      <blockStorageVolumeType>
        <code>CB1</code>
        <codeName>Common BlockStorage 1</codeName>
      </blockStorageVolumeType>
    </blockStorageSnapshotInstance>
  </blockStorageSnapshotInstanceList>
</getBlockStorageSnapshotInstanceListResponse>