GetLindormV2StorageUsage - Lindorm - Alibaba Cloud Documentation Center

Retrieves the storage details for each storage medium of a specific Lindorm instance that uses 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

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

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 for each storage medium.
	object	mode: The storage mode. Valid values: LOCAL_DISK: Local disk CLOUD_DISK: Cloud disk REMOTE_STORAGE: Storage-optimized or archive cloud storage CLOUD_STORAGE: Performance-optimized or standard cloud storage category: The storage class. Valid values: LOCAL_HDD: Local HDD LOCAL_SSD: Local SSD CLOUD_ESSD: ESSD CLOUD_ESSD_PL1: ESSD PL1 CLOUD_EFFICIENCY: Ultra disk STD_CLOUD_ESSD_PL0: Standard cloud storage (ESSD PL0) PERF_CLOUD_ESSD_PL1: Performance-optimized cloud storage (ESSD PL1) REMOTE_CAP_OSS: Remote storage-optimized OSS REMOTE_ARCHIVE_OSS: Remote archive OSS BACKUP_OSS: Backup capacity perfLevel: The performance level of the cloud disk. Valid values: PL0 PL1 PL2 PL3 AUTO capacity: The total capacity in GiB. usedCapacity: The used capacity in GiB.	{ "mode": "CLOUD_STORAGE", "perfLevel": "PL1", "usedCapacity": 0, "category": "PERF_CLOUD_ESSD_PL1", "capacity": 4000 }
UsageByDiskCategory	array<object>	The usage information for each storage medium.
	object	capacity: The total capacity in bytes. used: The used capacity in bytes. diskType: The storage class. Valid values: STANDARD_CLOUD_STORAGE: Remote standard cloud storage PERFORMANCE_CLOUD_STORAGE: Remote performance-optimized cloud storage CAPACITY_CLOUD_STORAGE: Remote storage-optimized cloud storage LOCAL_SSD_STORAGE: Local SSD LOCAL_HDD_STORAGE: Local HDD LOCAL_EBS_STORAGE: Local data disk FOREIGN_BUFFER_STORAGE: Local cache disk for storage-optimized cloud storage LOCAL_EBS_STORAGE_EFFECTIVE: Local ultra data disk LOCAL_EBS_STORAGE_PL0: Local PL0 data disk LOCAL_EBS_STORAGE_PL1: Local PL1 data disk LOCAL_EBS_STORAGE_PL2: Local PL2 data disk LOCAL_EBS_STORAGE_PL3: Local PL3 data 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 services.	{ "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 ID of the request. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.	BDDB1954-002B-4249-B2DF-2CDDA0259668
InstanceStorageZoneMap	object	The capacity information for the 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 the 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.