tencent cloud

APIs

DetachDisks

Download
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-05-12 19:37:55

1. API Description

Domain name for API request: cbs.intl.tencentcloudapi.com.

This API is used to unmount one or more cloud disks.

  • Batch operation is supported. You can unmount multiple cloud disks from the same CVM in a single request. If any of these cloud disks cannot be unmounted, the operation fails and a specific error code returns.
  • This is an async API. A successful request does not mean that the cloud disks have been unmounted successfully. You can call the DescribeDisks API to query the status of cloud disks. When the status changes from ATTACHED to UNATTACHED, the unmounting is successful.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DetachDisks.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
DiskIds.N Yes Array of String IDs of the cloud disks to be unmounted, which can be queried via the DescribeDisks API. Up to 10 elastic cloud disks can be unmounted in a single request.
InstanceId No String For non-shared cloud disks, this parameter validates whether it matches the actual mounted instance. for shared cloud disks, this parameter indicates from which CVM instance to unmount the cloud disk.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Detaching a single cloud disk

This example shows you how to detach a single cloud disk.

Input Example

https://cbs.intl.tencentcloudapi.com/?Action=DetachDisks
&DiskIds.0=disk-lzrg2pwi
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "aafa71a0-ed62-0fac-3ebf-5a1f808d1085"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError.ComponentError Dependent component request failed. Please contact customer service.
InternalError.ResourceOpFailed The operation performed on the resource failed. For error message, see the "Message" field in error description. Try again later or contact customer service.
InvalidDisk.NotPortable Non-elastic cloud disks are not supported.
InvalidDisk.NotSupported Indicates that the operation is not supported for the cloud disk.
InvalidDisk.TypeError Invalid cloud disk type.
InvalidDiskId.NotFound The ‘DiskId’ entered does not exist.
InvalidInstance.NotSupported Cloud Virtual Machine does not support mounting cloud disk.
InvalidInstanceId.NotFound The ‘InstanceId’ entered does not exist.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.LimitExceeded Number of parameter values exceeds the limit.
MissingParameter Missing parameter.
ResourceBusy The resource is busy. Try again later.
ResourceInUse.DiskMigrating The cloud disk is being migrated. Try again later.
ResourceNotFound.NotFound The resource is not found.
ResourceUnavailable.NotPortable The non-elastic cloud disk does not support this operation.
ResourceUnavailable.NotSupported The resource does not support this operation.
ResourceUnavailable.TypeError Incorrect cloud disk type. For example, a system disk cannot be mounted to CVM.
UnauthorizedOperation.MFAExpired Multi-factor authentication (MFA) has expired. Please try again.
UnsupportedOperation Unsupported operation
UnsupportedOperation.DetachPod Detaching cloud disks from EKS is not currently supported.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백