QueryVisionDeviceInfo_物联网智能视频服务(LinkVisual)-阿里云帮助中心

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。

说明单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	QueryVisionDeviceInfo	系统规定参数。取值：QueryVisionDeviceInfo。
IotInstanceId	String	是	iot-cn-n6w1y59****	实例ID。您可在物联网平台控制台的实例概览页签，查看当前实例的ID。
ProductKey	String	否	a1BwAGV****	设备所属产品的ProductKey。您可以在物联网平台控制台产品页查看或调用QueryProductList查看当前账号下所有产品的信息。重要如果传入该参数，需同时传入DeviceName。
DeviceName	String	否	camera1	设备的设备名称。您可以在物联网平台控制台的设备页查看DeviceName。重要如果传入该参数，需同时传入ProductKey。
IotId	String	否	d7XmBoJhAr88C6PelXDF00****	设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台QueryDeviceDetail查询。重要 IotId作为设备唯一标识符，和ProductKey与DeviceName组合是一一对应的关系。如果传入该参数，则无需传入ProductKey和DeviceName。如果您同时传入IotId和ProductKey与DeviceName组合，则以IotId为准。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称	类型	示例值	描述
Code	String	403	接口返回码： 200：表示成功。其它：表示错误码。错误码详情，请参见错误码。
Data	Struct		返回的设备信息。
Description	String	test	设备描述信息。
DeviceType	Integer	1	设备类型。 1：国标IPC。 2：国标NVR。 3：国标NVR子设备。 4：RTMP流设备。 7：其他设备。
GbDeviceInfo	Struct		国标设备信息。 DeviceType为1、2或3时，返回该参数信息。
DeviceProtocol	Integer	1	设备协议。 1：TCP。 2：UDP。
GbId	String	31****************21	国标ID。
NetProtocol	Integer	1	网络协议，取值1表示GB28181。
NickName	String	GBdevice	设备昵称。
Password	String	23*******	设备的密码。
SubProductKey	String	we5*****	子设备产品的ProductKey。
RtmpDeviceInfo	Struct		RTMP设备信息。 DeviceType为4时，返回该参数信息。
PullAuthKey	String	z8X5*****OQ	播流鉴权Key。
PullKeyExpireTime	Integer	600	播流URL有效期，单位秒。
PushAuthKey	String	PH******fpn	收流鉴权Key。
PushKeyExpireTime	Integer	600	收流URL有效期，单位秒。
PushUrlSample	String	rtmp://example.com/live/example	收流URL示例地址。
StreamName	String	linkvisual_iot-*******i_test	RTMP流名称。
StreamStatus	Integer	1	RTMP流状态。 0：未激活。 1：在线。 3：离线。
ErrorMessage	String	Request forbidden.	调用失败时，返回的出错信息。
RequestId	String	E55*B7-4-4-8-D3*****F565	阿里云为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功： true：调用成功。 false：调用失败。

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryVisionDeviceInfo
&IotInstanceId=iot-cn-n6w1y59****
&ProductKey=a1BwAGV****
&DeviceName=camera1
&<公共请求参数>

正常返回示例

XML格式

<QueryVisionDeviceInfoResponse>
  <RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>
  <Data>
        <DeviceType>1</DeviceType>
        <Description>test</Description>
        <GbDeviceInfo>
              <SubProductKey>we5*****</SubProductKey>
              <GbId>31****************21</GbId>
              <DeviceProtocol>1</DeviceProtocol>
              <NetProtocol>1</NetProtocol>
              <NickName>GBdevice</NickName>
              <Password>23*******</Password>
        </GbDeviceInfo>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</QueryVisionDeviceInfoResponse>

JSON格式

{
    "RequestId": "E55***B7-4***-4***-8***-D3******F565",
    "Data": {
        "DeviceType": 1,
        "Description": "test",
        "GbDeviceInfo": {
            "SubProductKey": "we5*****",
            "GbId": "31****************21",
            "DeviceProtocol": 1,
            "NetProtocol": 1,
            "NickName": "GBdevice",
            "Password": "23*******"
        }
    },
    "Code": 200,
    "Success": true
}

错误码

HttpCode	错误码	错误信息	描述
403	iot.vision.RequestForbidden	Request forbidden.	请求被禁止。
429	iot.vision.RequestTrafficControl	Request traffic control.	请求太频繁被限流。
400	iot.vision.RequestParameterError	Request parameter error:%s	请求参数错误。
400	iot.vision.RequestError	Request error.	请求失败。

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