{
  "name": "iot",
  "display_name": "加速物联网套件",
  "description": "",
  "domain": "other",
  "api_version": "2018-01-23",
  "endpoint": "iot.tencentcloudapi.com",
  "actions": [
    {
      "name": "ActivateRule",
      "description": "启用规则",
      "status": "online",
      "parameters": [
        {
          "name": "RuleId",
          "type": "string",
          "required": true,
          "description": "规则Id"
        }
      ],
      "required": [
        "RuleId"
      ]
    },
    {
      "name": "AddDevice",
      "description": "提供在指定的产品Id下创建一个设备的能力，生成设备名称与设备秘钥。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称，唯一标识某产品下的一个设备"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "AddProduct",
      "description": "本接口(AddProduct)用于创建、定义某款硬件产品。",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "产品名称，同一区域产品名称需唯一，支持中文、英文字母、中划线和下划线，长度不超过31个字符，中文占两个字符"
        },
        {
          "name": "Description",
          "type": "string",
          "required": true,
          "description": "产品描述"
        },
        {
          "name": "DataTemplate",
          "type": "array",
          "required": false,
          "description": "数据模版",
          "item_type": "object",
          "children": [
            {
              "name": "Number",
              "type": "object",
              "required": false,
              "description": "数字类型 注意：此字段可能返回 null，表示取不到有效值。",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": true,
                  "description": "名称"
                },
                {
                  "name": "Desc",
                  "type": "string",
                  "required": true,
                  "description": "描述"
                },
                {
                  "name": "Mode",
                  "type": "string",
                  "required": true,
                  "description": "读写模式"
                },
                {
                  "name": "Range",
                  "type": "array",
                  "required": true,
                  "description": "取值范围",
                  "item_type": "float"
                }
              ]
            },
            {
              "name": "String",
              "type": "object",
              "required": false,
              "description": "字符串类型 注意：此字段可能返回 null，表示取不到有效值。",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": true,
                  "description": "名称"
                },
                {
                  "name": "Desc",
                  "type": "string",
                  "required": true,
                  "description": "描述"
                },
                {
                  "name": "Mode",
                  "type": "string",
                  "required": true,
                  "description": "读写模式"
                },
                {
                  "name": "Range",
                  "type": "array",
                  "required": true,
                  "description": "长度范围",
                  "item_type": "integer"
                }
              ]
            },
            {
              "name": "Enum",
              "type": "object",
              "required": false,
              "description": "枚举类型 注意：此字段可能返回 null，表示取不到有效值。",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": true,
                  "description": "名称"
                },
                {
                  "name": "Desc",
                  "type": "string",
                  "required": true,
                  "description": "描述"
                },
                {
                  "name": "Mode",
                  "type": "string",
                  "required": true,
                  "description": "读写模式"
                },
                {
                  "name": "Range",
                  "type": "array",
                  "required": true,
                  "description": "取值列表",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "Bool",
              "type": "object",
              "required": false,
              "description": "布尔类型 注意：此字段可能返回 null，表示取不到有效值。",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": true,
                  "description": "名称"
                },
                {
                  "name": "Desc",
                  "type": "string",
                  "required": true,
                  "description": "描述"
                },
                {
                  "name": "Mode",
                  "type": "string",
                  "required": true,
                  "description": "读写模式"
                },
                {
                  "name": "Range",
                  "type": "array",
                  "required": true,
                  "description": "取值列表",
                  "item_type": "boolean"
                }
              ]
            }
          ]
        },
        {
          "name": "DataProtocol",
          "type": "string",
          "required": false,
          "description": "产品版本（native表示基础版，template表示高级版，默认值为template）"
        },
        {
          "name": "AuthType",
          "type": "integer",
          "required": false,
          "description": "设备认证方式（1：动态令牌，2：签名直连鉴权）"
        },
        {
          "name": "CommProtocol",
          "type": "string",
          "required": false,
          "description": "通信方式（other/wifi/cellular/nb-iot）"
        },
        {
          "name": "DeviceType",
          "type": "string",
          "required": false,
          "description": "产品的设备类型（device: 直连设备；sub_device：子设备；gateway：网关设备）"
        }
      ],
      "required": [
        "Name",
        "Description"
      ]
    },
    {
      "name": "AddRule",
      "description": "新增规则",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "名称"
        },
        {
          "name": "Description",
          "type": "string",
          "required": true,
          "description": "描述"
        },
        {
          "name": "Query",
          "type": "object",
          "required": false,
          "description": "查询",
          "children": [
            {
              "name": "Field",
              "type": "string",
              "required": true,
              "description": "字段"
            },
            {
              "name": "Condition",
              "type": "string",
              "required": true,
              "description": "过滤规则"
            },
            {
              "name": "Topic",
              "type": "string",
              "required": false,
              "description": "Topic 注意：此字段可能返回 null，表示取不到有效值。"
            },
            {
              "name": "ProductId",
              "type": "string",
              "required": false,
              "description": "产品Id 注意：此字段可能返回 null，表示取不到有效值。"
            }
          ]
        },
        {
          "name": "Actions",
          "type": "array",
          "required": false,
          "description": "转发动作列表",
          "item_type": "object",
          "children": [
            {
              "name": "Topic",
              "type": "object",
              "required": false,
              "description": "转发至topic 注意：此字段可能返回 null，表示取不到有效值。",
              "children": [
                {
                  "name": "Topic",
                  "type": "string",
                  "required": true,
                  "description": "目标topic"
                }
              ]
            },
            {
              "name": "Service",
              "type": "object",
              "required": false,
              "description": "转发至第三发 注意：此字段可能返回 null，表示取不到有效值。",
              "children": [
                {
                  "name": "Url",
                  "type": "string",
                  "required": true,
                  "description": "服务url地址"
                }
              ]
            },
            {
              "name": "Ckafka",
              "type": "object",
              "required": false,
              "description": "转发至第三发Ckafka 注意：此字段可能返回 null，表示取不到有效值。",
              "children": [
                {
                  "name": "InstanceId",
                  "type": "string",
                  "required": true,
                  "description": "实例Id"
                },
                {
                  "name": "TopicName",
                  "type": "string",
                  "required": true,
                  "description": "topic名称"
                },
                {
                  "name": "Region",
                  "type": "string",
                  "required": true,
                  "description": "地域"
                }
              ]
            }
          ]
        },
        {
          "name": "DataType",
          "type": "integer",
          "required": false,
          "description": "数据类型（0：文本，1：二进制）"
        }
      ],
      "required": [
        "Name",
        "Description"
      ]
    },
    {
      "name": "AddTopic",
      "description": "新增Topic，用于设备或应用发布消息至该Topic或订阅该Topic的消息。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "TopicName",
          "type": "string",
          "required": true,
          "description": "Topic名称"
        }
      ],
      "required": [
        "ProductId",
        "TopicName"
      ]
    },
    {
      "name": "AppAddUser",
      "description": "为APP提供用户注册功能",
      "status": "online",
      "parameters": [
        {
          "name": "UserName",
          "type": "string",
          "required": true,
          "description": "用户名"
        },
        {
          "name": "Password",
          "type": "string",
          "required": true,
          "description": "密码"
        }
      ],
      "required": [
        "UserName",
        "Password"
      ]
    },
    {
      "name": "AppDeleteDevice",
      "description": "用户解除与设备的关联关系，解除后APP用户无法控制设备，获取设备数据",
      "status": "online",
      "parameters": [
        {
          "name": "AccessToken",
          "type": "string",
          "required": true,
          "description": "访问Token"
        },
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称"
        }
      ],
      "required": [
        "AccessToken",
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "AppGetDevice",
      "description": "获取绑定设备的基本信息与数据模板定义",
      "status": "online",
      "parameters": [
        {
          "name": "AccessToken",
          "type": "string",
          "required": true,
          "description": "访问Token"
        },
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称"
        }
      ],
      "required": [
        "AccessToken",
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "AppGetDeviceData",
      "description": "获取绑定设备数据，用于实时展示设备的最新数据",
      "status": "online",
      "parameters": [
        {
          "name": "AccessToken",
          "type": "string",
          "required": true,
          "description": "访问Token"
        },
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称"
        }
      ],
      "required": [
        "AccessToken",
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "AppGetDeviceStatuses",
      "description": "获取绑定设备的上下线状态",
      "status": "online",
      "parameters": [
        {
          "name": "AccessToken",
          "type": "string",
          "required": true,
          "description": "访问Token"
        },
        {
          "name": "DeviceIds",
          "type": "array",
          "required": true,
          "description": "设备Id列表（单次限制1000个设备）",
          "item_type": "string"
        }
      ],
      "required": [
        "AccessToken",
        "DeviceIds"
      ]
    },
    {
      "name": "AppGetDevices",
      "description": "获取用户的绑定设备列表",
      "status": "online",
      "parameters": [
        {
          "name": "AccessToken",
          "type": "string",
          "required": true,
          "description": "访问Token"
        }
      ],
      "required": [
        "AccessToken"
      ]
    },
    {
      "name": "AppGetToken",
      "description": "获取用户token",
      "status": "online",
      "parameters": [
        {
          "name": "UserName",
          "type": "string",
          "required": true,
          "description": "用户名"
        },
        {
          "name": "Password",
          "type": "string",
          "required": true,
          "description": "密码"
        },
        {
          "name": "Expire",
          "type": "integer",
          "required": false,
          "description": "TTL"
        }
      ],
      "required": [
        "UserName",
        "Password"
      ]
    },
    {
      "name": "AppGetUser",
      "description": "获取用户信息",
      "status": "online",
      "parameters": [
        {
          "name": "AccessToken",
          "type": "string",
          "required": true,
          "description": "访问Token"
        }
      ],
      "required": [
        "AccessToken"
      ]
    },
    {
      "name": "AppIssueDeviceControl",
      "description": "用户通过APP控制设备",
      "status": "online",
      "parameters": [
        {
          "name": "AccessToken",
          "type": "string",
          "required": true,
          "description": "访问Token"
        },
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称"
        },
        {
          "name": "ControlData",
          "type": "string",
          "required": true,
          "description": "控制数据（json）"
        },
        {
          "name": "Metadata",
          "type": "boolean",
          "required": false,
          "description": "是否发送metadata字段"
        }
      ],
      "required": [
        "AccessToken",
        "ProductId",
        "DeviceName",
        "ControlData"
      ]
    },
    {
      "name": "AppResetPassword",
      "description": "重置APP用户密码",
      "status": "online",
      "parameters": [
        {
          "name": "AccessToken",
          "type": "string",
          "required": true,
          "description": "访问Token"
        },
        {
          "name": "OldPassword",
          "type": "string",
          "required": true,
          "description": "旧密码"
        },
        {
          "name": "NewPassword",
          "type": "string",
          "required": true,
          "description": "新密码"
        }
      ],
      "required": [
        "AccessToken",
        "OldPassword",
        "NewPassword"
      ]
    },
    {
      "name": "AppSecureAddDevice",
      "description": "用户绑定设备，绑定后可以在APP端进行控制。绑定设备前需调用“获取设备绑定签名”接口",
      "status": "online",
      "parameters": [
        {
          "name": "AccessToken",
          "type": "string",
          "required": true,
          "description": "访问Token"
        },
        {
          "name": "DeviceSignature",
          "type": "string",
          "required": true,
          "description": "设备签名"
        }
      ],
      "required": [
        "AccessToken",
        "DeviceSignature"
      ]
    },
    {
      "name": "AppUpdateDevice",
      "description": "修改设备别名，便于用户个性化定义设备的名称",
      "status": "online",
      "parameters": [
        {
          "name": "AccessToken",
          "type": "string",
          "required": true,
          "description": "访问Token"
        },
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称"
        },
        {
          "name": "AliasName",
          "type": "string",
          "required": false,
          "description": "设备别名"
        }
      ],
      "required": [
        "AccessToken",
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "AppUpdateUser",
      "description": "修改用户信息",
      "status": "online",
      "parameters": [
        {
          "name": "AccessToken",
          "type": "string",
          "required": true,
          "description": "访问Token"
        },
        {
          "name": "NickName",
          "type": "string",
          "required": false,
          "description": "昵称"
        }
      ],
      "required": [
        "AccessToken"
      ]
    },
    {
      "name": "AssociateSubDeviceToGatewayProduct",
      "description": "关联子设备产品和网关产品",
      "status": "online",
      "parameters": [
        {
          "name": "SubDeviceProductId",
          "type": "string",
          "required": true,
          "description": "子设备产品Id"
        },
        {
          "name": "GatewayProductId",
          "type": "string",
          "required": true,
          "description": "网关产品Id"
        }
      ],
      "required": [
        "SubDeviceProductId",
        "GatewayProductId"
      ]
    },
    {
      "name": "DeactivateRule",
      "description": "禁用规则",
      "status": "online",
      "parameters": [
        {
          "name": "RuleId",
          "type": "string",
          "required": true,
          "description": "规则Id"
        }
      ],
      "required": [
        "RuleId"
      ]
    },
    {
      "name": "DeleteDevice",
      "description": "提供在指定的产品Id下删除一个设备的能力。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "DeleteProduct",
      "description": "删除用户指定的产品Id对应的信息。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        }
      ],
      "required": [
        "ProductId"
      ]
    },
    {
      "name": "DeleteRule",
      "description": "删除规则",
      "status": "online",
      "parameters": [
        {
          "name": "RuleId",
          "type": "string",
          "required": true,
          "description": "规则Id"
        }
      ],
      "required": [
        "RuleId"
      ]
    },
    {
      "name": "DeleteTopic",
      "description": "删除Topic",
      "status": "online",
      "parameters": [
        {
          "name": "TopicId",
          "type": "string",
          "required": true,
          "description": "TopicId"
        },
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        }
      ],
      "required": [
        "TopicId",
        "ProductId"
      ]
    },
    {
      "name": "GetDataHistory",
      "description": "批量获取设备某一段时间范围的设备上报数据。该接口适用于使用高级版类型的产品",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "DeviceNames",
          "type": "array",
          "required": true,
          "description": "设备名称列表，允许最多一次100台",
          "item_type": "string"
        },
        {
          "name": "StartTime",
          "type": "string",
          "required": true,
          "description": "查询开始时间"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": true,
          "description": "查询结束时间"
        },
        {
          "name": "Size",
          "type": "integer",
          "required": false,
          "description": "查询数据量"
        },
        {
          "name": "Order",
          "type": "string",
          "required": false,
          "description": "时间排序（desc/asc）"
        },
        {
          "name": "ScrollId",
          "type": "string",
          "required": false,
          "description": "查询游标"
        }
      ],
      "required": [
        "ProductId",
        "DeviceNames",
        "StartTime",
        "EndTime"
      ]
    },
    {
      "name": "GetDebugLog",
      "description": "获取设备的调试日志，用于定位问题",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "DeviceNames",
          "type": "array",
          "required": true,
          "description": "设备名称列表，最大支持100台",
          "item_type": "string"
        },
        {
          "name": "StartTime",
          "type": "string",
          "required": true,
          "description": "查询开始时间"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": true,
          "description": "查询结束时间"
        },
        {
          "name": "Size",
          "type": "integer",
          "required": false,
          "description": "查询数据量"
        },
        {
          "name": "Order",
          "type": "string",
          "required": false,
          "description": "时间排序（desc/asc）"
        },
        {
          "name": "ScrollId",
          "type": "string",
          "required": false,
          "description": "查询游标"
        },
        {
          "name": "Type",
          "type": "string",
          "required": false,
          "description": "日志类型（shadow/action/mqtt）"
        }
      ],
      "required": [
        "ProductId",
        "DeviceNames",
        "StartTime",
        "EndTime"
      ]
    },
    {
      "name": "GetDevice",
      "description": "提供查询某个设备详细信息的能力。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "GetDeviceData",
      "description": "获取某个设备当前上报到云端的数据，该接口适用于使用数据模板协议的产品。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "GetDeviceLog",
      "description": "批量获取设备与云端的详细通信日志，该接口适用于使用高级版类型的产品。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "DeviceNames",
          "type": "array",
          "required": true,
          "description": "设备名称列表，最大支持100台",
          "item_type": "string"
        },
        {
          "name": "StartTime",
          "type": "string",
          "required": true,
          "description": "查询开始时间"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": true,
          "description": "查询结束时间"
        },
        {
          "name": "Size",
          "type": "integer",
          "required": false,
          "description": "查询数据量"
        },
        {
          "name": "Order",
          "type": "string",
          "required": false,
          "description": "时间排序（desc/asc）"
        },
        {
          "name": "ScrollId",
          "type": "string",
          "required": false,
          "description": "查询游标"
        },
        {
          "name": "Type",
          "type": "string",
          "required": false,
          "description": "日志类型（comm/status）"
        }
      ],
      "required": [
        "ProductId",
        "DeviceNames",
        "StartTime",
        "EndTime"
      ]
    },
    {
      "name": "GetDeviceSignatures",
      "description": "获取设备绑定签名，用于用户绑定某个设备的应用场景",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID"
        },
        {
          "name": "DeviceNames",
          "type": "array",
          "required": true,
          "description": "设备名称列表（单次限制1000个设备）",
          "item_type": "string"
        },
        {
          "name": "Expire",
          "type": "integer",
          "required": false,
          "description": "过期时间"
        }
      ],
      "required": [
        "ProductId",
        "DeviceNames"
      ]
    },
    {
      "name": "GetDeviceStatistics",
      "description": "查询某段时间范围内产品的在线、激活设备数",
      "status": "online",
      "parameters": [
        {
          "name": "Products",
          "type": "array",
          "required": false,
          "description": "产品Id列表",
          "item_type": "string"
        },
        {
          "name": "StartDate",
          "type": "string",
          "required": false,
          "description": "开始日期"
        },
        {
          "name": "EndDate",
          "type": "string",
          "required": false,
          "description": "结束日期"
        }
      ],
      "required": []
    },
    {
      "name": "GetDeviceStatuses",
      "description": "批量获取设备的当前状态，状态包括在线、离线或未激活状态。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID"
        },
        {
          "name": "DeviceNames",
          "type": "array",
          "required": true,
          "description": "设备名称列表（单次限制1000个设备）",
          "item_type": "string"
        }
      ],
      "required": [
        "ProductId",
        "DeviceNames"
      ]
    },
    {
      "name": "GetDevices",
      "description": "提供分页查询某个产品Id下设备信息的能力。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移"
        },
        {
          "name": "Length",
          "type": "integer",
          "required": false,
          "description": "长度"
        },
        {
          "name": "Keyword",
          "type": "string",
          "required": false,
          "description": "关键字查询"
        }
      ],
      "required": [
        "ProductId"
      ]
    },
    {
      "name": "GetProduct",
      "description": "获取产品定义的详细信息，包括产品名称、产品描述，鉴权模式等信息。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        }
      ],
      "required": [
        "ProductId"
      ]
    },
    {
      "name": "GetProducts",
      "description": "获取用户在物联网套件所创建的所有产品信息。",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移"
        },
        {
          "name": "Length",
          "type": "integer",
          "required": false,
          "description": "长度"
        }
      ],
      "required": []
    },
    {
      "name": "GetRule",
      "description": "获取转发规则信息",
      "status": "online",
      "parameters": [
        {
          "name": "RuleId",
          "type": "string",
          "required": true,
          "description": "规则Id"
        }
      ],
      "required": [
        "RuleId"
      ]
    },
    {
      "name": "GetRules",
      "description": "获取转发规则列表",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移"
        },
        {
          "name": "Length",
          "type": "integer",
          "required": false,
          "description": "长度"
        }
      ],
      "required": []
    },
    {
      "name": "GetTopic",
      "description": "获取Topic信息",
      "status": "online",
      "parameters": [
        {
          "name": "TopicId",
          "type": "string",
          "required": true,
          "description": "TopicId"
        },
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        }
      ],
      "required": [
        "TopicId",
        "ProductId"
      ]
    },
    {
      "name": "GetTopics",
      "description": "获取Topic列表",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移"
        },
        {
          "name": "Length",
          "type": "integer",
          "required": false,
          "description": "长度"
        }
      ],
      "required": [
        "ProductId"
      ]
    },
    {
      "name": "IssueDeviceControl",
      "description": "提供下发控制指令到指定设备的能力，该接口适用于使用高级版类型的产品。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称"
        },
        {
          "name": "ControlData",
          "type": "string",
          "required": true,
          "description": "控制数据（json）"
        },
        {
          "name": "Metadata",
          "type": "boolean",
          "required": false,
          "description": "是否发送metadata字段"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName",
        "ControlData"
      ]
    },
    {
      "name": "PublishMsg",
      "description": "提供向指定的Topic发布消息的能力，常用于向设备下发控制指令。该接口只适用于产品版本为“基础版”类型的产品，使用高级版的产品需使用“下发设备控制指令”接口",
      "status": "online",
      "parameters": [
        {
          "name": "Topic",
          "type": "string",
          "required": true,
          "description": "Topic"
        },
        {
          "name": "Message",
          "type": "string",
          "required": true,
          "description": "消息内容"
        },
        {
          "name": "Qos",
          "type": "integer",
          "required": false,
          "description": "Qos(目前QoS支持0与1)"
        }
      ],
      "required": [
        "Topic",
        "Message"
      ]
    },
    {
      "name": "ResetDevice",
      "description": "重置设备操作，将会为设备生成新的证书及清空最新数据，需谨慎操作。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "UnassociateSubDeviceFromGatewayProduct",
      "description": "业务无客户使用，下线接口。 取消子设备产品与网关设备产品的关联",
      "status": "deprecated",
      "parameters": [
        {
          "name": "SubDeviceProductId",
          "type": "string",
          "required": true,
          "description": "子设备产品Id"
        },
        {
          "name": "GatewayProductId",
          "type": "string",
          "required": true,
          "description": "网关设备产品Id"
        }
      ],
      "required": [
        "SubDeviceProductId",
        "GatewayProductId"
      ]
    },
    {
      "name": "UpdateProduct",
      "description": "提供修改产品信息及数据模板的能力。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "产品名称"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "产品描述"
        },
        {
          "name": "DataTemplate",
          "type": "array",
          "required": false,
          "description": "数据模版",
          "item_type": "object",
          "children": [
            {
              "name": "Number",
              "type": "object",
              "required": false,
              "description": "数字类型 注意：此字段可能返回 null，表示取不到有效值。",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": true,
                  "description": "名称"
                },
                {
                  "name": "Desc",
                  "type": "string",
                  "required": true,
                  "description": "描述"
                },
                {
                  "name": "Mode",
                  "type": "string",
                  "required": true,
                  "description": "读写模式"
                },
                {
                  "name": "Range",
                  "type": "array",
                  "required": true,
                  "description": "取值范围",
                  "item_type": "float"
                }
              ]
            },
            {
              "name": "String",
              "type": "object",
              "required": false,
              "description": "字符串类型 注意：此字段可能返回 null，表示取不到有效值。",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": true,
                  "description": "名称"
                },
                {
                  "name": "Desc",
                  "type": "string",
                  "required": true,
                  "description": "描述"
                },
                {
                  "name": "Mode",
                  "type": "string",
                  "required": true,
                  "description": "读写模式"
                },
                {
                  "name": "Range",
                  "type": "array",
                  "required": true,
                  "description": "长度范围",
                  "item_type": "integer"
                }
              ]
            },
            {
              "name": "Enum",
              "type": "object",
              "required": false,
              "description": "枚举类型 注意：此字段可能返回 null，表示取不到有效值。",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": true,
                  "description": "名称"
                },
                {
                  "name": "Desc",
                  "type": "string",
                  "required": true,
                  "description": "描述"
                },
                {
                  "name": "Mode",
                  "type": "string",
                  "required": true,
                  "description": "读写模式"
                },
                {
                  "name": "Range",
                  "type": "array",
                  "required": true,
                  "description": "取值列表",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "Bool",
              "type": "object",
              "required": false,
              "description": "布尔类型 注意：此字段可能返回 null，表示取不到有效值。",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": true,
                  "description": "名称"
                },
                {
                  "name": "Desc",
                  "type": "string",
                  "required": true,
                  "description": "描述"
                },
                {
                  "name": "Mode",
                  "type": "string",
                  "required": true,
                  "description": "读写模式"
                },
                {
                  "name": "Range",
                  "type": "array",
                  "required": true,
                  "description": "取值列表",
                  "item_type": "boolean"
                }
              ]
            }
          ]
        }
      ],
      "required": [
        "ProductId"
      ]
    },
    {
      "name": "UpdateRule",
      "description": "更新规则",
      "status": "online",
      "parameters": [
        {
          "name": "RuleId",
          "type": "string",
          "required": true,
          "description": "规则Id"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "名称"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "描述"
        },
        {
          "name": "Query",
          "type": "object",
          "required": false,
          "description": "查询",
          "children": [
            {
              "name": "Field",
              "type": "string",
              "required": true,
              "description": "字段"
            },
            {
              "name": "Condition",
              "type": "string",
              "required": true,
              "description": "过滤规则"
            },
            {
              "name": "Topic",
              "type": "string",
              "required": false,
              "description": "Topic 注意：此字段可能返回 null，表示取不到有效值。"
            },
            {
              "name": "ProductId",
              "type": "string",
              "required": false,
              "description": "产品Id 注意：此字段可能返回 null，表示取不到有效值。"
            }
          ]
        },
        {
          "name": "Actions",
          "type": "array",
          "required": false,
          "description": "转发动作列表",
          "item_type": "object",
          "children": [
            {
              "name": "Topic",
              "type": "object",
              "required": false,
              "description": "转发至topic 注意：此字段可能返回 null，表示取不到有效值。",
              "children": [
                {
                  "name": "Topic",
                  "type": "string",
                  "required": true,
                  "description": "目标topic"
                }
              ]
            },
            {
              "name": "Service",
              "type": "object",
              "required": false,
              "description": "转发至第三发 注意：此字段可能返回 null，表示取不到有效值。",
              "children": [
                {
                  "name": "Url",
                  "type": "string",
                  "required": true,
                  "description": "服务url地址"
                }
              ]
            },
            {
              "name": "Ckafka",
              "type": "object",
              "required": false,
              "description": "转发至第三发Ckafka 注意：此字段可能返回 null，表示取不到有效值。",
              "children": [
                {
                  "name": "InstanceId",
                  "type": "string",
                  "required": true,
                  "description": "实例Id"
                },
                {
                  "name": "TopicName",
                  "type": "string",
                  "required": true,
                  "description": "topic名称"
                },
                {
                  "name": "Region",
                  "type": "string",
                  "required": true,
                  "description": "地域"
                }
              ]
            }
          ]
        },
        {
          "name": "DataType",
          "type": "integer",
          "required": false,
          "description": "数据类型（0：文本，1：二进制）"
        }
      ],
      "required": [
        "RuleId"
      ]
    }
  ]
}