全部產品
Search

搜尋本產品

    ApsaraVideo Live：DescribeDomainUsageData

    文件中心

    ApsaraVideo Live：DescribeDomainUsageData

    更新時間：Jul 20, 2026

    呼叫 DescribeDomainUsageData 查詢網域名稱在特定計費區域的用量資料。

    介面說明

    • 此介面支援批量網域名稱查詢，多個網域名稱用英文逗號（,）分隔，最多一次可以查詢 100 個網域名稱。如果 DomainName 參數為空，則返回帳號下所有網域名稱的資料。

    • 用量資料包括流量、頻寬和請求數三類，單位分別為 Byte、bps 和次數。

    • 如果不指定 Interval 參數，最長可查詢近 1 年的資料，單次查詢的最大時間跨度為 31 天。查詢時間為 1~3 天，資料按小時粒度返回；查詢時間大於 3 天，資料按天粒度返回。

    • 指定 Interval 參數時，支援單次查詢的時間跨度、對應的可查詢歷史資料時間範圍和資料延遲如下：

    時間粒度單次查詢的最大時間跨度可查詢歷史資料時間範圍資料延遲
    5 分鐘3 天93 天15 分鐘
    1 小時31 天186 天4 小時
    1 天90 天366 天次日凌晨 4 點

    QPS 限制

    本介面的單使用者 QPS 限制為 10 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理呼叫。

    調試

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

    調試

    授權資訊

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

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

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:DescribeDomainUsageData

    get

    *全部資源。

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地域 ID。

    cn-shanghai
    DomainName

    string

    否

    直播網域名稱。

    • 支援單個或批量網域名稱查詢。批量查詢時多個網域名稱用英文逗號（,）分隔。

    • 若參數為空，預設返回所有直播網域名稱合併後的資料。

    example.com
    StartTime

    string

    是

    起始時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2015-12-10T20:00:00Z
    EndTime

    string

    是

    結束時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    需大於起始時間，且與起始時間相差不能超過 31 天。

    2015-12-10T21:00:00Z
    Type

    string

    否

    需要獲取的用量類型。

    當 Field 取值為 bps 或 traf 時，該參數取值範圍：

    • rts：RTS 頻寬或流量。

    • quic：QUIC 頻寬或流量。

    當 Field 取值為 req_traf 或 req_bps 時，該參數取值範圍：

    • push：推流頻寬或流量。

    • push_proxy：轉推頻寬或流量。

    枚舉值：

    • rts :

      RTS 頻寬或流量。

    • all :

      全部。

    • normal :

      normal 類型。

    • static :

      靜態。

    • dynamic :

      動態。

    • push_proxy :

      轉推頻寬或流量。

    • quic :

      QUIC 頻寬或流量。

    • push :

      推流頻寬或流量。

    all
    Field

    string

    是

    查詢用量的資料類型。取值：

    • bps：播放頻寬。

    • traf：流量。

    • req_traf：當 Type 為 push 時，為推流流量，當 Type 為 push_proxy 時，為轉推流量。

    • req_bps：當 Type 為 push 時，為推流頻寬，當 Type 為 push_proxy 時，為轉推頻寬。

    traf
    Area

    string

    否

    區域代號。支援：

    • CN：中國內地。

    • OverSeas：海外大區。

    • AP1：亞太 1 區。

    • AP2：亞太 2 區。

    • AP3：亞太 3 區。

    • NA：北美。

    • SA：南美。

    • EU：歐洲。

    • MEAA：中東非洲。

    • all：全部。

    說明

    不傳值則預設為中國內地。海外大區說明：- 亞太 1 區：中國香港地區、中國澳門地區、中國台灣地區、日本以及東南亞除越南和印尼之外的國家。- 亞太 2 區：印尼、韓國、越南。- 亞太 3 區：澳大利亞、紐西蘭。北美：美國、加拿大。- 南美：巴西。- 歐洲：烏克蘭、英國、法國、荷蘭、西班牙、義大利、瑞典、德國。- 中東非洲：南非、阿曼、阿聯酋、科威特。

    CN
    DataProtocol

    string

    否

    需要獲取的資料的通訊協定。取值：

    • http：HTTP 通訊協定。

    • https：HTTPS 通訊協定。

    • quic：QUIC 通訊協定。

    • all（預設）：以上全部通訊協定。

    all
    Interval

    string

    否

    強制指定獲取指定時間粒度的資料，單位為秒。支援 300（5 分鐘）、3600（1 小時）和 86400（1 天）。

    300
    說明

    介面查詢 T 時刻資料時，T+N 時刻可獲取到穩態資料，N 為 2 小時。
    範例：當您查詢 12 月 21 日下午 1 點鐘資料，可在 12 月 21 日下午 3 點鐘獲取到 1 點及 1 點前的穩態資料。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    EndTime

    string

    結束時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2015-12-10T21:00Z
    Type

    string

    用量類型。

    all
    StartTime

    string

    開始時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2015-12-10T20:00Z
    RequestId

    string

    請求 ID。

    B955107D-E658-4E77-B913-E0AC3D31693E
    Area

    string

    用量區域。

    CN
    DomainName

    string

    直播網域名稱。

    example.com
    DataInterval

    string

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

    300
    UsageDataPerInterval

    object

    DataModule

    array<object>

    每條記錄的流量資料。

    object

    Value

    string

    用量。

    • 當 Field 為 traf 或 req_traf 時單位是位元組（Byte）。

    • 當 Field 為 bps 或 req_bps 時單位是 bps。

    • 當 Field 為 acc 時單位是次數。

    423304182
    TimeStamp

    string

    時間片起始時刻。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2015-12-10T20:00:00Z

    樣本

    正常返回樣本

    JSON格式

    {
  "EndTime": "2015-12-10T21:00Z",
  "Type": "all",
  "StartTime": "2015-12-10T20:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "Area": "CN",
  "DomainName": "example.com",
  "DataInterval": "300",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "Value": "423304182",
        "TimeStamp": "2015-12-10T20:00:00Z"
      }
    ]
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvaildParameter Invalid Parameter 您輸入的參數無效，請檢查輸入的參數是否完整正確。
    400 InvalidStartTime.Malformed Specified StartTime is malformed.
    400 InvalidEndTime.Malformed Specified EndTime is malformed.
    400 InvalidStartTime.ValueNotSupported The specified value of parameter StartTime is not supported. 傳入的 StartTime 參數不支援。
    400 InvalidTime.Malformed Specified Time is malformed. StartTime和EndTime間隔無效，請檢查後重試。
    400 InvalidParameterField The specified Field is invalid. Field參數錯誤，請確認後輸入。
    400 InvalidParameterType The specified Type is invalid. Type參數錯誤，請確認後輸入。
    400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. 結束時間與開始時間不匹配，請您確認時間的匹配度。
    400 InvalidTimeSpan The time span exceeds the limit. 時間跨度超過限制，請參照介面文件，設定合理查詢跨度。

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

    變更歷史

    更多資訊，參考變更詳情。