全部產品
Search
文件中心

ENS:DescribeUserBandWidthData - 查詢頻寬監控資料

更新時間:Mar 20, 2026

調用DescribeUserBandWidthData查詢使用者在指定時間段內使用的頻寬資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ens:DescribeUserBandWidthData

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

EnsRegionId

string

節點 ID,僅支援傳單個 ID,預設查詢所有節點。

cn-taiyuan-telecom

InstanceId

string

擷取指定資料的執行個體 ID,僅支援傳單個 ID,預設查詢所有執行個體。

i-5inkeimcipxk26yqtzm4q****

StartTime

string

擷取資料的起始時間點。

  • 按照 ISO8601 標準表示,並需要使用 UTC 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。

  • 如果秒不是 00,則自動取為下一分鐘開始時。

2019-05-21T10:22:00Z

EndTime

string

擷取資料的結束時間點。

  • 按照 ISO8601 標準表示,並需要使用 UTC 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。

  • 如果秒不是 00,則自動取為下一分鐘開始時。

2019-05-21T12:22:00Z

Period

string

擷取監控資料的精度,取值:300(預設值)、1200、3600、14400,單位:秒。

300

Isp

string

電訊廠商,取值如下所示:

  • cmcc:移動。

  • telecom:電信。

  • unicom:聯通。

  • multiCarrier:多線。

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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情