getBlockStorageSnapshotInstanceList
- Print
- PDF
getBlockStorageSnapshotInstanceList
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Available in VPC
Overview
Views the snapshot instance list of the Block Storage.
Requests
Request parameters
| Parameter name | Essential parameter (True/False) | Type | Limitations | Description |
|---|---|---|---|---|
| regionCode | No | String | - Region code It can determine the Region for which the Block Storage snapshot instance list is to be viewed regionCode can be acquired through getRegionList action Default: select the first region shown through getRegionList | |
| blockStorageSnapshotInstanceNoList.N | No | List<String> | - Views the snapshot instance number list of the Block Storage. You can search by filtering with a Block Storage snapshot instance number. blockStorageSnapshotInstanceNo can be obtained through getBlockStorageSnapshotInstanceList action e.g., --blockStorageSnapshotInstanceNoList 1234 2345 | |
| blockStorageSnapshotName | No | String | - Name of Block Storage snapshot You can search by filtering with a Block Storage snapshot name. | |
| blockStorageSnapshotInstanceStatusCode | No | String | - Views the snapshot instance status code of the Block Storage. You can search by filtering with a Block Storage snapshot instance status code. Options : INIT | CREAT | |
| originalBlockStorageInstanceNoList.N | No | List<String> | - Original instance number list of the Block Storage You can search by filtering with the original Block Storage instance number. originalBlockStorageInstanceNo can be obtained through getBlockStorageInstanceList action e.g., --originalBlockStorageInstanceNoList 1234 2345 | |
| blockStorageSnapshotVolumeSize | No | Integer | - Size of Block Storage snapshot volume Block Storage snapshots of sizes equal or less than the GB-level size entered can be filtered and searched | |
| isEncryptedOriginalBlockStorageVolume | No | Boolean | - Whether the original Block Storage volume is encrypted You can search by filtering based on whether the original Block Storage volume is encrypted Options : true | false | |
| hypervisorTypeCodeList | No | List<String> | - List of hypervisor type codes You can search by filtering by hypervisor type Options : XEN | KVM e.g., --hypervisorTypeCodeList KVM XEN | |
| isBootable | No | Boolean | - Whether an image for my server can be generated You can search by filtering based on whether an image for my server can be generated Options : true | false | |
| pageNo | No | Integer | - Page number of paged result The results can be paged using page No. and page size | |
| pageSize | Conditional | Integer | - Size of each page to be shown during paging The results can be paged using page No. and page size Must be entered when entering pageNo | |
| sortedBy | No | String | - Items subject to sorting Results can be sorted by Block Storage snapshot name Options : blockStorageSnapshotName | |
| sortingOrder | No | String | - Sorting order When using sortedBy, set for sort in ascending/descending order Options: ASC (ascending order) | DESC (descending order) Default : ASC | |
| responseFormatType | No | String | - Format type of responses Options : xml | json Default : xml |
Responses
Response data type
- Type of 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; |
Examples
Request examples
ncloud vserver getBlockStorageSnapshotInstanceList --regionCode KR --blockStorageSnapshotInstanceNoList ***1951 --blockStorageSnapshotName test-*** --blockStorageSnapshotInstanceStatusCode CREAT --originalBlockStorageInstanceNoList ***7746 --blockStorageSnapshotVolumeSize 50 --isEncryptedOriginalBlockStorageVolume false --hypervisorTypeCodeList KVM --isBootable true
Response examples
<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>
</blockStorageSnapshotInstance>
</blockStorageSnapshotInstanceList>
</getBlockStorageSnapshotInstanceListResponse>
Was this article helpful?