DescribeResourceCoverageTotal - 资源覆盖率汇总 - 阿里云交易和账单管理API

预留实例、SCU覆盖率汇总查询。

接口说明

与费用中心“资源实例管理”菜单中的“覆盖率概况”的汇总数据一致。当前支持 RI 和 SCU 两种资源的覆盖率查询。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
bssapi:DescribeResourceCoverageTotal	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
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：小时维度；	HOUR
BillOwnerId	long	否	资源归属账号的 ID，资源归属账号是实际使用资源的账号。	123745698925000
ResourceType	string	是	RI：预留实例；SCU：存储容量单位包	RI

返回参数

名称	类型	描述	示例值
	object
Code	string	状态码	Success
Message	string	错误信息	Successful!
RequestId	string	请求标识	79EE7556-0CFD-44EB-9CD6-B3B526E3A85F
Success	boolean	是否成功	true
Data	object	返回数据
PeriodCoverage	object []	时段覆盖率
CoveragePercentage	float	覆盖率	0.1
Period	string	时段 yyyyMMddHH	2020110100
TotalCoverage	object	总覆盖率
CapacityUnit	string	抵扣单位	算力*小时
DeductQuantity	float	总抵扣量	1
CoveragePercentage	float	总覆盖率	1
TotalQuantity	float	总使用量	1

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
  "Success": true,
  "Data": {
    "PeriodCoverage": [
      {
        "CoveragePercentage": 0.1,
        "Period": "2020110100"
      }
    ],
    "TotalCoverage": {
      "CapacityUnit": "算力*小时",
      "DeductQuantity": 1,
      "CoveragePercentage": 1,
      "TotalQuantity": 1
    }
  }
}

错误码

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