查询指定域名推流app及流粒度数据。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| live:DescribeLiveStreamPushMetricDetailData |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DomainName | string | 是 |
| example.com |
| StartTime | string | 是 | 获取数据起始时间点，日期格式按照 ISO8601 表示法，并使用 UTC 时间。 格式为：YYYY-MM-DDThh:mm:ssZ。 | 2022-09-10T20:00:00Z |
| EndTime | string | 是 | 获取数据结束时间点，日期格式按照 ISO8601 表示法，并使用 UTC 时间，结束时间需大于起始时间，且不能相差超过 1 天。 格式为：YYYY-MM-DDThh:mm:ssZ。 | 2022-09-10T21:00:00Z |
| AppName | string | 否 | 直播流所属应用名称。指定应用名称，查询对应应用流粒度的数据。 | liveApp**** |
| StreamName | string | 否 | 直播流名称。指定 StreamName 时，按指定 AppName 的指定 StreamName，返回流粒度的数据（指定 StreamName 时，必须指定 AppName）。 | liveStream**** |
| NextPageToken | string | 否 | 分页查询 token，每次查询最多返回 5000 行数据，当要查询的数据超过 5000 行时，响应数据会提供下次查询数据的起始索引。 请求时传入该 token，将从上一次查询结束的下一行继续查询未获取的数据。 | UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0= |
返回参数
示例
正常返回示例
JSON格式
{
"DomainName": "example.com",
"EndTime": "2022-09-10T21:00:00Z",
"NextPageToken": "UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=",
"PageSize": 5000,
"RequestId": "5EBF2AC3-4B73-40A5-8B32-83F49D5F035E",
"StartTime": "2022-09-10T20:00:00Z",
"StreamDetailData": {
"StreamData": [
{
"AppName": "liveApp****",
"ReqBps": 133.33,
"ReqTraffic": 1000,
"StreamName": "liveStream****",
"TimeStamp": "2022-09-10T20:00:00Z"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | StartTime参数错误，请您确认该StartTime参数是否正确。 |
| 400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | 结束时间错误，请您确认结束时间是否正确。 |
| 400 | InvalidTime.Malformed | Specified StartTime or 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 | InvalidPageToken | The token of page is invalid. | 指定的分页token错误，请传入上次查询返回的正确索引，并确认没有修改您的请求参数。 |
| 400 | InvalidAppName.Mismatch | The AppName param must be passed. | AppName参数不匹配，请确认传入了正确的AppName参数。 |
| 400 | InvalidStreamProtocol.NotSupport | The specified stream protocol is not support. | 指定的流协议不支持，请参照文档查询所需的流协议。 |
| 400 | InvalidStreamName.LengthTooLong | The specified stream name is too long. | StreamName的长度超过限制，请传入合法的StreamName。 |
| 400 | InvalidAppName.LengthTooLong | The specified app name is too long. | AppName的长度超过限制，请传入合法的AppName。 |
| 400 | InvalidTime.ValueNotSupported | Specified Time is malformed. | 指定的时间无效。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史