tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud Lighthouse
    Documentation
    Download PDF

    DescribeDisks

    Last updated: 2023-12-04 16:32:04
    Download PDF

      1. API Description

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

      This API is used to query the information of 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: DescribeDisks.
      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.
      Filters.N No Array of Filter Filter list
      disk-id
      Filter by cloud disk ID.
      Type: String
      Required: No
      instance-id
      Filter by instance ID.
      Type: String
      Required: No
      disk-name
      Filter by cloud disk name.
      Type: String
      Required: No
      zone
      Filter by availability zone.
      Type: String
      Required: No
      disk-usage
      Filter by cloud disk type.
      Type: String
      Required: No
      Values: SYSTEM_DISK and DATA_DISK
      disk-state
      Filter by cloud disk status.
      Type: String
      Required: No
      Values: See DiskState in Disk
      Each request can contain up to 10 Filters and 100 Filter.Values. DiskIds and Filters cannot be specified at the same time.
      Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.
      Offset No Integer Offset. Default value: 0.
      OrderField No String The field by which the cloud disks are sorted. Valid values: "CREATED_TIME" (creation time), "EXPIRED_TIME" (expiration time), "DISK_SIZE" (size of cloud disks). Default value: "CREATED_TIME".
      Order No String Sorting order of the output cloud disks. Valid values: "ASC" (ascending order), "DESC" (descending order). Default value: "DESC".

      3. Output Parameters

      Parameter Name Type Description
      DiskSet Array of Disk List of cloud disk information.
      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 disks

      This example shows you how to query disks.

      Input Example

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

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

      Output Example

      {
    "Response": {
        "TotalCount": 1,
        "DiskSet": [
            {
                "DiskId": "lhdisk-p1zflrif",
                "InstanceId": "lhins-anxwfvxh",
                "Zone": "ap-guangzhou-3",
                "DiskName": "lhdisk-p1zflrif-system-disk",
                "DiskUsage": "DATA_DISK",
                "DiskType": "CLOUD_PREMIUM",
                "DiskChargeType": "PREPAID",
                "DiskSize": 30,
                "RenewFlag": "NOTIFY_AND_AUTO_RENEW",
                "DiskState": "ATTACHED",
                "Attached": true,
                "DeleteWithInstance": false,
                "DiskBackupCount": 1,
                "DiskBackupQuota": 1,
                "LatestOperation": "DetachDisks",
                "LatestOperationState": "FAILED",
                "LatestOperationRequestId": "54118bb6-7206-43f7-bf53-b77a394ad51e",
                "CreatedTime": "2021-08-25T08:50:57Z",
                "ExpiredTime": "2021-10-28T09:11:37Z",
                "IsolatedTime": null
            }
        ],
        "RequestId": "b362f486-571c-4094-afd5-22a38bd63046"
    }
}

      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
      AuthFailure Error with CAM signature/authentication.
      FailedOperation Operation failed.
      InternalError.InvalidCommandNotFound The command is not found.
      InvalidParameter.FilterValueLimitExceeded Invalid parameter: the number of Values in the Filter parameter exceeds the allowed maximum number.
      InvalidParameter.InvalidFilter Invalid parameter: the Filter parameter is invalid.
      InvalidParameter.InvalidFilterInvalidKey Invalid parameter: the value of Name in the Filter parameter is invalid.
      InvalidParameter.ParameterConflict Invalid parameter: the parameters conflict.
      InvalidParameterValue Incorrect parameter value.
      InvalidParameterValue.DiskNameTooLong The disk name is too long.
      InvalidParameterValue.Duplicated Invalid parameter value: duplicate values are not allowed.
      InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
      InvalidParameterValue.InvalidDiskIdMalformed Invalid parameter value: the disk ID format is invalid.
      InvalidParameterValue.InvalidZone Invalid Zone value.
      InvalidParameterValue.LimitExceeded Invalid parametric value: the number of parameter values exceeds the upper limit.
      InvalidParameterValue.OutOfRange Invalid parametric value: it is not within the valid range.
      InvalidParameterValue.RegionNotFound The region does not exist.
      InvalidParameterValue.RegionNotMatch The regions do not match.
      InvalidParameterValue.RegionNotSupported Unsupported region.
      InvalidParameterValue.RegionUnavailable The region is unavailable.
      InvalidParameterValue.ZoneInvalid Invalid AZ.
      ResourceNotFound.DiskIdNotFound The disk ID does not exist.
      UnauthorizedOperation.NoPermission No permission
      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
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy