detachBlockStorageInstances

VPC環境で利用できます。

ブロックストレージインスタンスリストをサーバインスタンスから割り当て解除します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET \| POST	/vserver/v2/detachBlockStorageInstances

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

Server APIで共通して使用されるヘッダの詳細は、Serverのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`blockStorageInstanceNoList.N`	Array	Required	ブロックストレージインスタンス番号リスト getBlockStorageInstanceListを参照 <例> `blockStorageInstanceNoList.1=1234&blockStorageInstanceNoList.2=2345`
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`detachBlockStorageInstancesResponse`	Object	-	レスポンス結果 BlockStorageInstanceListを参照
`detachBlockStorageInstancesResponse.requestId`	String	-	リクエスト ID UUID形式
`detachBlockStorageInstancesResponse.returnCode`	String	-	レスポンスコード
`detachBlockStorageInstancesResponse.returnMessage`	String	-	レスポンスメッセージ

レスポンスステータスコード

Server APIで共通して使用されるレスポンスステータスコードの詳細は、Serverのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "detachBlockStorageInstancesResponse": {
    "totalRows": 1,
    "blockStorageInstanceList": [
      {
        "blockStorageInstanceNo": "*****3168",
        "serverInstanceNo": "*****3165",
        "blockStorageName": "storageX",
        "blockStorageType": {
          "code": "SVRBS",
          "codeName": "サーバ BS"
        },
        "blockStorageSize": 21474836480,
        "deviceName": "/dev/vdb",
        "blockStorageProductCode": "BST.CB.CB1.V001",
        "blockStorageInstanceStatus": {
          "code": "ATTAC",
          "codeName": "ブロックストレージ ATTACHED状態"
        },
        "blockStorageInstanceOperation": {
          "code": "DETAC",
          "codeName": "ブロックストレージ DETACH OP"
        },
        "blockStorageInstanceStatusName": "detaching",
        "createDate": "2025-06-20T15:35:25+0900",
        "blockStorageDiskType": {
          "code": "NET",
          "codeName": "ネットワークストレージ"
        },
        "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"
  }
}