Querying the Stream Push Monitoring Data
Function
Queries stream push monitoring data, including the frame rate, bitrate, and stream interruption.
The maximum query time span is one day. You can query data over the past seven days.
The granularity of the returned bitrate data is one second.
Constraints
Queries only the data of domain names deployed on the new Live service (excluding CN North-Beijing1). This constraint applies only to the Huawei Cloud Chinese Mainland website.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/stats/stream-detail
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
publish_domain |
Yes |
String |
Ingest domain name |
app |
Yes |
String |
App name |
stream |
Yes |
String |
Stream name |
start_time |
No |
String |
Start time. The format must comply with the ISO 8601 standard (UTC time) and is YYYY-MM-DDThh:mm:ssZ. The maximum query time span is one day. You can query data over the past seven days. If this parameter is not specified, data over the past hour is queried by default. |
end_time |
No |
String |
End time. The format must comply with the ISO 8601 standard (UTC time) and is YYYY-MM-DDThh:mm:ssZ. The maximum query time span is one day. You can query data over the past seven days. If this parameter is not specified, the current time will be used by default. The end time must be later than the start time. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. This parameter is mandatory when token authentication is used. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Authorization |
No |
String |
Authentication information. This parameter is mandatory for AK/SK authentication. |
X-Sdk-Date |
No |
String |
Time when the request is sent. This parameter is mandatory for AK/SK authentication. |
X-Project-Id |
No |
String |
Project ID, which is the same as that used in the URI. This parameter is mandatory for AK/SK authentication. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-Request-Id |
String |
Unique identifier of the request |
Parameter |
Type |
Description |
---|---|---|
publish_domain |
String |
Ingest domain name |
app |
String |
App name |
stream |
String |
Stream name |
video_framerate |
Array of StreamDetail objects |
Displays the frame rate of a video stream, in FPS. If stream interruption occurs, stream information in multiple time segments is displayed. For example: "video_framerate": [ { "start_time": "2022-02-04T07:00:00Z", "end_time": "2022-02-04T07:00:02Z", "data_list": [ 21, 22 ] }, { "start_time": "2022-02-04T07:00:05Z", "end_time": "2022-02-04T07:00:07Z", "data_list": [ 13, 34, 21 ] } ] |
video_bitrate |
Array of StreamDetail objects |
Displays the bitrate of a video stream, in kbit/s. If stream interruption occurs, stream information in multiple time segments is displayed. For example: "video_bitrate": [ { "start_time": "2022-02-04T07:00:00Z", "end_time": "2022-02-04T07:00:02Z", "data_list": [ 1326, 1268, 775 ] }, { "start_time": "2022-02-04T07:00:05Z", "end_time": "2022-02-04T07:00:07Z", "data_list": [ 1021, 2022 ] } ] |
Parameter |
Type |
Description |
---|---|---|
start_time |
String |
Sampling start time. The date format complies with the ISO 8601 standard and the UTC time is used. The format is YYYY-MM-DDThh:mm:ssZ. |
end_time |
String |
Sampling end time. The date format complies with the ISO 8601 standard and the UTC time is used. The format is YYYY-MM-DDThh:mm:ssZ. |
data_list |
Array of longs |
Stream monitoring data list |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
X-Request-Id |
String |
Unique identifier of the request |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error description |
Example Requests
Queries streaming data.
GET /v2/{project_id}/stats/stream-detail?app=live&stream=pull_stream&publish_domain=livepush-test.huaweicloud.com
Example Responses
Status code: 200
Information is returned when the processing is successful.
{ "publish_domain" : "livepull-test.huaweicloud.com", "app" : "app", "stream" : "pull_stream", "video_framerate" : [ { "start_time" : "2022-02-04T07:00:00Z", "end_time" : "2022-02-04T07:00:02Z", "data_list" : [ 21, 22 ] }, { "start_time" : "2022-02-04T07:00:05Z", "end_time" : "2022-02-04T07:00:07Z", "data_list" : [ 13, 34, 21 ] } ], "video_bitrate" : [ { "start_time" : "2022-02-04T07:00:00Z", "end_time" : "2022-02-04T07:00:02Z", "data_list" : [ 1326, 1268, 775 ] }, { "start_time" : "2022-02-04T07:00:05Z", "end_time" : "2022-02-04T07:00:07Z", "data_list" : [ 1021, 2022 ] } ] }
Status code: 400
Information is returned when the processing fails.
{ "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: publish_domain" }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.live.v2.region.LiveRegion; import com.huaweicloud.sdk.live.v2.*; import com.huaweicloud.sdk.live.v2.model.*; public class ListSingleStreamDetailSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); LiveClient client = LiveClient.newBuilder() .withCredential(auth) .withRegion(LiveRegion.valueOf("<YOUR REGION>")) .build(); ListSingleStreamDetailRequest request = new ListSingleStreamDetailRequest(); try { ListSingleStreamDetailResponse response = client.listSingleStreamDetail(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklive.v2.region.live_region import LiveRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklive.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = LiveClient.new_builder() \ .with_credentials(credentials) \ .with_region(LiveRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListSingleStreamDetailRequest() response = client.list_single_stream_detail(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := live.NewLiveClient( live.LiveClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListSingleStreamDetailRequest{} response, err := client.ListSingleStreamDetail(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Information is returned when the processing is successful. |
400 |
Information is returned when the processing fails. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot