实时查询单路流状态。
接口说明
使用说明
先获取直播域名,再调用本接口实时查询单路流状态。关于不在线状态(offline)的详细信息,请根据推流回调返回的数据获取,本接口不做细分。
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:DescribeLiveStreamState | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DomainName | string | 是 | 直播推流域名或播流域名。 | demo.aliyundoc.com |
AppName | string | 是 | 直播流所属应用名称。 | liveApp**** |
StreamName | string | 是 | 直播流名称。 | liveStream**** |
返回参数
示例
正常返回示例
JSON
格式
{
"Type": "push",
"RequestId": "CE6CD79D-0A98-1F22-A15F-FADA74DF2729",
"StreamState": "online"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParam | Parameter invalid. | 输入参数不合法 |
500 | InternalError | The request processing has failed due to backend service exception. | - |
访问错误中心查看更多错误码。