Available in VPC
Overview
Get the block storage snapshot instance details using the block storage snapshot instance number.
Request
Request parameters
| Parameter name |
Required |
Type |
Restrictions |
Description |
| regionCode |
No |
String |
|
Region code- Determine the Region in which the block storage snapshot instance will be queried.
- regionCode can be obtained through the getRegionList action.
- Default: Select the first Region of the getRegionList query result.
|
| blockStorageSnapshotInstanceNo |
Yes |
String |
|
Block storage snapshot instance number to query |
| responseFormatType |
No |
String |
|
Response result's format type- Options: xml | json
- Default: xml
|
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 getBlockStorageSnapshotInstanceDetail --regionCode KR --blockStorageSnapshotInstanceNo ***1951
Response example
<getBlockStorageSnapshotInstanceDetailResponse>
<requestId>d0fb36ff-f7f5-4171-94ae-c4ff53edd46e</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>
</getBlockStorageSnapshotInstanceDetailResponse>