detachBlockStorageInstances

Available in VPC

Unassign the list of block storage instances from a server instance.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET \| POST	/vserver/v2/detachBlockStorageInstances

Note

This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.

Request headers

For information about the headers common to all Server APIs, see Server request headers.

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`regionCode`	String	Optional	Region code See getRegionList. First Region in the query results (default)
`blockStorageInstanceNoList.N`	Array	Required	Block storage instance number list See getBlockStorageInstanceList. Example: `blockStorageInstanceNoList.1=1234&blockStorageInstanceNoList.2=2345`
`responseFormatType`	String	Optional	Format of the response data `xml` (default) \| `json`

Request example

The request example is as follows:

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/detachBlockStorageInstances
?regionCode=KR
&blockStorageInstanceNoList.1=*****3168
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`detachBlockStorageInstancesResponse`	Object	-	Response result See BlockStorageInstanceList.
`detachBlockStorageInstancesResponse.requestId`	String	-	ID for the request UUID format
`detachBlockStorageInstancesResponse.returnCode`	String	-	Response code
`detachBlockStorageInstancesResponse.returnMessage`	String	-	Response message

Response status codes

For information about the response status codes common to all Server APIs, see Server response status codes.

Response example

The response example is as follows:

{
  "detachBlockStorageInstancesResponse": {
    "totalRows": 1,
    "blockStorageInstanceList": [
      {
        "blockStorageInstanceNo": "*****3168",
        "serverInstanceNo": "*****3165",
        "blockStorageName": "storageX",
        "blockStorageType": {
          "code": "SVRBS",
          "codeName": "Server BS"
        },
        "blockStorageSize": 21474836480,
        "deviceName": "/dev/vdb",
        "blockStorageProductCode": "BST.CB.CB1.V001",
        "blockStorageInstanceStatus": {
          "code": "ATTAC",
          "codeName": "Block storage ATTACHED status"
        },
        "blockStorageInstanceOperation": {
          "code": "DETAC",
          "codeName": "Block storage DETACH OP"
        },
        "blockStorageInstanceStatusName": "detaching",
        "createDate": "2025-06-20T15:35:25+0900",
        "blockStorageDiskType": {
          "code": "NET",
          "codeName": "Network storage"
        },
        "blockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "maxIopsThroughput": 100,
        "isEncryptedVolume": false,
        "zoneCode": "KR-2",
        "regionCode": "KR",
        "isReturnProtection": false,
        "blockStorageVolumeType": {
          "code": "CB1",
          "codeName": "Common BlockStorage 1"
        },
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "throughput": 104857600,
        "iops": 100
      }
    ],
    "requestId": "a3463239-****-****-****-3239a8f41566",
    "returnCode": "0",
    "returnMessage": "success"
  }
}