查询CDN上行推流质量数据接口
功能介绍
查询CDN上行推流质量数据。
最大查询跨度1天,最大查询周期7天。
返回的CDN上行推流质量数据列表粒度为1分钟。
接口约束
该接口暂只支持查询部署在新版视频直播服务上的域名的相关数据(不包含“华北-北京一”)。此约束条件仅适用于中国站。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/stats/up-stream/detail
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
publish_domain |
是 |
String |
推流域名。 |
app |
是 |
String |
应用名。 |
stream |
是 |
String |
流名。 |
start_time |
否 |
String |
起始时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度1天,最大查询周期7天。 若参数为空,默认查询最近1小时数据。 |
end_time |
否 |
String |
结束时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度1天,最大查询周期7天。 若参数为空,默认为当前时间。结束时间需大于起始时间。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 |
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选,携带项目ID信息,与路径参数中的项目ID相同。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求的唯一标识。 |
参数 |
参数类型 |
描述 |
---|---|---|
publish_domain |
String |
推流域名 |
app |
String |
应用名 |
stream |
String |
流名 |
data |
Array of UpStreamDetail objects |
推流质量数据 |
参数 |
参数类型 |
描述 |
---|---|---|
time |
String |
采样时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。 |
fps |
Long |
帧率。 单位fps。 |
rate |
Long |
码率。 单位Kbps。 |
delay |
Long |
时延。 单位ms。 |
gop_duration |
Long |
最近一次gop的时长。 单位ms。 |
last_video_pts |
Long |
视频PTS。 单位ms。 |
last_audio_pts |
Long |
音频PTS。 单位ms。 |
last_video_audio_pts_diff |
Long |
音视频PTS差值。 单位ms。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求的唯一标识。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
查询推流域名详细数据
GET /v2/{project_id}/stats/up-stream/detail?app=stage&stream=stream-7159441965564594945&publish_domain=livepush-test.huaweicloud.com
响应示例
状态码: 200
处理成功返回。
{ "publish_domain" : "livepush-test.huaweicloud.com", "app" : "stage", "stream" : "stream-7159441965564594945", "data" : [ { "fps" : 29, "rate" : 8191, "delay" : 225, "gop_duration" : 1999, "last_video_pts" : 1224054, "last_audio_pts" : 1224054, "last_video_audio_pts_diff" : 0, "time" : "2020-04-23T07:00:00Z" }, { "fps" : 28, "rate" : 184, "delay" : 0, "gop_duration" : 0, "last_video_pts" : 10135133, "last_audio_pts" : 10135125, "last_video_audio_pts_diff" : 8, "time" : "2020-04-23T07:00:00Z" } ] }
状态码: 400
处理失败返回。
{ "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: publish_domain" }
SDK代码示例
SDK代码示例如下。
Java
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 ListUpStreamDetailSolution { 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(); ListUpStreamDetailRequest request = new ListUpStreamDetailRequest(); try { ListUpStreamDetailResponse response = client.listUpStreamDetail(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()); } } } |
Python
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 = ListUpStreamDetailRequest() response = client.list_up_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) |
Go
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.ListUpStreamDetailRequest{} response, err := client.ListUpStreamDetail(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
处理成功返回。 |
400 |
处理失败返回。 |
错误码
请参见错误码。