DescribeLiveUserStreamMetricData - ApsaraVideo Live

用於查詢指定加速網域下的流粒度批量資料，支援多種協定。

介面說明

說明

暫不支援 HLS 協定新建連線數查詢，HLS 的並行連線數按照預設格式的請求進行統計，特殊格式的請求需提交工單進行配置。預設格式如下：

m3u8 請求示例：http(s)://example.aliyundoc.com/Appname/ StreamName.m3u8
ts 請求示例：http(s)://example.aliyundoc.com/Appname/ StreamName/153xxxxxxxx_137xxxxx.ts。

請求說明

單次查詢限制：單次查詢最多返回 5000 行資料。
網域查詢限制：僅支援單個網域查詢，多個網域會報錯。
時間跨度限制：資料最大查詢跨度為 24 小時。
時間粒度限制：資料最小查詢粒度為 1 分鐘。
查詢範圍限制：資料最大查詢範圍為 31 天。
呼叫頻率限制：單使用者呼叫頻率為 10 次/秒。
特殊參數組合：當DomainName不為空且AppName和StreamName都設置為all時，將返回加速網域下的聚合資料。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:DescribeLiveUserStreamMetricData

none

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
DomainName	string	否	需要查詢的加速網域。說明僅支援單個網域查詢，傳多個網域將報錯。網域為空時，查詢使用者下的所有加速網域的聚合資料。不指定 `AppName` 和 `StreamName` 時，按網域返回所有流粒度的資料。	test.com
StartTime	string	是	取得資料起始時間點，日期格式按照 ISO8601 表示法，並使用 UTC 時間。格式為：`YYYY-MM-DDThh:mm:ssZ`。	2015-12-10T20:00:00Z
EndTime	string	是	結束時間需大於起始時間，不能相差超過 1 天；日期格式按照 ISO8601 表示法，並使用 UTC 時間。格式為：`YYYY-MM-DDThh:mm:ssZ`。	2015-12-10T21:00:00Z
AppName	string	否	應用名稱。指定應用名稱，查詢對應應用流粒度的資料；指定 `StreamName` 時，必須指定 `AppName`。	app
StreamName	string	否	流名稱。指定 `StreamName` 時，按指定 `AppName` 的指定 `StreamName`，返回流粒度的資料（指定 `StreamName` 時，必須指定 `AppName`）。	test.flv
Protocol	string	否	流協定名。指定流協定名查詢流對應協定的資料，目前支援：`flv`, `hls`, `rtmp`, `rts`, `p2p`。支援查詢多個協定的資料，協定間用 `,` 分隔，多個協定的資料不會聚合，按照流的粒度輸出。說明 rts 選項可查詢 artc 協定的超低延時直播流。使用 rts 可能需要額外統計 xxx_AliRTS-opu 轉碼流。原因：Web 端播超低延時直播時，會生成流名後加上_AliRTS-opus 後綴的轉碼流進行自動轉碼，產生轉碼流資料。詳細請參見 rts 亞秒延時自動轉碼。	flv
PageNumber	integer	是	當前頁碼。	1
PageSize	integer	是	單頁資料條數，單頁最大 5000。	10

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
DomainName	string	加速網域資訊。	test.com
EndTime	string	YYYY-MM-DDThh:mm:ssZ	2015-12-10T21:00:00Z
PageSize	integer	每頁顯示的條數。	10
RequestId	string	請求 ID。	16A96B9A-F203-4EC5-8E43-CB92E68F****
StartTime	string	取得資料起始時間點，日期格式按照 ISO8601 表示法，並使用 UTC 時間。格式為：`YYYY-MM-DDThh:mm:ssZ`。	2015-12-10T20:00:00Z
StreamDetailData	array<object>	每個時間間隔的流量資料。
	object	返回資料組。
AppName	string	應用名稱，無論是否指定均返回該值。	app
Bps	number	流每分鐘總頻寬，單位`bps`。	423304182.66
Count	integer	流每分鐘總在並行連線數。說明並行連線數指單位時間內同一個流下對用戶端處理程序連線數的統計。	423304182
FlvBps	number	flv 協定頻寬，單位 bps（指定協定不滿足時，不返回）。	454
FlvCount	integer	flv 協定的並行連線數（指定協定不滿足時，不返回）。	32
FlvTraffic	number	flv 協定流量，單位 byte（指定協定不滿足時，不返回）。	1254
HlsBps	number	hls 協定頻寬，單位 bps（指定協定不滿足時，不返回）。	4456
HlsCount	integer	hls 協定的並行連線數（指定協定不滿足時，不返回）。	56
HlsTraffic	number	hls 協定流量，單位 byte（指定協定不滿足時，不返回）。	568
NewConns	integer	流每分鐘新建連線數。	450
P2pBps	number	p2p 協定頻寬，單位 bps（指定協定不滿足時，不返回）。	6845
P2pCount	integer	p2p 協定的並行連線數（指定協定不滿足時，不返回）。	78
P2pTraffic	number	p2p 協定流量，單位 byte（指定協定不滿足時，不返回）。	4102
RtmpBps	number	rtmp 協定頻寬，單位 bps（指定協定不滿足時，不返回）。	3323
RtmpCount	integer	rtmp 協定的並行連線數（指定協定不滿足時，不返回）。	63
RtmpTraffic	number	rtmp 協定流量，單位 byte（指定協定不滿足時，不返回）。	5568
RtsBps	number	rts 協定頻寬，單位 bps（指定協定不滿足時，不返回）。	2361
RtsCount	integer	rts 協定的並行連線數（指定協定不滿足時，不返回）。	89
RtsTraffic	number	rts 協定流量，單位 byte（指定協定不滿足時，不返回）。	2322
StreamName	string	流名稱，無論是否指定均返回該值。	test.flv
TimeStamp	string	時間片起始時刻。日期格式按照 ISO8601 表示法，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。	2015-12-10T20:00:00Z
Traffic	number	流每分鐘總流量，單位 byte。	423304182
TotalCount	integer	總條數。	50
PageNumber	integer	頁碼。	1

樣本

正常返回樣本

JSON格式

{
  "DomainName": "test.com",
  "EndTime": "2015-12-10T21:00:00Z",
  "PageSize": 10,
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****",
  "StartTime": "2015-12-10T20:00:00Z",
  "StreamDetailData": [
    {
      "AppName": "app",
      "Bps": 423304182.66,
      "Count": 423304182,
      "FlvBps": 454,
      "FlvCount": 32,
      "FlvTraffic": 1254,
      "HlsBps": 4456,
      "HlsCount": 56,
      "HlsTraffic": 568,
      "NewConns": 450,
      "P2pBps": 6845,
      "P2pCount": 78,
      "P2pTraffic": 4102,
      "RtmpBps": 3323,
      "RtmpCount": 63,
      "RtmpTraffic": 5568,
      "RtsBps": 2361,
      "RtsCount": 89,
      "RtsTraffic": 2322,
      "StreamName": "test.flv",
      "TimeStamp": "2015-12-10T20:00:00Z",
      "Traffic": 423304182
    }
  ],
  "TotalCount": 50,
  "PageNumber": 1
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	Meter.ParamError	Param Error:%s,Please Check Again.
500	Meter.ServerInternalError	The Request Processing Has Failed Due To Some Unknown Error.
500	Meter.DataSourceQueryError	Data Source Error:%s,Please Try Again.
403	Meter.AuthError	Authentication Failed,Please Try Again.
502	Meter.ReadyTsError	Get ReadyTs Failed,Please Try Again.

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

變更歷史

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