attachBlockStorageInstance

Prev Next

Can be used in a VPC environment.

Overview

Assign block storage instance to the server instance.

Request

Request parameter

Parameter Name Required Status Type Restrictions Description
regionCode No String Region Code
You can decide the region of the block storage instance to be assigned to the server instance.
The regionCode can be obtained through the getRegionList action.
Default: Select the first region of the getRegionList query results.
blockStorageInstanceNo Yes String The number of the block storage instance
This determines the block storage instance number to be assigned to the server instance.
The blockStorageInstanceNo can be obtained through the getBlockStorageInstanceList action.
serverInstanceNo Yes String Server instance number
This determines the server instance to which the block storage instance will be assigned.
The serverInstanceNo can be obtained through the getServerInstanceList action.
responseFormatType No String Format type for the response result
Options : xml | json
Default : xml

Response

Response data type

  • BlockStorageInstanceList type
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;

Example

Request example

ncloud vserver attachBlockStorageInstance --regionCode KR --blockStorageInstanceNo ***7746 --serverInstanceNo ***4299

Response example

<attachBlockStorageInstanceResponse>
  <requestId></requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <blockStorageInstanceList>
    <blockStorageInstance>
      <blockStorageInstanceNo>***7746</blockStorageInstanceNo>
      <serverInstanceNo></serverInstanceNo>
      <blockStorageName>test-***</blockStorageName>
      <blockStorageType>
        <code>SVRBS</code>
        <codeName>Server BS</codeName>
      </blockStorageType>
      <blockStorageSize>53687091200</blockStorageSize>
      <deviceName></deviceName>
      <blockStorageProductCode>SPBSTBSTAD000006</blockStorageProductCode>
      <blockStorageInstanceStatus>
        <code>CREAT</code>
        <codeName>Block storage CREATED state</codeName>
      </blockStorageInstanceStatus>
      <blockStorageInstanceOperation>
        <code>ATTAC</code>
        <codeName>Block Storage  STOP OP</codeName>
      </blockStorageInstanceOperation>
      <blockStorageInstanceStatusName>attaching</blockStorageInstanceStatusName>
      <createDate>2020-08-25T09:18:34+0900</createDate>
      <blockStorageDescription></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>
    </blockStorageInstance>
  </blockStorageInstanceList>
</attachBlockStorageInstanceResponse>