調用DescribeLiveProducerUsageData介面查詢導播台用量資料-ApsaraVideo for Live-阿里雲

調用DescribeLiveProducerUsageData查詢導播台用量資料。

介面說明

最小資料查詢粒度為 1 小時；最大查詢時間跨度為 31 天；支援歷史最大查詢時間範圍為最近 90 天。

QPS 限制

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:DescribeLiveProducerUsageData

get

*Domain

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID。	cn-shanghai
Region	string	否	網域名稱所屬地區。若參數為空白，預設返回所有 Region 合并後資料，支援批量查詢，多個 Region 用半形逗號（,）分隔。	cn-shanghai
DomainName	string	否	雲導播播流網域名稱。支援單個或批量網域名稱查詢。批量查詢時多個網域名稱用英文逗號（,）分隔。若參數為空白，預設返回所有直播網域名稱合并後的資料。	example.com
Instance	string	否	查詢執行個體。支援批量執行個體查詢，多個執行個體用英文逗號（,）分隔。說明若參數為空白，預設返回所有執行個體合并後資料。	a17d0184-462d-4630-b2a6-8c26dde2****
Type	string	否	導播類型。支援批量查詢，多個類型用英文逗號（,）分隔。取值： slidelive：播單型。 universal：通用型。說明若參數為空白，預設返回所有導播類型合并後資料。	slidelive
SplitBy	string	否	分組鍵。可以指定 domain、region、 instance,、type 其中之一或多個, 多個使用英文逗號（,）分隔.。指定了 split 的欄位將會被分組輸出。說明若參數為空白, 則只輸出按照彙總後資料.	type
StartTime	string	否	開始時間。日期格式按照 ISO8601 標記法，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。	2018-09-30T16:00:00Z
EndTime	string	否	結束時間。日期格式按照 ISO8601 標記法，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。說明結束時間需大於起始時間。	2018-10-31T15:59:59Z
Interval	string	否	指定查詢資料的時間粒紋，支援 3600（1 小時）和 86400（1 天）的取值。單位：秒。	3600
app	string	否	播流所屬應用程式名稱。	liveApp****

返回參數

名稱	類型	描述	樣本值
	object
BillProducerData	object
BillProducerDataItem	array<object>	使用者導播台用量資料。
	object
DomainName	string	用量網域名稱。SplitBy 指定為 domain 時，分組輸出。	example.com
Instance	string	用量執行個體。SplitBy 指定為 instance 時，分組輸出。	a17d0184-462d-4630-b2a6-8c26dde2****
OutputHdDuration	integer	高清解析度時間長度，單位為分鐘。	6000
OutputLdDuration	integer	流暢解析度時間長度，單位為分鐘。	1001
OutputSdDuration	integer	標準解析度時間長度，單位為分鐘。	500
Region	string	用量地區。SplitBy 指定為 region 時，分組輸出。	cn-shanghai
TimeStamp	string	時間片起始時刻。	2018-09-30T00:00:00Z
TranHdDuration	integer	轉碼高清解析度時間長度，單位為分鐘。	6777
TranLdDuration	integer	轉碼流暢解析度時間長度，單位為分鐘。	111
TranSdDuration	integer	轉碼標準解析度時間長度，單位為分鐘。	666
Type	string	導播類型。SplitBy 指定為 type 時，分組輸出。	slidelive
EndTime	string	結束時間。	2018-09-30T16:00:00Z
RequestId	string	請求 ID。	C370DAF1-C838-4288-A1A0-9A87633D248E
StartTime	string	開始時間。	2018-10-31T15:59:59Z

樣本

正常返回樣本

JSON格式

{
  "BillProducerData": {
    "BillProducerDataItem": [
      {
        "DomainName": "example.com",
        "Instance": "a17d0184-462d-4630-b2a6-8c26dde2****",
        "OutputHdDuration": 6000,
        "OutputLdDuration": 1001,
        "OutputSdDuration": 500,
        "Region": "cn-shanghai",
        "TimeStamp": "2018-09-30T00:00:00Z",
        "TranHdDuration": 6777,
        "TranLdDuration": 111,
        "TranSdDuration": 666,
        "Type": "slidelive"
      }
    ]
  },
  "EndTime": "2018-09-30T16:00:00Z",
  "RequestId": "C370DAF1-C838-4288-A1A0-9A87633D248E",
  "StartTime": "2018-10-31T15:59:59Z"
}

錯誤碼

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	InvalidTime.ValueNotSupported	Specified Time is malformed.	指定的時間無效。

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

變更歷史

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