查询指定空间内已接入的设备列表。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | ListDevices | 要执行的操作，取值：ListDevices。 |
Version | String | 是 | 2021-01-01 | API的版本，取值：2021-01-01。 |
PageNumber | String | 否 | 1 | 分页页码 |
PageSize | String | 是 | 20 | 分页大小 |
SpaceID | String | 是 | 2db38a3a-2a9d-4bf7-afd9-7cdc13xxxxxx | 空间 ID，可通过调用 ListSpaces 接口获取 |
DeviceID | String | 否 | devicexxxxxxxxuuid | 筛选条件，设备 ID，可通过调用 CreateDevice 接口获取 |
DeviceNSID | String | 否 | 31400000000101xxx | 筛选条件，设备国标 ID，可通过调用 GenSipID 接口生成设备国标 ID |
Status | String | 否 | online,offline | 筛选条件，设备状态，通过**,**分割多个状态 |
Order | String | 否 | -1 | 排序条件，按照创建时间排序，-1倒序，1正序，默认倒序 |
DeviceName | String | 否 | device name | 筛选条件，设备国标ID或设备名称 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
PageNumber | Integer | 1 | PageNumber |
PageSize | Integer | 20 | PageSize |
TotalCount | Integer | 7 | TotalCount |
Devices | Array of Object | 查询到的设备信息列表，参考以下 |
GET https://open.volcengineapi.com?Action=ListDevices&Version=2021-01-01&SpaceID=2db38a3a-2a9d-4bf7-afd9-7cdc13xxxxxx&DeviceID=&DeviceNSID=
{"ResponseMetadata":{"RequestId":"202304111721102AF16D52C34EDD3E9FA7","Action":"ListDevices","Version":"2021-01-01","Service":"aiotvideo","Region":"cn-north-1"},"Result":{"PageNumber":1,"PageSize":20,"TotalCount":7,"Devices":[{"SpaceID":"2db38a3a-2a9d-4bf7-afd9-7cdc13xxxxxx","Type":"IPC","DeviceName":"SH-HK-IPC01","DeviceID":"6851c282-c7f6-4a04-xxxx-xxxx","DeviceNSID":"34020056991320xxxxxx","Username":"34020056991320xxxxxx","Password":"xxxxxx","Status":"online","ChannelNum":1,"Description":"Camera001","AutoPullAfterRegiter":false,"Manufactory":"ABC","CreatedAt":"2021-12-08T14:06:58+08:00","UpdatedAt":"2021-12-08T14:06:58+08:00","AlertNotification":{"Enabled":false,"Phone":false,"Device":false,"SMS":false,"GPS":false,"Video":false,"DeviceFault":false,"Other":false},"DeviceIP":"xx.xxx.xxx.xx","RtpTransportTcp":true,"DeviceStreams":{"988800xxxxxx20000000":{"StreamID":"2c6b2bb4-4463-468c-adf5-2ac5b75f6847","PullUrls":["rtmp://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.flv","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.m3u8","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.sdp"],"PushUrl":"rtmp://xxxx.fcdn-xxx-push.org/xxxx/xxx000001?Time=1681798490&Secret=xxx","Status":""},"988800xxxxxx20000001":{"StreamID":"a43dae5a-0823-4970-a1fc-6b6c88xxxxxx","PullUrls":["rtmp://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.flv","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.m3u8","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.sdp"],"PushUrl":"rtmp://xxxx.fcdn-xxx-push.org/xxxx/xxx000001?Time=1681798490&Secret=xxx","Status":""},"988800xxxxxx20000002":{"StreamID":"91b4072c-fb65-444b-b0c4-687041xxxxxx","PullUrls":["rtmp://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.flv","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.m3u8","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.sdp"],"PushUrl":"rtmp://xxxx.fcdn-xxx-push.org/xxxx/xxx000001?Time=1681798490&Secret=xxx","Status":""}},"DeviceSubStreams":{"988800xxxxxx20000000":[{"StreamID":"516bcfaa-9075-4007-85a4-ebd543xxxxxx","PullUrls":["rtmp://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.flv","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.m3u8","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.sdp"],"PushUrl":"rtmp://xxxx.fcdn-xxx-push.org/xxxx/xxx000001?Time=1681798490&Secret=xxx","Status":"online"},{"PullUrls":["rtmp://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.flv","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.m3u8","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.sdp"],"PushUrl":"rtmp://xxxx.fcdn-xxx-push.org/xxxx/xxx000001?Time=1681798490&Secret=xxx","Status":"online"}],"988800xxxxxx20000001":[{"StreamID":"e1f6ab2b-09c4-4f36-8464-f30967xxxxxx","PullUrls":["rtmp://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.flv","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.m3u8","http://xxxx.fcdn-xxx-pull.org/xxxx/xxx000001.sdp"],"PushUrl":"rtmp://xxxx.fcdn-xxx-push.org/xxxx/xxx000001?Time=1681798490&Secret=xxx","Status":"online"}]},"UseSubStream":true}]}}
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
|---|---|---|
400 | InvalidParameter.DeviceListPaging |