All Products
Search

This Product

    Lindorm:GetLindormFsUsedDetail

    Document Center

    Lindorm:GetLindormFsUsedDetail

    Last Updated:Oct 27, 2025

    Retrieves the storage usage details for each storage medium of a specific Lindorm instance.

    Operation description

    For Lindorm clusters that use storage engine version 4.1.9 or later, refer to the LStorageUsageList parameter for detailed storage usage information.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The ID of the region where the instance is located. Call the DescribeRegions operation to obtain the region ID.

    cn-hangzhou
    InstanceId

    string

    Yes

    The ID of the instance. Call the GetLindormInstanceList operation to obtain the instance ID.

    ld-xxxx

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request. Alibaba Cloud generates this unique identifier for each request. Use this ID to troubleshoot issues.

    4F23D50C-400C-592C-9486-9D1E10179065
    Valid

    string

    Indicates whether the return value is valid. A value of `true` indicates a valid value. A value of `false` indicates that an exception was returned. If an exception is returned, provide the request ID for troubleshooting.

    true
    FsCapacity

    string

    The total storage capacity of the cluster, in bytes.

    85899345920
    FsCapacityHot

    string

    The hot storage capacity of the cluster, in bytes.

    85899345920
    FsCapacityCold

    string

    The cold storage capacity of the cluster, in bytes.

    85899345920
    FsUsedHot

    string

    The used hot storage of the cluster, in bytes.

    33269
    FsUsedCold

    string

    The used cold storage of the cluster, in bytes.

    33269
    FsUsedOnLindormTable

    string

    The storage usage of LindormTable, in bytes.

    33269
    FsUsedOnLindormTableData

    string

    The storage usage of table data in LindormTable, in bytes.

    33269
    FsUsedOnLindormTableWAL

    string

    The storage usage of log data in LindormTable, in bytes.

    33269
    FsUsedOnLindormSearch

    string

    The storage usage of the search engine, in bytes.

    33269
    FsUsedOnLindormTSDB

    string

    The storage usage of LindormTSDB, in bytes.

    33269
    FsUsedHotOnLindormTable

    string

    The used hot storage for table data in LindormTable, in bytes.

    33269
    FsUsedColdOnLindormTable

    string

    The used cold storage for table data in LindormTable, in bytes.

    33269
    FsUsedHotOnLindormSearch

    string

    The used hot storage for table data in the search engine, in bytes.

    33269
    FsUsedColdOnLindormSearch

    string

    The used cold storage for table data in the search engine, in bytes.

    33269
    FsUsedHotOnLindormTSDB

    string

    The used hot storage for table data in LindormTSDB, in bytes.

    33269
    FsUsedColdOnLindormTSDB

    string

    The used cold storage for table data in LindormTSDB, in bytes.

    33269
    LStorageUsageList

    array<object>

    A list of storage details categorized by storage medium. This parameter is returned for clusters that use an underlying storage engine of version 4.1.9 or later.

    object

    The storage details for a type of storage medium.

    DiskType

    string

    The storage class of the cluster. Valid values:

    • StandardCloudStorage: Standard cloud storage.

    • PerformanceCloudStorage: Performance cloud storage.

    • CapacityCloudStorage: Capacity-optimized cloud storage.

    • LocalSsdStorage: Local SSD.

    • LocalHddStorage: Local HDD.

    • LocalEbsStorage: Local cloud storage.

    StandardCloudStorage
    Capacity

    string

    The total storage capacity of this storage medium type, in bytes.

    85899345920
    Used

    string

    The used storage of this storage medium type, in bytes.

    33269
    UsedLindormTable

    string

    The storage usage of LindormTable on this storage medium type, in bytes.

    33269
    UsedLindormTsdb

    string

    The storage usage of LindormTSDB on this storage medium type, in bytes.

    33269
    UsedLindormSearch

    string

    The storage usage of the search engine on this storage medium type, in bytes.

    33269
    UsedLindormSpark

    string

    The storage usage of the compute engine on this storage medium type, in bytes.

    33269
    UsedOther

    string

    The storage usage for other purposes, such as logs and recycle bin storage, on this storage medium type, in bytes.

    33269
    UsedLindormMessage3

    string

    UsedLindormColumn3

    string

    UsedLindormVector3

    string

    AccessDeniedDetail

    string

    The detailed reason why the access was denied.

    {}

    Examples

    Success response

    JSON format

    {
  "RequestId": "4F23D50C-400C-592C-9486-9D1E10179065",
  "Valid": "true",
  "FsCapacity": "85899345920",
  "FsCapacityHot": "85899345920",
  "FsCapacityCold": "85899345920",
  "FsUsedHot": "33269",
  "FsUsedCold": "33269",
  "FsUsedOnLindormTable": "33269",
  "FsUsedOnLindormTableData": "33269",
  "FsUsedOnLindormTableWAL": "33269",
  "FsUsedOnLindormSearch": "33269",
  "FsUsedOnLindormTSDB": "33269",
  "FsUsedHotOnLindormTable": "33269",
  "FsUsedColdOnLindormTable": "33269",
  "FsUsedHotOnLindormSearch": "33269",
  "FsUsedColdOnLindormSearch": "33269",
  "FsUsedHotOnLindormTSDB": "33269",
  "FsUsedColdOnLindormTSDB": "33269",
  "LStorageUsageList": [
    {
      "DiskType": "StandardCloudStorage",
      "Capacity": "85899345920",
      "Used": "33269",
      "UsedLindormTable": "33269",
      "UsedLindormTsdb": "33269",
      "UsedLindormSearch": "33269",
      "UsedLindormSpark": "33269",
      "UsedOther": "33269",
      "UsedLindormMessage3": "",
      "UsedLindormColumn3": "",
      "UsedLindormVector3": ""
    }
  ],
  "AccessDeniedDetail": "{}"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 Lindorm.Errorcode.ParameterInvaild The parameter is invalid.
    403 Lindorm.Errorcode.ServiceLinkedRoleNoPermission No permission to create service linked role. You are not authorized to create the service-linked role.
    403 API.Forbidden The API operation is forbidden in this environment. This operation is not supported in the current environment.
    403 Lindorm.Errorcode.OperationDenied You are not authorized to operate on the specified resource. You are not authorized to manage the specified resource.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.