DescribeResourceUsageTotal - 资源使用率汇总

更新时间:
复制 MD 格式

预留实例、SCU使用率汇总查询。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

bssapi:DescribeResourceUsageTotal

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

StartPeriod

string

是

格式:yyyy-MM-dd HH:mm:ss; 查询逻辑为包括该时间,查询对应的时间为开始时间

2021-01-01 00:00:00

EndPeriod

string

否

格式:yyyy-MM-dd HH:mm:ss;查询逻辑为不包括该时间;为空表示截止到当前时间,查询对应的时间为结束时间

2021-01-02 00:00:00

PeriodType

string

是

MONTH:月维度; DAY:天维度; HOUR:小时维度

枚举值:

  • MONTH :

    MONTH

  • HOUR :

    HOUR

  • DAY :

    DAY

HOUR

BillOwnerId

integer

否

资源归属账号的 ID,资源归属账号是实际使用资源的账号;只支持传入 1 个账号

123745698925000

ResourceType

string

是

资源包类型,枚举值包括 RI/SCU;RI:预留实例; SCU:存储容量单位包

枚举值:

  • SCU :

    SCU

  • RI :

    RI

RI

返回参数

名称

类型

描述

示例值

object

(根节点)

Code

string

状态码

Success

Data

object

数据

PeriodCoverage

array<object>

时段使用率

object

(时段使用率)

Period

string

时段

2021071500

UsagePercentage

number

使用率

0.1

TotalUsage

object

总使用率

PostpaidCost

number

总按量实例成本

200

PotentialSavedCost

number

潜在总节省金额

100

ReservationCost

number

总资源购买费用

10

SavedCost

number

总节省金额

100

UsagePercentage

number

总使用率

1

Message

string

错误信息

Successful!

RequestId

string

请求 id

364C7C81-5E5E-51A0-B738-1969D2671B05

Success

boolean

是否成功

True

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Data": {
    "PeriodCoverage": [
      {
        "Period": "2021071500",
        "UsagePercentage": 0.1
      }
    ],
    "TotalUsage": {
      "PostpaidCost": 200,
      "PotentialSavedCost": 100,
      "ReservationCost": 10,
      "SavedCost": 100,
      "UsagePercentage": 1
    }
  },
  "Message": "Successful!",
  "RequestId": "364C7C81-5E5E-51A0-B738-1969D2671B05",
  "Success": true
}

错误码

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

变更历史

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