getBlockStorageInstanceDetail

VPC環境で利用できます。

概要

ブロックストレージインスタンス番号を利用してブロックストレージインスタンスの詳細情報を照会します。

リクエスト

リクエストパラメータ

パラメータ名	必須の有無	タイプ	説明
regionCode	No	String	- リージョンコードブロックストレージインスタンスの詳細情報が照会されるリージョン(Region)を決定可能 regionCodeはgetRegionListアクションを通じて取得可能デフォルト: getRegionList照会結果の最初のリージョンを選択
blockStorageInstanceNo	Yes	String	- 照会するブロックストレージインスタンス番号 blockStorageInstanceNoはgetBlockStorageInstanceListアクションを通じて取得可能
output	No	String	- レスポンス結果の形式タイプオプション: xml \| json デフォルト: json

レスポンス

レスポンスデータタイプ

BlockStorageInstanceListタイプ

BlockStorageInstanceList extends CommonResponse
private Integer totalRows;
private List<BlockStorageInstance> blockStorageInstanceList = new ArrayList<>();

BlockStorageInstance
private String blockStorageInstanceNo;
private String serverInstanceNo;
private String blockStorageName;
private CommonCode blockStorageType;
private Long blockStorageSize;
private String deviceName;
private String blockStorageProductCode;
private CommonCode blockStorageInstanceStatus;
private CommonCode blockStorageInstanceOperation;
private String blockStorageInstanceStatusName;
private Date createDate;
private String blockStorageDescription;
private CommonCode blockStorageDiskType;
private CommonCode blockStorageDiskDetailType;
private Integer maxIopsThroughput;
private Boolean isEncryptedVolume;
private String zoneCode;
private String regionCode;
private Boolean isReturnProtection;
private CommonCode blockStorageVolumeType;
private CommonCode hypervisorType;
private Long throughput;
private List<String> eventList;

例

リクエスト例

ncloud vserver getBlockStorageInstanceDetail --regionCode KR --blockStorageInstanceNo ***7746

レスポンス例

<getBlockStorageInstanceDetailResponse>
    <requestId></requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <blockStorageInstanceList>
        <blockStorageInstance>
            <blockStorageInstanceNo>***7746</blockStorageInstanceNo>
            <serverInstanceNo>***4299</serverInstanceNo>
            <blockStorageName>test-***</blockStorageName>
            <blockStorageType>
                <code>BASIC</code>
                <codeName>Basic BS</codeName>
            </blockStorageType>
            <blockStorageSize>53687091200</blockStorageSize>
            <deviceName>/dev/xvda</deviceName>
            <blockStorageProductCode>SPBSTBSTBS000005</blockStorageProductCode>
            <blockStorageInstanceStatus>
                <code>ATTAC</code>
                <codeName>Block storage ATTACHED state</codeName>
            </blockStorageInstanceStatus>
            <blockStorageInstanceOperation>
                <code>NULL</code>
                <codeName>Block Storage NULLOP</codeName>
            </blockStorageInstanceOperation>
            <blockStorageInstanceStatusName>attached</blockStorageInstanceStatusName>
            <createDate>2020-08-19T15:05:07+0900</createDate>
            <blockStorageDescription>test-***'s basic storage</blockStorageDescription>
            <blockStorageDiskType>
                <code>NET</code>
                <codeName>Network Storage</codeName>
            </blockStorageDiskType>
            <blockStorageDiskDetailType>
                <code>SSD</code>
                <codeName>SSD</codeName>
            </blockStorageDiskDetailType>
            <maxIopsThroughput>4000</maxIopsThroughput>
            <isEncryptedVolume>false</isEncryptedVolume>
            <zoneCode>KR-1</zoneCode>
            <regionCode>KR</regionCode>
            <isReturnProtection>false</isReturnProtection>
            <blockStorageVolumeType>
                <code>CB1</code>
                <codeName>Common BlockStorage 1</codeName>
            </blockStorageVolumeType>
            <hypervisorType>
                <code>KVM</code>
                <codeName>KVM</codeName>
            </hypervisorType>
            <throughput>10000</throughput>
            <eventList>
                <event>Scheduled Maintenance Event | 2025-03-19 PM 10:11 (UTC+09:00) migration</event>
            </eventList>
        </blockStorageInstance>
    </blockStorageInstanceList>
</getBlockStorageInstanceDetailResponse>