文档首页/ 行业视频管理服务 IVM/ API参考/ 资源管理/ 查询包周期或按需资源下的通道列表
更新时间：2024-05-21 GMT+08:00
查看PDF
分享

查询包周期或按需资源下的通道列表

功能介绍

用户查询包周期或按需资源下的通道列表

URI

GET /v1/{user_id}/resources/{resource_id}/channels

表1 路径参数

参数

是否必选

参数类型

描述

resource_id

是

String

包周期资源ID：32位数字、字母组成

user_id

是

String

用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

单页内显示记录数：取值范围为[1,300]，不填时默认值为10

offset

否

Integer

偏移量：取值范围为[0,2142147483646]

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

是

String

用户认证AccessToken：从获取用户北向接口认证AccessToken中获取

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

channels

Array of ChannelInfo objects

通道列表

resource_type_code

String

资源类型编码

  • MANAGE 视图接入调阅
  • NORMAL 连续云储存
  • DATAFLOW 行业数据流
  • MOTION 动检云存储

resource_name

String

资源名称

resource_id

String

资源ID

resource_state

String

资源状态

  • NORMAL 正常
  • ARREARS 欠费
  • UNAVAILABLE 不可使用冻结

mode

String

按需或包周期

  • PACKAGE 包周期
  • ONDEMAND 按需

total

Integer

通道总数

invalid_num

Integer

非法通道数

manage_num

Integer

管理通道数
表5 ChannelInfo

参数

参数类型

描述

attrs

Array of AttributeInfo objects

资源属性

device_name

String

设备名称

device_id

String

设备id

channel_id

String

通道id

channel_state

String

通道状态：

  • UNALLOCATED 未分配
  • ONLINE 在线
  • OFFLINE 离线

channel_name

String

通道名称，长度取值范围[1,64]个字符

bind_state

String

绑定状态
表6 AttributeInfo

参数

参数类型

描述

attr_code

String

属性编码

  • access_number 接入路数
  • bandwidth 带宽
  • storage_day 存储天数

attr_value

float

属性值

请求示例

GET /v1/7864512589745854564*****/resources/c0d3c9f9b70b4c3599fe4a98e*******/channels?offset=0&limit=2

响应示例

状态码： 200

OK 
{
	"channels": [
		{
			"attrs": [
				{
					"attr_code": "storage_day",
					"attr_value": 90
				}
			],
			"device_name": "HoloSens IPC",
			"device_id": "testwl000***",
			"channel_id": "0",
			"channel_state": "OFFLINE",
			"channel_name": "HoloSens IPC",
			"bind_state": "NORMAL"
		},
		{
			"attrs": [
				{
					"attr_code": "storage_day",
					"attr_value": 90
				}
			],
			"device_name": "HoloSens SDC-test2",
			"device_id": "210123456SMY***",
			"channel_id": "0",
			"channel_state": "OFFLINE",
			"channel_name": "HoloSens SDC-test2",
			"bind_state": "NORMAL"
		}
	],
	"resource_type_code": "NORMAL",
	"resource_name": "90天连续云存储月套餐",
	"resource_id": "321456789012345678901234567*****",
	"resource_state": "NORMAL",
	"mode": "PACKAGE",
	"total": 12,
	"invalid_num": 0,
	"manage_num": 0
}

状态码

请参见状态码

错误码

请参见错误码。

父主题： 资源管理

相关文档