tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

TerminateDisks

Last updated: 2023-12-04 16:32:02

    1. API Description

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

    This API is used to terminate one or more cloud disk.

    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: TerminateDisks.
    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.

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

    This example shows you how to terminates cloud disks.

    Input Example

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

{
    "DiskIds": [
        "lhdisk-p1zflrif"
    ]
}

    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.DestroyResourcesFailed Unable to terminate the resource. Please retry later.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.InvalidDiskIdMalformed Invalid parameter value: the disk ID format is invalid.
    OperationDenied.DiskOperationInProgress The disk is being manipulated. Try again later.
    OperationDenied.DiskUsageNotSupportOperation The cloud disk type of the disk does not support this operation.
    ResourceNotFound.DiskIdNotFound The disk ID does not exist.
    UnsupportedOperation.InvalidDiskState The disk's status does not support this operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy