DescribeUpBpsPeakData - 查询用户的每日上行带宽峰值

查询用户的每日上行带宽峰值

接口说明

调用接口查询用户的每日上行带宽峰值。

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeUpBpsPeakData

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

StartTime

string

拉流开始时间,UTC 格式,StartTime 和 EndTime 时间间隔在 30 天内。

2017-10-10T20:00:00Z

EndTime

string

拉流结束时间,UTC 格式, StartTime 和 EndTime 时间间隔在 30 天内,且 EndTime 超过当前时间。

2017-10-10T21:00:00Z

DomainSwitch

string

域名统计开关,取值:

  • on:开启域名统计级别。

  • off:用户级别数据。默认统计用户级别数据。

on

DomainName

string

加速域名。

example.com

返回参数

名称

类型

描述

示例值

object

带宽信息。

RequestId

string

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F****

DescribeUpPeakTraffics

object

DescribeUpPeakTraffic

array<object>

每日上行峰值带宽信息

object

每日上行峰值带宽信息

QueryTime

string

查询的每日时间。

1522080000000

BandWidth

string

每日峰值上行峰值带宽。

777.2727083333333

StatName

string

计数据属性名称。当 DomainSwitch 取值为 on 时,显示用户直播域名;为 off 或者不传值是显示用户 Id。

push-live.aliyuncs.com

PeakTime

string

每日峰值上行带宽的峰值时刻。

1522180000000

示例

正常返回示例

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****",
  "DescribeUpPeakTraffics": {
    "DescribeUpPeakTraffic": [
      {
        "QueryTime": "1522080000000",
        "BandWidth": "777.2727083333333",
        "StatName": "push-live.aliyuncs.com",
        "PeakTime": "1522180000000"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidStartTime.Malformed The specified StartTime is invalid.
400 InvalidEndTime.Malformed Specified EndTime is malformed.
401 IllegalOperation %s
500 InternalError %s
404 InvalidCaster.NotFound %s

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

变更历史

更多信息,参考变更详情