DescribeEpnBandWidthData - 查询边边网络带宽用量

调用DescribeEpnBandWidthData查询边边网络带宽用量。

调试

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

授权信息

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

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

请求参数

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

ENS 节点 ID。

cn-beijing-cmcc
InstanceIdstring

实例 ID。

i-5sg1owx0g4ojy66ab2tez77r2
StartTimestring

获取数据的起始时间点。

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

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

2021-12-15T16:00:00Z
EndTimestring

获取数据的结束时间点。

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

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

2021-12-16T16:00:00Z
Periodstring

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

300
Ispstring

运营商,取值如下所示:

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

组网模式。取值:

  • SpeedUp:智能加速(外网)。
  • Connection:内网联通(内网模式)。
  • SpeedUpAndConnection:智能加速及内网联通(内网模式)。
SpeedUp
EPNInstanceIdstring

边边网络实例 ID。

epn-20200825134537VyK81T

返回参数

名称类型描述示例值
object
MonitorDataobject

实例的监控数据集合。

BandWidthMonitorDataarray<object>

带宽监控数据。

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
MaxDownBandWidthlong

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

16817468
MaxUpBandWidthlong

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

231008
RequestIdstring

请求 ID。

1D289DAA-F6DA-5FC4-AE47-F5C8B6277BFC

示例

正常返回示例

JSON格式

{
  "MonitorData": {
    "BandWidthMonitorData": [
      {
        "DownBandWidth": 0,
        "InternetRX": 0,
        "InternetTX": 0,
        "TimeStamp": "2019-10-12T05:45:00Z",
        "UpBandWidth": 0
      }
    ],
    "MaxDownBandWidth": 16817468,
    "MaxUpBandWidth": 231008
  },
  "RequestId": "1D289DAA-F6DA-5FC4-AE47-F5C8B6277BFC"
}

错误码

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.-

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

变更历史

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