AttachDisks

Last updated: 2021-05-10 15:24:01

1. API Description

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

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

  • Batch operation is supported. You can mount multiple cloud disks to one CVM in a single request. If any of these cloud disks cannot be mounted, the operation fails and a specific error code returns.
  • This is an async API. A successful request indicates that the mounting is initiated. You can call the DescribeDisks API to query the status of cloud disks. If the status changes from ATTACHING to ATTACHED, the mounting is successful.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cbs.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: AttachDisks.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
DiskIds.N Yes Array of String ID of the elastic cloud disk to be mounted, which can be queried through the API DescribeDisks. A maximum of 10 elastic cloud disks can be mounted in a single request.
InstanceId Yes String ID of the CVM instance on which the cloud disk will be mounted. It can be queried via the API DescribeInstances.
DeleteWithInstance No Boolean Optional parameter. If this is not passed only the mount operation is executed. If True is passed, the cloud disk will be configured to be terminated when the server it is mounted to is terminated. This is only valid for pay-as-you-go cloud disks.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Mounting a cloud disk

Input Example

https://cbs.tencentcloudapi.com/?Action=AttachDisks
&DiskIds.0=disk-lzrg2pwi
&InstanceId=ins-dyzmimrw
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "e0f140e5-14d6-c4a1-91e0-5a1f7f05a68a"
  }
}

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.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.Attached Cloud disk is already mounted.
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.
LimitExceeded.InstanceAttachedDisk Number of instances mounted to cloud disk exceeds the limit.
MissingParameter Missing parameter.
ResourceBusy The resource is busy. Try again later.
ResourceUnavailable.Attached The cloud disk has been mounted to another CVM.
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.
ZoneNotMatch The cloud disk and the instance are not in the same availability zone.

Was this page helpful?