文档

QueryDPUtilizationDetail - 资源包用量查询

更新时间:

查询资源包(包含RI、scu)的使用量情况。

接口说明

限制:

  • 仅支持查询最近 1 年的用量记录

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
InstanceIdstring

筛选查询的实例 ID,为空时返回所有的使用的实例明细。

oss-123123
InstanceSpecstring

实例对应的规格。

Instancetyp
CommodityCodestring

商品 code,如 ecsRi、scu_bag 等。如果填写该字段,则 prodCode 字段不生效

ecsRi
DeductedInstanceIdstring

被抵扣实例的 ID,为空时返回所有实例的明细数据。

oss-123123
StartTimestring

开始时间,格式:YYYY-MM-dd HH:mm:ss。

2019-05-23 12:00:00
EndTimestring

结束时间,格式:YYYY-MM-dd HH:mm:ss。

2019-05-23 12:00:00
LastTokenstring

查询从 LastToken 之后开始返回。第一次查询填 null,之后的从结果 NextToken 获取

CAESF***zNTAw
Limitinteger

每次查询条数,默认为 20,最大值为 300。

20
IncludeShareboolean

是否包含财务云子账号的资源包用量

  • true:包含
  • false:不包含
true
ProdCodestring

产品 code,如:ecs

oss

返回参数

名称类型描述示例值
object
Codestring

状态码。

Success
Messagestring

错误信息。

Successful!
RequestIdstring

请求 ID。

DF58589C-A06C-4224-8615-7797E6474FA3
Successboolean

是否成功。

true
Dataobject

返回数据。

NextTokenstring

下次请求查询开始标识,填充到 request 的 LastToken 字段中。如果返回为 null,则标识查询结束

CAESF***zNTAw
DetailListobject []

明细数组。

DeductedInstanceIdstring

被抵扣实例 ID。

oss-123123
InstanceIdstring

预留实例 ID。

oss-123123
DeductHoursfloat

抵扣系数。 仅当 CommodityCode 为 ecsRi 有效。

24
ShareUidlong

抵扣实例所属 uid

  • 共享抵扣:抵扣实例所属 uid
  • 非共享抵扣:等于 uid 字段
1111111111
DeductDatestring

抵扣日期。

2019/5/23 12:00
InstanceSpecstring

被抵扣实例的规格。

rds.mysql.s3.large
DeductedCommodityCodestring

被抵扣商品 code。

rds
DeductedProductDetailstring

被抵商品(产品明细)名称。

云数据库RDS
DeductMeasurefloat

原始计量量

1
Regionstring

计量中 region,可以是空

cn-hangzhou
DeductQuantityfloat

实际抵扣对应按量实例的算力或容量。

1
DeductFactorTotalfloat

RI 或 SCU 在该时间段的算力或容量总量。

1
ResCodestring

计费项

PutRequest
Uidlong

被抵扣实例的 uid

1111111111

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "DF58589C-A06C-4224-8615-7797E6474FA3",
  "Success": true,
  "Data": {
    "NextToken": "CAESF***zNTAw",
    "DetailList": {
      "DetailList": [
        {
          "DeductedInstanceId": "oss-123123",
          "InstanceId": "oss-123123",
          "DeductHours": 24,
          "ShareUid": 1111111111,
          "DeductDate": "2019/5/23 12:00",
          "InstanceSpec": "rds.mysql.s3.large",
          "DeductedCommodityCode": "rds",
          "DeductedProductDetail": "云数据库RDS",
          "DeductMeasure": 1,
          "Region": "cn-hangzhou ",
          "DeductQuantity": 1,
          "DeductFactorTotal": 1,
          "ResCode": "PutRequest",
          "Uid": 1111111111
        }
      ]
    }
  }
}

错误码

HTTP status code错误码错误信息描述
400InternalErrorAn error occurred in the internal server.-
400InvalidOwnerThe specified owner does not belong to caller.指定的所有者不属于调用方。
400InvalidParameterThe specified request contains invalid parameters.请求中包含无效参数。
400MissingParameterThe specified request lacks essential parameters.该请求缺少必要参数。
400NotApplicableThe specified API is not applicable for the user.此API不适用于调用方。
400NotAuthorizedThe user is not authorized for the specified API.此API未对该调用者进行授权。
400InvalidInstanceSpecThe specified Instance specification is not valid.实例规格无效
400InvalidQueryTimeThe specified start time and end time are incorrect开始时间或结束时间格式错误
400CommodityNotSupportedThe specified commodity is not supported.商品code无效

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈