DescribeToutiaoLivePlay - 头条拉流查询接口-阿里云帮助中心

接口说明

调用接口查询头条指定直播流的拉流信息。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeToutiaoLivePlay

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
StartTime	string	是	获取数据起始时间点，日期格式按照 ISO8601 表示法，并使用 UTC 时间。	2017-10-10T20:00:00Z
EndTime	string	是	结束时间需大于起始时间,时间跨度不得大于 10 小时，StartTime 和 EndTime 都不填则默认查询当前一小时的数据；获日期格式按照 ISO8601 表示法，并使用 UTC 时间。	2017-10-10T21:00:00Z
Domain	string	是	播流域名。	example.com
Stream	string	是	播流名称。	liveStream****
App	string	是	播流所属应用名称。	liveApp****

返回参数

名称	类型	描述	示例值
	object
Description	string	响应状态描述。	OK
RequestId	string	请求 ID。	16A96B9A-F203-4EC5-8E43-CB92E68F****
Content	array	播流信息详情。
	object	播流信息详情。
Domain	string	播流域名。	example.com
Bandwidth	number	带宽。单位：Mbps	0.0801239013671875
StreamName	string	播流名称。	liveStream****
App	string	播流所属应用名称。	liveApp****
PlayNum	integer	观看人数。	452
Timestamp	integer	时间戳。	1625484600
CdnName	string	Cdn 名称。	ali

示例

正常返回示例

JSON格式

{
  "Description": "OK",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****",
  "Content": [
    {
      "Domain": "example.com",
      "Bandwidth": 0.0801239013671875,
      "StreamName": "liveStream****",
      "App": "liveApp****\n",
      "PlayNum": 452,
      "Timestamp": 1625484600,
      "CdnName": "ali"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。