GetOssUsageData - 查询存储和带宽用量

调用GetOssUsageData查询时间段内的存储、带宽用量的计算值。

接口说明

带宽和存储用量查询聚合粒度不可超过一天,聚合数据处理是将一段时间内点位数据分别取最大值。

调试

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

授权信息

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

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

请求参数

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

起始时间点,UTC 时间,格式:2010-01-21T09:50:23Z。

2022-01-11T00:00:00Z
EndTimestring

结束时间点,UTC 时间,格式:2010-01-21T09:50:23Z。

2022-01-12T00:00:00Z
Bucketstring

OSS 逻辑 bucket 名称。

ens-sink-bucketzyp1656903494
Periodstring

时间聚合粒度,单位:分钟。

默认为 5 分钟,取值范围:5~1440。

10

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

2A8CCD48-14F9-0309-B957-7B1D74A8119D
UsageListarray<object>

用量数组。

UsageListobject

用量对象。

LanRxBwlong

内网入向带宽,单位:Bps。

37865147
LanTxBwlong

内网出向带宽,单位:Bps。

22012187890
Pointlong

一天内的时间点编号。

144
PointTsstring

时间点,UTC 时间,格式:2010-01-21T09:50:23Z。

2022-01-12T00:00:00Z
StorageUsageBytelong

存储用量,单位:byte。

85462146217
WanRxBwlong

外网入向带宽,单位:Bps。

542155715
WanTxBwlong

外网出向带宽,单位:Bps。

547126175217

示例

正常返回示例

JSON格式

{
  "RequestId": "2A8CCD48-14F9-0309-B957-7B1D74A8119D",
  "UsageList": [
    {
      "LanRxBw": 37865147,
      "LanTxBw": 22012187890,
      "Point": 144,
      "PointTs": "2022-01-12T00:00:00Z",
      "StorageUsageByte": 85462146217,
      "WanRxBw": 542155715,
      "WanTxBw": 547126175217
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ParamNotEnough参数不足-
400ParamScopeError参数值错误-
400ParamTypeError参数类型错误-
400SqlError数据库操作异常-
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

变更历史

变更时间变更内容概要操作
2024-01-22OpenAPI 错误码发生变更查看变更详情