文档

DescribeChannel - 查询在线频道信息

更新时间:

本接口用于查询在线频道信息。

接口说明

使用说明

本接口用于查询在线频道信息。

QPS 限制

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID,通过控制台创建和查询,仅支持传单个 ID。

eo85****
ChannelIdstring

待查询的频道 ID,仅支持传单个 ID。

testid

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CF8
Channelobject

频道信息。

StartTimelong

频道开始的秒级时间戳(UTC 时间)。

1557909133
ChannelIdstring

频道 ID。

testid
ChannelExistboolean

频道是否存在。取值:

  • true:存在。
  • false:不存在。

示例

正常返回示例

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CF8",
  "Channel": {
    "StartTime": 1557909133,
    "ChannelId": "testid"
  },
  "ChannelExist": true
}

错误码

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