Documentation Index

Fetch the complete documentation index at: https://cli-gov.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getBlockStorageInstanceDetail

Prev Next

VPC 환경에서 이용 가능합니다.

개요

블록 스토리지 인스턴스 번호로 해당 인스턴스의 상세 정보를 조회합니다.

요청

요청 파라미터

요청 파라미터는 다음과 같습니다.

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String
  • 리전 코드
  • 블록 스토리지 인스턴스 상세 정보를 조회할 리전(Region)을 결정 가능
  • regionCode는 getRegionList 액션을 통해 획득 가능
  • Default: getRegionList 조회 결과의 첫 번째 리전을 선택
blockStorageInstanceNo Yes String
output No String
  • 응답 결과의 포맷 타입
  • Options: xml | json
  • Default: json

응답

응답 데이터 타입

응답 데이터 타입은 다음과 같습니다.

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 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>
            <eventList>
                <event>Scheduled Maintenance Event | 2025-03-19 PM 10:11 (UTC+09:00) migration</event>
            </eventList>
        </blockStorageInstance>
    </blockStorageInstanceList>
</getBlockStorageInstanceDetailResponse>