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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeUserBandWidthData

系统规定参数,取值:DescribeUserBandWidthData

Period String 300

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

Version String 2017-11-10

版本号。

StartTime String 2019-05-21T10:22:00Z

获取数据的起始时间点。

  • 按照ISO8601标准表示,并需要使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。
  • 如果秒不是00,则自动取为下一分钟开始时。
EndTime String 2019-05-21T12:22:00Z

获取数据的结束时间点。

  • 按照ISO8601标准表示,并需要使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。
  • 如果秒不是00,则自动取为下一分钟开始时。
EnsRegionId String cn-taiyuan-telecom

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

InstanceId String i-5inkeimcipxk26yqtzm4q****

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

返回数据

名称 类型 示例值 描述
Code Integer 0

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

MonitorData Struct

监控数据信息。

BandWidthMonitorData Array

带宽监控数据。

DownBandWidth Integer 0

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

InternetRX Integer 0

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

InternetTX Integer 0

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

TimeStamp String 2019-10-12T05:45:00Z

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

UpBandWidth Integer 0

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

MaxDownBandWidth String 16817468

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

MaxUpBandWidth String 231008

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

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

请求ID。

示例

请求示例

https://ens.aliyuncs.com/?Action=DescribeUserBandWidthData
&StartTime=2014-10-29T23:00:00Z
&EndTime=2014-10-30T08:00:00Z
&Version=2017-11-10
&Period=300
&<公共请求参数>

正常返回示例

XML 格式

<DescribeUserBandWidthDataResponse>
  <code>200</code>
      <RequestId>50373E71-7710-4620-8AAB-133CCE49451C</RequestId>
      <MonitorData>
            <MaxDownBandWidth>16817468</MaxDownBandWidth>
            <MaxUpBandWidth>231008</MaxUpBandWidth>
            <BandWidthMonitorData>
                  <UpBandWidth>0</UpBandWidth>
                  <DownBandWidth>0</DownBandWidth>
                  <InternetTX>0</InternetTX>
                  <InternetRX>0</InternetRX>
                  <TimeStamp>2019-10-12T05:45:00Z</TimeStamp>
            </BandWidthMonitorData>
      </MonitorData>
      <Code>0</Code>
  <requestId>50373E71-7710-4620-8AAB-133CCE49451C</requestId>
  <successResponse>true</successResponse>
</DescribeUserBandWidthDataResponse>

JSON 格式

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

错误码

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