查詢指定網域名稱推流app及流粒度資料。
介面說明
僅支援單個網域名稱查詢,多個網域名稱會報錯。
資料最大查詢跨度:24 小時。
資料最小查詢粒度:1 分鐘。
資料最大查詢範圍:31 天。
本介面為監控資料介面,資料擷取處理方式不同於計費,不能用於計算用量進行對賬參考。
QPS 限制
本介面的單使用者 QPS 限制為 10 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:DescribeLiveStreamPushMetricDetailData |
*Domain
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-shanghai |
| DomainName |
string |
是 |
|
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. | 指定的分頁token錯誤,請傳入上次查詢返回的正確索引,並確認沒有修改您的請求參數。 |
| 400 | InvalidAppName.Mismatch | The AppName param must be passed. | AppName參數不匹配,請確認傳入了正確的AppName參數。 |
| 400 | InvalidStreamProtocol.NotSupport | The specified stream protocol is not support. | 指定的流協議不支援,請參照文檔查詢所需的流協議。 |
| 400 | InvalidStreamName.LengthTooLong | The specified stream name is too long. | StreamName的長度超過限制,請傳入合法的StreamName。 |
| 400 | InvalidAppName.LengthTooLong | The specified app name is too long. | AppName的長度超過限制,請傳入合法的AppName。 |
| 400 | InvalidTime.ValueNotSupported | Specified Time is malformed. | 指定的時間無效。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。