tencent cloud

All product documents
APIs
DocumentationAPIsTencent Cloud LighthouseCBS APIsAttachDisks
AttachDisks
Last updated: 2023-12-04 16:32:05
AttachDisks
Last updated: 2023-12-04 16:32:05

1. API Description

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

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

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: 2020-03-24.
Region No String Common Params. This parameter is not required for this API.
DiskIds.N Yes Array of String List of cloud disk IDs.
InstanceId Yes String Instance ID.
RenewFlag No String Specify whether to renew an instance automatically when it expires. Values:

NOTIFY_AND_AUTO_RENEW: Trigger expiration notification and renew automatically; NOTIFY_AND_MANUAL_RENEW: Trigger expiration notification but do not renew; DISABLE_NOTIFY_AND_MANUAL_RENEW: Do not trigger the notification and do not renew.

Default: NOTIFY_AND_MANUAL_RENEW. If NOTIFY_AND_AUTO_RENEW is specified, the instance is automatically renewed on a monthly basis when the account balance is sufficient.

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 Attaching a cloud disk

This example shows you how to attach a cloud disk.

Input Example

POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AttachDisks
<Common request parameters>

{
    "DiskIds": [
        "lhdisk-5vmz00i3"
    ],
    "InstanceId": "lhins-qg08np8l"
}

Output Example

{
    "Response": {
        "RequestId": "0d5e192e-10a2-44a6-a6ce-2ac6b01f7646"
    }
}

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
FailedOperation.InvalidCommandNotFound The command is not found.
InternalError.TradeCallBillingGatewayFailed Failed to call billing gateway service
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
InvalidParameterValue.InvalidDiskIdMalformed Invalid parameter value: the disk ID format is invalid.
LimitExceeded.AttachDataDiskQuotaLimitExceeded Failed to attach the disk: Reached the upper limit of attached data disks
OperationDenied.DiskCreating The disk is being created.
OperationDenied.DiskOperationInProgress The disk is being manipulated. Try again later.
OperationDenied.InstanceCreating It is not allowed to manipulate this instance, as it is being created.
OperationDenied.InstanceOperationInProgress It is not allowed to manipulate this instance, as the last operation is still in progress.
ResourceNotFound.DiskIdNotFound The disk ID does not exist.
ResourceNotFound.DiskNotFound The disk does not exist.
ResourceNotFound.InstanceIdNotFound The instance ID does not exist.
ResourceNotFound.InstanceNotFound The instance does not exist.
UnsupportedOperation.DiskLatestOperationUnfinished Unsupported operation: the last operation of the disk has not been completed.
UnsupportedOperation.InvalidDiskState The disk's status does not support this operation.
UnsupportedOperation.InvalidInstanceState Unsupported operation: the instance status is invalid.
UnsupportedOperation.LatestOperationUnfinished Unsupported operation: the last operation of the instance has not been completed.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon