调用DescribeUserBandWidthData查询用户在指定时间段内使用的带宽信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ens:DescribeUserBandWidthData |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| EnsRegionId |
string |
否 |
节点 ID,仅支持传单个 ID,默认查询所有节点。 |
cn-taiyuan-telecom |
| InstanceId |
string |
否 |
获取指定数据的实例 ID,仅支持传单个 ID,默认查询所有实例。 |
i-5inkeimcipxk26yqtzm4q**** |
| StartTime |
string |
是 |
获取数据的起始时间点。
|
2019-05-21T10:22:00Z |
| EndTime |
string |
是 |
获取数据的结束时间点。
|
2019-05-21T12:22:00Z |
| Period |
string |
是 |
获取监控数据的精度,取值:300(默认值)、1200、3600、14400,单位:秒。 |
300 |
| Isp |
string |
否 |
运营商,取值如下所示:
|
cmcc |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
integer |
业务返回码,成功返回 0。 |
0 |
| MonitorData |
object |
监控数据信息。 |
|
| BandWidthMonitorData |
array<object> |
带宽监控数据。 |
|
|
object |
带宽监控数据。 |
||
| DownBandWidth |
integer |
下行带宽,单位:bit/s。 |
0 |
| InternetRX |
integer |
实例接收的公网数据流量,单位:bits。 |
0 |
| InternetTX |
integer |
实例发送的公网数据流量,单位:bits。 |
0 |
| TimeStamp |
string |
查询监控信息的时间戳,UTC 时间,格式为 yyyy-MM-DDThh:mm:ssZ。 |
2019-10-12T05:45:00Z |
| UpBandWidth |
integer |
上行带宽,单位:bit/s。 |
0 |
| MaxDownBandWidth |
string |
查询时间范围内最大下行带宽,单位:bit/s。 |
16817468 |
| MaxUpBandWidth |
string |
查询时间范围内最大上行带宽,单位:bit/s。 |
231008 |
| RequestId |
string |
请求 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 |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | MissingParameter | The input parameters that is mandatory for processing this request is not supplied. | |
| 400 | USERNOTFOUND | The user is not in ens-controller. | 当前用户未注册边缘节点服务或暂未通过用户审核。 |
| 400 | NoPermission | Permission denied. | |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。