Available in VPC
Overview
Get the list of block storage snapshot instances.
Request
Request parameters
| Parameter name |
Required |
Type |
Restrictions |
Description |
| regionCode |
No |
String |
|
Region code- Determine the Region in which the block storage snapshot instance list will be queried.
- regionCode can be obtained through the getRegionList action.
- Default: Select the first Region of the getRegionList query result.
|
| blockStorageSnapshotInstanceNoList.N |
No |
List<String> |
|
Block storage snapshot instance number list- Search by filtering with block storage snapshot instance number.
- blockStorageSnapshotInstanceNo can be obtained through the getBlockStorageSnapshotInstanceList action.
- Example) --blockStorageSnapshotInstanceNoList 1234 2345
|
| blockStorageSnapshotName |
No |
String |
|
Block storage snapshot name- Search by filtering with the block storage snapshot name.
|
| blockStorageSnapshotInstanceStatusCode |
No |
String |
|
Block storage snapshot instance status code- Search by filtering with the block storage snapshot instance status code.
- Options: INIT | CREAT
|
| originalBlockStorageInstanceNoList.N |
No |
List<String> |
|
Source block storage snapshot instance number list- Search by filtering with source block storage snapshot instance number.
- originalBlockStorageInstanceNo can be obtained through the getBlockStorageInstanceList action.
- Example) --originalBlockStorageInstanceNoList 1234 2345
|
| blockStorageSnapshotVolumeSize |
No |
Integer |
|
Block storage snapshot volume size- Search by filtering with block storage snapshots that are equal to or less than the GB size entered.
|
| isEncryptedOriginalBlockStorageVolume |
No |
Boolean |
|
Source block storage volume encryption status- Search by filtering with encryption status of the source block storage volume.
- Options: true | false
|
| hypervisorTypeCodeList |
No |
List<String> |
|
Hypervisor type code list- Search by filtering with hypervisor type.
- Options: XEN | KVM
- Example) --hypervisorTypeCodeList KVM XEN
|
| isBootable |
No |
Boolean |
|
My server image creation availability- Search by filtering with My server image creation availability.
- Options: true | false
|
| pageNo |
No |
Integer |
|
Page numbers in paged results- The results can be paged using pageNo and pageSize.
|
| pageSize |
Conditional |
Integer |
|
Size of each page to display when paging- The results can be paged using pageNo and pageSize.
- Required when entering pageNo
|
| sortedBy |
No |
String |
|
Sort target- The results can be sorted by block storage snapshot name.
- Options: blockStorageSnapshotName
|
| sortingOrder |
No |
String |
|
Sort order- Set ascending/descending sorting when using sortedBy.
- Options: ASC (ascending) | DESC (descending)
- Default: ASC
|
| output |
No |
String |
|
Response result's format type- Options : xml | json
- Default : json
|
Response
Response data type
- BlockStorageSnapshotInstanceList type
| 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; |
Examples
Request example
ncloud vserver getBlockStorageSnapshotInstanceList --regionCode KR --blockStorageSnapshotInstanceNoList ***1951 --blockStorageSnapshotName test-*** --blockStorageSnapshotInstanceStatusCode CREAT --originalBlockStorageInstanceNoList ***7746 --blockStorageSnapshotVolumeSize 50 --isEncryptedOriginalBlockStorageVolume false --hypervisorTypeCodeList KVM --isBootable true
Response example
<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>