调用DescribeLiveDomainMonitoringUsageData获取域名广目监播用量数据。
使用说明
- 支持批量域名查询,多个域名用半角逗号(,)分隔。
- 最多可获取最近90天的数据。
- 查询数据的时间粒度为小时或天。
- 最大支持查询时间跨度31天。
QPS限制
本接口的单用户QPS限制为20次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DescribeLiveDomainMonitoringUsageData | 系统规定参数。取值:DescribeLiveDomainMonitoringUsageData。 |
DomainName | String | 否 | example.com | 域名。若参数为空,默认返回所有域名数据,支持批量域名查询,多个域名用半角逗号(,)分隔。 |
StartTime | String | 否 | 2022-12-10T20:00:00Z | 开始时间。获取数据起始时间点,日期格式按照ISO8601表示法,并使用UTC时间。
|
EndTime | String | 否 | 2022-12-10T22:00:00Z | 结束时间。结束时间需大于起始时间;获日期格式按照ISO8601表示法,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。 |
Region | String | 否 | cn-shanghai | 直播中心Region。若参数为空,默认返回所有Region合并后数据,支持批量查询,多个Region用半角逗号(,)分隔。 |
InstanceId | String | 否 | e62af24d-a354-3b0c-9f1f-da592c4b**** | 监播场次ID,若参数为空,默认返回所有监播场次合并后数据,支持批量查询,多个ID用半角逗号(,)分隔。 |
Interval | String | 否 | 3600 | 查询的时间粒度,可以使用3600和86400,即小时和天粒度。 |
SplitBy | String | 否 | resolution | 分组键。默认为resolution,即按清晰度分组,可选值为domain,region,instance,resolution之一。可以指定多个,多个值用半角逗号(,)分隔。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
EndTime | String | 2022-12-10T22:00:00Z | 查询结束时间。 |
StartTime | String | 2022-12-10T20:00:00Z | 查询起始时间。 |
RequestId | String | 3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F | 请求ID。 |
Region | String | cn-shanghai | 直播中心Region。 |
InstanceId | String | e62af24d-a354-3b0c-9f1f-da592c4b**** | 监播场次ID。 |
DomainName | String | example.com | 域名。 |
MonitoringData | Array of MonitoringDataItem | 广目监播用量明细。 |
|
MonitoringDataItem | |||
Region | String | cn-shanghai | 直播中心Region。只有当Split指定了Region时有效。 |
TimeStamp | String | 2022-12-10T20:00:00Z | 时间片起始时刻。 |
Duration | Integer | 2000 | 时长,单位为分钟。 |
InstanceId | String | e62af24d-a354-3b0c-9f1f-da592c4b**** | 监播场次ID。只有当Split指定了instance时有效。 |
DomainName | String | example.com | 域名。只有当Split指定了domain时有效。 |
Resolution | String | 720P | 分辨率.。只有当Split指定了resolution时有效。 |
示例
请求示例
http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainMonitoringUsageData
&DomainName=example.com
&StartTime=2022-12-10T20:00:00Z
&EndTime=2022-12-10T22:00:00Z
&Region=cn-shanghai
&InstanceId=e62af24d-a354-3b0c-9f1f-da592c4b****
&Interval=3600
&SplitBy=resolution
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeLiveDomainMonitoringUsageDataResponse>
<EndTime>2022-12-10T22:00:00Z</EndTime>
<StartTime>2022-12-10T20:00:00Z</StartTime>
<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>
<Region>cn-shanghai</Region>
<InstanceId>e62af24d-a354-3b0c-9f1f-da592c4b****</InstanceId>
<DomainName>example.com</DomainName>
<MonitoringData>
<Region>cn-shanghai</Region>
<TimeStamp>2022-12-10T20:00:00Z</TimeStamp>
<Duration>2000</Duration>
<InstanceId>e62af24d-a354-3b0c-9f1f-da592c4b****</InstanceId>
<DomainName>example.com</DomainName>
<Resolution>720P</Resolution>
</MonitoringData>
</DescribeLiveDomainMonitoringUsageDataResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"EndTime" : "2022-12-10T22:00:00Z",
"StartTime" : "2022-12-10T20:00:00Z",
"RequestId" : "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
"Region" : "cn-shanghai",
"InstanceId" : "e62af24d-a354-3b0c-9f1f-da592c4b****",
"DomainName" : "example.com",
"MonitoringData" : [ {
"Region" : "cn-shanghai",
"TimeStamp" : "2022-12-10T20:00:00Z",
"Duration" : 2000,
"InstanceId" : "e62af24d-a354-3b0c-9f1f-da592c4b****",
"DomainName" : "example.com",
"Resolution" : "720P"
} ]
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | StartTime参数错误,请您确认该StartTime参数是否正确。 |
400 | InvalidEndTime.Malformed | Specified 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 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | 传入的StartTime参数不支持。 |
访问错误中心查看更多错误码。
特殊错误码
错误代码 |
描述 |
HTTP状态码 |
语义 |
Throttling |
Request was denied due to request throttling. |
503 |
请求被流量控制限制 |
InvalidDomain.NotFound |
The domain provided does not belong to you. |
404 |
域名不存在或不属于当前用户 |