BatchQueryVisionDeviceInfo
调用该接口批量查询视频设备信息。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为30。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | BatchQueryVisionDeviceInfo | 系统规定参数。取值:BatchQueryVisionDeviceInfo。 |
IotInstanceId | String | 是 | iot-cn-n6w1y59**** | 实例ID。您可在物联网平台控制台的实例概览页签,查看当前实例的ID。 |
DeviceNameList.N | RepeatList | 否 | camera1 | 设备的设备名称列表。您可以在物联网平台控制台的设备页查看DeviceName。 重要 如果传入该参数,需同时传入ProductKey。
|
ProductKey | String | 否 | a1BwAGV**** | 设备所属产品的ProductKey。 您可以在物联网平台控制台产品页查看或调用QueryProductList查看当前账号下所有产品的信息。 重要 如果传入该参数,需同时传入DeviceName。
|
IotIdList.N | RepeatList | 否 | d7XmBoJhAr88C6PelXDF00**** | 设备的设备ID列表。物联网平台为该设备颁发的ID,设备的唯一标识符。可调用物联网平台QueryDeviceDetail查询。 重要 IotId作为设备唯一标识符,和ProductKey与DeviceName组合是一一对应的关系。如果传入该参数,则无需传入ProductKey和DeviceName。如果您同时传入IotId和ProductKey与DeviceName组合,则以IotId为准。
|
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 |
类型 |
示例值 |
描述 |
Code | String | 400 | 接口返回码:
|
Data | Struct | 返回的设备信息。 |
|
DeviceInfoList | Array of DeviceInfo | 设备信息列表。 |
|
Description | String | test | 设备描述信息。 |
DeviceType | Integer | 1 | 设备类型。
|
GbDeviceInfo | Struct | 国标设备信息。 DeviceType为1、2或3时,返回该参数信息。 |
|
DeviceProtocol | Integer | 1 | 设备协议。
|
GbId | String | 31****************21 | 国标ID。 |
NetProtocol | Integer | 1 | 网络协议,取值1表示GB28181。 |
NickName | String | GBdevice | 设备昵称。 |
Password | String | 23******* | 设备的密码。 |
SubProductKey | String | we5***** | 子设备产品的ProductKey。 |
IotId | String | y4u2weAIrpp****WHMle1234 | 设备ID。 |
RtmpDeviceInfo | Struct | RTMP设备信息。 DeviceType为4时,返回该参数信息。 |
|
PullAuthKey | String | z8X5*****OQ | 播流鉴权Key,支持英文字母和数字,长度限制为8~16位。 |
PullKeyExpireTime | Integer | 600 | 播流URL有效期,单位秒。时长范围为60秒~7200秒。 |
PushAuthKey | String | PH******fpn | 收流鉴权Key,支持英文字母和数字,长度限制为8~16位。 |
PushKeyExpireTime | Integer | 600 | 收流URL有效期,单位秒。时长范围为60秒~7200秒。 |
PushUrlSample | String | rtmp://example.com/live/example | 收流URL示例地址。 |
StreamName | String | linkvisual_iot-*******i_test | RTMP流名称。 |
StreamStatus | Integer | 1 | RTMP流状态。
|
ErrorMessage | String | Request error. | 调用失败时,返回的出错信息。 |
RequestId | String | E55***B7-4***-4***-8***-D3******F565 | 阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true | 是否调用成功:
|
示例
请求示例
http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=BatchQueryVisionDeviceInfo
&IotInstanceId=iot-cn-n6w1y59****
&ProductKey=a1BwAGV****
&DeviceName.1=camera1
&DeviceName.2=camera2
&<公共请求参数>
正常返回示例
XML
格式
<BatchQueryVisionDeviceInfoResponse>
<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>
<Data>
<DeviceInfoList>
<IotId>y4u2weAIrpp****WHMle1234</IotId>
<DeviceType>4</DeviceType>
<Description>test</Description>
<RtmpDeviceInfo>
<PullKeyExpireTime>600</PullKeyExpireTime>
<PushAuthKey>PH******fpn</PushAuthKey>
<StreamName>linkvisual_iot-*******i_test</StreamName>
<PullAuthKey>z8X5*****OQ</PullAuthKey>
<StreamStatus>1</StreamStatus>
<PushKeyExpireTime>600</PushKeyExpireTime>
<PushUrlSample>rtmp://example.com/live/example</PushUrlSample>
</RtmpDeviceInfo>
</DeviceInfoList>
</Data>
<Code>200</Code>
<Success>true</Success>
</BatchQueryVisionDeviceInfoResponse>
JSON
格式
{
"RequestId": "E55***B7-4***-4***-8***-D3******F565",
"Data": {
"DeviceInfoList": [{
"IotId": "y4u2weAIrpp****WHMle1234",
"DeviceType": 4,
"Description": "test",
"RtmpDeviceInfo": {
"PullKeyExpireTime": 600,
"PushAuthKey": "PH******fpn",
"StreamName": "linkvisual_iot-*******i_test",
"PullAuthKey": "z8X5*****OQ",
"StreamStatus": 1,
"PushKeyExpireTime": 600,
"PushUrlSample": "rtmp://example.com/live/example"
}
}]
},
"Code": 200,
"Success": true
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
429 | iot.vision.RequestTrafficControl | Request traffic control. | 请求太频繁被限流。 |
403 | iot.vision.RequestForbidden | Request forbidden. | 请求被禁止。 |
400 | iot.vision.RequestParameterError | Request parameter error:%s | 请求参数错误。 |
400 | iot.vision.RequestError | Request error. | 请求失败。 |
访问错误中心查看更多错误码。
- 本页导读 (1)