方舟物联网使用手册

# QueryProduct

调用该接口查询指定产品的详细信息。

# 请求参数

名称 类型 是否必选 示例值 描述
Action String 是 QueryProduct 系统规定参数。取值：QueryProduct。
ProductKey String 是 a1BwAGV**** 要查询的产品的ProductKey。ProductKey是物联网平台为新建产品颁发的全局唯一标识符。您可以在物联网平台控制台或调用QueryProductList，查看当前账号下所有产品的信息。
IotInstanceId String 是 6912917943269**** 实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

# 返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException 调用失败时，返回的错误码。
Data Struct 调用成功时，返回的产品信息详情。
AuthType String secret 产品下的设备接入物联网平台的认证方式。
secret：使用设备密钥进行设备身份认证。
DataFormat Integer 1 取值：
1：Alink JSON。平台物联网平台定义的设备与云端的数据交换协议，采用 AlinkJSON 格式。
2：透传/自定义。使用自定义的数据格式。
Description String 智能路灯 产品描述。
DeviceCount Integer 0 该产品下的设备数量。
GmtCreate String Fri, 21-Mar-2022 10:04:24 GMT 该产品的创建时间。GMT 格式。
NodeType Integer 0 产品的节点类型。取值：
0：设备，可以直连物联网平台。
Owner Boolean true 调用者是否是产品的拥有者。
true：是。
false：不是。
ProductKey String a1T27vz**** 产品的ProductKey。创建产品时，物联网平台为该产品颁发的全局唯一标识。
ProductName String 路灯 产品名称。
ProductSecret String U5tW7i44uilc**** 产品密钥。
ProductStatus String DEVELOPMENT_STATUS 产品的状态。
DEVELOPMENT_STATUS：开发中。
RELEASE_STATUS：产品已发布。
ValidateType Integer 1 数据校验级别。可取值：
2：免校验。对上报的数据不进行校验，流转全量数据。
数据不展示在物联网平台控制台对应设备的设备详情页物模型数据页签。
1：弱校验。只校验设备数据的 identifier 和 dataType 字段，不校验其他字段，流转全量数据。
ErrorMessage String 系统异常 调用失败时，返回的出错信息。
RequestId String olmM8Mc9H3DcP7y4kGswzCG6lKHSAndq 平台为该请求生成的唯一标识符。
Success Boolean true 是否调用成功。
true：表示调用成功。
false：表示调用失败。

# 示例

请求示例

http://open.${区域}.fenydata.com/fenydata-java-open/?Action=QueryProduct
&ProductKey=a1BwAGV****
&IotInstanceId=70255861902711****
&<公共请求参数>

正常返回示例

XML格式

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xml>
    <Data>
        <AuthType>secret</AuthType>
        <DataFormat>1</DataFormat>
        <DeviceCount>0</DeviceCount>
        <GmtCreate>Tue, 27-May-2025 02:24:39 GMT</GmtCreate>
        <NodeType>0</NodeType>
        <Owner>true</Owner>
        <ProductKey>a1BwAGV****</ProductKey>
        <ProductName>路灯</ProductName>
        <ProductSecret>U5tW7i44uilc****</ProductSecret>
        <ProductStatus>DEVELOPMENT_STATUS</ProductStatus>
        <ValidateType>1</ValidateType>
        <Description>test23</Description>
    </Data>
    <RequestId>olmM8Mc9H3DcP7y4kGswzCG6lKHSAndq</RequestId>
    <Success>true</Success>
</xlm>

JSON格式

{
  "Data": {
    "AuthType": "secret",
    "DataFormat": 1,
    "DeviceCount": 0,
    "GmtCreate": "Tue, 27-May-2025 02:24:39 GMT",
    "NodeType": 0,
    "Owner": true,
    "ProductKey": "a1BwAGV****",
    "ProductName": "路灯",
    "ProductSecret": "U5tW7i44uilc****",
    "ProductStatus": "DEVELOPMENT_STATUS",
    "ValidateType": 1,
    "Description": "test23"
  },
  "RequestId": "olmM8Mc9H3DcP7y4kGswzCG6lKHSAndq",
  "Success": true
}

← 注册设备 →