Lindorm Instance Storage Usage API Reference - Lindorm - Alibaba Cloud - Lindorm

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

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:GetLindormV2StorageUsage

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	ld-ufxxxxxxxxxx

Response elements

Element	Type	Description	Example
	object
CapacityByDiskCategory	array<object>	The capacity information of each storage medium.
	object	mode The storage pattern. Valid values: LOCAL_DISK: local disk. CLOUD_DISK: cloud disk. REMOTE_STORAGE: storage-optimized or archive cloud storage. CLOUD_STORAGE: compute-optimized instance or standard cloud storage. category The storage type. Valid values: LOCAL_HDD: local HDD. LOCAL_SSD: local SSD. CLOUD_ESSD: ESSD cloud disk. CLOUD_ESSD_PL1: ESSD PL1 cloud disk. CLOUD_EFFICIENCY: ultra cloud disk. STD_CLOUD_ESSD_PL0: standard cloud storage (ESSD PL0). PERF_CLOUD_ESSD_PL1: performance cloud storage (ESSD PL1). REMOTE_CAP_OSS: remote capacity OSS. REMOTE_ARCHIVE_OSS: remote archive OSS. BACKUP_OSS: backup capacity. perfLevel The performance level (PL) of the cloud disk. Valid values: PL0 PL1 PL2 PL3 AUTO capacity The total capacity (unit: GiB). usedCapacity The used capacity (unit: GiB).	{ "mode": "CLOUD_STORAGE", "perfLevel": "PL1", "usedCapacity": 0, "category": "PERF_CLOUD_ESSD_PL1", "capacity": 4000 }
UsageByDiskCategory	array<object>	The usage information of each storage medium.
	object	capacity The total capacity (unit: bytes). used The used capacity (unit: bytes). diskType The storage type. Valid values: STANDARD_CLOUD_STORAGE: remote cloud storage - standard. PERFORMANCE_CLOUD_STORAGE: remote cloud storage - performance. CAPACITY_CLOUD_STORAGE: remote cloud storage - capacity. LOCAL_SSD_STORAGE: local SSD. LOCAL_HDD_STORAGE: local HDD. LOCAL_EBS_STORAGE: local data cloud disk. FOREIGN_BUFFER_STORAGE: local cache cloud disk for capacity cloud storage. LOCAL_EBS_STORAGE_EFFECTIVE: local ultra data cloud disk. LOCAL_EBS_STORAGE_PL0: local PL0 data cloud disk. LOCAL_EBS_STORAGE_PL1: local PL1 data cloud disk. LOCAL_EBS_STORAGE_PL2: local PL2 data cloud disk. LOCAL_EBS_STORAGE_PL3: local PL3 data cloud disk. usedLindormTable The capacity used by LindormTable. usedLindormTsdb The capacity used by LindormTSDB. usedLindormSteam The capacity used by the stream engine. usedLindormSearch The capacity used by the search engine. usedLindormSearch3 The capacity used by the search engine. usedLindormVector3 The capacity used by the vector engine. usedLindormColumn3 The capacity used by the column store engine. usedLindormMessage3 The capacity used by the message engine. usedLindormSpark The capacity used by the compute engine. usedOther The capacity used by other components.	{ "usedLindormColumn3": 688935, "usedLindormTable": 1086288931872, "usedLindormTsdb": 0, "usedOther": 0, "usedLindormMessage3": 0, "diskType": "PerformanceCloudStorage", "used": 1719816329046, "usedLindormSearch3": 36339905446, "usedLindormSpark": 2131936938, "capacity": 4294967296000, "usedLindormSearch": 0, "usedLindormVector3": 595054865855 }
RequestId	string	The request ID. Alibaba Cloud generates a unique identifier for each request. You can use the request ID to troubleshoot issues.	BDDB1954-002B-4249-B2DF-2CDDA0259668
InstanceStorageZoneMap	object	The capacity information of a multi-zone instance. {"ZoneId":{"CapacityByDiskCategory":{...},"UsageByDiskCategory":{...}}}	{ "cn-hangzhou-i": { "diskTypeCapacity": [ { "mode": "CLOUD_STORAGE", "perfLevel": "PL1", "usedCapacity": 0, "category": "PERF_CLOUD_ESSD_PL1", "capacity": 4000 } ], "diskTypeUsage": [ { "usedLindormColumn3": 688935, "usedLindormTable": 1086288931872, "usedLindormTsdb": 0, "usedOther": 0, "usedLindormMessage3": 0, "diskType": "PerformanceCloudStorage", "used": 1719816329046, "usedLindormSearch3": 36339905446, "usedLindormSpark": 2131936938, "capacity": 4294967296000, "usedLindormSearch": 0, "usedLindormVector3": 595054865855 } ] } }
AccessDeniedDetail	string	The detailed reason why access was denied.	{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}

Examples

Success response

JSON format

{
  "CapacityByDiskCategory": [
    {
      "mode": "CLOUD_STORAGE",
      "perfLevel": "PL1",
      "usedCapacity": 0,
      "category": "PERF_CLOUD_ESSD_PL1",
      "capacity": 4000
    }
  ],
  "UsageByDiskCategory": [
    {
      "usedLindormColumn3": 688935,
      "usedLindormTable": 1086288931872,
      "usedLindormTsdb": 0,
      "usedOther": 0,
      "usedLindormMessage3": 0,
      "diskType": "PerformanceCloudStorage",
      "used": 1719816329046,
      "usedLindormSearch3": 36339905446,
      "usedLindormSpark": 2131936938,
      "capacity": 4294967296000,
      "usedLindormSearch": 0,
      "usedLindormVector3": 595054865855
    }
  ],
  "RequestId": "BDDB1954-002B-4249-B2DF-2CDDA0259668",
  "InstanceStorageZoneMap": {
    "cn-hangzhou-i": {
      "diskTypeCapacity": [
        {
          "mode": "CLOUD_STORAGE",
          "perfLevel": "PL1",
          "usedCapacity": 0,
          "category": "PERF_CLOUD_ESSD_PL1",
          "capacity": 4000
        }
      ],
      "diskTypeUsage": [
        {
          "usedLindormColumn3": 688935,
          "usedLindormTable": 1086288931872,
          "usedLindormTsdb": 0,
          "usedOther": 0,
          "usedLindormMessage3": 0,
          "diskType": "PerformanceCloudStorage",
          "used": 1719816329046,
          "usedLindormSearch3": 36339905446,
          "usedLindormSpark": 2131936938,
          "capacity": 4294967296000,
          "usedLindormSearch": 0,
          "usedLindormVector3": 595054865855
        }
      ]
    }
  },
  "AccessDeniedDetail": "{\"AuthAction\":\"xxx\",\"AuthPrincipalDisplayName\":\"222\",\"AuthPrincipalOwnerId\":\"111\",\"AuthPrincipalType\":\"SubUser\",,\"NoPermissionType\":\"ImplicitDeny\",\"PolicyType\":\"AccountLevelIdentityBasedPolicy\",\"EncodedDiagnosticMessage\":\"xxxxxx\"}"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Lindorm.Errorcode.ParameterInvaild	The parameter is invalid.
400	Instance.IsDeleted	The instance is deleted.
400	Instance.IsNotValid	The instance is invalid.	The specified instance is invalid.
403	Lindorm.Errorcode.OperationDenied	You are not authorized to operate on the specified resource.
403	API.Forbidden	The API operation is forbidden in this environment.	This operation is not supported in the current environment.
403	Lindorm.Errorcode.ServiceLinkedRoleNoPermission	No permission to create service linked role.	You are not authorized to create the service-linked role.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.