文档

DescribeUserBandWidthData - 查询带宽监控数据

更新时间:

调用DescribeUserBandWidthData查询用户在指定时间段内使用的带宽信息。

调试

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

授权信息

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

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

请求参数

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

节点 ID,仅支持传单个 ID,默认查询所有节点。

cn-taiyuan-telecom
InstanceIdstring

获取指定数据的实例 ID,仅支持传单个 ID,默认查询所有实例。

i-5inkeimcipxk26yqtzm4q****
StartTimestring

获取数据的起始时间点。

  • 按照 ISO8601 标准表示,并需要使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

  • 如果秒不是 00,则自动取为下一分钟开始时。

2019-05-21T10:22:00Z
EndTimestring

获取数据的结束时间点。

  • 按照 ISO8601 标准表示,并需要使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

  • 如果秒不是 00,则自动取为下一分钟开始时。

2019-05-21T12:22:00Z
Periodstring

获取监控数据的精度,取值:300(默认值)、1200、3600、14400,单位:秒。

300
Ispstring

运营商,取值如下所示:

  • cmcc:移动。
  • telecom:电信。
  • unicom:联通。
  • multiCarrier:多线。
cmcc

返回参数

名称类型描述示例值
object
Codeinteger

业务返回码,成功返回 0。

0
MonitorDataobject

监控数据信息。

BandWidthMonitorDataobject []

带宽监控数据。

DownBandWidthlong

下行带宽,单位:bit/s。

0
InternetRXlong

实例接收的公网数据流量,单位:bits。

0
InternetTXlong

实例发送的公网数据流量,单位:bits。

0
TimeStampstring

查询监控信息的时间戳,UTC 时间,格式为 yyyy-MM-DDThh:mm:ssZ。

2019-10-12T05:45:00Z
UpBandWidthlong

上行带宽,单位:bit/s。

0
MaxDownBandWidthstring

查询时间范围内最大下行带宽,单位:bit/s。

16817468
MaxUpBandWidthstring

查询时间范围内最大上行带宽,单位:bit/s。

231008
RequestIdstring

请求 ID。

50373E71-7710-4620-8AAB-133CCE49451C

示例

正常返回示例

JSON格式

{
  "Code": 0,
  "MonitorData": {
    "BandWidthMonitorData": [
      {
        "DownBandWidth": 0,
        "InternetRX": 0,
        "InternetTX": 0,
        "TimeStamp": "2019-10-12T05:45:00Z",
        "UpBandWidth": 0
      }
    ],
    "MaxDownBandWidth": "16817468",
    "MaxUpBandWidth": "231008"
  },
  "RequestId": "50373E71-7710-4620-8AAB-133CCE49451C"
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe input parameters that is mandatory for processing this request is not supplied.-
400USERNOTFOUNDThe user is not in ens-controller.-
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

变更历史

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