Lindorm Instance Storage Usage Details API Overview - Lindorm - Alibaba Cloud - Lindorm

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

Operation description

For Lindorm clusters with an underlying storage version >= 4.1.9, refer to the list values returned by LStorageUsageList for storage usage details.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

lindorm:GetLindormFsUsedDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the instance. You can call the DescribeRegions operation to obtain the region ID.	cn-hangzhou
InstanceId	string	Yes	The instance ID. You can call the GetLindormInstanceList operation to obtain the instance ID.	ld-xxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.	4F23D50C-400C-592C-9486-9D1E10179065
Valid	string	Indicates whether the response is valid. Valid values: true: The response is valid. false: The response is abnormal. Provide the RequestId for troubleshooting.	true
FsCapacity	string	The total storage capacity of the cluster. Unit: bytes.	85899345920
FsCapacityHot	string	The hot storage capacity of the cluster. Unit: bytes.	85899345920
FsCapacityCold	string	The cold storage capacity of the cluster. Unit: bytes.	85899345920
FsUsedHot	string	The hot storage usage of the cluster. Unit: bytes.	33269
FsUsedCold	string	The cold storage usage of the cluster. Unit: bytes.	33269
FsUsedOnLindormTable	string	The storage usage of the LindormTable engine in the cluster. Unit: bytes.	33269
FsUsedOnLindormTableData	string	The storage usage of table data in the LindormTable engine. Unit: bytes.	33269
FsUsedOnLindormTableWAL	string	The storage usage of log data in the LindormTable engine. Unit: bytes.	33269
FsUsedOnLindormSearch	string	The storage usage of the search index DPI engine in the cluster. Unit: bytes.	33269
FsUsedOnLindormTSDB	string	The storage usage of the LindormTSDB engine in the cluster. Unit: bytes.	33269
FsUsedHotOnLindormTable	string	The hot storage usage of table data in the LindormTable engine. Unit: bytes.	33269
FsUsedColdOnLindormTable	string	The cold storage usage of table data in the LindormTable engine. Unit: bytes.	33269
FsUsedHotOnLindormSearch	string	The hot storage usage of table data in the search index DPI engine. Unit: bytes.	33269
FsUsedColdOnLindormSearch	string	The cold storage usage of table data in the search index DPI engine. Unit: bytes.	33269
FsUsedHotOnLindormTSDB	string	The hot storage usage of table data in the LindormTSDB engine. Unit: bytes.	33269
FsUsedColdOnLindormTSDB	string	The cold storage usage of table data in the LindormTSDB engine. Unit: bytes.	33269
LStorageUsageList	array<object>	The storage details with categorization by storage medium. This field is the authoritative source for storage details when the underlying storage engine version is >= 4.1.9.
	object	The storage details of a specific storage medium type.
DiskType	string	The storage type of the cluster. Valid values: StandardCloudStorage: standard cloud storage. PerformanceCloudStorage: performance cloud storage. CapacityCloudStorage: capacity cloud storage. LocalSsdStorage: local SSD. LocalHddStorage: local HDD. LocalEbsStorage: local cloud storage.	StandardCloudStorage
Capacity	string	The total storage capacity of this storage medium type. Unit: bytes.	85899345920
Used	string	The storage usage of this storage medium type. Unit: bytes.	33269
UsedLindormTable	string	The storage usage of the LindormTable engine for this storage medium type. Unit: bytes.	33269
UsedLindormTsdb	string	The storage usage of the LindormTSDB engine for this storage medium type. Unit: bytes.	33269
UsedLindormSearch	string	The storage usage of the search index DPI engine for this storage medium type. Unit: bytes.	33269
UsedLindormSpark	string	The storage usage of the compute engine for this storage medium type. Unit: bytes.	33269
UsedOther	string	The storage usage of other items (such as logs and recycle bin) for this storage medium type. Unit: bytes.	33269
UsedLindormMessage3	string	The storage usage of the message engine for this storage medium type. Unit: bytes.
UsedLindormColumn3	string	The storage usage of the column store engine for this storage medium type. Unit: bytes.
UsedLindormVector3	string	The storage usage of the vector engine for this storage medium type. Unit: bytes.
AccessDeniedDetail	string	The detailed reason why 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.