tenyun

/// <reference types="node" /> import { AxiosPromise, AxiosRequestConfig } from "axios"; /** 设备属性 */ declare interface Attribute { /** 属性列表 */ Tags?: DeviceTag[]; } /** 子设备信息 */ declare interface BindDeviceInfo { /** 产品ID */ ProductId?: string; /** 设备名 */ DeviceName?: string; /** 设备Tag */ Tags?: DeviceTag[]; /** 子设备绑定时间 */ BindTime?: number | null; } /** 子产品信息 */ declare interface BindProductInfo { /** 产品ID */ ProductId?: string; /** 产品名 */ ProductName?: string; } /** 代理订阅信息 */ declare interface BrokerSubscribe { /** 产品ID */ ProductId: string; /** 设备名 */ DeviceName: string; } /** CLS日志 */ declare interface CLSLogItem { /** 日志内容 */ Content?: string; /** 设备名称 */ DeviceName?: string; /** 产品ID */ ProductId?: string; /** 请求ID */ RequestId?: string; /** 结果 */ Result?: string; /** 模块 */ Scene?: string; /** 日志时间 */ Time?: string; /** 腾讯云账号 */ Userid?: string; /** 腾讯云账号 */ UserId?: string; } /** X509证书信息 */ declare interface CertInfo { /** 证书名称 */ CertName: string; /** 证书的序列号，16进制编码 */ CertSN: string; /** 证书颁发着名称 */ IssuerName: string; /** 证书主题 */ Subject: string; /** 证书创建时间，秒级时间戳 */ CreateTime: number; /** 证书生效时间，秒级时间戳 */ EffectiveTime: number; /** 证书失效时间，秒级时间戳 */ ExpireTime: number; /** X509证书内容 */ CertText: string; } /** 设备详细信息 */ declare interface DeviceInfo { /** 设备名 */ DeviceName?: string; /** 设备是否在线，0不在线，1在线 */ Online?: number; /** 设备登录时间 */ LoginTime?: number; /** 设备版本 */ Version?: string; /** 设备证书，证书加密的设备返回 */ DeviceCert?: string; /** 设备密钥，密钥加密的设备返回 */ DevicePsk?: string; /** 设备属性 */ Tags?: DeviceTag[]; /** 设备类型 */ DeviceType?: number; /** 国际移动设备识别码 IMEI */ Imei?: string; /** 运营商类型 */ Isp?: number; /** NB IOT运营商处的DeviceID */ NbiotDeviceID?: string; /** IP地址 */ ConnIP?: number; /** 设备最后更新时间 */ LastUpdateTime?: number; /** LoRa设备的dev eui */ LoraDevEui?: string; /** LoRa设备的Mote type */ LoraMoteType?: number; /** 首次上线时间 */ FirstOnlineTime?: number | null; /** 最近下线时间 */ LastOfflineTime?: number | null; /** 设备创建时间 */ CreateTime?: number | null; /** 设备日志级别 */ LogLevel?: number | null; /** 设备证书获取状态, 1 已获取过设备密钥，0 未获取过设备密钥 */ CertState?: number | null; /** 设备可用状态，0禁用，1启用 */ EnableState?: number | null; /** 设备标签 */ Labels?: DeviceLabel[] | null; /** MQTT客户端IP地址 */ ClientIP?: string | null; /** ota最后更新时间 */ FirmwareUpdateTime?: number | null; /** 创建者 Uin */ CreateUserId?: number | null; /** NB IOT运营商处的DeviceID */ NBIoTDeviceID?: string; } /** 设备标签 */ declare interface DeviceLabel { /** 标签标识 */ Key: string; /** 标签值 */ Value: string; } /** 设备资源详细信息 */ declare interface DeviceResourceInfo { /** 产品ID */ ProductID?: string; /** 产品名 */ ProductName?: string; /** 资源名称 */ Name?: string; /** 资源文件md5 */ Md5?: string; /** 资源文件大小 */ Size?: number; /** 资源更新时间 */ UpdateTime?: string; /** 设备名称 */ DeviceName?: string; /** 设备资源上传状态 */ Status?: number; /** 设备资源上传百分比 */ Percent?: number; } /** 设备属性 */ declare interface DeviceTag { /** 属性名称 */ Tag: string; /** 属性值的类型，1 int，2 string */ Type: number; /** 属性的值 */ Value: string; /** 属性描述名称 */ Name?: string | null; } /** 设备固件更新状态 */ declare interface DeviceUpdateStatus { /** 设备名 */ DeviceName?: string; /** 最后处理时间 */ LastProcessTime?: number; /** 状态 */ Status?: number; /** 错误消息 */ ErrMsg?: string; /** 返回码 */ Retcode?: number; /** 目标更新版本 */ DstVersion?: string; /** 下载中状态时的下载进度 */ Percent?: number | null; /** 原版本号 */ OriVersion?: string | null; /** 任务ID */ TaskId?: number | null; } /** 设备固件详细信息 */ declare interface FirmwareInfo { /** 固件版本 */ Version?: string; /** 固件MD5值 */ Md5sum?: string; /** 固件创建时间 */ CreateTime?: number; /** 产品名称 */ ProductName?: string | null; /** 固件名称 */ Name?: string | null; /** 固件描述 */ Description?: string | null; /** 产品ID */ ProductId?: string | null; /** 固件类型 */ FwType?: string | null; /** 创建者 Uin */ CreateUserId?: number | null; /** 固件用户自定义配置信息 */ UserDefined?: string | null; } /** 固件升级任务信息 */ declare interface FirmwareTaskInfo { /** 任务ID */ TaskId?: number | null; /** 任务状态 */ Status?: number | null; /** 任务类型 */ Type?: number | null; /** 任务创建时间 */ CreateTime?: number | null; } /** 内容日志项 */ declare interface PayloadLogItem { /** 账号id */ Uin?: string; /** 产品id */ ProductId?: string; /** 设备名称 */ DeviceName?: string; /** 来源类型 */ SrcType?: string; /** 来源名称 */ SrcName?: string; /** 消息topic */ Topic?: string; /** 内容格式类型 */ PayloadFormatType?: string; /** 内容信息 */ Payload?: string; /** 请求ID */ RequestId?: string; /** 日期时间 */ DateTime?: string; } /** 产品详细信息 */ declare interface ProductInfo { /** 产品ID */ ProductId: string; /** 产品名 */ ProductName: string; /** 产品元数据 */ ProductMetadata: ProductMetadata; /** 产品属性 */ ProductProperties: ProductProperties; } /** 产品元数据 */ declare interface ProductMetadata { /** 产品创建时间 */ CreationDate?: number; /** 创建者 Uin */ CreateUserId?: number; /** 账号 Uin */ UserId?: number; } /** 产品属性 */ declare interface ProductProperties { /** 产品描述 */ ProductDescription?: string; /** 加密类型，1表示证书认证，2表示签名认证。如不填写，默认值是1 */ EncryptionType?: string; /** 产品所属区域，目前只支持广州（gz） */ Region?: string; /** 产品类型，各个类型值代表的节点-类型如下：0 普通产品，2 NB-IoT产品，4 LoRa产品，3 LoRa网关产品，5 普通网关产品默认值是0 */ ProductType?: number; /** 数据格式，取值为json或者custom，默认值是json */ Format?: string; /** 产品所属平台，默认值是0 */ Platform?: string; /** LoRa产品运营侧APPEUI，只有LoRa产品需要填写 */ Appeui?: string; /** 产品绑定的物模型ID，-1表示不绑定 */ ModelId?: string; /** 产品绑定的物模型名称 */ ModelName?: string; /** 产品密钥，suite产品才会有 */ ProductKey?: string; /** 动态注册类型 0-关闭, 1-预定义设备名 2-动态定义设备名 */ RegisterType?: number; /** 动态注册产品密钥 */ ProductSecret?: string; /** RegisterType为2时，设备动态创建的限制数量 */ RegisterLimit?: number; /** 划归的产品，展示为源产品ID，其余为空 */ OriginProductId?: string; /** 私有CA名称 */ PrivateCAName?: string; /** 划归的产品，展示为源用户ID，其余为空 */ OriginUserId?: number; /** 设备限制 */ DeviceLimit?: number; /** 产品禁用状态 */ ForbiddenStatus?: number; /** LoRa产品运营侧APPEUI，只有LoRa产品需要填写 */ AppEUI?: string; } /** 产品资源详细信息 */ declare interface ProductResourceInfo { /** 产品ID */ ProductID?: string; /** 产品名 */ ProductName?: string; /** 资源名称 */ Name?: string; /** 资源文件md5 */ Md5?: string; /** 资源文件大小 */ Size?: number; /** 资源文件描述 */ Description?: string | null; /** 资源创建时间 */ CreateTime?: string; } /** 产品级任务详细信息 */ declare interface ProductTaskInfo { /** 任务ID */ Id?: number; /** 任务类型 0-批量创建设备类型 */ Type?: number; /** 任务状态 0-创建中 1-待执行 2-执行中 3-执行失败 4-子任务部分失败 5-执行成功 */ State?: number; /** 任务参数类型 cosfile-文件输入 random-随机生成 */ ParametersType?: string; /** 任务参数 */ Parameters?: string; /** 任务执行结果类型 cosfile-文件输出 errmsg-错误信息 */ ResultType?: string | null; /** 任务执行结果 */ Result?: string | null; /** 子任务总个数 */ BatchCount?: number | null; /** 子任务已执行个数 */ BatchOffset?: number | null; /** 任务创建时间 */ CreateTime?: number; /** 任务更新时间 */ UpdateTime?: number; /** 任务完成时间 */ CompleteTime?: number | null; } /** 重置设备状态结果 */ declare interface ResetDeviceResult { /** 设备名 */ DeviceName?: string; /** 是否成功 */ Success?: boolean; /** 失败原因 */ Reason?: string | null; } /** SDK日志项 */ declare interface SDKLogItem { /** 产品ID */ ProductId?: string; /** 设备名称 */ DeviceName?: string; /** 日志等级 */ Level?: string; /** 日志时间 */ DateTime?: string; /** 日志内容 */ Content?: string; } /** 搜索关键词 */ declare interface SearchKeyword { /** 搜索条件的Key */ Key: string; /** 搜索条件的值 */ Value?: string; } /** 状态统计信息 */ declare interface StatusStatistic { /** 任务状态 */ Status?: number | null; /** 统计总数 */ Total?: number | null; } /** 规则详细信息 */ declare interface TopicRuleInfo { /** 规则名称 */ RuleName?: string; /** 规则描述 */ Description?: string; /** 创建时间 */ CreatedAt?: number; /** 不生效 */ RuleDisabled?: boolean; /** 规则模式 */ TopicPattern?: string; } /** 创建规则请求包体 */ declare interface TopicRulePayload { /** 规则的SQL语句，如： SELECT * FROM 'pid/dname/event'，然后对其进行base64编码，得：U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw== */ Sql: string; /** 行为的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_test", "fieldpairs": [ { "field": "test", "value": "test" } ], "devicetype": "CUSTOM" } }] */ Actions?: string; /** 规则描述 */ Description?: string; /** 是否禁用规则 */ RuleDisabled?: boolean; } declare interface BatchUpdateFirmwareRequest { /** 产品ID */ ProductId: string; /** 固件新版本号 */ FirmwareVersion: string; /** 固件原版本号，根据文件列表升级固件不需要填写此参数 */ FirmwareOriVersion?: string; /** 升级方式，0 静默升级 1 用户确认升级。不填默认为静默升级方式 */ UpgradeMethod?: number; /** 设备列表文件名称，根据文件列表升级固件需要填写此参数 */ FileName?: string; /** 设备列表的文件md5值 */ FileMd5?: string; /** 设备列表的文件大小值 */ FileSize?: number; /** 需要升级的设备名称列表 */ DeviceNames?: string[]; /** 固件升级任务，默认超时时间。最小取值60秒，最大为3600秒 */ TimeoutInterval?: number; /** 固件升级任务类型，默认静态升级值为空或1，动态升级值为7。 */ Type?: number; } declare interface BatchUpdateFirmwareResponse { /** 任务ID */ TaskId?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface BindDevicesRequest { /** 网关设备的产品ID */ GatewayProductId: string; /** 网关设备的设备名 */ GatewayDeviceName: string; /** 被绑定设备的产品ID */ ProductId: string; /** 被绑定的多个设备名 */ DeviceNames: string[]; /** 中兴CLAA设备的绑定需要skey，普通的设备不需要 */ Skey?: string; } declare interface BindDevicesResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CancelDeviceFirmwareTaskRequest { /** 产品ID */ ProductId: string; /** 设备名称 */ DeviceName: string; /** 固件版本号 */ FirmwareVersion: string; /** 固件升级任务ID */ TaskId: number; } declare interface CancelDeviceFirmwareTaskResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateDeviceRequest { /** 产品 ID 。创建产品时腾讯云为用户分配全局唯一的 ID */ ProductId: string; /** 设备名称。命名规则：[a-zA-Z0-9:_-]{1,48}。 */ DeviceName: string; /** 设备属性 */ Attribute?: Attribute; /** 是否使用自定义PSK，默认不使用 */ DefinedPsk?: string; /** 运营商类型，当产品是NB-IoT产品时，此字段必填。1表示中国电信，2表示中国移动，3表示中国联通 */ Isp?: number; /** IMEI，当产品是NB-IoT产品时，此字段必填 */ Imei?: string; /** LoRa设备的DevEui，当创建LoRa时，此字段必填 */ LoraDevEui?: string; /** LoRa设备的MoteType */ LoraMoteType?: number; /** 创建LoRa设备需要skey */ Skey?: string; /** LoRa设备的AppKey */ LoraAppKey?: string; /** 私有CA创建的设备证书 */ TlsCrt?: string; } declare interface CreateDeviceResponse { /** 设备名称 */ DeviceName?: string; /** 对称加密密钥，base64编码。采用对称加密时返回该参数 */ DevicePsk?: string; /** 设备证书，用于 TLS 建立链接时校验客户端身份。采用非对称加密时返回该参数 */ DeviceCert?: string; /** 设备私钥，用于 TLS 建立链接时校验客户端身份，腾讯云后台不保存，请妥善保管。采用非对称加密时返回该参数 */ DevicePrivateKey?: string; /** LoRa设备的DevEui，当设备是LoRa设备时，会返回该字段 */ LoraDevEui?: string; /** LoRa设备的MoteType，当设备是LoRa设备时，会返回该字段 */ LoraMoteType?: number; /** LoRa设备的AppKey，当设备是LoRa设备时，会返回该字段 */ LoraAppKey?: string; /** LoRa设备的NwkKey，当设备是LoRa设备时，会返回该字段 */ LoraNwkKey?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateMultiDevicesTaskRequest { /** 产品ID */ ProductId: string; /** 参数类型 cosfile-文件上传 random-随机创建 */ ParametersType: string; /** 文件上传类型时文件名 */ FileName?: string; /** 文件上传类型时文件大小 */ FileSize?: number; /** 随机创建时设备创建个数 */ BatchCount?: number; /** 文件上传类型时文件md5值 */ Hash?: string; } declare interface CreateMultiDevicesTaskResponse { /** 任务ID */ Id?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreatePrivateCARequest { /** CA证书名称 */ CertName: string; /** CA证书内容 */ CertText: string; /** 校验CA证书的证书内容 */ VerifyCertText: string; } declare interface CreatePrivateCAResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateProductRequest { /** 产品名称，名称不能和已经存在的产品名称重复。命名规则：[a-zA-Z0-9:_-]{1,32} */ ProductName: string; /** 产品属性 */ ProductProperties?: ProductProperties; /** 创建CLAA产品时，需要Skey */ Skey?: string; } declare interface CreateProductResponse { /** 产品名称 */ ProductName?: string; /** 产品 ID，腾讯云生成全局唯一 ID */ ProductId?: string; /** 产品属性 */ ProductProperties?: ProductProperties; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateTaskFileUrlRequest { /** 产品ID */ ProductId: string; } declare interface CreateTaskFileUrlResponse { /** 任务文件上传链接 */ Url?: string; /** 任务文件名 */ FileName?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateTopicPolicyRequest { /** 产品自身ID */ ProductId: string; /** Topic名称 */ TopicName: string; /** Topic权限，1发布，2订阅，3订阅和发布 */ Privilege: number; /** 代理订阅信息，网关产品为绑定的子产品创建topic时需要填写，内容为子产品的ID和设备信息。 */ BrokerSubscribe?: BrokerSubscribe; } declare interface CreateTopicPolicyResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateTopicRuleRequest { /** 规则名称 */ RuleName: string; /** 规则内容 */ TopicRulePayload: TopicRulePayload; } declare interface CreateTopicRuleResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DeleteDeviceRequest { /** 设备所属的产品 ID */ ProductId: string; /** 需要删除的设备名称 */ DeviceName: string; /** 删除LoRa设备以及LoRa网关设备需要skey */ Skey?: string; } declare interface DeleteDeviceResourceRequest { /** 资源名称 */ Name: string; /** 设备名称 */ DeviceName: string; /** 产品ID */ ProductID?: string; } declare interface DeleteDeviceResourceResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DeleteDeviceResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DeleteDeviceShadowRequest { /** 产品ID */ ProductId: string; /** 设备名称 */ DeviceName: string; } declare interface DeleteDeviceShadowResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DeletePrivateCARequest { /** 私有CA证书名称 */ CertName: string; } declare interface DeletePrivateCAResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DeleteProductPrivateCARequest { /** 产品ID */ ProductId: string; } declare interface DeleteProductPrivateCAResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DeleteProductRequest { /** 需要删除的产品 ID */ ProductId: string; /** 删除LoRa产品需要skey */ Skey?: string; } declare interface DeleteProductResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DeleteTopicRuleRequest { /** 规则名 */ RuleName: string; } declare interface DeleteTopicRuleResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeDeviceClientKeyRequest { /** 所属产品的Id */ ProductId: string; /** 设备名称 */ DeviceName: string; } declare interface DescribeDeviceClientKeyResponse { /** 设备的私钥 */ ClientKey?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeDeviceRequest { /** 产品ID */ ProductId: string; /** 设备名 */ DeviceName: string; } declare interface DescribeDeviceResourceRequest { /** 设备名称 */ DeviceName: string; /** 产品ID */ ProductID?: string; /** 具体的设备资源名称 */ Name?: string; } declare interface DescribeDeviceResourceResponse { /** 设备资源详情 */ Result?: DeviceResourceInfo; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeDeviceResourcesRequest { /** 偏移量，Offset从0开始 */ Offset: number; /** 分页的大小，数值范围 10-250 */ Limit: number; /** 产品ID */ ProductID?: string; /** 需要过滤的设备名称 */ DeviceName?: string; /** 资源搜索开始时间 */ StartTime?: string; /** 资源搜索结束时间 */ EndTime?: string; } declare interface DescribeDeviceResourcesResponse { /** 资源总数 */ TotalCount?: number; /** 资源列表 */ Result?: DeviceResourceInfo[] | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeDeviceResponse { /** 设备名 */ DeviceName?: string; /** 设备是否在线，0不在线，1在线，3未激活 */ Online?: number; /** 设备登录时间 */ LoginTime?: number; /** 设备固件版本 */ Version?: string; /** 设备最后更新时间 */ LastUpdateTime?: number; /** 设备证书 */ DeviceCert?: string; /** 设备密钥 */ DevicePsk?: string; /** 设备属性 */ Tags?: DeviceTag[]; /** 设备类型 */ DeviceType?: number; /** 国际移动设备识别码 IMEI */ Imei?: string; /** 运营商类型 */ Isp?: number; /** IP地址 */ ConnIP?: number; /** NB IoT运营商处的DeviceID */ NbiotDeviceID?: string; /** Lora设备的dev eui */ LoraDevEui?: string; /** Lora设备的mote type */ LoraMoteType?: number; /** 设备的sdk日志等级 */ LogLevel?: number | null; /** 首次上线时间 */ FirstOnlineTime?: number | null; /** 最近下线时间 */ LastOfflineTime?: number | null; /** 设备创建时间 */ CreateTime?: number | null; /** 设备证书获取状态，0 未获取过设备密钥, 1 已获取过设备密钥 */ CertState?: number | null; /** 设备启用状态 */ EnableState?: number | null; /** 设备标签 */ Labels?: DeviceLabel[] | null; /** MQTT客户端IP地址 */ ClientIP?: string | null; /** 设备固件更新时间 */ FirmwareUpdateTime?: number | null; /** 创建者账号ID */ CreateUserId?: number | null; /** NB IoT运营商处的DeviceID */ NBIoTDeviceID?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeDeviceShadowRequest { /** 产品 ID */ ProductId: string; /** 设备名称。命名规则：[a-zA-Z0-9:_-]{1,60} */ DeviceName: string; } declare interface DescribeDeviceShadowResponse { /** 设备影子数据 */ Data?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeDevicesRequest { /** 需要查看设备列表的产品 ID */ ProductId: string; /** 偏移量，Offset从0开始 */ Offset: number; /** 分页的大小，数值范围 10-250 */ Limit: number; /** 设备固件版本号，若不带此参数会返回所有固件版本的设备。传"None-FirmwareVersion"查询无版本号的设备 */ FirmwareVersion?: string; /** 需要过滤的设备名称 */ DeviceName?: string; /** 设备是否启用，0禁用状态1启用状态，默认不区分 */ EnableState?: number; } declare interface DescribeDevicesResponse { /** 设备总数 */ TotalCount?: number; /** 设备详细信息列表 */ Devices?: DeviceInfo[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeFirmwareRequest { /** 产品ID */ ProductId: string; /** 固件版本号 */ FirmwareVersion: string; } declare interface DescribeFirmwareResponse { /** 固件版本号 */ Version?: string; /** 产品ID */ ProductId?: string; /** 固件名称 */ Name?: string | null; /** 固件描述 */ Description?: string | null; /** 固件Md5值 */ Md5sum?: string | null; /** 固件上传的秒级时间戳 */ Createtime?: number | null; /** 产品名称 */ ProductName?: string; /** 固件类型。选项：mcu、module */ FwType?: string; /** 固件用户自定义配置信息 */ UserDefined?: string | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeFirmwareTaskDevicesRequest { /** 产品ID */ ProductId: string; /** 固件版本 */ FirmwareVersion?: string; /** 筛选条件 */ Filters?: SearchKeyword[]; /** 查询偏移量 */ Offset?: number; /** 查询的数量 */ Limit?: number; } declare interface DescribeFirmwareTaskDevicesResponse { /** 固件升级任务的设备总数 */ Total?: number | null; /** 固件升级任务的设备列表 */ Devices?: DeviceUpdateStatus[] | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeFirmwareTaskDistributionRequest { /** 产品ID */ ProductId: string; /** 固件版本号 */ FirmwareVersion: string; /** 固件升级任务ID */ TaskId: number; } declare interface DescribeFirmwareTaskDistributionResponse { /** 固件升级任务状态分布信息 */ StatusInfos?: StatusStatistic[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeFirmwareTaskRequest { /** 产品ID */ ProductId: string; /** 固件版本号 */ FirmwareVersion: string; /** 固件任务ID */ TaskId: number; } declare interface DescribeFirmwareTaskResponse { /** 固件任务ID */ TaskId?: number | null; /** 固件任务状态 */ Status?: number | null; /** 固件任务创建时间，单位:秒 */ CreateTime?: number | null; /** 固件任务升级类型 */ Type?: number | null; /** 产品名称 */ ProductName?: string | null; /** 固件任务升级模式。originalVersion（按版本号升级）、filename（提交文件升级）、devicenames（按设备名称升级） */ UpgradeMode?: string | null; /** 产品ID */ ProductId?: string | null; /** 升级前版本号 */ OriginalVersion?: string | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeFirmwareTaskStatisticsRequest { /** 产品ID */ ProductId: string; /** 固件版本号 */ FirmwareVersion: string; } declare interface DescribeFirmwareTaskStatisticsResponse { /** 升级成功的设备总数 */ SuccessTotal?: number | null; /** 升级失败的设备总数 */ FailureTotal?: number | null; /** 正在升级的设备总数 */ UpgradingTotal?: number | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeFirmwareTasksRequest { /** 产品ID */ ProductId: string; /** 固件版本号 */ FirmwareVersion: string; /** 查询偏移量 */ Offset: number; /** 返回查询结果条数 */ Limit: number; /** 搜索过滤条件 */ Filters?: SearchKeyword[]; } declare interface DescribeFirmwareTasksResponse { /** 固件升级任务列表 */ TaskInfos?: FirmwareTaskInfo[] | null; /** 固件升级任务总数 */ Total?: number | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeGatewayBindDevicesRequest { /** 网关设备的产品ID */ GatewayProductId: string; /** 网关设备的设备名 */ GatewayDeviceName: string; /** 偏移量，Offset从0开始 */ Offset: number; /** 分页的页大小 */ Limit: number; /** LoRa产品的ID */ ProductId?: string; } declare interface DescribeGatewayBindDevicesResponse { /** 子设备总数 */ TotalCount?: number; /** 子设备信息 */ Devices?: BindDeviceInfo[]; /** 子设备所属的产品名 */ ProductName?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribePrivateCABindedProductsRequest { /** 证书名称 */ CertName: string; /** 查询偏移量 */ Offset: number; /** 查询的数据量，默认为20，最大为200 */ Limit: number; } declare interface DescribePrivateCABindedProductsResponse { /** 私有CA绑定的产品列表 */ Products: BindProductInfo[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribePrivateCARequest { /** 私有化CA名称 */ CertName: string; } declare interface DescribePrivateCAResponse { /** 私有化CA详情 */ CA: CertInfo; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribePrivateCAsRequest { } declare interface DescribePrivateCAsResponse { /** 私有CA证书列表 */ CAs: CertInfo[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeProductCARequest { /** 产品ID */ ProductId: string; } declare interface DescribeProductCAResponse { /** CA证书列表 */ CAs?: CertInfo[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeProductRequest { /** 产品ID */ ProductId: string; } declare interface DescribeProductResourceRequest { /** 需要查看资源列表的产品 ID */ ProductID?: string; /** 需要过滤的资源名称 */ Name?: string; } declare interface DescribeProductResourceResponse { /** 资源详情 */ Result?: ProductResourceInfo | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeProductResourcesRequest { /** 偏移量，Offset从0开始 */ Offset: number; /** 分页的大小，数值范围 10-250 */ Limit: number; /** 需要查看资源列表的产品 ID */ ProductID?: string; /** 需要过滤的资源名称 */ Name?: string; } declare interface DescribeProductResourcesResponse { /** 资源总数 */ TotalCount?: number; /** 资源详情 */ Result?: ProductResourceInfo[] | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeProductResponse { /** 产品ID */ ProductId?: string; /** 产品名 */ ProductName?: string; /** 产品元数据 */ ProductMetadata?: ProductMetadata; /** 产品属性 */ ProductProperties?: ProductProperties; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeProductTaskRequest { /** 产品ID */ ProductId: string; /** 任务ID */ TaskId: number; } declare interface DescribeProductTaskResponse { /** 产品任务详细信息 */ TaskInfo?: ProductTaskInfo; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeProductTasksRequest { /** 产品ID */ ProductId: string; /** 产品级别任务列表偏移量 */ Offset: number; /** 产品级别任务列表拉取个数 */ Limit: number; } declare interface DescribeProductTasksResponse { /** 符合条件的任务总个数 */ TotalCount?: number; /** 任务详细信息列表 */ TaskInfos?: ProductTaskInfo[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeProductsRequest { /** 偏移量，Offset从0开始 */ Offset: number; /** 分页大小，当前页面中显示的最大数量，值范围 10-250。 */ Limit: number; } declare interface DescribeProductsResponse { /** 产品总数 */ TotalCount?: number; /** 产品详细信息列表 */ Products?: ProductInfo[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribePushResourceTaskStatisticsRequest { /** 产品ID */ ProductID: string; /** 资源名称 */ Name: string; } declare interface DescribePushResourceTaskStatisticsResponse { /** 推送成功的设备总数 */ SuccessTotal: number | null; /** 推送失败的设备总数 */ FailureTotal: number | null; /** 正在推送的设备总数 */ UpgradingTotal: number | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeResourceTasksRequest { /** 产品ID */ ProductID: string; /** 资源名称 */ Name: string; /** 查询偏移量 */ Offset: number; /** 返回查询结果条数 */ Limit: number; /** 搜索过滤条件 */ Filters?: SearchKeyword[]; } declare interface DescribeResourceTasksResponse { /** 资源任务列表 */ TaskInfos?: FirmwareTaskInfo[] | null; /** 资源任务总数 */ Total?: number | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DisableTopicRuleRequest { /** 规则名称 */ RuleName: string; } declare interface DisableTopicRuleResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DownloadDeviceResourceRequest { /** 产品ID */ ProductID: string; /** 资源名称 */ Name: string; /** 设备名称 */ DeviceName: string; } declare interface DownloadDeviceResourceResponse { /** 设备资源的cos链接 */ Url: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface EditFirmwareRequest { /** 产品ID。 */ ProductId: string; /** 固件版本号。 */ FirmwareVersion: string; /** 固件名称。 */ FirmwareName: string; /** 固件描述 */ FirmwareDescription?: string; /** 固件用户自定义配置信息 */ FirmwareUserDefined?: string; } declare interface EditFirmwareResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface EnableTopicRuleRequest { /** 规则名称 */ RuleName: string; } declare interface EnableTopicRuleResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface GetAllVersionRequest { /** 产品ID */ ProductId: string; } declare interface GetAllVersionResponse { /** 版本号列表 */ Version?: string[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface GetCOSURLRequest { /** 产品ID */ ProductId: string; /** 固件版本 */ FirmwareVersion: string; /** 固件版本大小 */ FileSize?: number; } declare interface GetCOSURLResponse { /** 固件URL */ Url?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface GetUserResourceInfoRequest { } declare interface GetUserResourceInfoResponse { /** 已使用的资源字节数 */ UsedSize: number; /** 可以使用资源的总大小 */ Limit: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface ListFirmwaresRequest { /** 获取的页数 */ PageNum: number; /** 分页的大小 */ PageSize: number; /** 产品ID */ ProductId?: string; /** 搜索过滤条件 */ Filters?: SearchKeyword[]; } declare interface ListFirmwaresResponse { /** 固件总数 */ TotalCount?: number; /** 固件列表 */ Firmwares?: FirmwareInfo[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface ListLogPayloadRequest { /** 日志开始时间，毫秒级时间戳 */ MinTime: number; /** 日志结束时间，毫秒级时间戳 */ MaxTime: number; /** 查询关键字，可以同时支持键值查询和文本查询，例如，查询某key的值为value，并且包含某word的日志，该参数为：key:value word。键值或文本可以包含多个，以空格隔开。其中可以索引的key比如：RequestID、ProductID、DeviceName等。一个典型的查询示例：ProductID:ABCDE12345 DeviceName:test publish */ Keywords: string; /** 日志检索上下文 */ Context?: string; /** 日志最大条数 */ MaxNum?: number; } declare interface ListLogPayloadResponse { /** 日志上下文 */ Context?: string; /** 是否还有日志，如有仍有日志，下次查询的请求带上当前请求返回的Context */ Listover?: boolean; /** 日志列表 */ Results?: PayloadLogItem[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface ListLogRequest { /** 日志开始时间，毫秒级时间戳 */ MinTime: number; /** 日志结束时间，毫秒级时间戳 */ MaxTime: number; /** 查询关键字，可以同时支持键值查询和文本查询，例如，查询某key的值为value，并且包含某word的日志，该参数为：key:vlue worda。键值或文本可以包含多个，以空格隔开。其中可以索引的key包括：requestid、productid、devicename、scene、content。一个典型的查询示例：productid:ABCDE12345 devicename:test scene:SHADOW content:Device%20connect publish */ Keywords?: string; /** 日志检索上下文 */ Context?: string; /** 查询条数 */ MaxNum?: number; } declare interface ListLogResponse { /** 日志上下文 */ Context?: string; /** 是否还有日志，如有仍有日志，下次查询的请求带上当前请求返回的Context */ Listover?: boolean; /** 日志列表 */ Results?: CLSLogItem[]; /** 日志总条数 */ TotalCount?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface ListSDKLogRequest { /** 日志开始时间 */ MinTime: number; /** 日志结束时间 */ MaxTime: number; /** 查询关键字，可以同时支持键值查询和文本查询，例如，查询某key的值为value，并且包含某word的日志，该参数为：key:value word。键值或文本可以包含多个，以空格隔开。其中可以索引的key包括：productid、devicename、loglevel一个典型的查询示例：productid:7JK1G72JNE devicename:name publish loglevel:WARN一个典型的查询示例：productid:ABCDE12345 devicename:test scene:SHADOW publish */ Keywords: string; /** 日志检索上下文 */ Context?: string; /** 查询条数 */ MaxNum?: number; } declare interface ListSDKLogResponse { /** 日志检索上下文 */ Context?: string; /** 是否还有日志，如有仍有日志，下次查询的请求带上当前请求返回的Context */ Listover?: boolean; /** 日志列表 */ Results?: SDKLogItem[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface ListTopicRulesRequest { /** 请求的页数 */ PageNum: number; /** 分页的大小 */ PageSize: number; } declare interface ListTopicRulesResponse { /** 规则总数量 */ TotalCnt?: number; /** 规则列表 */ Rules?: TopicRuleInfo[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface PublishBroadcastMessageRequest { /** 产品ID */ ProductId: string; /** 消息内容 */ Payload: string; /** 消息质量等级 */ Qos: number; /** Payload内容的编码格式，取值为base64或空。base64表示云端将收到的请求数据进行base64解码后下发到设备，空则直接将原始内容下发到设备 */ PayloadEncoding?: string; } declare interface PublishBroadcastMessageResponse { /** 广播消息任务ID */ TaskId?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface PublishMessageRequest { /** 消息发往的主题。命名规则：${ProductId}/${DeviceName}/[a-zA-Z0-9:_-]{1,128} */ Topic: string; /** 消息内容 */ Payload: string; /** 产品ID */ ProductId: string; /** 设备名称 */ DeviceName: string; /** 服务质量等级，取值为0或1 */ Qos?: number; /** Payload内容的编码格式，取值为base64或空。base64表示云端将收到的请求数据进行base64解码后下发到设备，空则直接将原始内容下发到设备 */ PayloadEncoding?: string; } declare interface PublishMessageResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface PublishRRPCMessageRequest { /** 产品ID */ ProductId: string; /** 设备名称 */ DeviceName: string; /** 消息内容，utf8编码 */ Payload: string; } declare interface PublishRRPCMessageResponse { /** RRPC消息ID */ MessageId: number; /** 设备回复的消息内容，采用base64编码 */ PayloadBase64: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface ReplaceTopicRuleRequest { /** 规则名称 */ RuleName: string; /** 替换的规则包体 */ TopicRulePayload: TopicRulePayload; } declare interface ReplaceTopicRuleResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface ResetDeviceStateRequest { /** 产品ID */ ProductId: string; /** 设备名称 */ DeviceNames: string[]; } declare interface ResetDeviceStateResponse { /** 批量重置设备成功数 */ SuccessCount?: number; /** 批量重置设备结果 */ ResetDeviceResults?: ResetDeviceResult[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface RetryDeviceFirmwareTaskRequest { /** 产品ID */ ProductId: string; /** 设备名称 */ DeviceName: string; /** 固件版本号 */ FirmwareVersion: string; /** 固件升级任务ID */ TaskId: number; } declare interface RetryDeviceFirmwareTaskResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface SetProductsForbiddenStatusRequest { /** 要设置禁用状态的产品列表 */ ProductId: string[]; /** 0启用，1禁用 */ Status: number; } declare interface SetProductsForbiddenStatusResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface UnbindDevicesRequest { /** 网关设备的产品ID */ GatewayProductId: string; /** 网关设备的设备名 */ GatewayDeviceName: string; /** 产品ID */ ProductId: string; /** 多个设备名 */ DeviceNames: string[]; /** 中兴CLAA设备的解绑需要Skey，普通设备不需要 */ Skey?: string; } declare interface UnbindDevicesResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface UpdateDeviceAvailableStateRequest { /** 设备所属产品id */ ProductId: string; /** 设备名称 */ DeviceName: string; /** 要设置的设备状态，1为启用，0为禁用 */ EnableState: number; } declare interface UpdateDeviceAvailableStateResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface UpdateDeviceLogLevelRequest { /** 产品ID */ ProductId: string; /** 设备名称 */ DeviceName: string; /** 日志级别，0：关闭，1：错误，2：告警，3：信息，4：调试 */ LogLevel: number; } declare interface UpdateDeviceLogLevelResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface UpdateDevicePSKRequest { /** 产品名 */ ProductId: string; /** 设备名 */ DeviceName: string; /** 设备的psk */ Psk: string; } declare interface UpdateDevicePSKResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface UpdateDeviceShadowRequest { /** 产品ID */ ProductId: string; /** 设备名称 */ DeviceName: string; /** 虚拟设备的状态，JSON字符串格式，由desired结构组成 */ State: string; /** 当前版本号，需要和后台的version保持一致，才能更新成功 */ ShadowVersion: number; } declare interface UpdateDeviceShadowResponse { /** 设备影子数据，JSON字符串格式 */ Data?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface UpdateDevicesEnableStateRequest { /** 设备所属产品id */ ProductId: string; /** 设备名称集合 */ DeviceNames: string[]; /** 要设置的设备状态，1为启用，0为禁用 */ Status: number; } declare interface UpdateDevicesEnableStateResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface UpdateOtaTaskStatusRequest { /** 产品ID */ ProductId: string; /** 固件升级任务ID */ TaskId: number; /** 固件任务取消状态 */ Status: number; } declare interface UpdateOtaTaskStatusResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface UpdatePrivateCARequest { /** CA证书名称 */ CertName: string; /** CA证书内容 */ CertText: string; /** 校验CA证书的证书内容 */ VerifyCertText: string; } declare interface UpdatePrivateCAResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface UpdateProductDynamicRegisterRequest { /** 产品Id */ ProductId: string; /** 动态注册类型，0-关闭 1-预创建设备 2-自动创建设备 */ RegisterType: number; /** 动态注册设备上限 */ RegisterLimit: number; } declare interface UpdateProductDynamicRegisterResponse { /** 动态注册类型，0-关闭 1-预创建设备 2-自动创建设备 */ RegisterType?: number; /** 动态注册产品密钥 */ ProductSecret?: string; /** 动态注册设备上限 */ RegisterLimit?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface UpdateProductPrivateCARequest { /** 产品ID */ ProductId: string; /** 私有CA证书名称 */ CertName: string; } declare interface UpdateProductPrivateCAResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface UpdateTopicPolicyRequest { /** 产品ID */ ProductId: string; /** 更新前Topic名 */ TopicName: string; /** 更新后Topic名 */ NewTopicName: string; /** Topic权限 */ Privilege: number; /** 代理订阅信息 */ BrokerSubscribe?: BrokerSubscribe; } declare interface UpdateTopicPolicyResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface UploadFirmwareRequest { /** 产品ID */ ProductId: string; /** 固件版本号 */ FirmwareVersion: string; /** 固件的MD5值 */ Md5sum: string; /** 固件的大小 */ FileSize: number; /** 固件名称 */ FirmwareName?: string; /** 固件描述 */ FirmwareDescription?: string; /** 固件用户自定义配置信息 */ FirmwareUserDefined?: string; } declare interface UploadFirmwareResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare namespace V20180614 { type VersionHeader = { headers: { 'X-TC-Version': '2018-06-14' } } /** 设备属性 */ interface Attribute { /** 属性列表 */ Tags?: DeviceTag[]; } /** 批量发消息请求 */ interface BatchPublishMessage { /** 消息发往的主题。为 Topic 权限中去除 ProductID 和 DeviceName 的部分，如 “event” */ Topic: string; /** 消息内容 */ Payload: string; } /** 批量更新设备影子任务 */ interface BatchUpdateShadow { /** 设备影子的期望状态，格式为 Json 对象序列化之后的字符串 */ Desired: string; } /** 代理订阅信息 */ interface BrokerSubscribe { /** 产品ID */ ProductId: string; /** 设备名 */ DeviceName: string; } /** CLS日志 */ interface CLSLogItem { /** 日志内容 */ Content: string; /** 设备名称 */ Devicename: string; /** 产品ID */ Productid: string; /** 请求ID */ Requestid: string; /** 结果 */ Result: string; /** 模块 */ Scene: string; /** 日志时间 */ Time: string; /** 腾讯云账号 */ Userid: string; } /** 设备详细信息 */ interface DeviceInfo { /** 设备名 */ DeviceName: string; /** 设备是否在线，0不在线，1在线 */ Online: number; /** 设备登录时间 */ LoginTime: number; /** 设备版本 */ Version: string; /** 设备证书，证书加密的设备返回 */ DeviceCert: string; /** 设备密钥，密钥加密的设备返回 */ DevicePsk: string; /** 设备属性 */ Tags: DeviceTag[]; /** 设备类型 */ DeviceType: number; /** 国际移动设备识别码 IMEI */ Imei: string; /** 运营商类型 */ Isp: number; /** NB IOT运营商处的DeviceID */ NbiotDeviceID: string; /** IP地址 */ ConnIP: number; /** 设备最后更新时间 */ LastUpdateTime: number; /** LoRa设备的dev eui */ LoraDevEui: string; /** LoRa设备的Mote type */ LoraMoteType: number; /** 首次上线时间 */ FirstOnlineTime: number | null; /** 最近下线时间 */ LastOfflineTime: number | null; /** 设备创建时间 */ CreateTime: number | null; /** 设备日志级别 */ LogLevel: number | null; /** 设备证书获取状态, 1 已获取过设备密钥，0 未获取过设备密钥 */ CertState: number | null; /** 设备可用状态，0禁用，1启用 */ EnableState: number | null; /** 设备标签 */ Labels: DeviceLabel[] | null; /** MQTT客户端IP地址 */ ClientIP: string | null; /** ota最后更新时间 */ FirmwareUpdateTime: number | null; } /** 设备标签 */ interface DeviceLabel { /** 标签标识 */ Key: string; /** 标签值 */ Value: string; } /** 设备资源信息。 */ interface DeviceProperty { /** 产品ID。 */ ProductId: string | null; /** 产品名称。 */ ProductName: string | null; /** 设备名称。 */ DeviceName: string | null; /** 设备资源ID。 */ ResourceId: string | null; } /** 设备资源详细信息 */ interface DeviceResourceInfo { /** 产品ID */ ProductID: string; /** 产品名 */ ProductName: string; /** 资源名称 */ Name: string; /** 资源文件md5 */ Md5: string; /** 资源文件大小 */ Size: number; /** 资源更新时间 */ UpdateTime: string; /** 设备名称 */ DeviceName: string; /** 设备资源上传状态 */ Status: number; /** 设备资源上传百分比 */ Percent: number; } /** 设备属性 */ interface DeviceTag { /** 属性名称 */ Tag: string; /** 属性值的类型，1 int，2 string */ Type: number; /** 属性的值 */ Value: string; /** 属性描述名称 */ Name?: string | null; } /** 设备固件更新状态 */ interface DeviceUpdateStatus { /** 设备名 */ DeviceName: string; /** 最后处理时间 */ LastProcessTime: number; /** 状态 */ Status: number; /** 错误消息 */ ErrMsg: string; /** 返回码 */ Retcode: number; /** 目标更新版本 */ DstVersion: string; /** 下载中状态时的下载进度 */ Percent: number | null; /** 原版本号 */ OriVersion: string | null; /** 任务ID */ TaskId: number | null; } /** 固件升级任务信息 */ interface FirmwareTaskInfo { /** 任务ID */ TaskId: number | null; /** 任务状态 */ Status: number | null; /** 任务类型 */ Type: number | null; /** 任务创建时间 */ CreateTime: number | null; } /** 创建设备时返回的设备信息 */ interface MultiDevicesInfo { /** 设备名 */ DeviceName: string; /** 对称加密密钥，base64 编码，采用对称加密时返回该参数 */ DevicePsk: string; /** 设备证书，采用非对称加密时返回该参数 */ DeviceCert: string; /** 设备私钥，采用非对称加密时返回该参数，腾讯云为用户缓存起来，其生命周期与任务生命周期一致 */ DevicePrivateKey: string; /** 错误码 */ Result: number; /** 错误信息 */ ErrMsg: string; } /** 内容日志项 */ interface PayloadLogItem { /** 账号id */ Uin: string; /** 产品id */ ProductID: string; /** 设备名称 */ DeviceName: string; /** 来源类型 */ SrcType: string; /** 来源名称 */ SrcName: string; /** 消息topic */ Topic: string; /** 内容格式类型 */ PayloadFmtType: string; /** 内容信息 */ Payload: string; /** 请求ID */ RequestID: string; /** 日期时间 */ DateTime: string; } /** 产品详细信息 */ interface ProductInfo { /** 产品ID */ ProductId: string; /** 产品名 */ ProductName: string; /** 产品元数据 */ ProductMetadata: ProductMetadata; /** 产品属性 */ ProductProperties: ProductProperties; } /** 产品元数据 */ interface ProductMetadata { /** 产品创建时间 */ CreationDate: number; } /** 产品属性 */ interface ProductProperties { /** 产品描述 */ ProductDescription?: string; /** 加密类型，1表示证书认证，2表示签名认证。如不填写，默认值是1 */ EncryptionType?: string; /** 产品所属区域，目前只支持广州（gz） */ Region?: string; /** 产品类型，各个类型值代表的节点-类型如下：0 普通产品，2 NB-IoT产品，4 LoRa产品，3 LoRa网关产品，5 普通网关产品默认值是0 */ ProductType?: number; /** 数据格式，取值为json或者custom，默认值是json */ Format?: string; /** 产品所属平台，默认值是0 */ Platform?: string; /** LoRa产品运营侧APPEUI，只有LoRa产品需要填写 */ Appeui?: string; /** 产品绑定的物模型ID，-1表示不绑定 */ ModelId?: string; /** 产品绑定的物模型名称 */ ModelName?: string; /** 产品密钥，suite产品才会有 */ ProductKey?: string; /** 动态注册类型 0-关闭, 1-预定义设备名 2-动态定义设备名 */ RegisterType?: number; /** 动态注册产品秘钥 */ ProductSecret?: string; /** RegisterType为2时，设备动态创建的限制数量 */ RegisterLimit?: number; } /** 产品资源详细信息 */ interface ProductResourceInfo { /** 产品ID */ ProductID: string; /** 产品名 */ ProductName: string; /** 资源名称 */ Name: string; /** 资源文件md5 */ Md5: string; /** 资源文件大小 */ Size: number; /** 资源文件描述 */ Description: string | null; /** 资源创建时间 */ CreateTime: string; } /** 产品级任务详细信息 */ interface ProductTaskInfo { /** 任务ID */ Id: number; /** 任务类型 0-批量创建设备类型 */ Type: number; /** 任务状态 0-创建中 1-待执行 2-执行中 3-执行失败 4-子任务部分失败 5-执行成功 */ State: number; /** 任务参数类型 cosfile-文件输入 random-随机生成 */ ParametersType: string; /** 任务参数 */ Parameters: string; /** 任务执行结果类型 cosfile-文件输出 errmsg-错误信息 */ ResultType: string | null; /** 任务执行结果 */ Result: string | null; /** 子任务总个数 */ BatchCount: number | null; /** 子任务已执行个数 */ BatchOffset: number | null; /** 任务创建时间 */ CreateTime: number; /** 任务更新时间 */ UpdateTime: number; /** 任务完成时间 */ CompleteTime: number | null; } /** 重置设备状态结果 */ interface ResetDeviceResult { /** 设备名 */ DeviceName: string; /** 是否成功 */ Success: boolean; /** 失败原因 */ Reason: string | null; } /** SDK日志项 */ interface SDKLogItem { /** 产品ID */ ProductID: string; /** 设备名称 */ DeviceName: string; /** 日志等级 */ Level: string; /** 日志时间 */ DateTime: string; /** 日志内容 */ Content: string; } /** 搜索关键词 */ interface SearchKeyword { /** 搜索条件的Key */ Key: string; /** 搜索条件的值 */ Value?: string; } /** 状态统计信息 */ interface StatusStatistic { /** 任务状态 */ Status: number | null; /** 统计总数 */ Total: number | null; } /** 任务描述细节 */ interface Task { /** 批量更新影子任务的描述细节，当 taskType 取值为 “UpdateShadow” 时，此字段必填。描述见下 BatchUpdateShadow */ UpdateShadowTask?: BatchUpdateShadow; /** 批量下发消息任务的描述细节，当 taskType 取值为 “PublishMessage” 时，此字段必填。描述见下 BatchPublishMessage */ PublishMessageTask?: BatchPublishMessage; } /** 任务列表详细信息 */ interface TaskInfo { /** 任务类型，目前取值为 “UpdateShadow” 或者 “PublishMessage” */ Type: string; /** 任务 ID */ Id: string; /** 产品 ID */ ProductId: string; /** 状态。1表示等待处理，2表示调度处理中，3表示已完成，4表示失败，5表示已取消 */ Status: number; /** 任务创建时间，Unix 时间戳 */ CreateTime: number; /** 最后任务更新时间，Unix 时间戳 */ UpdateTime: number; /** 返回的错误码 */ RetCode: number; /** 返回的错误信息 */ ErrMsg: string; } /** 创建规则请求包体 */ interface TopicRulePayload { /** 规则的SQL语句，如： SELECT * FROM 'pid/dname/event'，然后对其进行base64编码，得：U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw== */ Sql: string; /** 行为的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_test", "fieldpairs": [ { "field": "test", "value": "test" } ], "devicetype": "CUSTOM" } }] */ Actions?: string; /** 规则描述 */ Description?: string; /** 是否禁用规则 */ RuleDisabled?: boolean; } interface BatchUpdateFirmwareRequest { /** 产品ID */ ProductID: string; /** 固件新版本号 */ FirmwareVersion: string; /** 固件原版本号，根据文件列表升级固件不需要填写此参数 */ FirmwareOriVersion?: string; /** 升级方式，0 静默升级 1 用户确认升级。不填默认为静默升级方式 */ UpgradeMethod?: number; /** 设备列表文件名称，根据文件列表升级固件需要填写此参数 */ FileName?: string; /** 设备列表的文件md5值 */ FileMd5?: string; /** 设备列表的文件大小值 */ FileSize?: number; /** 需要升级的设备名称列表 */ DeviceNames?: string[]; /** 固件升级任务，默认超时时间。最小取值60秒，最大为3600秒 */ TimeoutInterval?: number; } interface BatchUpdateFirmwareResponse { /** 任务ID */ TaskId: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } interface BindDevicesRequest { /** 网关设备的产品ID */ GatewayProductId: string; /** 网关设备的设备名 */ GatewayDeviceName: string; /** 被绑定设备的产品ID */ ProductId: string; /** 被绑定的多个设备名 */ DeviceNames: string[]; /** 中兴CLAA设备的绑定需要skey，普通的设备不需要 */ Skey?: string; } interface BindDevicesResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } interface CancelDeviceFirmwareTaskRequest { /** 产品ID */ ProductID: string; /** 设备名称 */ DeviceName: string; /** 固件版本号 */ FirmwareVersion: string; /** 固件升级任务ID */ TaskId: number; } interface CancelDeviceFirmwareTaskResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } interface CancelTaskRequest { /** 任务 ID */ Id: string; } interface CancelTaskResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } interface CreateDeviceRequest { /** 产品 ID 。创建产品时腾讯云为用户分配全局唯一的 ID */ ProductId: string; /** 设备名称。命名规则：[a-zA-Z0-9:_-]{1,48}。 */ DeviceName: string; /** 设备属性 */ Attribute?: Attribute; /** 是否使用自定义PSK，默认不使用 */ DefinedPsk?: string; /** 运营商类型，当产品是NB-IoT产品时，此字段必填。1表示中国电信，2表示中国移动，3表示中国联通 */ Isp?: number; /** IMEI，当产品是NB-IoT产品时，此字段必填 */ Imei?: string; /** LoRa设备的DevEui，当创建LoRa时，此字段必填 */ LoraDevEui?: string; /** LoRa设备的MoteType */ LoraMoteType?: number; /** 创建LoRa设备需要skey */ Skey?: string; /** LoRa设备的AppKey */ LoraAppKey?: string; } interface CreateDeviceResponse { /** 设备名称 */ DeviceName?: string; /** 对称加密密钥，base64编码。采用对称加密时返回该参数 */ DevicePsk?: string; /** 设备证书，用于 TLS 建立链接时校验客户端身份。采用非对称加密时返回该参数 */ DeviceCert?: string; /** 设备私钥，用于 TLS 建立链接时校验客户端身份，腾讯云后台不保存，请妥善保管。采用非对称加密时返回该参数 */ DevicePrivateKey?: string; /** LoRa设备的DevEui，当设备是LoRa设备时，会返回该字段 */ LoraDevEui?: string; /** LoRa设备的MoteType，当设备是LoRa设备时，会返回该字段 */ LoraMoteType?: number; /** LoRa设备的AppKey，当设备是LoRa设备时，会返回该字段 */ LoraAppKey?: string; /** LoRa设备的NwkKey，当设备是LoRa设备时，会返回该字段 */ LoraNwkKey?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } interface CreateLoraDeviceRequest { /** 产品Id ，创建产品时腾讯云为用户分配全局唯一的Id */ ProductId: string; /** 设备名称 */ DeviceName: string; /** 设备类型，目前支持A、B、C三种 */ DeviceType: string; /** LoRa应用UUID */ AppEui?: string; /** LoRa设备UUID */ DeviceEui?: string; /** LoRa应用密钥 */ AppKey?: string; /** LoRa设备验证密钥 */ AuthKey?: string; /** 设备备注 */ Memo?: string; } interface CreateLoraDeviceResponse { /** LoRa应用UUID */ AppEui?: string; /** LoRa设备UUID */ DeviceEui?: string; /** 设备类型,目前支持A、B、C三种 */ ClassType?: string; /** 设备名称 */ DeviceName?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } interface CreateMultiDeviceRequest { /** 产品 ID。创建产品时腾讯云为用户分配全局唯一的 ID */ ProductId: string; /** 批量创建的设备名数组，单次最多创建 100 个设备。命名规则：[a-zA-Z0-9:_-]{1,48} */ DeviceNames: string[]; } interface CreateMultiDeviceResponse { /** 任务ID，腾讯云生成全局唯一的任务 ID，有效期一个月，一个月之后任务失效。可以调用获取创建多设备任务状态接口获取该任务的执行状态，当状态为成功时，可以调用获取创建多设备任务结果接口获取该任务的结果 */ TaskId?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } interface CreateMultiDevicesTaskRequest { /** 产品ID */ ProductId: string; /** 参数类型 cosfile-文件上传 random-随机创建 */ ParametersType: string; /** 文件上传类型时文件名 */ FileName?: string; /** 文件上传类型时文件大小 */ FileSize?: number; /** 随机创建时设备创建个数 */ BatchCount?: number; /** 文件上传类型时文件md5值 */ Hash?: string; } interface CreateMultiDevicesTaskResponse { /** 任务ID */ Id?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } interface CreateProductRequest { /** 产品名称，名称不能和已经存在的产品名称重复。命名规则：[a-zA-Z0-9:_-]{1,32} */ ProductName: string; /** 产品属性 */ ProductProperties?: ProductProperties; /** 创建CLAA产品时，需要Skey */ Skey?: string; } interface CreateProductRespon