使用DescribeLiveStreamMetricDetailData批量查詢指定網域名稱的流粒度監控資料-ApsaraVideo for Live-阿里雲 - ApsaraVideo Live

呼叫 DescribeLiveStreamMetricDetailData 查詢指定網域名稱流粒度批次資料，單次查詢最多返回 5000 行資料。

介面說明

若指定網域名稱第一次使用此介面進行流粒度資料的查詢，需先提交工單進行後端配置後方可使用。請在工單中提供如下資訊：

需要查詢的網域名稱。
對應網域名稱下最高並行直播流數。
每個直播流最高並行線上人數。
對應用戶端請求包含的協議類型。

重要當前介面將於 2025 年 9 月 31 號不再進行維護，請及時切換到新版流粒度介面 DescribeLiveUserStreamMetricData ，新版流粒度介面無需後台配置即可使用。

。

使用限制

預設不支援 HLS 的線上人數統計。
僅支援單個網域名稱查詢。
資料最大查詢跨度：24 小時。
資料最小查詢粒度：1 分鐘。
資料最大查詢範圍：31 天。

QPS 限制

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:DescribeLiveStreamMetricDetailData

none

*Domain

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地域 ID。枚舉值： cn-shenzhen : cn-shenzhen	cn-shenzhen
DomainName	string	否	需要查詢的加速網域名稱。僅支援單個網域名稱查詢，傳多個網域名稱將報錯。不指定 AppName 和 StreamName 時，按網域名稱返回所有流粒度的資料。網域名稱為空時，查詢使用者下的所有加速網域名稱的聚合資料。 DomainName 不為空且 AppName 為 all 和 StreamName 為 all 時，返回指定加速網域名稱下的聚合資料。傳入 DomainName 時，請確保傳入網域名稱為直播網域名稱，同時呼叫本介面的使用者擁有傳入網域名稱的操作權限。	example.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。	liveApp****
StreamName	string	否	流名稱，按照設定的 AppName 指定 StreamName，返回流粒度的資料。說明指定 StreamName 時，必須指定 AppName。	liveStream****
Protocol	string	否	流協議名，目前支援：flv、hls、rtmp、rts 和 p2p。支援查詢多個協議的資料，不同協議之間用英文逗號（,）分隔。但多個協議的資料不會聚合，按照流的粒度輸出。說明 rts 選項可查詢 artc 協議的超低延時直播流。使用 rts 可能需要額外統計 xxx_AliRTS-opu 轉碼流。原因：Web 端播超低延時直播時，會產生流名後加上 _AliRTS-opus 後綴的轉碼流進行自動轉碼，產生轉碼流資料。詳細請參見rts 亞秒延時自動轉碼。	flv
NextPageToken	string	否	分頁查詢 token，每次查詢最多返回 5000 行資料，當要查詢的資料超過 5000 行時，回應資料會提供下次查詢資料的起始索引。請求時傳入該 token，將從上一次查詢結束的下一行繼續查詢未取得的資料。	UjsM9x3aVcJi9a0-ArwJUTTC67CIBKLw*****

返回參數

名稱	類型	描述	樣本值
	object	查詢資料。
DomainName	string	查詢的加速網域名稱。	example.com
EndTime	string	結束時間。日期格式按照 ISO8601 表示法，並使用 UTC 時間。格式為：YYYY-MM-DDThh:mm:ssZ。	2015-12-10T21:00:00Z
NextPageToken	string	下一次返回資料的起始索引，當查詢的資料未取得完時返回該值。	UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=
PageSize	integer	返回資料行數。	5000
RequestId	string	請求 ID。	B955107D-E658-4E77-B913-E0AC3D31693E
StartTime	string	開始時間。日期格式按照 ISO8601 表示法，並使用 UTC 時間。格式為：YYYY-MM-DDThh:mm:ssZ。	2015-12-10T20:00:00Z
StreamDetailData	object
StreamData	array<object>	返回資料組。
	object	返回資料組。
AppName	string	應用程式名稱。	app
Bps	number	流每分鐘平均頻寬，單位：bps。	423304182.66
Count	integer	流每分鐘總線上人數。	423304182
FlvBps	number	FLV 協議頻寬，單位：bps。說明指定協議不滿足時，不返回。	454
FlvCount	integer	FLV 協議線上人數。說明指定協議不滿足時，不返回。	32
FlvTraffic	integer	FLV 協議流量，單位：Byte。說明指定協議不滿足時，不返回。	1254
HlsBps	number	HLS 協議頻寬，單位：bps。說明指定協議不滿足時，不返回。	4456
HlsCount	integer	HLS 協議線上人數。說明目前不支援。	56
HlsTraffic	integer	HLS 協議流量，單位：Byte。說明指定協議不滿足時，不返回。	568
NewConns	string	流每分鐘建立串連數。	450
P2pBps	number	P2P 協議頻寬，單位：bps。說明指定協議不滿足時，不返回.	6845
P2pCount	integer	P2P 協議線上人數。說明指定協議不滿足時，不返回。	78
P2pTraffic	integer	P2P 協議流量，單位：Byte。說明指定協議不滿足時，不返回。	4102
RtmpBps	number	RTMP 協議頻寬，單位：bps。說明指定協議不滿足時，不返回。	3323
RtmpCount	integer	RTMP 協議線上人數。說明指定協議不滿足時，不返回。	63
RtmpTraffic	integer	RTMP 協議流量，單位：Byte。說明指定協議不滿足時，不返回。	5568
RtsBps	number	RTS 協議頻寬，單位：bps。說明指定協議不滿足時，不返回。	2361
RtsCount	integer	RTS 協議線上人數。說明指定協議不滿足時，不返回。	89
RtsTraffic	integer	RTS 協議流量，單位：Byte。說明指定協議不滿足時，不返回。	2322
StreamName	string	流名稱。	test.flv
TimeStamp	string	時間片起始時刻。	2015-12-10T20:00:00Z
Traffic	integer	流每分鐘總流量，單位：Byte。	423304182

樣本

正常返回樣本

JSON格式

{
  "DomainName": "example.com",
  "EndTime": "2015-12-10T21:00:00Z",
  "NextPageToken": "UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=",
  "PageSize": 5000,
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "StartTime": "2015-12-10T20:00:00Z",
  "StreamDetailData": {
    "StreamData": [
      {
        "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
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified 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.

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

變更歷史

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