调用DescribeLiveDomainMonitoringUsageData获取域名广目监播用量数据。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| live:DescribeLiveDomainMonitoringUsageData | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DomainName | string | 否 | 需要查询的主播流域名。
| example.com |
| StartTime | string | 否 | 开始时间。获取数据起始时间点，日期格式按照 ISO8601 表示法，并使用 UTC 时间。
| 2022-12-10T20:00:00Z |
| EndTime | string | 否 | 结束时间。结束时间需大于起始时间；获日期格式按照 ISO8601 表示法，并使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 | 2022-12-10T22:00:00Z |
| Region | string | 否 | 直播中心 Region。若参数为空，默认返回所有 Region 合并后数据，支持批量查询，多个 Region 用半角逗号（,）分隔。 | cn-shanghai |
| InstanceId | string | 否 | 监播场次 ID，若参数为空，默认返回所有监播场次合并后数据，支持批量查询，多个 ID 用半角逗号（,）分隔。 | e62af24d-a354-3b0c-9f1f-da592c4b**** |
| Interval | string | 否 | 查询的时间粒度，可以使用 3600 和 86400，即小时和天粒度。 | 3600 |
| SplitBy | string | 否 | 分组键。默认为 resolution，即按清晰度分组，可选值为 domain，region，instance，resolution 之一。可以指定多个，多个值用半角逗号（,）分隔。 | resolution |
返回参数
示例
正常返回示例
JSON格式
{
"DomainName": "example.com",
"EndTime": "2022-12-10T22:00:00Z",
"InstanceId": "e62af24d-a354-3b0c-9f1f-da592c4b****",
"MonitoringData": {
"MonitoringDataItem": [
{
"DomainName": "example.com",
"Duration": 2000,
"InstanceId": "e62af24d-a354-3b0c-9f1f-da592c4b****",
"Region": "cn-shanghai",
"Resolution": "720P",
"TimeStamp": "2022-12-10T20:00:00Z"
}
]
},
"Region": "cn-shanghai",
"RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3******",
"StartTime": "2022-12-10T20:00:00Z"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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参数不支持。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-29 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |