调用该接口根据NVR量产批次ID来请求NVR及对应的IPC组合的设备列表。

路径 /living/cloud/product/nvr/device/cert/query
版本号 1.0.0
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 5000

请求参数

名称 类型 是否必选 示例值 描述
batchId String 量产批次ID。
productKey String NVR产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。
pageNo Int 从1开始的分页查询页。
pageSize Int 分页大小,取值范围:1~20。

返回数据

名称 类型 示例值 描述
code Int

接口返回码。200表示成功。

message String

调用失败时,返回的出错信息。

localizedMsg String

本地语言的错误消息。

data JSON

响应结果。

total Long

该批次的NVR设备证书总数。

pageNo Long

从1开始的当前页号。

pageSize Long

分页大小,取值范围:1~20。

NvrDeviceCertList JSON

nvr设备及其子设备列表三元组列表信息

ipcNum Int

该NVR网关下子设备的数量。

nvrDeviceCertInfo JSON

NVR设备证书信息。

iotId String

设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。

productKey String

产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。

deviceName String

设备的名称,设备证书信息之一。在注册设备时,自定义的或系统生成的设备名称,具备产品维度内的唯一性。

deviceSecret String

设备的密钥,设备证书信息之一。在注册设备时生活物联网平台为设备颁发的设备密钥,用于认证加密。需与DeviceName成对使用。

subDeviceCertList JSON

该NVR网关下子设备的设备证书列表。

iotId String

设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。

productKey String

产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。

deviceName String

设备的名称,设备证书信息之一。在注册设备时,自定义的或系统生成的设备名称,具备产品维度内的唯一性。

deviceSecret String

设备的密钥,设备证书信息之一。在注册设备时生活物联网平台为设备颁发的设备密钥,用于认证加密。需与DeviceName成对使用。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.0"
	},
	"params":{
		"batchId": "value0",
		"productKey": "value1",
		"pageNo": "value2",
		"pageSize": "value3"
	}
}

正常返回示例

JSON格式

{
    "code":200,
    "data":{
        "NvrDeviceCertList":[
            {
                "subDeviceCertList":[
                    {
                        "iotId":"09cxxxx0101",
                        "deviceSecret":"e2RexxxxMepCL4n",
                        "productKey":"a1xxxx3Q",
                        "deviceName":"09cxxxxFfgn"
                    },
                    {
                        "iotId":"0Ay8zxxxx000101",
                        "deviceSecret":"lYQaxxxxSmdMFC",
                        "productKey":"a1xxxx3Q",
                        "deviceName":"0AyxxxxRpp"
                    },
                    {
                        "iotId":"0Md9bpxxxx00101",
                        "deviceSecret":"ZVflxxxxW5pW",
                        "productKey":"a1xxxx3Q",
                        "deviceName":"0Mdxxxxeoqd"
                    }
                ],
                "nvrDeviceCertInfo":{
                    "iotId":"vcR91xxxx000101",
                    "deviceSecret":"RYV9xxxxXltunD",
                    "productKey":"a1xxxxCe",
                    "deviceName":"vcRxxxxMUf"
                },
                "ipcNum":3
            }       
        ],
        "totalNum":500,
        "pageNo":235,
        "pageSize":1
    },
    "id":"f0d2acef-xxxx-488b-xxxx-049b95f66a00"
}

异常返回示例

JSON格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}