全部產品
Search
文件中心

ApsaraVideo VOD:DescribeVodDomainBpsDataByLayer

更新時間:Jul 21, 2026

呼叫此介面依通訊協定類型查詢加速網域的頻寬資料。

介面說明

  • 目前該介面服務地址僅支援:華東 2(上海)

  • 支援批次查詢,一次最多查詢 500 個網域資料。

  • 若您未指定 StartTimeEndTime,該介面預設返回過去 24 小時的資料;若指定 StartTimeEndTime,該介面則返回指定時間範圍內的資料。

返回資料時間粒度

根據您指定的 StartTimeEndTime 時間跨度,且未同時設定 Interval 的情況下,預設返回的資料時間粒度,以及對應的可查詢歷史資料時間範圍和資料延遲如下:

時間粒度單次查詢的時間跨度可查詢歷史資料時間範圍資料延遲
5 分鐘單次查詢的時間跨度 < 3 天93 天15 分鐘
1 小時3 天 ≤ 單次查詢的時間跨度 < 31 天186 天一般延遲 3-4 小時
1 天31 天 ≤ 單次查詢的時間跨度 ≤ 366 天366 天一般延遲 4 小時,不超過 24 小時

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vod:DescribeVodDomainBpsDataByLayer

get

*All Resource

*

請求參數

名稱

類型

必填

描述

樣本值

DomainName

string

要查詢的加速網域。

  • 若不傳入此參數,則預設返回所有加速網域的合併資料。

  • 支援批次查詢,多個網域之間請使用半形逗號(,)分隔,一次最多支援查詢 500 個網域。

  • 您可以登入影片點播主控台,從左側導覽列選擇配置管理 > 分發加速配置 > 網域管理,檢視您已接入影片點播的加速網域,或者呼叫 DescribeVodUserDomains 介面查詢加速網域清單。

example.com

StartTime

string

獲取資料的起始時間點。

日期格式遵循 ISO8601 標準,並使用 UTC 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。

2019-01-23T12:35:12Z

EndTime

string

獲取資料的結束時間點。

日期格式遵循 ISO8601 標準,並使用 UTC 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。

說明

結束時間必須大於起始時間。

2019-01-23T12:40:12Z

Interval

string

設定查詢資料的時間粒度。單位:秒。取值:300360086400。若未傳入或傳入的值不支援時,將使用預設值。根據您指定的 StartTimeEndTime 時間跨度,支援設定的時間粒度如下:

  • 3 天以內(不含 3 天整)支援:300(預設)、360086400

  • 3 至 31 天(不含 31 天整)支援:3600(預設)和 86400

  • 31 天以上支援:86400(預設)。

300

IspNameEn

string

電信業者英文名稱。若不傳入此參數,預設查詢所有電信業者。

unicom

LocationNameEn

string

地域英文名稱。若不傳入此參數,預設查詢所有地域。

beijing

Layer

string

通訊協定類型。可依網路層或應用層的維度指定查詢的通訊協定類型。

預設取值:

  • all:包含網路層和應用層

網路層取值:

  • IPv4

  • IPv6

應用層取值:

  • http

  • https

  • quic

IPv4

返回參數

名稱

類型

描述

樣本值

object

DataInterval

integer

每筆記錄的時間間隔,即資料的時間粒度。單位:秒。

300

RequestId

string

請求 ID。

25818875-5F78-4A*****F6-D7393642CA58

BpsDataInterval

object

DataModule

array<object>

每個時間間隔的每秒位元數 Bps 資料清單。

object

Value

number

峰值頻寬,單位:bps。

75.33

TrafficValue

integer

總流量,單位:位元組。

1000

TimeStamp

string

資料時間戳記。日期格式按照 ISO8601 標記法,並使用 UTC 時間。

2019-01-23T12:35:12Z

樣本

正常返回樣本

JSON格式

{
  "DataInterval": 300,
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "BpsDataInterval": {
    "DataModule": [
      {
        "Value": 75.33,
        "TrafficValue": 1000,
        "TimeStamp": "2019-01-23T12:35:12Z"
      }
    ]
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 InvalidStartTime.Malformed Specified StartTime is malformed.
400 InvalidEndTime.Malformed Specified EndTime is malformed.
400 InvalidEndTime.Mismatch StartTime or EndTime is mismatch.
400 InvalidStartTime.ValueNotSupported The specified start time has invalid value.

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

變更歷史

更多資訊,參考變更詳情