{
  "name": "iotcloud",
  "display_name": "物联网通信",
  "description": "介绍如何使用API对物联网通信进行操作，包括规则引擎等。",
  "domain": "other",
  "api_version": "2021-04-08",
  "endpoint": "iotcloud.tencentcloudapi.com",
  "actions": [
    {
      "name": "BatchUpdateFirmware",
      "description": "本接口（BatchUpdateFirmware）用于批量更新设备固件",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5123"
        },
        {
          "name": "FirmwareVersion",
          "type": "string",
          "required": true,
          "description": "固件新版本号",
          "example": "2.0.0"
        },
        {
          "name": "FirmwareOriVersion",
          "type": "string",
          "required": false,
          "description": "固件原版本号，根据文件列表升级固件不需要填写此参数",
          "example": "1.0.0"
        },
        {
          "name": "UpgradeMethod",
          "type": "integer",
          "required": false,
          "description": "升级方式，0 静默升级 1 用户确认升级。 不填默认为静默升级方式",
          "example": "0"
        },
        {
          "name": "FileName",
          "type": "string",
          "required": false,
          "description": "设备列表文件名称，根据文件列表升级固件需要填写此参数",
          "example": "ota"
        },
        {
          "name": "FileMd5",
          "type": "string",
          "required": false,
          "description": "设备列表的文件md5值",
          "example": "608afe29a06b19d3033c5f8787ec75fa"
        },
        {
          "name": "FileSize",
          "type": "integer",
          "required": false,
          "description": "设备列表的文件大小值",
          "example": "120"
        },
        {
          "name": "DeviceNames",
          "type": "array",
          "required": false,
          "description": "需要升级的设备名称列表",
          "example": "dev_001",
          "item_type": "string"
        },
        {
          "name": "TimeoutInterval",
          "type": "integer",
          "required": false,
          "description": "固件升级任务，默认超时时间。 最小取值60秒，最大为3600秒",
          "example": "120"
        },
        {
          "name": "Type",
          "type": "integer",
          "required": false,
          "description": "固件升级任务类型，默认静态升级值为空或1，动态升级值为7。",
          "example": "7"
        }
      ],
      "required": [
        "ProductId",
        "FirmwareVersion"
      ]
    },
    {
      "name": "BindDevices",
      "description": "本接口（BindDevices）用于网关设备批量绑定子设备",
      "status": "online",
      "parameters": [
        {
          "name": "GatewayProductId",
          "type": "string",
          "required": true,
          "description": "网关设备的产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "GatewayDeviceName",
          "type": "string",
          "required": true,
          "description": "网关设备的设备名",
          "example": "devGat-001"
        },
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "被绑定设备的产品ID",
          "example": "DGRESAG222"
        },
        {
          "name": "DeviceNames",
          "type": "array",
          "required": true,
          "description": "被绑定的多个设备名",
          "example": "[\"dev01\\n\",\"dev02\\n\"]",
          "item_type": "string"
        },
        {
          "name": "Skey",
          "type": "string",
          "required": false,
          "description": "中兴CLAA设备的绑定需要skey，普通的设备不需要",
          "example": "adferdfwe"
        }
      ],
      "required": [
        "GatewayProductId",
        "GatewayDeviceName",
        "ProductId",
        "DeviceNames"
      ]
    },
    {
      "name": "CancelDeviceFirmwareTask",
      "description": "取消设备升级任务",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称",
          "example": "dev-001"
        },
        {
          "name": "FirmwareVersion",
          "type": "string",
          "required": true,
          "description": "固件版本号",
          "example": "1.0.0"
        },
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "固件升级任务ID",
          "example": "10000"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName",
        "FirmwareVersion",
        "TaskId"
      ]
    },
    {
      "name": "CreateDevice",
      "description": "本接口（CreateDevice）用于新建一个物联网通信设备。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品 ID 。创建产品时腾讯云为用户分配全局唯一的 ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称。命名规则：[a-zA-Z0-9:_-]{1,48}。",
          "example": "dev-001"
        },
        {
          "name": "Attribute",
          "type": "object",
          "required": false,
          "description": "设备属性",
          "example": "{\"type\":1}",
          "children": [
            {
              "name": "Tags",
              "type": "array",
              "required": false,
              "description": "属性列表",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Tag",
                  "type": "string",
                  "required": true,
                  "description": "属性名称",
                  "example": "tagkey"
                },
                {
                  "name": "Type",
                  "type": "integer",
                  "required": true,
                  "description": "属性值的类型，1 int，2 string",
                  "example": "1"
                },
                {
                  "name": "Value",
                  "type": "string",
                  "required": true,
                  "description": "属性的值",
                  "example": "34231"
                },
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "属性描述名称 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "xyz"
                }
              ]
            }
          ]
        },
        {
          "name": "DefinedPsk",
          "type": "string",
          "required": false,
          "description": "是否使用自定义PSK，默认不使用",
          "example": "adferdfwe"
        },
        {
          "name": "Isp",
          "type": "integer",
          "required": false,
          "description": "运营商类型，当产品是NB-IoT产品时，此字段必填。1表示中国电信，2表示中国移动，3表示中国联通",
          "example": "Isp"
        },
        {
          "name": "Imei",
          "type": "string",
          "required": false,
          "description": "IMEI，当产品是NB-IoT产品时，此字段必填",
          "example": "Imsi"
        },
        {
          "name": "LoraDevEui",
          "type": "string",
          "required": false,
          "description": "LoRa设备的DevEui，当创建LoRa时，此字段必填",
          "example": "Eui"
        },
        {
          "name": "LoraMoteType",
          "type": "integer",
          "required": false,
          "description": "LoRa设备的MoteType",
          "example": "Type"
        },
        {
          "name": "Skey",
          "type": "string",
          "required": false,
          "description": "创建LoRa设备需要skey",
          "example": "skey"
        },
        {
          "name": "LoraAppKey",
          "type": "string",
          "required": false,
          "description": "LoRa设备的AppKey",
          "example": "key"
        },
        {
          "name": "TlsCrt",
          "type": "string",
          "required": false,
          "description": "私有CA创建的设备证书",
          "example": "-----BEGIN CERTIFICATE----- MIIFGjCCBAKgAwIBAgIQCgRw0Ja8ihLIkKbf"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "CreateMultiDevicesTask",
      "description": "本接口（CreateMultiDevicesTask）用于创建产品级别的批量创建设备任务",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "ParametersType",
          "type": "string",
          "required": true,
          "description": "参数类型 cosfile-文件上传 random-随机创建",
          "example": "random"
        },
        {
          "name": "FileName",
          "type": "string",
          "required": false,
          "description": "文件上传类型时文件名",
          "example": "mydev"
        },
        {
          "name": "FileSize",
          "type": "integer",
          "required": false,
          "description": "文件上传类型时文件大小",
          "example": "20"
        },
        {
          "name": "BatchCount",
          "type": "integer",
          "required": false,
          "description": "随机创建时设备创建个数",
          "example": "1"
        },
        {
          "name": "Hash",
          "type": "string",
          "required": false,
          "description": "文件上传类型时文件md5值",
          "example": "bda2cc64487b0db7f53d689bccabde2d"
        }
      ],
      "required": [
        "ProductId",
        "ParametersType"
      ]
    },
    {
      "name": "CreatePrivateCA",
      "description": "创建私有CA证书",
      "status": "online",
      "parameters": [
        {
          "name": "CertName",
          "type": "string",
          "required": true,
          "description": "CA证书名称",
          "example": "Cert_dev"
        },
        {
          "name": "CertText",
          "type": "string",
          "required": true,
          "description": "CA证书内容",
          "example": "-----BEGIN CERTIFICATE-----\\nMIID...\\n-----END CERTIFICATE-----"
        },
        {
          "name": "VerifyCertText",
          "type": "string",
          "required": true,
          "description": "校验CA证书的证书内容",
          "example": "-----BEGIN CERTIFICATE-----\\nMIID...\\n-----END CERTIFICATE-----"
        }
      ],
      "required": [
        "CertName",
        "CertText",
        "VerifyCertText"
      ]
    },
    {
      "name": "CreateProduct",
      "description": "本接口（CreateProduct）用于创建一个新的物联网通信产品",
      "status": "online",
      "parameters": [
        {
          "name": "ProductName",
          "type": "string",
          "required": true,
          "description": "产品名称，名称不能和已经存在的产品名称重复。命名规则：[a-zA-Z0-9:_-]{1,32}",
          "example": "dev-01"
        },
        {
          "name": "ProductProperties",
          "type": "object",
          "required": false,
          "description": "产品属性",
          "example": "{\"EncryptionType=1\",}",
          "children": [
            {
              "name": "ProductDescription",
              "type": "string",
              "required": false,
              "description": "产品描述",
              "example": "IotHub"
            },
            {
              "name": "EncryptionType",
              "type": "string",
              "required": false,
              "description": "加密类型，1表示证书认证，2表示签名认证。如不填写，默认值是1",
              "example": "2"
            },
            {
              "name": "Region",
              "type": "string",
              "required": false,
              "description": "产品所属区域，目前只支持广州（gz）",
              "example": "gz"
            },
            {
              "name": "ProductType",
              "type": "integer",
              "required": false,
              "description": "产品类型，各个类型值代表的节点-类型如下： 0 普通产品，2 NB-IoT产品，4 LoRa产品，3 LoRa网关产品，5 普通网关产品 默认值是0",
              "example": "5"
            },
            {
              "name": "Format",
              "type": "string",
              "required": false,
              "description": "数据格式，取值为json或者custom，默认值是json",
              "example": "json"
            },
            {
              "name": "Platform",
              "type": "string",
              "required": false,
              "description": "产品所属平台，默认值是0",
              "example": "0"
            },
            {
              "name": "ModelId",
              "type": "string",
              "required": false,
              "description": "产品绑定的物模型ID，-1表示不绑定",
              "example": "-1"
            },
            {
              "name": "ModelName",
              "type": "string",
              "required": false,
              "description": "产品绑定的物模型名称",
              "example": "ipc"
            },
            {
              "name": "ProductKey",
              "type": "string",
              "required": false,
              "description": "产品密钥，suite产品才会有",
              "example": "grwgrer"
            },
            {
              "name": "RegisterType",
              "type": "integer",
              "required": false,
              "description": "动态注册类型 0-关闭, 1-预定义设备名 2-动态定义设备名",
              "example": "0"
            },
            {
              "name": "ProductSecret",
              "type": "string",
              "required": false,
              "description": "动态注册产品密钥",
              "example": "key"
            },
            {
              "name": "RegisterLimit",
              "type": "integer",
              "required": false,
              "description": "RegisterType为2时，设备动态创建的限制数量",
              "example": "1000"
            },
            {
              "name": "OriginProductId",
              "type": "string",
              "required": false,
              "description": "划归的产品，展示为源产品ID，其余为空",
              "example": "UTY6QRLMQY"
            },
            {
              "name": "PrivateCAName",
              "type": "string",
              "required": false,
              "description": "私有CA名称",
              "example": "caname"
            },
            {
              "name": "OriginUserId",
              "type": "integer",
              "required": false,
              "description": "划归的产品，展示为源用户ID，其余为空",
              "example": "fag"
            },
            {
              "name": "DeviceLimit",
              "type": "integer",
              "required": false,
              "description": "设备限制",
              "example": "1000"
            },
            {
              "name": "ForbiddenStatus",
              "type": "integer",
              "required": false,
              "description": "产品禁用状态",
              "example": "0"
            },
            {
              "name": "AppEUI",
              "type": "string",
              "required": false,
              "description": "LoRa产品运营侧APPEUI，只有LoRa产品需要填写",
              "example": "UTY6QRLMQY"
            }
          ]
        },
        {
          "name": "Skey",
          "type": "string",
          "required": false,
          "description": "创建CLAA产品时，需要Skey",
          "example": "adferdfwe"
        }
      ],
      "required": [
        "ProductName"
      ]
    },
    {
      "name": "CreateTaskFileUrl",
      "description": "本接口（CreateTaskFileUrl）用于获取产品级任务文件上传链接",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        }
      ],
      "required": [
        "ProductId"
      ]
    },
    {
      "name": "CreateTopicPolicy",
      "description": "本接口（CreateTopicPolicy）用于创建一个Topic",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品自身ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "TopicName",
          "type": "string",
          "required": true,
          "description": "Topic名称",
          "example": "update"
        },
        {
          "name": "Privilege",
          "type": "integer",
          "required": true,
          "description": "Topic权限，1发布，2订阅，3订阅和发布",
          "example": "2"
        },
        {
          "name": "BrokerSubscribe",
          "type": "object",
          "required": false,
          "description": "代理订阅信息，网关产品为绑定的子产品创建topic时需要填写，内容为子产品的ID和设备信息。",
          "example": "无",
          "children": [
            {
              "name": "ProductId",
              "type": "string",
              "required": true,
              "description": "产品ID",
              "example": "UTY5QRLMQY"
            },
            {
              "name": "DeviceName",
              "type": "string",
              "required": true,
              "description": "设备名",
              "example": "dev-001"
            }
          ]
        }
      ],
      "required": [
        "ProductId",
        "TopicName",
        "Privilege"
      ]
    },
    {
      "name": "CreateTopicRule",
      "description": "本接口（CreateTopicRule）用于创建一个规则",
      "status": "online",
      "parameters": [
        {
          "name": "RuleName",
          "type": "string",
          "required": true,
          "description": "规则名称",
          "example": "allrule"
        },
        {
          "name": "TopicRulePayload",
          "type": "object",
          "required": true,
          "description": "规则内容",
          "example": "无",
          "children": [
            {
              "name": "Sql",
              "type": "string",
              "required": true,
              "description": "规则的SQL语句，如： SELECT * FROM 'pid/dname/event'，然后对其进行base64编码，得：U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw==",
              "example": "U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw=="
            },
            {
              "name": "Actions",
              "type": "string",
              "required": false,
              "description": "行为的JSON字符串，大部分种类举例如下： [ { \"republish\": { \"topic\": \"TEST/test\" } }, { \"forward\": { \"api\": \"http://127.0.0.1:8080\", \"token\":\"xxx\" } }, { \"ckafka\": { \"instance\": { \"id\": \"ckafka-test\", \"name\": \"\" }, \"topic\": { \"id\": \"topic-test\", \"name\": \"test\" }, \"region\": \"gz\" } }, { \"cmqqueue\": { \"queuename\": \"queue-test-TEST\", \"region\": \"gz\" } }, { \"mysql\": { \"instanceid\": \"cdb-test\", \"region\": \"gz\", \"username\": \"test\", \"userpwd\": \"*****\", \"dbname\": \"d_mqtt\", \"tablename\": \"t_te...",
              "example": "{\"name\",}"
            },
            {
              "name": "Description",
              "type": "string",
              "required": false,
              "description": "规则描述",
              "example": "description1"
            },
            {
              "name": "RuleDisabled",
              "type": "boolean",
              "required": false,
              "description": "是否禁用规则",
              "example": "false"
            }
          ]
        }
      ],
      "required": [
        "RuleName",
        "TopicRulePayload"
      ]
    },
    {
      "name": "DeleteDevice",
      "description": "本接口（DeleteDevice）用于删除物联网通信设备。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "设备所属的产品 ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "需要删除的设备名称",
          "example": "dev001"
        },
        {
          "name": "Skey",
          "type": "string",
          "required": false,
          "description": "删除LoRa设备以及LoRa网关设备需要skey",
          "example": "adferdfwe"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "DeleteDeviceResource",
      "description": "本接口（DeleteDeviceResource）用于删除设备资源",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "资源名称",
          "example": "myname"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称",
          "example": "dev-001"
        },
        {
          "name": "ProductID",
          "type": "string",
          "required": false,
          "description": "产品ID",
          "example": "EQPOKD5111"
        }
      ],
      "required": [
        "Name",
        "DeviceName"
      ]
    },
    {
      "name": "DeleteDeviceShadow",
      "description": "本接口（DeleteDeviceShadow）用于删除设备影子",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称",
          "example": "dev-001"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "DeletePrivateCA",
      "description": "删除私有CA证书",
      "status": "online",
      "parameters": [
        {
          "name": "CertName",
          "type": "string",
          "required": true,
          "description": "私有CA证书名称",
          "example": "certname"
        }
      ],
      "required": [
        "CertName"
      ]
    },
    {
      "name": "DeleteProduct",
      "description": "本接口（DeleteProduct）用于删除一个物联网通信产品",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "需要删除的产品 ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "Skey",
          "type": "string",
          "required": false,
          "description": "删除LoRa产品需要skey",
          "example": "adferdfwe"
        }
      ],
      "required": [
        "ProductId"
      ]
    },
    {
      "name": "DeleteProductPrivateCA",
      "description": "删除产品的私有CA证书",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        }
      ],
      "required": [
        "ProductId"
      ]
    },
    {
      "name": "DeleteTopicRule",
      "description": "本接口（DeleteTopicRule）用于删除规则",
      "status": "online",
      "parameters": [
        {
          "name": "RuleName",
          "type": "string",
          "required": true,
          "description": "规则名",
          "example": "myname"
        }
      ],
      "required": [
        "RuleName"
      ]
    },
    {
      "name": "DescribeDevice",
      "description": "本接口（DescribeDevice）用于查看设备信息",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名",
          "example": "dev-001"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "DescribeDeviceClientKey",
      "description": "获取证书认证类型设备的私钥，刚生成或者重置设备后仅可调用一次",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "所属产品的Id",
          "example": "EQPOKD5111"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称",
          "example": "dev-001"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "DescribeDeviceResource",
      "description": "本接口（DescribeDeviceResource）用于查询设备资源详情。",
      "status": "online",
      "parameters": [
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称",
          "example": "dev-001"
        },
        {
          "name": "ProductID",
          "type": "string",
          "required": false,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "具体的设备资源名称",
          "example": "myname"
        }
      ],
      "required": [
        "DeviceName"
      ]
    },
    {
      "name": "DescribeDeviceResources",
      "description": "本接口（DescribeDeviceResources）用于查询设备资源列表。",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量，Offset从0开始",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "分页的大小，数值范围 10-250",
          "example": "10"
        },
        {
          "name": "ProductID",
          "type": "string",
          "required": false,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": false,
          "description": "需要过滤的设备名称",
          "example": "dev-001"
        },
        {
          "name": "StartTime",
          "type": "string",
          "required": false,
          "description": "资源搜索开始时间",
          "example": "2006-01-02 15:04:05"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": false,
          "description": "资源搜索结束时间",
          "example": "2006-01-02 15:04:05"
        }
      ],
      "required": [
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeDeviceShadow",
      "description": "本接口（DescribeDeviceShadow）用于查询虚拟设备信息。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品 ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称。命名规则：[a-zA-Z0-9:_-]{1,60}",
          "example": "dev-001"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "DescribeDevices",
      "description": "本接口（DescribeDevices）用于查询物联网通信设备的设备列表。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "需要查看设备列表的产品 ID",
          "example": "UTY6QRLMQY"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量，Offset从0开始",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "分页的大小，数值范围 10-250",
          "example": "10"
        },
        {
          "name": "FirmwareVersion",
          "type": "string",
          "required": false,
          "description": "设备固件版本号，若不带此参数会返回所有固件版本的设备。传\"None-FirmwareVersion\"查询无版本号的设备",
          "example": "1.0.0"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": false,
          "description": "需要过滤的设备名称",
          "example": "myname1"
        },
        {
          "name": "EnableState",
          "type": "integer",
          "required": false,
          "description": "设备是否启用，0禁用状态1启用状态，默认不区分",
          "example": "1"
        }
      ],
      "required": [
        "ProductId",
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeFirmware",
      "description": "查询固件信息",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "7ZISKXPJVU"
        },
        {
          "name": "FirmwareVersion",
          "type": "string",
          "required": true,
          "description": "固件版本号",
          "example": "1.0.3"
        }
      ],
      "required": [
        "ProductId",
        "FirmwareVersion"
      ]
    },
    {
      "name": "DescribeFirmwareTask",
      "description": "查询固件升级任务详情",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "FirmwareVersion",
          "type": "string",
          "required": true,
          "description": "固件版本号",
          "example": "1.0.0"
        },
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "固件任务ID",
          "example": "10000"
        }
      ],
      "required": [
        "ProductId",
        "FirmwareVersion",
        "TaskId"
      ]
    },
    {
      "name": "DescribeFirmwareTaskDevices",
      "description": "查询固件升级任务的设备列表",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "O4CCMMZE3A"
        },
        {
          "name": "FirmwareVersion",
          "type": "string",
          "required": false,
          "description": "固件版本",
          "example": "1.0"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "筛选条件",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "搜索条件的Key",
              "example": "key"
            },
            {
              "name": "Value",
              "type": "string",
              "required": false,
              "description": "搜索条件的值",
              "example": "value"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "查询的数量",
          "example": "100"
        }
      ],
      "required": [
        "ProductId"
      ]
    },
    {
      "name": "DescribeFirmwareTaskDistribution",
      "description": "查询固件升级任务状态分布",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "O4CCMMZE3A"
        },
        {
          "name": "FirmwareVersion",
          "type": "string",
          "required": true,
          "description": "固件版本号",
          "example": "1.0"
        },
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "固件升级任务ID",
          "example": "43522"
        }
      ],
      "required": [
        "ProductId",
        "FirmwareVersion",
        "TaskId"
      ]
    },
    {
      "name": "DescribeFirmwareTaskStatistics",
      "description": "查询固件升级任务统计信息",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "O4CCMMZE3A"
        },
        {
          "name": "FirmwareVersion",
          "type": "string",
          "required": true,
          "description": "固件版本号",
          "example": "1.0"
        }
      ],
      "required": [
        "ProductId",
        "FirmwareVersion"
      ]
    },
    {
      "name": "DescribeFirmwareTasks",
      "description": "查询固件升级任务列表",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "FirmwareVersion",
          "type": "string",
          "required": true,
          "description": "固件版本号",
          "example": "1.0.0"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "查询偏移量",
          "example": "1"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "返回查询结果条数",
          "example": "5"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "搜索过滤条件",
          "example": "{\"Values\": [\"\\u672a\\u547d\\u540d\"], \"Name\": \"instance-name\"}",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "搜索条件的Key",
              "example": "key"
            },
            {
              "name": "Value",
              "type": "string",
              "required": false,
              "description": "搜索条件的值",
              "example": "value"
            }
          ]
        }
      ],
      "required": [
        "ProductId",
        "FirmwareVersion",
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeGatewayBindDevices",
      "description": "本接口（DescribeGatewayBindDevices）用于获取网关绑定的子设备列表",
      "status": "online",
      "parameters": [
        {
          "name": "GatewayProductId",
          "type": "string",
          "required": true,
          "description": "网关设备的产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "GatewayDeviceName",
          "type": "string",
          "required": true,
          "description": "网关设备的设备名",
          "example": "devGat-001"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量，Offset从0开始",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "分页的页大小",
          "example": "10"
        },
        {
          "name": "ProductId",
          "type": "string",
          "required": false,
          "description": "LoRa产品的ID",
          "example": "BSDGEW222"
        }
      ],
      "required": [
        "GatewayProductId",
        "GatewayDeviceName",
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribePrivateCA",
      "description": "查询私有化CA信息",
      "status": "online",
      "parameters": [
        {
          "name": "CertName",
          "type": "string",
          "required": true,
          "description": "私有化CA名称",
          "example": "IotHub"
        }
      ],
      "required": [
        "CertName"
      ]
    },
    {
      "name": "DescribePrivateCABindedProducts",
      "description": "查询私有CA绑定的产品列表",
      "status": "online",
      "parameters": [
        {
          "name": "CertName",
          "type": "string",
          "required": true,
          "description": "证书名称",
          "example": "ABCDE2345"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "查询偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "查询的数据量，默认为20， 最大为200",
          "example": "100"
        }
      ],
      "required": [
        "CertName",
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribePrivateCAs",
      "description": "查询私有CA证书列表",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "DescribeProduct",
      "description": "本接口（DescribeProduct）用于查看产品详情",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "UTY6QRLMQY"
        }
      ],
      "required": [
        "ProductId"
      ]
    },
    {
      "name": "DescribeProductCA",
      "description": "查询产品绑定的CA证书",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        }
      ],
      "required": [
        "ProductId"
      ]
    },
    {
      "name": "DescribeProductResource",
      "description": "本接口（DescribeProductResource）用于查询产品资源详情。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductID",
          "type": "string",
          "required": false,
          "description": "需要查看资源列表的产品 ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "需要过滤的资源名称",
          "example": "myname"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeProductResources",
      "description": "本接口（DescribeProductResources）用于查询产品资源列表。",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量，Offset从0开始",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "分页的大小，数值范围 10-250",
          "example": "10"
        },
        {
          "name": "ProductID",
          "type": "string",
          "required": false,
          "description": "需要查看资源列表的产品 ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "需要过滤的资源名称",
          "example": "myname"
        }
      ],
      "required": [
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeProductTask",
      "description": "本接口（DescribeProductTask）用于查看产品级别的任务信息",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "任务ID",
          "example": "3153452"
        }
      ],
      "required": [
        "ProductId",
        "TaskId"
      ]
    },
    {
      "name": "DescribeProductTasks",
      "description": "本接口（DescribeProductTasks）用于查看产品级别的任务列表",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "产品级别任务列表偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "产品级别任务列表拉取个数",
          "example": "10"
        }
      ],
      "required": [
        "ProductId",
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeProducts",
      "description": "本接口（DescribeProducts）用于列出产品列表。",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量，Offset从0开始",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "分页大小，当前页面中显示的最大数量，值范围 10-250。",
          "example": "10"
        }
      ],
      "required": [
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribePushResourceTaskStatistics",
      "description": "查询推送资源任务统计信息",
      "status": "online",
      "parameters": [
        {
          "name": "ProductID",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "O4CCMMZE3A"
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "资源名称",
          "example": "1.0"
        }
      ],
      "required": [
        "ProductID",
        "Name"
      ]
    },
    {
      "name": "DescribeResourceTasks",
      "description": "查询资源推送任务列表",
      "status": "online",
      "parameters": [
        {
          "name": "ProductID",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "资源名称",
          "example": "1.0.0"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "查询偏移量",
          "example": "1"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "返回查询结果条数",
          "example": "5"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "搜索过滤条件",
          "example": "{ \"TaskId\": 1000175}",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "搜索条件的Key",
              "example": "key"
            },
            {
              "name": "Value",
              "type": "string",
              "required": false,
              "description": "搜索条件的值",
              "example": "value"
            }
          ]
        }
      ],
      "required": [
        "ProductID",
        "Name",
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DisableTopicRule",
      "description": "本接口（DisableTopicRule）用于禁用规则",
      "status": "online",
      "parameters": [
        {
          "name": "RuleName",
          "type": "string",
          "required": true,
          "description": "规则名称",
          "example": "rule1"
        }
      ],
      "required": [
        "RuleName"
      ]
    },
    {
      "name": "DownloadDeviceResource",
      "description": "本接口（DownloadDeviceResource）用于下载设备资源",
      "status": "online",
      "parameters": [
        {
          "name": "ProductID",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "AAAAAAAAAA"
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "资源名称",
          "example": "test"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称",
          "example": "test"
        }
      ],
      "required": [
        "ProductID",
        "Name",
        "DeviceName"
      ]
    },
    {
      "name": "EditFirmware",
      "description": "编辑固件信息",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID。",
          "example": "EQPOKD5111"
        },
        {
          "name": "FirmwareVersion",
          "type": "string",
          "required": true,
          "description": "固件版本号。",
          "example": "1.0.0"
        },
        {
          "name": "FirmwareName",
          "type": "string",
          "required": true,
          "description": "固件名称。",
          "example": "name1"
        },
        {
          "name": "FirmwareDescription",
          "type": "string",
          "required": false,
          "description": "固件描述",
          "example": "desc"
        },
        {
          "name": "FirmwareUserDefined",
          "type": "string",
          "required": false,
          "description": "固件用户自定义配置信息",
          "example": "{\"key1\":\"value1\", \"key2\":\"支持中文\"}"
        }
      ],
      "required": [
        "ProductId",
        "FirmwareVersion",
        "FirmwareName"
      ]
    },
    {
      "name": "EnableTopicRule",
      "description": "本接口（EnableTopicRule）用于启用规则",
      "status": "online",
      "parameters": [
        {
          "name": "RuleName",
          "type": "string",
          "required": true,
          "description": "规则名称",
          "example": "rule1"
        }
      ],
      "required": [
        "RuleName"
      ]
    },
    {
      "name": "GetAllVersion",
      "description": "本接口（GetAllVersion）用于获取所有的版本列表",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        }
      ],
      "required": [
        "ProductId"
      ]
    },
    {
      "name": "GetCOSURL",
      "description": "本接口（GetCOSURL）用于获取固件存储在COS的URL",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "FirmwareVersion",
          "type": "string",
          "required": true,
          "description": "固件版本",
          "example": "2.0.0"
        },
        {
          "name": "FileSize",
          "type": "integer",
          "required": false,
          "description": "固件版本大小",
          "example": "256"
        }
      ],
      "required": [
        "ProductId",
        "FirmwareVersion"
      ]
    },
    {
      "name": "GetUserResourceInfo",
      "description": "本接口（GetUserResourceInfo）用于查询用户资源使用信息。",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "ListFirmwares",
      "description": "本接口（ListFirmwares）用于获取固件列表",
      "status": "online",
      "parameters": [
        {
          "name": "PageNum",
          "type": "integer",
          "required": true,
          "description": "获取的页数",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "分页的大小",
          "example": "10"
        },
        {
          "name": "ProductId",
          "type": "string",
          "required": false,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "搜索过滤条件",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "搜索条件的Key",
              "example": "key"
            },
            {
              "name": "Value",
              "type": "string",
              "required": false,
              "description": "搜索条件的值",
              "example": "value"
            }
          ]
        }
      ],
      "required": [
        "PageNum",
        "PageSize"
      ]
    },
    {
      "name": "ListLog",
      "description": "本接口（ListLog）用于查看日志信息",
      "status": "online",
      "parameters": [
        {
          "name": "MinTime",
          "type": "integer",
          "required": true,
          "description": "日志开始时间，毫秒级时间戳",
          "example": "1530244265000"
        },
        {
          "name": "MaxTime",
          "type": "integer",
          "required": true,
          "description": "日志结束时间，毫秒级时间戳",
          "example": "1530258665000"
        },
        {
          "name": "Keywords",
          "type": "string",
          "required": false,
          "description": "查询关键字，可以同时支持键值查询和文本查询，例如，查询某key的值为value，并且包含某word的日志，该参数为：key:vlue worda。键值或文本可以包含多个，以空格隔开。其中可以索引的key包括：requestid、productid、devicename、scene、content。一个典型的查询示例：productid:ABCDE12345 devicename:test scene:SHADOW content:Device%20connect publish",
          "example": "UTY6QRLMQY"
        },
        {
          "name": "Context",
          "type": "string",
          "required": false,
          "description": "日志检索上下文",
          "example": "hello"
        },
        {
          "name": "MaxNum",
          "type": "integer",
          "required": false,
          "description": "查询条数",
          "example": "10"
        }
      ],
      "required": [
        "MinTime",
        "MaxTime"
      ]
    },
    {
      "name": "ListLogPayload",
      "description": "获取日志内容列表",
      "status": "online",
      "parameters": [
        {
          "name": "MinTime",
          "type": "integer",
          "required": true,
          "description": "日志开始时间，毫秒级时间戳",
          "example": "1606207080000"
        },
        {
          "name": "MaxTime",
          "type": "integer",
          "required": true,
          "description": "日志结束时间，毫秒级时间戳",
          "example": "1606208039999"
        },
        {
          "name": "Keywords",
          "type": "string",
          "required": true,
          "description": "查询关键字，可以同时支持键值查询和文本查询，例如，查询某key的值为value，并且包含某word的日志，该参数为：key:value word。键值或文本可以包含多个，以空格隔开。其中可以索引的key比如：RequestID、ProductID、DeviceName等。 一个典型的查询示例：ProductID:ABCDE12345 DeviceName:test publish",
          "example": "productid:EQPOKD5111"
        },
        {
          "name": "Context",
          "type": "string",
          "required": false,
          "description": "日志检索上下文",
          "example": "62080"
        },
        {
          "name": "MaxNum",
          "type": "integer",
          "required": false,
          "description": "日志最大条数",
          "example": "10"
        }
      ],
      "required": [
        "MinTime",
        "MaxTime",
        "Keywords"
      ]
    },
    {
      "name": "ListSDKLog",
      "description": "获取设备上报的日志",
      "status": "online",
      "parameters": [
        {
          "name": "MinTime",
          "type": "integer",
          "required": true,
          "description": "日志开始时间",
          "example": "1606205400000"
        },
        {
          "name": "MaxTime",
          "type": "integer",
          "required": true,
          "description": "日志结束时间",
          "example": "1606209059999"
        },
        {
          "name": "Keywords",
          "type": "string",
          "required": true,
          "description": "查询关键字，可以同时支持键值查询和文本查询， 例如，查询某key的值为value，并且包含某word的日志，该参数为：key:value word。 键值或文本可以包含多个，以空格隔开。 其中可以索引的key包括：productid、devicename、loglevel 一个典型的查询示例：productid:7JK1G72JNE devicename:name publish loglevel:WARN一个典型的查询示例：productid:ABCDE12345 devicename:test scene:SHADOW publish",
          "example": "productid:adferdfwe"
        },
        {
          "name": "Context",
          "type": "string",
          "required": false,
          "description": "日志检索上下文",
          "example": "7KMDyZLys1KQivxnY"
        },
        {
          "name": "MaxNum",
          "type": "integer",
          "required": false,
          "description": "查询条数",
          "example": "100"
        }
      ],
      "required": [
        "MinTime",
        "MaxTime",
        "Keywords"
      ]
    },
    {
      "name": "ListTopicRules",
      "description": "本接口（ListTopicRules）用于分页获取规则列表",
      "status": "online",
      "parameters": [
        {
          "name": "PageNum",
          "type": "integer",
          "required": true,
          "description": "请求的页数",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "分页的大小",
          "example": "10"
        }
      ],
      "required": [
        "PageNum",
        "PageSize"
      ]
    },
    {
      "name": "PublishBroadcastMessage",
      "description": "发布广播消息",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "ASBHKN121"
        },
        {
          "name": "Payload",
          "type": "string",
          "required": true,
          "description": "消息内容",
          "example": "5346563"
        },
        {
          "name": "Qos",
          "type": "integer",
          "required": true,
          "description": "消息质量等级",
          "example": "1"
        },
        {
          "name": "PayloadEncoding",
          "type": "string",
          "required": false,
          "description": "Payload内容的编码格式，取值为base64或空。base64表示云端将收到的请求数据进行base64解码后下发到设备，空则直接将原始内容下发到设备",
          "example": "base64"
        }
      ],
      "required": [
        "ProductId",
        "Payload",
        "Qos"
      ]
    },
    {
      "name": "PublishMessage",
      "description": "本接口（PublishMessage）用于向某个主题发消息。",
      "status": "online",
      "parameters": [
        {
          "name": "Topic",
          "type": "string",
          "required": true,
          "description": "消息发往的主题。命名规则：${ProductId}/${DeviceName}/[a-zA-Z0-9:_-]{1,128}",
          "example": "RL0BAZKZ6V/dev1/control"
        },
        {
          "name": "Payload",
          "type": "string",
          "required": true,
          "description": "消息内容",
          "example": "hahaha"
        },
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "RL0BAZKZ6V"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称",
          "example": "dev1"
        },
        {
          "name": "Qos",
          "type": "integer",
          "required": false,
          "description": "服务质量等级，取值为0或1",
          "example": "0"
        },
        {
          "name": "PayloadEncoding",
          "type": "string",
          "required": false,
          "description": "Payload内容的编码格式，取值为base64或空。base64表示云端将收到的请求数据进行base64解码后下发到设备，空则直接将原始内容下发到设备",
          "example": "base64"
        }
      ],
      "required": [
        "Topic",
        "Payload",
        "ProductId",
        "DeviceName"
      ]
    },
    {
      "name": "PublishRRPCMessage",
      "description": "发布RRPC消息",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "ASBHKN121"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称",
          "example": "dev"
        },
        {
          "name": "Payload",
          "type": "string",
          "required": true,
          "description": "消息内容，utf8编码",
          "example": "1234561"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName",
        "Payload"
      ]
    },
    {
      "name": "ReplaceTopicRule",
      "description": "本接口（ReplaceTopicRule）用于修改替换规则",
      "status": "online",
      "parameters": [
        {
          "name": "RuleName",
          "type": "string",
          "required": true,
          "description": "规则名称",
          "example": "testrulename"
        },
        {
          "name": "TopicRulePayload",
          "type": "object",
          "required": true,
          "description": "替换的规则包体",
          "example": "topic1",
          "children": [
            {
              "name": "Sql",
              "type": "string",
              "required": true,
              "description": "规则的SQL语句，如： SELECT * FROM 'pid/dname/event'，然后对其进行base64编码，得：U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw==",
              "example": "U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw=="
            },
            {
              "name": "Actions",
              "type": "string",
              "required": false,
              "description": "行为的JSON字符串，大部分种类举例如下： [ { \"republish\": { \"topic\": \"TEST/test\" } }, { \"forward\": { \"api\": \"http://127.0.0.1:8080\", \"token\":\"xxx\" } }, { \"ckafka\": { \"instance\": { \"id\": \"ckafka-test\", \"name\": \"\" }, \"topic\": { \"id\": \"topic-test\", \"name\": \"test\" }, \"region\": \"gz\" } }, { \"cmqqueue\": { \"queuename\": \"queue-test-TEST\", \"region\": \"gz\" } }, { \"mysql\": { \"instanceid\": \"cdb-test\", \"region\": \"gz\", \"username\": \"test\", \"userpwd\": \"*****\", \"dbname\": \"d_mqtt\", \"tablename\": \"t_te...",
              "example": "{\"name\",}"
            },
            {
              "name": "Description",
              "type": "string",
              "required": false,
              "description": "规则描述",
              "example": "description1"
            },
            {
              "name": "RuleDisabled",
              "type": "boolean",
              "required": false,
              "description": "是否禁用规则",
              "example": "false"
            }
          ]
        }
      ],
      "required": [
        "RuleName",
        "TopicRulePayload"
      ]
    },
    {
      "name": "ResetDeviceState",
      "description": "重置设备的连接状态",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "DeviceNames",
          "type": "array",
          "required": true,
          "description": "设备名称",
          "example": "[\"test_device1\\n\",\"test_device2\\n\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "ProductId",
        "DeviceNames"
      ]
    },
    {
      "name": "RetryDeviceFirmwareTask",
      "description": "重试设备升级任务",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称",
          "example": "dev-001"
        },
        {
          "name": "FirmwareVersion",
          "type": "string",
          "required": true,
          "description": "固件版本号",
          "example": "1.0.0"
        },
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "固件升级任务ID",
          "example": "10000"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName",
        "FirmwareVersion",
        "TaskId"
      ]
    },
    {
      "name": "SetProductsForbiddenStatus",
      "description": "批量设置产品禁用状态",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "array",
          "required": true,
          "description": "要设置禁用状态的产品列表",
          "example": "[\"productID1\",\"productID2\"]",
          "item_type": "string"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": true,
          "description": "0启用，1禁用",
          "example": "1"
        }
      ],
      "required": [
        "ProductId",
        "Status"
      ]
    },
    {
      "name": "UnbindDevices",
      "description": "本接口（UnbindDevices）用于网关设备批量解绑子设备",
      "status": "online",
      "parameters": [
        {
          "name": "GatewayProductId",
          "type": "string",
          "required": true,
          "description": "网关设备的产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "GatewayDeviceName",
          "type": "string",
          "required": true,
          "description": "网关设备的设备名",
          "example": "gateway-001"
        },
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "DeviceNames",
          "type": "array",
          "required": true,
          "description": "多个设备名",
          "example": "[\"dev-001\\n\",\"dev-0021\\n\"]",
          "item_type": "string"
        },
        {
          "name": "Skey",
          "type": "string",
          "required": false,
          "description": "中兴CLAA设备的解绑需要Skey，普通设备不需要",
          "example": "adferdfwe"
        }
      ],
      "required": [
        "GatewayProductId",
        "GatewayDeviceName",
        "ProductId",
        "DeviceNames"
      ]
    },
    {
      "name": "UpdateDeviceAvailableState",
      "description": "启用或者禁用设备",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "设备所属产品id",
          "example": "SB9OJFCJ1C"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称",
          "example": "test123"
        },
        {
          "name": "EnableState",
          "type": "integer",
          "required": true,
          "description": "要设置的设备状态，1为启用，0为禁用",
          "example": "0"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName",
        "EnableState"
      ]
    },
    {
      "name": "UpdateDeviceLogLevel",
      "description": "设置设备上报的日志级别",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称",
          "example": "dev-001"
        },
        {
          "name": "LogLevel",
          "type": "integer",
          "required": true,
          "description": "日志级别，0：关闭，1：错误，2：告警，3：信息，4：调试",
          "example": "1"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName",
        "LogLevel"
      ]
    },
    {
      "name": "UpdateDevicePSK",
      "description": "本接口（UpdateDevicePSK）用于更新设备的PSK",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品名",
          "example": "EQPOKD5111"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名",
          "example": "dev-001"
        },
        {
          "name": "Psk",
          "type": "string",
          "required": true,
          "description": "设备的psk",
          "example": "VOQmAku7T1haYaiV7LJfmg=="
        }
      ],
      "required": [
        "ProductId",
        "DeviceName",
        "Psk"
      ]
    },
    {
      "name": "UpdateDeviceShadow",
      "description": "本接口（UpdateDeviceShadow）用于更新虚拟设备信息。",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "设备名称",
          "example": "dev-001"
        },
        {
          "name": "State",
          "type": "string",
          "required": true,
          "description": "虚拟设备的状态，JSON字符串格式，由desired结构组成",
          "example": "{\"desired\":{\"color\":\"red\"}}"
        },
        {
          "name": "ShadowVersion",
          "type": "integer",
          "required": true,
          "description": "当前版本号，需要和后台的version保持一致，才能更新成功",
          "example": "1"
        }
      ],
      "required": [
        "ProductId",
        "DeviceName",
        "State",
        "ShadowVersion"
      ]
    },
    {
      "name": "UpdateDevicesEnableState",
      "description": "批量启用或者禁用设备",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "设备所属产品id",
          "example": "SB9OJFCJ1C"
        },
        {
          "name": "DeviceNames",
          "type": "array",
          "required": true,
          "description": "设备名称集合",
          "example": "[\"test123\\n\"]",
          "item_type": "string"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": true,
          "description": "要设置的设备状态，1为启用，0为禁用",
          "example": "1"
        }
      ],
      "required": [
        "ProductId",
        "DeviceNames",
        "Status"
      ]
    },
    {
      "name": "UpdateOtaTaskStatus",
      "description": "本接口（UpdateOtaTask）当固件升级大任务处于没有在全部成功的状态时，可修改为取消状态，取消部分或全部设备的升级;或其它允许的可修改的状态",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "固件升级任务ID",
          "example": "11236"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": true,
          "description": "固件任务取消状态",
          "example": "6"
        }
      ],
      "required": [
        "ProductId",
        "TaskId",
        "Status"
      ]
    },
    {
      "name": "UpdatePrivateCA",
      "description": "更新私有CA证书",
      "status": "online",
      "parameters": [
        {
          "name": "CertName",
          "type": "string",
          "required": true,
          "description": "CA证书名称",
          "example": "Cert_dev"
        },
        {
          "name": "CertText",
          "type": "string",
          "required": true,
          "description": "CA证书内容",
          "example": "-----BEGIN CERTIFICATE-----\\nMIID...\\n-----END CERTIFICATE-----"
        },
        {
          "name": "VerifyCertText",
          "type": "string",
          "required": true,
          "description": "校验CA证书的证书内容",
          "example": "-----BEGIN CERTIFICATE-----\\nMIID...\\n-----END CERTIFICATE-----"
        }
      ],
      "required": [
        "CertName",
        "CertText",
        "VerifyCertText"
      ]
    },
    {
      "name": "UpdateProductDynamicRegister",
      "description": "更新产品动态注册的配置",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品Id",
          "example": "EQPOKD5111"
        },
        {
          "name": "RegisterType",
          "type": "integer",
          "required": true,
          "description": "动态注册类型，0-关闭 1-预创建设备 2-自动创建设备",
          "example": "0"
        },
        {
          "name": "RegisterLimit",
          "type": "integer",
          "required": true,
          "description": "动态注册设备上限",
          "example": "10"
        }
      ],
      "required": [
        "ProductId",
        "RegisterType",
        "RegisterLimit"
      ]
    },
    {
      "name": "UpdateProductPrivateCA",
      "description": "更新产品的私有CA",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "CertName",
          "type": "string",
          "required": true,
          "description": "私有CA证书名称",
          "example": "CertName"
        }
      ],
      "required": [
        "ProductId",
        "CertName"
      ]
    },
    {
      "name": "UpdateTopicPolicy",
      "description": "本接口（UpdateTopicPolicy）用于更新Topic信息",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "TopicName",
          "type": "string",
          "required": true,
          "description": "更新前Topic名",
          "example": "topic1"
        },
        {
          "name": "NewTopicName",
          "type": "string",
          "required": true,
          "description": "更新后Topic名",
          "example": "topic2"
        },
        {
          "name": "Privilege",
          "type": "integer",
          "required": true,
          "description": "Topic权限",
          "example": "2"
        },
        {
          "name": "BrokerSubscribe",
          "type": "object",
          "required": false,
          "description": "代理订阅信息",
          "example": "无",
          "children": [
            {
              "name": "ProductId",
              "type": "string",
              "required": true,
              "description": "产品ID",
              "example": "UTY5QRLMQY"
            },
            {
              "name": "DeviceName",
              "type": "string",
              "required": true,
              "description": "设备名",
              "example": "dev-001"
            }
          ]
        }
      ],
      "required": [
        "ProductId",
        "TopicName",
        "NewTopicName",
        "Privilege"
      ]
    },
    {
      "name": "UploadFirmware",
      "description": "本接口（UploadFirmware）用于上传设备固件信息",
      "status": "online",
      "parameters": [
        {
          "name": "ProductId",
          "type": "string",
          "required": true,
          "description": "产品ID",
          "example": "EQPOKD5111"
        },
        {
          "name": "FirmwareVersion",
          "type": "string",
          "required": true,
          "description": "固件版本号",
          "example": "1.0.0"
        },
        {
          "name": "Md5sum",
          "type": "string",
          "required": true,
          "description": "固件的MD5值",
          "example": "hfshfspodkoiwuidoiwjcuie"
        },
        {
          "name": "FileSize",
          "type": "integer",
          "required": true,
          "description": "固件的大小",
          "example": "1024"
        },
        {
          "name": "FirmwareName",
          "type": "string",
          "required": false,
          "description": "固件名称",
          "example": "ota-1.0"
        },
        {
          "name": "FirmwareDescription",
          "type": "string",
          "required": false,
          "description": "固件描述",
          "example": "1.0.0"
        },
        {
          "name": "FirmwareUserDefined",
          "type": "string",
          "required": false,
          "description": "固件用户自定义配置信息",
          "example": "{\"key1\":\"value1\", \"key2\":\"支持中文\"}"
        }
      ],
      "required": [
        "ProductId",
        "FirmwareVersion",
        "Md5sum",
        "FileSize"
      ]
    }
  ]
}