全部產品
Search
文件中心

ApsaraVideo Live:DescribeLiveStreamPushMetricDetailData

更新時間:Jun 16, 2026

查詢指定網域推流 app 及流粒度資料。

介面說明

  • 僅支援單個網域查詢,多個網域會報錯。

  • 資料最大查詢跨度:24 小時。

  • 資料最小查詢粒度:1 分鐘。

  • 資料最大查詢範圍:31 天。

  • 本介面為監控資料介面,資料採集處理方式不同於計費,不能用於計算用量進行對帳參考。

QPS 限制

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

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:DescribeLiveStreamPushMetricDetailData

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

地域 ID。

cn-shanghai

DomainName

string

  • 需要查詢的加速網域。僅支援單個網域查詢,傳多個網域將報錯。

  • 不指定 AppName 和 StreamName 時,按指定加速網域返回此網域下所有流粒度的資料,所有查詢資料不聚合。

  • DomainName 不為空且 AppName 為 all 和 StreamName 為 all 時,返回指定加速網域下所有流粒度的聚合資料。

example.com

StartTime

string

取得資料起始時間點,日期格式按照 ISO8601 表示法,並使用 UTC 時間。

格式為:YYYY-MM-DDThh:mm:ssZ。

2022-09-10T20:00:00Z

EndTime

string

取得資料結束時間點,日期格式按照 ISO8601 表示法,並使用 UTC 時間,結束時間需大於起始時間,且不能相差超過 1 天。

格式為:YYYY-MM-DDThh:mm:ssZ。

2022-09-10T21:00:00Z

AppName

string

直播流所屬應用名稱。指定應用名稱,查詢對應應用流粒度的資料。

liveApp****

StreamName

string

直播流名稱。指定 StreamName 時,按指定 AppName 的指定 StreamName,返回流粒度的資料(指定 StreamName 時,必須指定 AppName)。

liveStream****

NextPageToken

string

分頁查詢 token,每次查詢最多返回 5000 行資料,當要查詢的資料超過 5000 行時,回應資料會提供下次查詢資料的起始索引。

請求時傳入該 token,將從上一次查詢結束的下一行繼續查詢未取得的資料。

UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=

返回參數

名稱

類型

描述

樣本值

object

返回結果。

DomainName

string

加速網域資訊。

example.com

EndTime

string

取得資料結束時間點,日期格式按照 ISO8601 表示法,並使用 UTC 時間。

格式為:YYYY-MM-DDThh:mm:ssZ。

2022-09-10T21:00:00Z

NextPageToken

string

分頁查詢 token,每次查詢最多返回 5000 行資料,當要查詢的資料超過 5000 行時,回應資料會提供下次查詢資料的起始索引。

請求時傳入該 token,將從上一次查詢結束的下一行繼續查詢未取得的資料。

UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=

PageSize

integer

返回資料行數。

5000

RequestId

string

請求 ID。

5EBF2AC3-4B73-40A5-8B32-83F49D5F035E

StartTime

string

取得資料起始時間點,日期格式按照 ISO8601 表示法,並使用 UTC 時間。

格式為:YYYY-MM-DDThh:mm:ssZ。

2022-09-10T20:00:00Z

StreamDetailData

object

StreamData

array<object>

返回資料組。

object

返回資料組。

AppName

string

應用程式名稱。

liveApp****

ReqBps

number

流每分鐘總頻寬,單位:Bps。

133.33

ReqTraffic

integer

流每分鐘總流量,單位:Byte。

1000

StreamName

string

流名稱。

liveStream****

TimeStamp

string

時間片起始時刻。

2022-09-10T20:00:00Z

樣本

正常返回樣本

JSON格式

{
  "DomainName": "example.com",
  "EndTime": "2022-09-10T21:00:00Z",
  "NextPageToken": "UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=",
  "PageSize": 5000,
  "RequestId": "5EBF2AC3-4B73-40A5-8B32-83F49D5F035E",
  "StartTime": "2022-09-10T20:00:00Z",
  "StreamDetailData": {
    "StreamData": [
      {
        "AppName": "liveApp****",
        "ReqBps": 133.33,
        "ReqTraffic": 1000,
        "StreamName": "liveStream****",
        "TimeStamp": "2022-09-10T20:00:00Z"
      }
    ]
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 InvalidStartTime.Malformed Specified StartTime is malformed.
400 InvalidEndTime.Malformed Specified EndTime is malformed.
400 InvalidTime.Malformed Specified StartTime or EndTime is malformed.
400 InvalidEndTime.Mismatch Specified end time does not math the specified start time.
400 InvalidTimeSpan The time span exceeds the limit.
400 InvalidPageToken The token of page is invalid.
400 InvalidAppName.Mismatch The AppName param must be passed.
400 InvalidStreamProtocol.NotSupport The specified stream protocol is not support.
400 InvalidStreamName.LengthTooLong The specified stream name is too long.
400 InvalidAppName.LengthTooLong The specified app name is too long.
400 InvalidTime.ValueNotSupported Specified Time is malformed.

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

變更歷史

更多資訊,參考變更詳情