查询直播各区域指标分布接口
功能介绍
查询直播全球区域维度的详细数据接口。
如果不传入域名,则查询租户下所有播放域名的详细数据。
当查询租户级别数据时,参数app、stream不生效。
最大查询跨度1天,最大查询周期90天。
当查询观众数据时,仅支持查询FLV和RTMP流的在线人数
支持查询当天,当前数据延时少于5分钟。
如果用于对账,请查询三小时之前的数据。
指定起始时间和结束时间时,起始时间必须为时间粒度的整时刻点,结束时间为不包含整点时刻。
比如查询时间粒度为5分钟,起始时间为5分钟整时刻点,如:0分、5分、50分、55分,结束时间为不包含整点时刻点,
如:4分59秒、9分59秒、59分59秒。时间传参start_time为2020-06-04T07:00:00Z ,end_time为2020-06-04T07:04:59Z,表示统计这个时间区间5分钟粒度的数据。如果查询不按照此规范,返回数据可能和预期不一致。
接口约束
该接口暂只支持查询部署在新版视频直播服务上的域名的相关数据(不包含“华北-北京一”)。此约束条件仅适用于中国站。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/stats/area/detail
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
start_time |
是 |
String |
查询起始时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度1天,最大查询周期90天。 |
end_time |
是 |
String |
查询结束时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度1天,最大查询周期90天。 |
play_domains |
否 |
Array of strings |
需查询的播放域名列表,最多支持查询100个域名。 |
app |
否 |
String |
需查询的app。 |
stream |
否 |
String |
流名称。 |
interval |
否 |
Integer |
查询数据的时间粒度。支持300(默认值)、3600和86400秒。若参数为空,则默认为300秒。 注意:若metric的值为player(观众数),则interval填入的值不生效,查询粒度interval默认为60秒。 |
isp |
否 |
Array of strings |
运营商列表,取值如下:
若参数为空,则查询所有运营商。 |
area |
是 |
Array of strings |
需查询的计费大区,取值如下:
中国内地返回结果为省份/直辖市的中文名称,比如:广东、上海; 海外大区与地区/国家的对应关系请参考地区/国家代码对照表。 |
metric |
是 |
String |
指标,取值如下:
|
protocol |
否 |
String |
请求协议,取值如下:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
请求的唯一标识。 |
参数 |
参数类型 |
描述 |
---|---|---|
data_list |
Array of AreaDetail objects |
时间戳及相应时间的指标数值 |
参数 |
参数类型 |
描述 |
---|---|---|
area |
String |
各个计费大区名称,例如CN |
summary |
Array of TimeValue objects |
时间戳及相应时间的指标数值 |
detail |
Array of AreaTimeValue objects |
各个大区下的具体省份、区域、国家的时间戳及相应时间的指标数值 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
各个大区下的具体省份、区域、国家的名称。 中国内地返回结果为省份/直辖市的中文名称,比如:广东、上海; 海外大区下的地区/国家对应关系请参考地区/国家代码对照表。 |
data |
Array of TimeValue objects |
当前时间返回指定指标的值 |
参数 |
参数类型 |
描述 |
---|---|---|
time |
String |
采样时间。日期格式按照ISO8601表示法,并使用UTC时间。格式为YYYY-MM-DDThh:mm:ssZ |
value |
Long |
当前时间返回指定指标的值 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求的唯一标识。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
查询区域直播播放域名指标详情
GET /v2/{project_id}/stats/area/detail?start_time=2021-12-20T07:00:00Z&end_time=2021-12-20T07:09:59Z&play_domains=livepull-test.huaweicloud.com&area=CN&metric=traffic
响应示例
状态码: 200
处理成功返回。
{ "data_list" : [ { "area" : "AP2", "summary" : [ { "time" : "2021-12-20T07:00:00Z", "value" : 323 }, { "time" : "2021-12-20T09:05:00Z", "value" : 325 } ], "detail" : [ { "name" : "TH", "data" : [ { "time" : "2021-12-20T07:00:00Z", "value" : 223 }, { "time" : "2021-12-20T09:05:00Z", "value" : 123 } ] }, { "name" : "PH", "data" : [ { "time" : "2021-12-20T07:00:00Z", "value" : 123 }, { "time" : "2021-12-20T09:05:00Z", "value" : 223 } ] } ] } ] }
状态码: 400
参数错误。
{ "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: play_domains" }
SDK代码示例
SDK代码示例如下。
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 ListAreaDetailSolution { 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(); ListAreaDetailRequest request = new ListAreaDetailRequest(); try { ListAreaDetailResponse response = client.listAreaDetail(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 = ListAreaDetailRequest() response = client.list_area_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.ListAreaDetailRequest{} response, err := client.ListAreaDetail(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
处理成功返回。 |
400 |
参数错误。 |
错误码
请参见错误码。