GetLindormV2StorageUsage - 获取Lindorm_V2实例存储详情

更新时间:
复制 MD 格式

获取某个具体的Lindorm新架构实例下各个存储介质的存储详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

lindorm:GetLindormV2StorageUsage

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

是

实例 ID。

ld-ufxxxxxxxxxx

返回参数

名称

类型

描述

示例值

object

CapacityByDiskCategory

array<object>

各存储介质的容量信息

object

  • mode 存储模式,取值:
    • LOCAL_DISK 本地盘

    • CLOUD_DISK 云盘

    • REMOTE_STORAGE 容量型/归档型 云存储

    • CLOUD_STORAGE 性能型/标准型 云存储

  • category 存储类型,取值:
    • LOCAL_HDD 本地 HDD 盘

    • LOCAL_SSD 本地 SSD 盘

    • CLOUD_ESSD ESSD 云盘

    • CLOUD_ESSD_PL1 ESSD_PL1 云盘

    • CLOUD_EFFICIENCY 高效云盘

    • STD_CLOUD_ESSD_PL0 标准型云存储(ESSD_PL0)

    • PERF_CLOUD_ESSD_PL1 性能型云存储(ESSD_PL1)

    • REMOTE_CAP_OSS 远端容量型 OSS

    • REMOTE_ARCHIVE_OSS 远端归档型 OSS

    • BACKUP_OSS 备份容量

  • perfLevel 云盘性能等级,取值:
    • PL0

    • PL1

    • PL2

    • PL3

    • AUTO

  • capacity 总容量 (单位: GiB)

  • usedCapacity 已使用容量 (单位: GiB)

{ "mode": "CLOUD_STORAGE", "perfLevel": "PL1", "usedCapacity": 0, "category": "PERF_CLOUD_ESSD_PL1", "capacity": 4000 }

UsageByDiskCategory

array<object>

各存储介质的水位信息

object

  • capacity 总容量(单位: Byte)

  • used 已使用容量(单位: Byte)

  • diskType 存储类型,取值:
    • STANDARD_CLOUD_STORAGE 远端云存储-标准型

    • PERFORMANCE_CLOUD_STORAGE 远端云存储-性能型

    • CAPACITY_CLOUD_STORAGE 远端云存储-容量型

    • LOCAL_SSD_STORAGE 本地 SSD 盘

    • LOCAL_HDD_STORAGE 本地 HDD 盘

    • LOCAL_EBS_STORAGE 本地数据云盘

    • FOREIGN_BUFFER_STORAGE 容量型云存储本地缓存云盘

    • LOCAL_EBS_STORAGE_EFFECTIVE 本地高效数据云盘

    • LOCAL_EBS_STORAGE_PL0 本地 PL0 数据云盘

    • LOCAL_EBS_STORAGE_PL1 本地 PL1 数据云盘

    • LOCAL_EBS_STORAGE_PL2 本地 PL2 数据云盘

    • LOCAL_EBS_STORAGE_PL3 本地 PL3 数据云盘

  • usedLindormTable 宽表引擎使用

  • usedLindormTsdb 时序引擎使用

  • usedLindormSteam 流引擎使用

  • usedLindormSearch 搜索引擎使用

  • usedLindormSearch3 搜索引擎使用

  • usedLindormVector3 向量引擎使用

  • usedLindormColumn3 列存引擎使用

  • usedLindormMessage3 消息引擎使用

  • usedLindormSpark 计算引擎使用

  • usedOther 其他使用

{ "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

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

BDDB1954-002B-4249-B2DF-2CDDA0259668

InstanceStorageZoneMap

object

多可用区实例容量信息

{"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

访问被拒绝的详细原因。

{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}

示例

正常返回示例

JSON格式

{
  "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\"}"
}

错误码

HTTP status code

错误码

错误信息

描述

400 Lindorm.Errorcode.ParameterInvaild The parameter is invalid.
400 Instance.IsDeleted The instance is deleted.
400 Instance.IsNotValid The 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. 操作失败,当前环境中该API无法使用。
403 Lindorm.Errorcode.ServiceLinkedRoleNoPermission No permission to create service linked role. 操作失败,请先申请创建服务关联角色的权限。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。