tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDisksReturnable

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

    1. API Description

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

    This API is used to query whether the specified cloud disk can be returned.

    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: DescribeDisksReturnable.
    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 No Array of String List of cloud disk IDs.
    Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.
    Offset No Integer Offset. Default value: 0.

    3. Output Parameters

    Parameter Name Type Description
    DiskReturnableSet Array of DiskReturnable List of returnable cloud disks.
    TotalCount Integer Number of eligible cloud disks.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying whether the specified disk can be returned

    Input Example

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

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

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "DiskReturnableSet": [
            {
                "DiskId": "lhdisk-5vmz00i3",
                "IsReturnable": true,
                "ReturnFailCode": 0,
                "ReturnFailMessage": ""
            }
        ],
        "RequestId": "3eec6c10-a8c7-41e4-b4ba-c84a5000211d"
    }
}

    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.DescribeDisksReturnableError The disk query returned invalid content.
    InvalidParameterValue.InvalidDiskIdMalformed Invalid parameter value: the disk ID format is invalid.
    InvalidParameterValue.OutOfRange Invalid parametric value: it is not within the valid range.
    UnauthorizedOperation.NoPermission No permission
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy