新手指引

产品公告

腾讯云云硬盘快照正式商业化计费公告

腾讯云云硬盘快照跨地域复制功能正式商业化计费公告

产品简介

产品概述

产品优势

应用场景

地域和可用区

云硬盘实例

云硬盘快照

访问管理

AttachDisks

PDF

聚焦模式

字号

最后更新时间： 2024-11-27 16:51:05

1. API Description

Domain name for API request: cbs.intl.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.

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: AttachDisks.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceId	Yes	String	ID of the CVM instance on which the cloud disk will be mounted. It can be queried via the API DescribeInstances.
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.
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.
AttachMode	No	String	(Optional) Specifies the cloud disk mounting method. It’s only valid for BM models. Valid values: PF VF

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 Attaching cloud disks

This example shows you how to attach cloud disk disk-lzrg2pwi to the CVM ins-dyzmimrw.

Input Example

https://cbs.intl.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

Tencent Cloud CLI 3.0

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.
LimitExceeded.InstanceAttachedDisk	Number of instances mounted to cloud disk 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.Attached	The cloud disk has been mounted to another CVM.
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.
ResourceUnavailable.ZoneNotMatch

帮助和支持

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

填写满意度调查问卷，共创更好文档体验。

文档反馈

tencent cloud

云硬盘