全部產品
Search
文件中心

:DescribeVodDomainUsageData - 查詢流量頻寬用量

更新時間:Dec 15, 2025

調用本介面查詢加速流量或頻寬用量資料。

介面說明

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

  • 支援批量網域名稱查詢,多個網域名稱用逗號半形(,)分隔,最多可以一次查詢 100 個網域名稱。如果為空白則返回帳號下所有網域名稱的資料。

  • 最長可查詢近 1 年的資料,單次查詢跨度最長為 3 個月,查詢時間為 1-3 天時,資料按小時粒度返回,查詢時間大於 4 天,資料按天粒度返回。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vod:DescribeVodDomainUsageData

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

DomainName

string

加速網域名稱。若參數為空白,預設返回所有加速網域名稱合并後資料。支援批量查詢,多個用半形逗號(,)分隔。

example.com

StartTime

string

擷取資料起始時間點。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2015-12-10T10:20:00Z

EndTime

string

擷取資料結束時間點,需晚於起始時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2015-12-10T12:20:00Z

Field

string

資料類型。取值:

  • bps:頻寬。

  • traf:流量。

bps

Type

string

需要擷取的用量類型。取值:

  • static:靜態。

  • dynamic:動態。

  • all:全部。

static

Area

string

地區代號。預設為 CN 中國大陸。取值:

  • CN:中國大陸。

  • OverSeas:海外地區。

CN

Interval

string

強制指定擷取指定時間粒紋的資料,單位為秒。支援 300(5 分鐘)、3600(1 小時)和 86400(1 天)。

  • Interval=300:最長可查詢最近半年的資料,單次查詢的時間跨度最長為 3 天。

  • Interval=360086400:最長可查詢最近 1 年的資料。

  • 不指定 Interval:單次查詢跨度最長為 1 個月。當查詢時間為 1~3 天時,資料按小時粒度返回;當查詢時間為 4 天及以上時,資料按天粒度返回。

300

返回參數

名稱

類型

描述

樣本值

object

EndTime

string

結束時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2015-12-10T12:20:00Z

Type

string

資料類型。取值:

  • bps:頻寬。

  • traf:流量。

bps

StartTime

string

開始時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2015-12-10T10:20:00Z

RequestId

string

請求 ID。

B955107D-E658-4E77-****-E0AC3D31693E

Area

string

用量地區。

CN

DomainName

string

加速網域名稱資訊。

example.com

DataInterval

string

每條記錄的時間間隔。單位:秒。

300

UsageDataPerInterval

object

DataModule

array<object>

流量或頻寬用量資料。

object

Value

string

流量或頻寬用量。單位:bit/second。

2592.3920000000003

TimeStamp

string

時間片起始時刻。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2015-12-10T10:00:00Z

樣本

正常返回樣本

JSON格式

{
  "EndTime": "2015-12-10T12:20:00Z",
  "Type": "bps",
  "StartTime": "2015-12-10T10:20:00Z",
  "RequestId": "B955107D-E658-4E77-****-E0AC3D31693E",
  "Area": "CN",
  "DomainName": "example.com",
  "DataInterval": "300",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "Value": "2592.3920000000003",
        "TimeStamp": "2015-12-10T10:00:00Z"
      }
    ]
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 InvalidParameter The specified parameter is not valid. 參數無效。
400 InvalidParameterProduct The specified parameter Product is invalid. 指定的Product參數不合法,請參照文檔修改。
400 InvalidParameterArea The specified parameter Area is invalid. 指定的Area參數非法,請根據API文檔修改。
400 InvalidParameterField The specified parameter Field is invalid. 指定的Field參數非法,請參照API文檔修改。
400 InvalidStartTime.Malformed Specified StartTime is malformed. 開始時間格式錯誤。
400 InvalidEndTime.Malformed Specified EndTime is malformed. 結束時間格式錯誤。
400 InvalidEndTime.Mismatch StartTime or EndTime is mismatch. 開始時間與結束時間不匹配
400 InvalidParameterInterval The specified Interval is invalid. 指定的時間粒紋無效,請根據API文檔輸入所需的時間粒紋。

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

變更歷史

更多資訊,參考變更詳情