DescribeDeviceChannels - 查询设备通道列表

查询设备通道列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vs:DescribeDeviceChannelsget
  • 全部资源
    *

请求参数

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

按设备 ID 查询

348*****380-cn-qingdao
PageSizelong

分页大小,默认为 20

20
PageNumlong

第几个分页,默认为 1

1

返回参数

名称类型描述示例值
object
PageNumlong

第几个分页

1
PageSizelong

分页大小

20
RequestIdstring

该条任务请求 ID。

4641C72D-462E-4AEA-8485-FC267AF90B0A
TotalCountlong

通道总数

1
PageCountlong

分页总数

1
Channelsarray<object>

通道列表

Channelobject
StreamStatusstring

流状态

off
GbIdstring

国标 ID

3100000****000000002
Paramsstring

设备其它配置。

{}
DeviceIdstring

设备 ID

348*****380-cn-qingdao
ChannelIdlong

通道 ID。

0
DeviceStatusstring

设备状态

on
Namestring

通道名称

通道1
StreamIdstring

流 ID

323*****997-cn-qingdao

示例

正常返回示例

JSON格式

{
  "PageNum": 1,
  "PageSize": 20,
  "RequestId": "4641C72D-462E-4AEA-8485-FC267AF90B0A",
  "TotalCount": 1,
  "PageCount": 1,
  "Channels": [
    {
      "StreamStatus": "off",
      "GbId": "3100000****000000002",
      "Params": "{}",
      "DeviceId": "348*****380-cn-qingdao",
      "ChannelId": 0,
      "DeviceStatus": "on",
      "Name": "通道1",
      "StreamId": "323*****997-cn-qingdao"
    }
  ]
}

JSON格式

{
  "PageNum": 1,
  "PageSize": 20,
  "RequestId": "4641C72D-462E-4AEA-8485-FC267AF90B0A",
  "TotalCount": 1,
  "PageCount": 1,
  "Channels": [
    {
      "StreamStatus": "off",
      "GbId": "3100000****000000002",
      "Params": "{}",
      "DeviceId": "348*****380-cn-qingdao",
      "ChannelId": 0,
      "DeviceStatus": "on",
      "Name": "通道1",
      "StreamId": "323*****997-cn-qingdao"
    }
  ]
}

错误码

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