調用DescribeLivePushProxyUsageData查詢直播中心轉推用量-ApsaraVideo for Live-阿里雲 - ApsaraVideo Live

介面說明

查詢直播中心轉推用量資料。
最大查詢跨度：31 天。
最小查詢粒度：1 天。
最大查詢範圍：最近 90 天的資料。

QPS 限制

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:DescribeLivePushProxyUsageData

get

*Domain

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地域 ID。	cn-shanghai
Region	string	否	查詢不同直播中心，支援批量地區查詢，多個地區用逗號（半形）分隔。取值： cn-beijing：北京 cn-shanghai：上海 cn-shenzhen：深圳 cn-qingdao：青島 ap-southeast-1：新加坡 eu-central-1：德國 ap-northeast-1：東京 ap-southeast-5：雅加達若參數為空，預設返回所有 Region 合併後資料。	cn-beijing
DomainName	string	否	需要查詢的主播流域名。支援單個或批量域名查詢。批量查詢時多個域名用英文逗號（,）分隔。若參數為空，預設返回所有直播域名合併後的資料。	example.com
StartTime	string	否	取得資料起始時間點，日期格式按照 ISO8601 表示法，並使用 UTC 時間，格式為：YYYY-MM-DDThh:mm:ssZ，預設返回近七天的資料。	2022-10-10T20:00:00Z
EndTime	string	否	結束時間需大於起始時間，日期格式按照 ISO8601 表示法，並使用 UTC 時間，格式為：YYYY-MM-DDThh:mm:ssZ。	2022-10-10T21:00:00Z
SplitBy	string	否	分組鍵，若參數為空，預設為 region，按照聚合後資料輸出。多個使用逗號（半形）分隔，取值： domain：域名。如果此參數 SplitBy（分組鍵）取值為 domain 時，返回參數 Domain 才生效。 region（預設值）：直播中心地域。如果此參數 SplitBy（分組鍵）取值為 region 時，返回參數 Region 才生效。	region

返回參數

名稱	類型	描述	樣本值
	object	返回資料。
EndTime	string	結束時間。日期格式按照 ISO8601 表示法，並使用 UTC 時間，格式為：YYYY-MM-DDThh:mm:ssZ。	2022-10-10T21:00:00Z
PushProxyData	object
PushProxyDataItem	array<object>	直播中心轉推用量資料。
	object	直播中心轉推用量資料。
DomainName	string	用量網域名稱，SplitBy 指定 domain 時，分組輸出。	example.com
Region	string	直播中心，SplitBy 指定 region 時，分組輸出。	cn-beijing
StreamCount	integer	直播中心轉推峰值路數，單位：路。	8
TimeStamp	string	時間片起始時刻。	2022-10-10T20:00:00Z
RequestId	string	該條任務請求 ID。	4B460F8B-993C-4F48-B98A-910811DEBFEB
StartTime	string	起始時間。日期格式按照 ISO8601 表示法，並使用 UTC 時間，格式為：YYYY-MM-DDThh:mm:ssZ。	2022-10-10T20:00:00Z

樣本

正常返回樣本

JSON格式

{
  "EndTime": "2022-10-10T21:00:00Z",
  "PushProxyData": {
    "PushProxyDataItem": [
      {
        "DomainName": "example.com",
        "Region": "cn-beijing",
        "StreamCount": 8,
        "TimeStamp": "2022-10-10T20:00:00Z"
      }
    ]
  },
  "RequestId": "4B460F8B-993C-4F48-B98A-910811DEBFEB",
  "StartTime": "2022-10-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	InvalidTime.ValueNotSupported	Specified Time is malformed.

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

變更歷史

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