attachBlockStorageInstance

Article summary

Did you find this summary helpful?

Thank you for your feedback

Overview

Assigning a block storage instance

Description

This assigns a block storage instance to the server instance.

Request Parameters

Parameter Name	Requiredness	Type	Limitation	Description
blockStorageInstanceNo	Yes	String		Block storage instance number - This determines the block storage instance number to be assigned to the server instance. - blockStorageInstanceNo can be obtained through the getBlockStorageInstanceList action.
serverInstanceNo	Yes	String		Server instance number - This determines the server instance in which a block storage will be assigned. - serverInstanceNo can be obtained through the getServerInstanceList action.

Response Data Type

BlockStorageInstanceList type

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

BlockStorageInstance
private String blockStorageInstanceNo;
private String serverInstanceNo;
private String serverName;
private CommonCode blockStorageType;
private String blockStorageName;
private Long blockStorageSize;
private String deviceName;
private String blockStorageProductCode;
private CommonCode blockStorageInstanceStatus;
private CommonCode blockStorageInstanceOperation;
private String blockStorageInstanceStatusName;
private Date createDate;
private String blockStorageInstanceDescription;
private CommonCode diskType;
private CommonCode diskDetailType;
private Integer maxIopsThroughput;
private Region region;
private Zone zone;

Examples

Request

ncloud server attachBlockStorageInstance --blockStorageInstanceNo ***1004 --serverInstanceNo ***1003

Response

{
  "attachBlockStorageInstanceResponse": {
    "requestId": "c8172d4a-5486-4d34-9331-dfec6a747abf",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "blockStorageInstanceList": [
      {
        "blockStorageInstanceNo": "***1004",
        "serverInstanceNo": "***1003",
        "serverName": "test-***",
        "blockStorageType": {
          "code": "SVRBS",
          "codeName": "Server BS"
        },
        "blockStorageName": "test-***",
        "blockStorageSize": 53687091200,
        "deviceName": "",
        "blockStorageProductCode": "SPBSTBSTAD000006",
        "blockStorageInstanceStatus": {
          "code": "CREAT",
          "codeName": "Block storage CREATED state"
        },
        "blockStorageInstanceOperation": {
          "code": "ATTAC",
          "codeName": "Block Storage  STOP OP"
        },
        "blockStorageInstanceStatusName": "attaching",
        "createDate": "2018-10-22T16:19:51+0900",
        "blockStorageInstanceDescription": "",
        "diskType": {
          "code": "NET",
          "codeName": "Network Storage"
        },
        "diskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "maxIopsThroughput": 4000,
        "region": {
          "regionNo": "1",
          "regionCode": "KR",
          "regionName": "Korea"
        },
        "zone": {
          "zoneNo": "3",
          "zoneName": "KR-2",
          "zoneCode": "KR-2",
          "zoneDescription": "평촌 zone",
          "regionNo": "1"
        }
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<attachBlockStorageInstanceResponse>
  <requestId>c8172d4a-5486-4d34-9331-dfec6a747abf</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <blockStorageInstanceList>
    <blockStorageInstance>
      <blockStorageInstanceNo>***1004</blockStorageInstanceNo>
      <serverInstanceNo>***1003</serverInstanceNo>
      <serverName>test-***</serverName>
      <blockStorageType>
        <code>SVRBS</code>
        <codeName>Server BS</codeName>
      </blockStorageType>
      <blockStorageName>test-***</blockStorageName>
      <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>2018-10-22T16:19:51+0900</createDate>
      <blockStorageInstanceDescription></blockStorageInstanceDescription>
      <diskType>
        <code>NET</code>
        <codeName>Network Storage</codeName>
      </diskType>
      <diskDetailType>
        <code>SSD</code>
        <codeName>SSD</codeName>
      </diskDetailType>
      <maxIopsThroughput>4000</maxIopsThroughput>
      <region>
        <regionNo>1</regionNo>
        <regionCode>KR</regionCode>
        <regionName>Korea</regionName>
      </region>
      <zone>
        <zoneNo>3</zoneNo>
        <zoneName>KR-2</zoneName>
        <zoneCode>KR-2</zoneCode>
        <zoneDescription>평촌 zone</zoneDescription>
        <regionNo>1</regionNo>
      </zone>
    </blockStorageInstance>
  </blockStorageInstanceList>
</attachBlockStorageInstanceResponse>

Was this article helpful?

What's Next

detachBlockStorageInstances

Table of contents

Overview
Description
Request Parameters
Response Data Type
Examples