Querying Stream Data of a Streaming Domain Name
Function
Queries the monitoring data of a streaming domain name. After a time point is entered, the bandwidth, number of online users, and protocol of all streams at the time point will be returned.
If no domain name is specified, the bandwidth, number of online users, and protocol of all streaming domain names of the tenant at the time point will be queried.
The granularity of the returned data is one minute.
You can query data over the past seven days, and the data delay is five minutes.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/stats/stream/play-info
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 |
---|---|---|---|
play_domains |
No |
Array |
Streaming domain name list. Up to 10 domain names can be queried. Separate domain names with commas (,). If no domain name is specified, the stream data of all streaming domain names of the tenant is queried. |
time |
Yes |
String |
Time when data is queried. The value is accurate to minute. The format must comply with the ISO 8601 standard (UTC time). Format: YYYY-MM-DDThh:mm:ssZ. The maximum query time span is seven days. The time must be an integral time point, for example, 2024-02-02T08:01:00Z. |
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 the user token. |
Authorization |
No |
String |
Authentication information. This parameter is mandatory for AK/SK authentication. |
X-Sdk-Date |
No |
String |
Time when a 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 |
Specifies the unique ID of a request. |
Parameter |
Type |
Description |
---|---|---|
time |
String |
Sampling time. The format must comply with the ISO 8601 standard (UTC time) and is YYYY-MM-DDThh:mm:ssZ. |
data_list |
Array of PlayDomainStreamInfo objects |
Sampled data list. |
Parameter |
Type |
Description |
---|---|---|
play_domain |
String |
Streaming domain name |
stream |
String |
Played stream name |
protocol |
String |
Streaming protocol, which can be FLV, HLS, or RTMP. |
bandwidth |
Long |
Specifies the bandwidth value when the granularity is one minute. The unit is bit/s. |
online |
Long |
Number of online users at the granularity of one minute. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
X-Request-Id |
String |
Specifies the unique ID of a request. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error description |
Example Requests
Queries stream data of a streaming domain name.
GET /v2/{project_id}/stats/stream/play-info?play_domains=play.example.com&time=2024-06-06T08:00:00Z
Example Responses
Status code: 200
The information is returned when the request succeeded.
{ "time" : "2024-06-06T08:00:00Z", "data_list" : [ { "play_domain" : "play.example.com", "stream" : "test_stream_01", "bandwidth" : 1245, "online" : 123, "protocol" : "hls" }, { "play_domain" : "play.example.com", "stream" : "test_stream_02", "bandwidth" : 1025, "online" : 60, "protocol" : "hls" }, { "play_domain" : "play.example01.com", "stream" : "test_stream_03", "bandwidth" : 3242, "online" : 546, "protocol" : "flv" } ] }
Status code: 400
The information is returned when the request failed.
{ "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: domains" }
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 ListPlayDomainStreamInfoSolution { 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(); ListPlayDomainStreamInfoRequest request = new ListPlayDomainStreamInfoRequest(); try { ListPlayDomainStreamInfoResponse response = client.listPlayDomainStreamInfo(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 = ListPlayDomainStreamInfoRequest() response = client.list_play_domain_stream_info(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.ListPlayDomainStreamInfoRequest{} response, err := client.ListPlayDomainStreamInfo(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 |
The information is returned when the request succeeded. |
400 |
The information is returned when the request failed. |
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