tencentcloud-sdk-nodejs 4.0.337 → 4.0.340

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. package/CHANGELOG.md +414 -0
  2. package/SERVICE_CHANGELOG.md +399 -33
  3. package/package.json +1 -1
  4. package/products.md +23 -22
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/antiddos/v20200309/antiddos_client.ts +13 -0
  7. package/src/services/antiddos/v20200309/antiddos_models.ts +153 -0
  8. package/src/services/bi/index.ts +5 -0
  9. package/src/services/bi/v20220105/bi_client.ts +57 -0
  10. package/src/services/bi/v20220105/bi_models.ts +214 -0
  11. package/src/services/bi/v20220105/index.ts +6 -0
  12. package/src/services/cfw/v20190904/cfw_models.ts +5 -0
  13. package/src/services/ckafka/v20190819/ckafka_client.ts +12 -0
  14. package/src/services/ckafka/v20190819/ckafka_models.ts +41 -1
  15. package/src/services/cvm/v20170312/cvm_models.ts +1 -1
  16. package/src/services/dlc/v20210125/dlc_models.ts +35 -0
  17. package/src/services/emr/v20190103/emr_client.ts +67 -63
  18. package/src/services/emr/v20190103/emr_models.ts +2011 -1833
  19. package/src/services/ess/v20201111/ess_models.ts +26 -8
  20. package/src/services/faceid/v20180301/faceid_client.ts +1 -1
  21. package/src/services/faceid/v20180301/faceid_models.ts +5 -4
  22. package/src/services/gaap/v20180529/gaap_client.ts +68 -28
  23. package/src/services/gaap/v20180529/gaap_models.ts +280 -68
  24. package/src/services/index.ts +1 -0
  25. package/src/services/iotcloud/v20210408/iotcloud_client.ts +608 -68
  26. package/src/services/iotcloud/v20210408/iotcloud_models.ts +2835 -667
  27. package/src/services/iotexplorer/v20190423/iotexplorer_client.ts +2 -2
  28. package/src/services/monitor/v20180724/monitor_models.ts +5 -0
  29. package/src/services/ocr/v20181119/ocr_client.ts +14 -1
  30. package/src/services/ocr/v20181119/ocr_models.ts +103 -15
  31. package/src/services/redis/v20180412/redis_models.ts +1 -1
  32. package/src/services/ses/v20201002/ses_client.ts +2 -2
  33. package/src/services/ses/v20201002/ses_models.ts +2 -2
  34. package/src/services/tiia/v20190529/tiia_models.ts +2 -2
  35. package/src/services/tke/v20180525/tke_models.ts +15 -0
  36. package/src/services/trtc/v20190722/trtc_models.ts +6 -6
  37. package/src/services/tsf/v20180326/tsf_models.ts +6 -0
  38. package/src/services/vod/v20180717/vod_client.ts +1 -0
  39. package/src/services/vod/v20180717/vod_models.ts +22 -1
  40. package/tencentcloud/common/sdk_version.d.ts +1 -1
  41. package/tencentcloud/common/sdk_version.js +1 -1
  42. package/tencentcloud/services/antiddos/v20200309/antiddos_client.d.ts +5 -1
  43. package/tencentcloud/services/antiddos/v20200309/antiddos_client.js +6 -0
  44. package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +126 -0
  45. package/tencentcloud/services/bi/index.d.ts +6 -0
  46. package/tencentcloud/services/bi/index.js +7 -0
  47. package/tencentcloud/services/bi/v20220105/bi_client.d.ts +18 -0
  48. package/tencentcloud/services/bi/v20220105/bi_client.js +43 -0
  49. package/tencentcloud/services/bi/v20220105/bi_models.d.ts +168 -0
  50. package/tencentcloud/services/bi/v20220105/bi_models.js +18 -0
  51. package/tencentcloud/services/bi/v20220105/index.d.ts +6 -0
  52. package/tencentcloud/services/bi/v20220105/index.js +9 -0
  53. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +4 -0
  54. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +5 -1
  55. package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +6 -0
  56. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +35 -1
  57. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +1 -1
  58. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +29 -0
  59. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +1 -1
  60. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +1757 -1607
  61. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +23 -7
  62. package/tencentcloud/services/faceid/v20180301/faceid_client.d.ts +1 -1
  63. package/tencentcloud/services/faceid/v20180301/faceid_client.js +1 -1
  64. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +5 -4
  65. package/tencentcloud/services/gaap/v20180529/gaap_client.d.ts +21 -9
  66. package/tencentcloud/services/gaap/v20180529/gaap_client.js +30 -12
  67. package/tencentcloud/services/gaap/v20180529/gaap_models.d.ts +245 -60
  68. package/tencentcloud/services/index.d.ts +1 -0
  69. package/tencentcloud/services/index.js +2 -0
  70. package/tencentcloud/services/iotcloud/v20210408/iotcloud_client.d.ts +187 -11
  71. package/tencentcloud/services/iotcloud/v20210408/iotcloud_client.js +279 -15
  72. package/tencentcloud/services/iotcloud/v20210408/iotcloud_models.d.ts +2515 -663
  73. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +2 -2
  74. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +2 -2
  75. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +4 -0
  76. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +6 -2
  77. package/tencentcloud/services/ocr/v20181119/ocr_client.js +7 -1
  78. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +87 -15
  79. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +1 -1
  80. package/tencentcloud/services/ses/v20201002/ses_client.d.ts +2 -2
  81. package/tencentcloud/services/ses/v20201002/ses_client.js +2 -2
  82. package/tencentcloud/services/ses/v20201002/ses_models.d.ts +2 -2
  83. package/tencentcloud/services/tiia/v20190529/tiia_models.d.ts +2 -2
  84. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +12 -0
  85. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +6 -6
  86. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +5 -0
  87. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +19 -1
  88. package/test/antiddos.v20200309.test.js +10 -0
  89. package/test/bi.v20220105.test.js +41 -0
  90. package/test/ckafka.v20190819.test.js +10 -0
  91. package/test/gaap.v20180529.test.js +44 -14
  92. package/test/iotcloud.v20210408.test.js +450 -10
  93. package/test/ocr.v20181119.test.js +10 -0
@@ -16,29 +16,44 @@
16
16
  */
17
17
 
18
18
  /**
19
- * ListLog返回参数结构体
19
+ * PublishMessage请求参数结构体
20
20
  */
21
- export interface ListLogResponse {
21
+ export interface PublishMessageRequest {
22
22
  /**
23
- * 日志上下文
23
+ * 消息发往的主题。命名规则:${ProductId}/${DeviceName}/[a-zA-Z0-9:_-]{1,128}
24
24
  */
25
- Context: string
25
+ Topic: string
26
26
 
27
27
  /**
28
- * 是否还有日志,如有仍有日志,下次查询的请求带上当前请求返回的Context
28
+ * 消息内容
29
29
  */
30
- Listover: boolean
30
+ Payload: string
31
31
 
32
32
  /**
33
- * 日志列表
33
+ * 产品ID
34
34
  */
35
- Results: Array<CLSLogItem>
35
+ ProductId: string
36
36
 
37
37
  /**
38
- * 日志总条数
38
+ * 设备名称
39
39
  */
40
- TotalCount: number
40
+ DeviceName: string
41
+
42
+ /**
43
+ * 服务质量等级,取值为0或1
44
+ */
45
+ Qos?: number
46
+
47
+ /**
48
+ * Payload内容的编码格式,取值为base64或空。base64表示云端将收到的请求数据进行base64解码后下发到设备,空则直接将原始内容下发到设备
49
+ */
50
+ PayloadEncoding?: string
51
+ }
41
52
 
53
+ /**
54
+ * UpdateDevicesEnableState返回参数结构体
55
+ */
56
+ export interface UpdateDevicesEnableStateResponse {
42
57
  /**
43
58
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
44
59
  */
@@ -46,44 +61,104 @@ export interface ListLogResponse {
46
61
  }
47
62
 
48
63
  /**
49
- * DeleteProduct请求参数结构体
64
+ * DescribeProductCA返回参数结构体
50
65
  */
51
- export interface DeleteProductRequest {
66
+ export interface DescribeProductCAResponse {
52
67
  /**
53
- * 需要删除的产品 ID
68
+ * CA证书列表
54
69
  */
55
- ProductId: string
70
+ CAs: Array<CertInfo>
56
71
 
57
72
  /**
58
- * 删除LoRa产品需要skey
73
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
59
74
  */
60
- Skey?: string
75
+ RequestId?: string
61
76
  }
62
77
 
63
78
  /**
64
- * DescribePrivateCABindedProducts请求参数结构体
79
+ * UpdateProductPrivateCA请求参数结构体
65
80
  */
66
- export interface DescribePrivateCABindedProductsRequest {
81
+ export interface UpdateProductPrivateCARequest {
67
82
  /**
68
- * 证书名称
83
+ * 产品ID
84
+ */
85
+ ProductId: string
86
+
87
+ /**
88
+ * 私有CA证书名称
69
89
  */
70
90
  CertName: string
91
+ }
92
+
93
+ /**
94
+ * UnbindDevices请求参数结构体
95
+ */
96
+ export interface UnbindDevicesRequest {
97
+ /**
98
+ * 网关设备的产品ID
99
+ */
100
+ GatewayProductId: string
71
101
 
72
102
  /**
73
- * 查询偏移量
103
+ * 网关设备的设备名
104
+ */
105
+ GatewayDeviceName: string
106
+
107
+ /**
108
+ * 产品ID
109
+ */
110
+ ProductId: string
111
+
112
+ /**
113
+ * 多个设备名
114
+ */
115
+ DeviceNames: Array<string>
116
+
117
+ /**
118
+ * 中兴CLAA设备的解绑需要Skey,普通设备不需要
119
+ */
120
+ Skey?: string
121
+ }
122
+
123
+ /**
124
+ * DescribeDeviceResources请求参数结构体
125
+ */
126
+ export interface DescribeDeviceResourcesRequest {
127
+ /**
128
+ * 偏移量,Offset从0开始
74
129
  */
75
130
  Offset: number
76
131
 
77
132
  /**
78
- * 查询的数据量,默认为20, 最大为200
133
+ * 分页的大小,数值范围 10-250
79
134
  */
80
135
  Limit: number
136
+
137
+ /**
138
+ * 产品ID
139
+ */
140
+ ProductID?: string
141
+
142
+ /**
143
+ * 需要过滤的设备名称
144
+ */
145
+ DeviceName?: string
146
+
147
+ /**
148
+ * 资源搜索开始时间
149
+ */
150
+ StartTime?: string
151
+
152
+ /**
153
+ * 资源搜索结束时间
154
+ */
155
+ EndTime?: string
81
156
  }
82
157
 
83
158
  /**
84
- * DeleteProductPrivateCA返回参数结构体
159
+ * DeletePrivateCA返回参数结构体
85
160
  */
86
- export interface DeleteProductPrivateCAResponse {
161
+ export interface DeletePrivateCAResponse {
87
162
  /**
88
163
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
89
164
  */
@@ -111,140 +186,218 @@ export interface UpdatePrivateCARequest {
111
186
  }
112
187
 
113
188
  /**
114
- * UpdateDevicesEnableState返回参数结构体
189
+ * BindDevices请求参数结构体
115
190
  */
116
- export interface UpdateDevicesEnableStateResponse {
191
+ export interface BindDevicesRequest {
117
192
  /**
118
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
193
+ * 网关设备的产品ID
119
194
  */
120
- RequestId?: string
121
- }
195
+ GatewayProductId: string
122
196
 
123
- /**
124
- * DescribePrivateCA请求参数结构体
125
- */
126
- export interface DescribePrivateCARequest {
127
197
  /**
128
- * 私有化CA名称
198
+ * 网关设备的设备名
129
199
  */
130
- CertName: string
131
- }
200
+ GatewayDeviceName: string
132
201
 
133
- /**
134
- * DescribeProductCA返回参数结构体
135
- */
136
- export interface DescribeProductCAResponse {
137
202
  /**
138
- * CA证书列表
203
+ * 被绑定设备的产品ID
139
204
  */
140
- CAs: Array<CertInfo>
205
+ ProductId: string
141
206
 
142
207
  /**
143
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
208
+ * 被绑定的多个设备名
144
209
  */
145
- RequestId?: string
210
+ DeviceNames: Array<string>
211
+
212
+ /**
213
+ * 中兴CLAA设备的绑定需要skey,普通的设备不需要
214
+ */
215
+ Skey?: string
146
216
  }
147
217
 
148
218
  /**
149
- * 产品属性
219
+ * CreatePrivateCA返回参数结构体
150
220
  */
151
- export interface ProductProperties {
221
+ export interface CreatePrivateCAResponse {
152
222
  /**
153
- * 产品描述
223
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
154
224
  */
155
- ProductDescription?: string
225
+ RequestId?: string
226
+ }
156
227
 
228
+ /**
229
+ * DescribeProducts请求参数结构体
230
+ */
231
+ export interface DescribeProductsRequest {
157
232
  /**
158
- * 加密类型,1表示证书认证,2表示签名认证。如不填写,默认值是1
233
+ * 偏移量,Offset从0开始
159
234
  */
160
- EncryptionType?: string
235
+ Offset: number
161
236
 
162
237
  /**
163
- * 产品所属区域,目前只支持广州(gz)
238
+ * 分页大小,当前页面中显示的最大数量,值范围 10-250。
164
239
  */
165
- Region?: string
240
+ Limit: number
241
+ }
166
242
 
167
- /**
168
- * 产品类型,各个类型值代表的节点-类型如下:
169
- 0 普通产品,2 NB-IoT产品,4 LoRa产品,3 LoRa网关产品,5 普通网关产品 默认值是0
243
+ /**
244
+ * 创建规则请求包体
245
+ */
246
+ export interface TopicRulePayload {
247
+ /**
248
+ * 规则的SQL语句,如: SELECT * FROM 'pid/dname/event',然后对其进行base64编码,得:U0VMRUNUICogRlJPTSAncGlkL2RuYW1lL2V2ZW50Jw==
249
+ */
250
+ Sql: string
251
+
252
+ /**
253
+ * 行为的JSON字符串,大部分种类举例如下:
254
+ [
255
+ {
256
+ "republish": {
257
+ "topic": "TEST/test"
258
+ }
259
+ },
260
+ {
261
+ "forward": {
262
+ "api": "http://127.0.0.1:8080",
263
+ "token":"xxx"
264
+ }
265
+ },
266
+ {
267
+ "ckafka": {
268
+ "instance": {
269
+ "id": "ckafka-test",
270
+ "name": ""
271
+ },
272
+ "topic": {
273
+ "id": "topic-test",
274
+ "name": "test"
275
+ },
276
+ "region": "gz"
277
+ }
278
+ },
279
+ {
280
+ "cmqqueue": {
281
+ "queuename": "queue-test-TEST",
282
+ "region": "gz"
283
+ }
284
+ },
285
+ {
286
+ "mysql": {
287
+ "instanceid": "cdb-test",
288
+ "region": "gz",
289
+ "username": "test",
290
+ "userpwd": "*****",
291
+ "dbname": "d_mqtt",
292
+ "tablename": "t_test",
293
+ "fieldpairs": [
294
+ {
295
+ "field": "test",
296
+ "value": "test"
297
+ }
298
+ ],
299
+ "devicetype": "CUSTOM"
300
+ }
301
+ }
302
+ ]
170
303
  */
171
- ProductType?: number
304
+ Actions?: string
172
305
 
173
306
  /**
174
- * 数据格式,取值为json或者custom,默认值是json
307
+ * 规则描述
175
308
  */
176
- Format?: string
309
+ Description?: string
177
310
 
178
311
  /**
179
- * 产品所属平台,默认值是0
312
+ * 是否禁用规则
180
313
  */
181
- Platform?: string
314
+ RuleDisabled?: boolean
315
+ }
182
316
 
317
+ /**
318
+ * 内容日志项
319
+ */
320
+ export interface PayloadLogItem {
183
321
  /**
184
- * LoRa产品运营侧APPEUI,只有LoRa产品需要填写
322
+ * 账号id
185
323
  */
186
- Appeui?: string
324
+ Uin: string
187
325
 
188
326
  /**
189
- * 产品绑定的物模型ID,-1表示不绑定
327
+ * 产品id
190
328
  */
191
- ModelId?: string
329
+ ProductId: string
192
330
 
193
331
  /**
194
- * 产品绑定的物模型名称
332
+ * 设备名称
195
333
  */
196
- ModelName?: string
334
+ DeviceName: string
197
335
 
198
336
  /**
199
- * 产品密钥,suite产品才会有
337
+ * 来源类型
200
338
  */
201
- ProductKey?: string
339
+ SrcType: string
202
340
 
203
341
  /**
204
- * 动态注册类型 0-关闭, 1-预定义设备名 2-动态定义设备名
342
+ * 来源名称
205
343
  */
206
- RegisterType?: number
344
+ SrcName: string
207
345
 
208
346
  /**
209
- * 动态注册产品秘钥
347
+ * 消息topic
210
348
  */
211
- ProductSecret?: string
349
+ Topic: string
212
350
 
213
351
  /**
214
- * RegisterType为2时,设备动态创建的限制数量
352
+ * 内容格式类型
215
353
  */
216
- RegisterLimit?: number
354
+ PayloadFormatType: string
217
355
 
218
356
  /**
219
- * 划归的产品,展示为源产品ID,其余为空
357
+ * 内容信息
220
358
  */
221
- OriginProductId?: string
359
+ Payload: string
222
360
 
223
361
  /**
224
- * 私有CA名称
362
+ * 请求ID
225
363
  */
226
- PrivateCAName?: string
364
+ RequestId: string
227
365
 
228
366
  /**
229
- * 划归的产品,展示为源用户ID,其余为空
367
+ * 日期时间
230
368
  */
231
- OriginUserId?: number
369
+ DateTime: string
232
370
  }
233
371
 
234
372
  /**
235
- * UpdatePrivateCA返回参数结构体
373
+ * 子产品信息
236
374
  */
237
- export interface UpdatePrivateCAResponse {
375
+ export interface BindProductInfo {
238
376
  /**
239
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
377
+ * 产品ID
240
378
  */
241
- RequestId?: string
379
+ ProductId: string
380
+
381
+ /**
382
+ * 产品名
383
+ */
384
+ ProductName: string
242
385
  }
243
386
 
244
387
  /**
245
- * DeletePrivateCA返回参数结构体
388
+ * DescribeDevices返回参数结构体
246
389
  */
247
- export interface DeletePrivateCAResponse {
390
+ export interface DescribeDevicesResponse {
391
+ /**
392
+ * 设备总数
393
+ */
394
+ TotalCount: number
395
+
396
+ /**
397
+ * 设备详细信息列表
398
+ */
399
+ Devices: Array<DeviceInfo>
400
+
248
401
  /**
249
402
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
250
403
  */
@@ -252,14 +405,9 @@ export interface DeletePrivateCAResponse {
252
405
  }
253
406
 
254
407
  /**
255
- * DescribePrivateCAs返回参数结构体
408
+ * DeleteTopicRule返回参数结构体
256
409
  */
257
- export interface DescribePrivateCAsResponse {
258
- /**
259
- * 私有CA证书列表
260
- */
261
- CAs: Array<CertInfo>
262
-
410
+ export interface DeleteTopicRuleResponse {
263
411
  /**
264
412
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
265
413
  */
@@ -267,9 +415,9 @@ export interface DescribePrivateCAsResponse {
267
415
  }
268
416
 
269
417
  /**
270
- * DeleteProductPrivateCA请求参数结构体
418
+ * DescribeProductCA请求参数结构体
271
419
  */
272
- export interface DeleteProductPrivateCARequest {
420
+ export interface DescribeProductCARequest {
273
421
  /**
274
422
  * 产品ID
275
423
  */
@@ -277,59 +425,44 @@ export interface DeleteProductPrivateCARequest {
277
425
  }
278
426
 
279
427
  /**
280
- * CLS日志
428
+ * 设备标签
281
429
  */
282
- export interface CLSLogItem {
430
+ export interface DeviceLabel {
283
431
  /**
284
- * 日志内容
432
+ * 标签标识
285
433
  */
286
- Content: string
434
+ Key: string
287
435
 
288
436
  /**
289
- * 设备名称
437
+ * 标签值
290
438
  */
291
- DeviceName: string
439
+ Value: string
440
+ }
292
441
 
442
+ /**
443
+ * DescribeProductTasks请求参数结构体
444
+ */
445
+ export interface DescribeProductTasksRequest {
293
446
  /**
294
447
  * 产品ID
295
448
  */
296
449
  ProductId: string
297
450
 
298
451
  /**
299
- * 请求ID
452
+ * 产品级别任务列表偏移量
300
453
  */
301
- RequestId: string
302
-
303
- /**
304
- * 结果
305
- */
306
- Result: string
307
-
308
- /**
309
- * 模块
310
- */
311
- Scene: string
312
-
313
- /**
314
- * 日志时间
315
- */
316
- Time: string
454
+ Offset: number
317
455
 
318
456
  /**
319
- * 腾讯云账号
457
+ * 产品级别任务列表拉取个数
320
458
  */
321
- Userid: string
459
+ Limit: number
322
460
  }
323
461
 
324
462
  /**
325
- * DescribePrivateCABindedProducts返回参数结构体
463
+ * UpdateProductPrivateCA返回参数结构体
326
464
  */
327
- export interface DescribePrivateCABindedProductsResponse {
328
- /**
329
- * 私有CA绑定的产品列表
330
- */
331
- Products: Array<BindProductInfo>
332
-
465
+ export interface UpdateProductPrivateCAResponse {
333
466
  /**
334
467
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
335
468
  */
@@ -337,153 +470,119 @@ export interface DescribePrivateCABindedProductsResponse {
337
470
  }
338
471
 
339
472
  /**
340
- * DeleteDevice请求参数结构体
473
+ * UpdateDeviceShadow请求参数结构体
341
474
  */
342
- export interface DeleteDeviceRequest {
475
+ export interface UpdateDeviceShadowRequest {
343
476
  /**
344
- * 设备所属的产品 ID
477
+ * 产品ID
345
478
  */
346
479
  ProductId: string
347
480
 
348
481
  /**
349
- * 需要删除的设备名称
482
+ * 设备名称
350
483
  */
351
484
  DeviceName: string
352
485
 
353
486
  /**
354
- * 删除LoRa设备以及LoRa网关设备需要skey
355
- */
356
- Skey?: string
357
- }
358
-
359
- /**
360
- * DeleteProduct返回参数结构体
361
- */
362
- export interface DeleteProductResponse {
363
- /**
364
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
365
- */
366
- RequestId?: string
367
- }
368
-
369
- /**
370
- * CreatePrivateCA返回参数结构体
371
- */
372
- export interface CreatePrivateCAResponse {
373
- /**
374
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
487
+ * 虚拟设备的状态,JSON字符串格式,由desired结构组成
375
488
  */
376
- RequestId?: string
377
- }
489
+ State: string
378
490
 
379
- /**
380
- * SetProductsForbiddenStatus返回参数结构体
381
- */
382
- export interface SetProductsForbiddenStatusResponse {
383
491
  /**
384
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
492
+ * 当前版本号,需要和后台的version保持一致,才能更新成功
385
493
  */
386
- RequestId?: string
494
+ ShadowVersion: number
387
495
  }
388
496
 
389
497
  /**
390
- * 内容日志项
498
+ * DescribeGatewayBindDevices返回参数结构体
391
499
  */
392
- export interface PayloadLogItem {
393
- /**
394
- * 账号id
395
- */
396
- Uin: string
397
-
500
+ export interface DescribeGatewayBindDevicesResponse {
398
501
  /**
399
- * 产品id
502
+ * 子设备总数
400
503
  */
401
- ProductId: string
504
+ TotalCount: number
402
505
 
403
506
  /**
404
- * 设备名称
507
+ * 子设备信息
405
508
  */
406
- DeviceName: string
509
+ Devices: Array<BindDeviceInfo>
407
510
 
408
511
  /**
409
- * 来源类型
512
+ * 子设备所属的产品名
410
513
  */
411
- SrcType: string
514
+ ProductName: string
412
515
 
413
516
  /**
414
- * 来源名称
517
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
415
518
  */
416
- SrcName: string
519
+ RequestId?: string
520
+ }
417
521
 
522
+ /**
523
+ * 产品资源详细信息
524
+ */
525
+ export interface ProductResourceInfo {
418
526
  /**
419
- * 消息topic
527
+ * 产品ID
420
528
  */
421
- Topic: string
529
+ ProductID: string
422
530
 
423
531
  /**
424
- * 内容格式类型
532
+ * 产品名
425
533
  */
426
- PayloadFormatType: string
534
+ ProductName: string
427
535
 
428
536
  /**
429
- * 内容信息
537
+ * 资源名称
430
538
  */
431
- Payload: string
539
+ Name: string
432
540
 
433
541
  /**
434
- * 请求ID
542
+ * 资源文件md5
435
543
  */
436
- RequestId: string
544
+ Md5: string
437
545
 
438
546
  /**
439
- * 日期时间
547
+ * 资源文件大小
440
548
  */
441
- DateTime: string
442
- }
549
+ Size: number
443
550
 
444
- /**
445
- * UpdateProductPrivateCA请求参数结构体
446
- */
447
- export interface UpdateProductPrivateCARequest {
448
551
  /**
449
- * 产品ID
450
- */
451
- ProductId: string
552
+ * 资源文件描述
553
+ 注意:此字段可能返回 null,表示取不到有效值。
554
+ */
555
+ Description: string
452
556
 
453
557
  /**
454
- * 私有CA证书名称
558
+ * 资源创建时间
455
559
  */
456
- CertName: string
560
+ CreateTime: string
457
561
  }
458
562
 
459
563
  /**
460
- * 子产品信息
564
+ * DescribeFirmware请求参数结构体
461
565
  */
462
- export interface BindProductInfo {
566
+ export interface DescribeFirmwareRequest {
463
567
  /**
464
568
  * 产品ID
465
569
  */
466
570
  ProductId: string
467
571
 
468
572
  /**
469
- * 产品名
573
+ * 固件版本号
470
574
  */
471
- ProductName: string
575
+ FirmwareVersion: string
472
576
  }
473
577
 
474
578
  /**
475
- * DescribeDevices返回参数结构体
579
+ * DescribeDeviceResource返回参数结构体
476
580
  */
477
- export interface DescribeDevicesResponse {
478
- /**
479
- * 设备总数
480
- */
481
- TotalCount: number
482
-
581
+ export interface DescribeDeviceResourceResponse {
483
582
  /**
484
- * 设备详细信息列表
583
+ * 设备资源详情
485
584
  */
486
- Devices: Array<DeviceInfo>
585
+ Result: DeviceResourceInfo
487
586
 
488
587
  /**
489
588
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -492,50 +591,34 @@ export interface DescribeDevicesResponse {
492
591
  }
493
592
 
494
593
  /**
495
- * 设备属性
594
+ * DescribeProductResources请求参数结构体
496
595
  */
497
- export interface DeviceTag {
498
- /**
499
- * 属性名称
500
- */
501
- Tag: string
502
-
596
+ export interface DescribeProductResourcesRequest {
503
597
  /**
504
- * 属性值的类型,1 int,2 string
598
+ * 偏移量,Offset从0开始
505
599
  */
506
- Type: number
600
+ Offset: number
507
601
 
508
602
  /**
509
- * 属性的值
603
+ * 分页的大小,数值范围 10-250
510
604
  */
511
- Value: string
512
-
513
- /**
514
- * 属性描述名称
515
- 注意:此字段可能返回 null,表示取不到有效值。
516
- */
517
- Name?: string
518
- }
605
+ Limit: number
519
606
 
520
- /**
521
- * PublishBroadcastMessage返回参数结构体
522
- */
523
- export interface PublishBroadcastMessageResponse {
524
607
  /**
525
- * 广播消息任务ID
608
+ * 需要查看资源列表的产品 ID
526
609
  */
527
- TaskId: number
610
+ ProductID?: string
528
611
 
529
612
  /**
530
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
613
+ * 需要过滤的资源名称
531
614
  */
532
- RequestId?: string
615
+ Name?: string
533
616
  }
534
617
 
535
618
  /**
536
- * DescribeProductCA请求参数结构体
619
+ * DescribeProduct请求参数结构体
537
620
  */
538
- export interface DescribeProductCARequest {
621
+ export interface DescribeProductRequest {
539
622
  /**
540
623
  * 产品ID
541
624
  */
@@ -543,29 +626,34 @@ export interface DescribeProductCARequest {
543
626
  }
544
627
 
545
628
  /**
546
- * CreatePrivateCA请求参数结构体
629
+ * DescribeProducts返回参数结构体
547
630
  */
548
- export interface CreatePrivateCARequest {
631
+ export interface DescribeProductsResponse {
549
632
  /**
550
- * CA证书名称
633
+ * 产品总数
551
634
  */
552
- CertName: string
635
+ TotalCount: number
553
636
 
554
637
  /**
555
- * CA证书内容
638
+ * 产品详细信息列表
556
639
  */
557
- CertText: string
640
+ Products: Array<ProductInfo>
558
641
 
559
642
  /**
560
- * 校验CA证书的证书内容
643
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
561
644
  */
562
- VerifyCertText: string
645
+ RequestId?: string
563
646
  }
564
647
 
565
648
  /**
566
- * UpdateDevicePSK返回参数结构体
649
+ * DescribeDeviceShadow返回参数结构体
567
650
  */
568
- export interface UpdateDevicePSKResponse {
651
+ export interface DescribeDeviceShadowResponse {
652
+ /**
653
+ * 设备影子数据
654
+ */
655
+ Data: string
656
+
569
657
  /**
570
658
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
571
659
  */
@@ -573,28 +661,36 @@ export interface UpdateDevicePSKResponse {
573
661
  }
574
662
 
575
663
  /**
576
- * DescribeProduct返回参数结构体
664
+ * EnableTopicRule返回参数结构体
577
665
  */
578
- export interface DescribeProductResponse {
666
+ export interface EnableTopicRuleResponse {
579
667
  /**
580
- * 产品ID
668
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
581
669
  */
582
- ProductId: string
670
+ RequestId?: string
671
+ }
583
672
 
673
+ /**
674
+ * DescribePushResourceTaskStatistics返回参数结构体
675
+ */
676
+ export interface DescribePushResourceTaskStatisticsResponse {
584
677
  /**
585
- * 产品名
586
- */
587
- ProductName: string
678
+ * 推送成功的设备总数
679
+ 注意:此字段可能返回 null,表示取不到有效值。
680
+ */
681
+ SuccessTotal: number
588
682
 
589
683
  /**
590
- * 产品元数据
591
- */
592
- ProductMetadata: ProductMetadata
684
+ * 推送失败的设备总数
685
+ 注意:此字段可能返回 null,表示取不到有效值。
686
+ */
687
+ FailureTotal: number
593
688
 
594
689
  /**
595
- * 产品属性
596
- */
597
- ProductProperties: ProductProperties
690
+ * 正在推送的设备总数
691
+ 注意:此字段可能返回 null,表示取不到有效值。
692
+ */
693
+ UpgradingTotal: number
598
694
 
599
695
  /**
600
696
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -603,44 +699,29 @@ export interface DescribeProductResponse {
603
699
  }
604
700
 
605
701
  /**
606
- * DescribeDevice请求参数结构体
702
+ * UpdateDeviceLogLevel请求参数结构体
607
703
  */
608
- export interface DescribeDeviceRequest {
704
+ export interface UpdateDeviceLogLevelRequest {
609
705
  /**
610
706
  * 产品ID
611
707
  */
612
708
  ProductId: string
613
709
 
614
710
  /**
615
- * 设备名
711
+ * 设备名称
616
712
  */
617
713
  DeviceName: string
618
- }
619
-
620
- /**
621
- * UpdateDevicesEnableState请求参数结构体
622
- */
623
- export interface UpdateDevicesEnableStateRequest {
624
- /**
625
- * 设备所属产品id
626
- */
627
- ProductId: string
628
-
629
- /**
630
- * 设备名称集合
631
- */
632
- DeviceNames: Array<string>
633
714
 
634
715
  /**
635
- * 要设置的设备状态,1为启用,0为禁用
716
+ * 日志级别,0:关闭,1:错误,2:告警,3:信息,4:调试
636
717
  */
637
- Status: number
718
+ LogLevel: number
638
719
  }
639
720
 
640
721
  /**
641
- * UpdateDeviceLogLevel请求参数结构体
722
+ * PublishRRPCMessage请求参数结构体
642
723
  */
643
- export interface UpdateDeviceLogLevelRequest {
724
+ export interface PublishRRPCMessageRequest {
644
725
  /**
645
726
  * 产品ID
646
727
  */
@@ -652,205 +733,201 @@ export interface UpdateDeviceLogLevelRequest {
652
733
  DeviceName: string
653
734
 
654
735
  /**
655
- * 日志级别,0:关闭,1:错误,2:告警,3:信息,4:调试
736
+ * 消息内容,utf8编码
656
737
  */
657
- LogLevel: number
738
+ Payload: string
658
739
  }
659
740
 
660
741
  /**
661
- * 设备标签
742
+ * 产品属性
662
743
  */
663
- export interface DeviceLabel {
744
+ export interface ProductProperties {
664
745
  /**
665
- * 标签标识
746
+ * 产品描述
666
747
  */
667
- Key: string
748
+ ProductDescription?: string
668
749
 
669
750
  /**
670
- * 标签值
751
+ * 加密类型,1表示证书认证,2表示签名认证。如不填写,默认值是1
671
752
  */
672
- Value: string
673
- }
753
+ EncryptionType?: string
674
754
 
675
- /**
676
- * UpdateProductDynamicRegister请求参数结构体
677
- */
678
- export interface UpdateProductDynamicRegisterRequest {
679
755
  /**
680
- * 产品Id
756
+ * 产品所属区域,目前只支持广州(gz)
681
757
  */
682
- ProductId: string
758
+ Region?: string
683
759
 
684
760
  /**
685
- * 动态注册类型,0-关闭 1-预创建设备 2-自动创建设备
686
- */
687
- RegisterType: number
761
+ * 产品类型,各个类型值代表的节点-类型如下:
762
+ 0 普通产品,2 NB-IoT产品,4 LoRa产品,3 LoRa网关产品,5 普通网关产品 默认值是0
763
+ */
764
+ ProductType?: number
688
765
 
689
766
  /**
690
- * 动态注册设备上限
767
+ * 数据格式,取值为json或者custom,默认值是json
691
768
  */
692
- RegisterLimit: number
693
- }
769
+ Format?: string
694
770
 
695
- /**
696
- * X509证书信息
697
- */
698
- export interface CertInfo {
699
771
  /**
700
- * 证书名称
772
+ * 产品所属平台,默认值是0
701
773
  */
702
- CertName: string
774
+ Platform?: string
703
775
 
704
776
  /**
705
- * 证书的序列号,16进制编码
777
+ * LoRa产品运营侧APPEUI,只有LoRa产品需要填写
706
778
  */
707
- CertSN: string
779
+ Appeui?: string
708
780
 
709
781
  /**
710
- * 证书颁发着名称
782
+ * 产品绑定的物模型ID,-1表示不绑定
711
783
  */
712
- IssuerName: string
784
+ ModelId?: string
713
785
 
714
786
  /**
715
- * 证书主题
787
+ * 产品绑定的物模型名称
716
788
  */
717
- Subject: string
789
+ ModelName?: string
718
790
 
719
791
  /**
720
- * 证书创建时间,秒级时间戳
792
+ * 产品密钥,suite产品才会有
721
793
  */
722
- CreateTime: number
794
+ ProductKey?: string
723
795
 
724
796
  /**
725
- * 证书生效时间,秒级时间戳
797
+ * 动态注册类型 0-关闭, 1-预定义设备名 2-动态定义设备名
726
798
  */
727
- EffectiveTime: number
799
+ RegisterType?: number
728
800
 
729
801
  /**
730
- * 证书失效时间,秒级时间戳
802
+ * 动态注册产品秘钥
731
803
  */
732
- ExpireTime: number
804
+ ProductSecret?: string
733
805
 
734
806
  /**
735
- * X509证书内容
807
+ * RegisterType为2时,设备动态创建的限制数量
736
808
  */
737
- CertText: string
738
- }
809
+ RegisterLimit?: number
739
810
 
740
- /**
741
- * 产品元数据
742
- */
743
- export interface ProductMetadata {
744
811
  /**
745
- * 产品创建时间
812
+ * 划归的产品,展示为源产品ID,其余为空
746
813
  */
747
- CreationDate: number
748
- }
814
+ OriginProductId?: string
749
815
 
750
- /**
751
- * DescribePrivateCAs请求参数结构体
752
- */
753
- export type DescribePrivateCAsRequest = null
816
+ /**
817
+ * 私有CA名称
818
+ */
819
+ PrivateCAName?: string
754
820
 
755
- /**
756
- * UpdateDevicePSK请求参数结构体
757
- */
758
- export interface UpdateDevicePSKRequest {
759
821
  /**
760
- * 产品名
822
+ * 划归的产品,展示为源用户ID,其余为空
761
823
  */
762
- ProductId: string
824
+ OriginUserId?: number
825
+ }
763
826
 
827
+ /**
828
+ * 设备固件更新状态
829
+ */
830
+ export interface DeviceUpdateStatus {
764
831
  /**
765
832
  * 设备名
766
833
  */
767
834
  DeviceName: string
768
835
 
769
836
  /**
770
- * 设备的psk
837
+ * 最后处理时间
771
838
  */
772
- Psk: string
773
- }
839
+ LastProcessTime: number
774
840
 
775
- /**
776
- * DescribeDevices请求参数结构体
777
- */
778
- export interface DescribeDevicesRequest {
779
841
  /**
780
- * 需要查看设备列表的产品 ID
842
+ * 状态
781
843
  */
782
- ProductId: string
844
+ Status: number
783
845
 
784
846
  /**
785
- * 偏移量,Offset从0开始
847
+ * 错误消息
786
848
  */
787
- Offset: number
849
+ ErrMsg: string
788
850
 
789
851
  /**
790
- * 分页的大小,数值范围 10-250
852
+ * 返回码
791
853
  */
792
- Limit: number
854
+ Retcode: number
793
855
 
794
856
  /**
795
- * 设备固件版本号,若不带此参数会返回所有固件版本的设备。传"None-FirmwareVersion"查询无版本号的设备
857
+ * 目标更新版本
796
858
  */
797
- FirmwareVersion?: string
859
+ DstVersion: string
798
860
 
799
861
  /**
800
- * 需要过滤的设备名称
801
- */
802
- DeviceName?: string
862
+ * 下载中状态时的下载进度
863
+ 注意:此字段可能返回 null,表示取不到有效值。
864
+ */
865
+ Percent: number
803
866
 
804
867
  /**
805
- * 设备是否启用,0禁用状态1启用状态,默认不区分
806
- */
807
- EnableState?: number
868
+ * 原版本号
869
+ 注意:此字段可能返回 null,表示取不到有效值。
870
+ */
871
+ OriVersion: string
872
+
873
+ /**
874
+ * 任务ID
875
+ 注意:此字段可能返回 null,表示取不到有效值。
876
+ */
877
+ TaskId: number
808
878
  }
809
879
 
810
880
  /**
811
- * ListLogPayload返回参数结构体
881
+ * BatchUpdateFirmware返回参数结构体
812
882
  */
813
- export interface ListLogPayloadResponse {
883
+ export interface BatchUpdateFirmwareResponse {
814
884
  /**
815
- * 日志上下文
885
+ * 任务ID
816
886
  */
817
- Context: string
887
+ TaskId: number
818
888
 
819
889
  /**
820
- * 是否还有日志,如有仍有日志,下次查询的请求带上当前请求返回的Context
890
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
821
891
  */
822
- Listover: boolean
892
+ RequestId?: string
893
+ }
823
894
 
895
+ /**
896
+ * DeleteProduct请求参数结构体
897
+ */
898
+ export interface DeleteProductRequest {
824
899
  /**
825
- * 日志列表
900
+ * 需要删除的产品 ID
826
901
  */
827
- Results: Array<PayloadLogItem>
902
+ ProductId: string
828
903
 
829
904
  /**
830
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
905
+ * 删除LoRa产品需要skey
831
906
  */
832
- RequestId?: string
907
+ Skey?: string
833
908
  }
834
909
 
835
910
  /**
836
- * DescribePrivateCA返回参数结构体
911
+ * 状态统计信息
837
912
  */
838
- export interface DescribePrivateCAResponse {
913
+ export interface StatusStatistic {
839
914
  /**
840
- * 私有化CA详情
841
- */
842
- CA: CertInfo
915
+ * 任务状态
916
+ 注意:此字段可能返回 null,表示取不到有效值。
917
+ */
918
+ Status: number
843
919
 
844
920
  /**
845
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
846
- */
847
- RequestId?: string
921
+ * 统计总数
922
+ 注意:此字段可能返回 null,表示取不到有效值。
923
+ */
924
+ Total: number
848
925
  }
849
926
 
850
927
  /**
851
- * UpdateDeviceLogLevel返回参数结构体
928
+ * DeleteProductPrivateCA返回参数结构体
852
929
  */
853
- export interface UpdateDeviceLogLevelResponse {
930
+ export interface DeleteProductPrivateCAResponse {
854
931
  /**
855
932
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
856
933
  */
@@ -858,438 +935,437 @@ export interface UpdateDeviceLogLevelResponse {
858
935
  }
859
936
 
860
937
  /**
861
- * ListSDKLog返回参数结构体
938
+ * DownloadDeviceResource请求参数结构体
862
939
  */
863
- export interface ListSDKLogResponse {
864
- /**
865
- * 日志检索上下文
866
- */
867
- Context: string
868
-
940
+ export interface DownloadDeviceResourceRequest {
869
941
  /**
870
- * 是否还有日志,如有仍有日志,下次查询的请求带上当前请求返回的Context
942
+ * 产品ID
871
943
  */
872
- Listover: boolean
944
+ ProductID: string
873
945
 
874
946
  /**
875
- * 日志列表
947
+ * 资源名称
876
948
  */
877
- Results: Array<SDKLogItem>
949
+ Name: string
878
950
 
879
951
  /**
880
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
952
+ * 设备名称
881
953
  */
882
- RequestId?: string
954
+ DeviceName: string
883
955
  }
884
956
 
885
957
  /**
886
- * ListLogPayload请求参数结构体
958
+ * DescribeDeviceResource请求参数结构体
887
959
  */
888
- export interface ListLogPayloadRequest {
889
- /**
890
- * 日志开始时间
891
- */
892
- MinTime: number
893
-
960
+ export interface DescribeDeviceResourceRequest {
894
961
  /**
895
- * 日志结束时间
962
+ * 设备名称
896
963
  */
897
- MaxTime: number
898
-
899
- /**
900
- * 查询关键字,可以同时支持键值查询和文本查询,例如,查询某key的值为value,并且包含某word的日志,该参数为:key:value word。键值或文本可以包含多个,以空格隔开。其中可以索引的key比如:RequestID、ProductID、DeviceName等。
901
- 一个典型的查询示例:ProductID:ABCDE12345 DeviceName:test publish
902
- */
903
- Keywords: string
964
+ DeviceName: string
904
965
 
905
966
  /**
906
- * 日志检索上下文
967
+ * 产品ID
907
968
  */
908
- Context?: string
969
+ ProductID?: string
909
970
 
910
971
  /**
911
- * 日志最大条数
972
+ * 具体的设备资源名称
912
973
  */
913
- MaxNum?: number
974
+ Name?: string
914
975
  }
915
976
 
916
977
  /**
917
- * CreateDevice返回参数结构体
978
+ * EditFirmware请求参数结构体
918
979
  */
919
- export interface CreateDeviceResponse {
920
- /**
921
- * 设备名称
922
- */
923
- DeviceName: string
924
-
980
+ export interface EditFirmwareRequest {
925
981
  /**
926
- * 对称加密密钥,base64编码。采用对称加密时返回该参数
982
+ * 产品ID。
927
983
  */
928
- DevicePsk: string
984
+ ProductId: string
929
985
 
930
986
  /**
931
- * 设备证书,用于 TLS 建立链接时校验客户端身份。采用非对称加密时返回该参数
987
+ * 固件版本号。
932
988
  */
933
- DeviceCert: string
989
+ FirmwareVersion: string
934
990
 
935
991
  /**
936
- * 设备私钥,用于 TLS 建立链接时校验客户端身份,腾讯云后台不保存,请妥善保管。采用非对称加密时返回该参数
992
+ * 固件名称。
937
993
  */
938
- DevicePrivateKey: string
994
+ FirmwareName: string
939
995
 
940
996
  /**
941
- * LoRa设备的DevEui,当设备是LoRa设备时,会返回该字段
997
+ * 固件描述
942
998
  */
943
- LoraDevEui: string
999
+ FirmwareDescription?: string
1000
+ }
944
1001
 
1002
+ /**
1003
+ * 子设备信息
1004
+ */
1005
+ export interface BindDeviceInfo {
945
1006
  /**
946
- * LoRa设备的MoteType,当设备是LoRa设备时,会返回该字段
1007
+ * 产品ID
947
1008
  */
948
- LoraMoteType: number
1009
+ ProductId: string
949
1010
 
950
1011
  /**
951
- * LoRa设备的AppKey,当设备是LoRa设备时,会返回该字段
1012
+ * 设备名
952
1013
  */
953
- LoraAppKey: string
1014
+ DeviceName: string
954
1015
 
955
1016
  /**
956
- * LoRa设备的NwkKey,当设备是LoRa设备时,会返回该字段
1017
+ * 设备Tag
957
1018
  */
958
- LoraNwkKey: string
1019
+ Tags: Array<DeviceTag>
959
1020
 
960
1021
  /**
961
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
962
- */
963
- RequestId?: string
1022
+ * 子设备绑定时间
1023
+ 注意:此字段可能返回 null,表示取不到有效值。
1024
+ */
1025
+ BindTime: number
964
1026
  }
965
1027
 
966
1028
  /**
967
- * ListSDKLog请求参数结构体
1029
+ * ResetDeviceState请求参数结构体
968
1030
  */
969
- export interface ListSDKLogRequest {
1031
+ export interface ResetDeviceStateRequest {
970
1032
  /**
971
- * 日志开始时间
1033
+ * 产品ID
972
1034
  */
973
- MinTime: number
1035
+ ProductId: string
974
1036
 
975
1037
  /**
976
- * 日志结束时间
1038
+ * 设备名称
977
1039
  */
978
- MaxTime: number
979
-
980
- /**
981
- * 查询关键字,可以同时支持键值查询和文本查询,
982
- 例如,查询某key的值为value,并且包含某word的日志,该参数为:key:value word。
983
- 键值或文本可以包含多个,以空格隔开。
984
- 其中可以索引的key包括:productid、devicename、loglevel
985
- 一个典型的查询示例:productid:7JK1G72JNE devicename:name publish loglevel:WARN一个典型的查询示例:productid:ABCDE12345 devicename:test scene:SHADOW publish
986
- */
987
- Keywords: string
1040
+ DeviceNames: Array<string>
1041
+ }
988
1042
 
1043
+ /**
1044
+ * DescribeDeviceClientKey请求参数结构体
1045
+ */
1046
+ export interface DescribeDeviceClientKeyRequest {
989
1047
  /**
990
- * 日志检索上下文
1048
+ * 所属产品的Id
991
1049
  */
992
- Context?: string
1050
+ ProductId: string
993
1051
 
994
1052
  /**
995
- * 查询条数
1053
+ * 设备名称
996
1054
  */
997
- MaxNum?: number
1055
+ DeviceName: string
998
1056
  }
999
1057
 
1000
1058
  /**
1001
- * CreateDevice请求参数结构体
1059
+ * CLS日志
1002
1060
  */
1003
- export interface CreateDeviceRequest {
1061
+ export interface CLSLogItem {
1004
1062
  /**
1005
- * 产品 ID 。创建产品时腾讯云为用户分配全局唯一的 ID
1063
+ * 日志内容
1006
1064
  */
1007
- ProductId: string
1065
+ Content: string
1008
1066
 
1009
1067
  /**
1010
- * 设备名称。命名规则:[a-zA-Z0-9:_-]{1,48}。
1068
+ * 设备名称
1011
1069
  */
1012
1070
  DeviceName: string
1013
1071
 
1014
1072
  /**
1015
- * 设备属性
1073
+ * 产品ID
1016
1074
  */
1017
- Attribute?: Attribute
1075
+ ProductId: string
1018
1076
 
1019
1077
  /**
1020
- * 是否使用自定义PSK,默认不使用
1078
+ * 请求ID
1021
1079
  */
1022
- DefinedPsk?: string
1080
+ RequestId: string
1023
1081
 
1024
1082
  /**
1025
- * 运营商类型,当产品是NB-IoT产品时,此字段必填。1表示中国电信,2表示中国移动,3表示中国联通
1083
+ * 结果
1026
1084
  */
1027
- Isp?: number
1085
+ Result: string
1028
1086
 
1029
1087
  /**
1030
- * IMEI,当产品是NB-IoT产品时,此字段必填
1088
+ * 模块
1031
1089
  */
1032
- Imei?: string
1090
+ Scene: string
1033
1091
 
1034
1092
  /**
1035
- * LoRa设备的DevEui,当创建LoRa时,此字段必填
1093
+ * 日志时间
1036
1094
  */
1037
- LoraDevEui?: string
1095
+ Time: string
1038
1096
 
1039
1097
  /**
1040
- * LoRa设备的MoteType
1098
+ * 腾讯云账号
1041
1099
  */
1042
- LoraMoteType?: number
1100
+ Userid: string
1101
+ }
1043
1102
 
1103
+ /**
1104
+ * DeleteDevice请求参数结构体
1105
+ */
1106
+ export interface DeleteDeviceRequest {
1044
1107
  /**
1045
- * 创建LoRa设备需要skey
1108
+ * 设备所属的产品 ID
1046
1109
  */
1047
- Skey?: string
1110
+ ProductId: string
1048
1111
 
1049
1112
  /**
1050
- * LoRa设备的AppKey
1113
+ * 需要删除的设备名称
1051
1114
  */
1052
- LoraAppKey?: string
1115
+ DeviceName: string
1053
1116
 
1054
1117
  /**
1055
- * 私有CA创建的设备证书
1118
+ * 删除LoRa设备以及LoRa网关设备需要skey
1056
1119
  */
1057
- TlsCrt?: string
1120
+ Skey?: string
1058
1121
  }
1059
1122
 
1060
1123
  /**
1061
- * DescribeProduct请求参数结构体
1124
+ * DescribeFirmwareTaskDistribution请求参数结构体
1062
1125
  */
1063
- export interface DescribeProductRequest {
1126
+ export interface DescribeFirmwareTaskDistributionRequest {
1064
1127
  /**
1065
1128
  * 产品ID
1066
1129
  */
1067
1130
  ProductId: string
1068
- }
1069
1131
 
1070
- /**
1071
- * UpdateProductPrivateCA返回参数结构体
1072
- */
1073
- export interface UpdateProductPrivateCAResponse {
1074
1132
  /**
1075
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1133
+ * 固件版本号
1076
1134
  */
1077
- RequestId?: string
1078
- }
1135
+ FirmwareVersion: string
1079
1136
 
1080
- /**
1081
- * 设备属性
1082
- */
1083
- export interface Attribute {
1084
1137
  /**
1085
- * 属性列表
1138
+ * 固件升级任务ID
1086
1139
  */
1087
- Tags?: Array<DeviceTag>
1140
+ TaskId: number
1088
1141
  }
1089
1142
 
1090
1143
  /**
1091
- * DeleteDevice返回参数结构体
1144
+ * DescribeFirmwareTaskDevices请求参数结构体
1092
1145
  */
1093
- export interface DeleteDeviceResponse {
1146
+ export interface DescribeFirmwareTaskDevicesRequest {
1094
1147
  /**
1095
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1148
+ * 产品ID
1096
1149
  */
1097
- RequestId?: string
1098
- }
1150
+ ProductId: string
1099
1151
 
1100
- /**
1101
- * DeletePrivateCA请求参数结构体
1102
- */
1103
- export interface DeletePrivateCARequest {
1104
1152
  /**
1105
- * 私有CA证书名称
1153
+ * 固件版本
1106
1154
  */
1107
- CertName: string
1108
- }
1155
+ FirmwareVersion?: string
1109
1156
 
1110
- /**
1111
- * 设备详细信息
1112
- */
1113
- export interface DeviceInfo {
1114
1157
  /**
1115
- * 设备名
1158
+ * 筛选条件
1116
1159
  */
1117
- DeviceName: string
1160
+ Filters?: Array<SearchKeyword>
1118
1161
 
1119
1162
  /**
1120
- * 设备是否在线,0不在线,1在线
1163
+ * 查询偏移量
1121
1164
  */
1122
- Online: number
1165
+ Offset?: number
1123
1166
 
1124
1167
  /**
1125
- * 设备登录时间
1168
+ * 查询的数量
1126
1169
  */
1127
- LoginTime: number
1170
+ Limit?: number
1171
+ }
1128
1172
 
1173
+ /**
1174
+ * DescribeFirmware返回参数结构体
1175
+ */
1176
+ export interface DescribeFirmwareResponse {
1129
1177
  /**
1130
- * 设备版本
1178
+ * 固件版本号
1131
1179
  */
1132
1180
  Version: string
1133
1181
 
1134
1182
  /**
1135
- * 设备证书,证书加密的设备返回
1183
+ * 产品ID
1136
1184
  */
1137
- DeviceCert: string
1185
+ ProductId: string
1138
1186
 
1139
1187
  /**
1140
- * 设备密钥,密钥加密的设备返回
1188
+ * 固件名称
1189
+ 注意:此字段可能返回 null,表示取不到有效值。
1190
+ */
1191
+ Name: string
1192
+
1193
+ /**
1194
+ * 固件描述
1195
+ 注意:此字段可能返回 null,表示取不到有效值。
1196
+ */
1197
+ Description: string
1198
+
1199
+ /**
1200
+ * 固件Md5值
1201
+ 注意:此字段可能返回 null,表示取不到有效值。
1202
+ */
1203
+ Md5sum: string
1204
+
1205
+ /**
1206
+ * 固件上传的秒级时间戳
1207
+ 注意:此字段可能返回 null,表示取不到有效值。
1208
+ */
1209
+ Createtime: number
1210
+
1211
+ /**
1212
+ * 产品名称
1141
1213
  */
1142
- DevicePsk: string
1214
+ ProductName: string
1143
1215
 
1144
1216
  /**
1145
- * 设备属性
1217
+ * 固件类型。选项:mcu、module
1146
1218
  */
1147
- Tags: Array<DeviceTag>
1219
+ FwType: string
1148
1220
 
1149
1221
  /**
1150
- * 设备类型
1222
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1151
1223
  */
1152
- DeviceType: number
1224
+ RequestId?: string
1225
+ }
1153
1226
 
1227
+ /**
1228
+ * DescribeResourceTasks请求参数结构体
1229
+ */
1230
+ export interface DescribeResourceTasksRequest {
1154
1231
  /**
1155
- * 国际移动设备识别码 IMEI
1232
+ * 产品ID
1156
1233
  */
1157
- Imei: string
1234
+ ProductID: string
1158
1235
 
1159
1236
  /**
1160
- * 运营商类型
1237
+ * 资源名称
1161
1238
  */
1162
- Isp: number
1239
+ Name: string
1163
1240
 
1164
1241
  /**
1165
- * NB IOT运营商处的DeviceID
1242
+ * 查询偏移量
1166
1243
  */
1167
- NbiotDeviceID: string
1244
+ Offset: number
1168
1245
 
1169
1246
  /**
1170
- * IP地址
1247
+ * 返回查询结果条数
1171
1248
  */
1172
- ConnIP: number
1249
+ Limit: number
1173
1250
 
1174
1251
  /**
1175
- * 设备最后更新时间
1252
+ * 搜索过滤条件
1176
1253
  */
1177
- LastUpdateTime: number
1254
+ Filters?: Array<SearchKeyword>
1255
+ }
1178
1256
 
1257
+ /**
1258
+ * CreateMultiDevicesTask请求参数结构体
1259
+ */
1260
+ export interface CreateMultiDevicesTaskRequest {
1179
1261
  /**
1180
- * LoRa设备的dev eui
1262
+ * 产品ID
1181
1263
  */
1182
- LoraDevEui: string
1264
+ ProductId: string
1183
1265
 
1184
1266
  /**
1185
- * LoRa设备的Mote type
1267
+ * 参数类型 cosfile-文件上传 random-随机创建
1186
1268
  */
1187
- LoraMoteType: number
1269
+ ParametersType: string
1188
1270
 
1189
1271
  /**
1190
- * 首次上线时间
1191
- 注意:此字段可能返回 null,表示取不到有效值。
1192
- */
1193
- FirstOnlineTime: number
1272
+ * 文件上传类型时文件名
1273
+ */
1274
+ FileName?: string
1194
1275
 
1195
1276
  /**
1196
- * 最近下线时间
1197
- 注意:此字段可能返回 null,表示取不到有效值。
1198
- */
1199
- LastOfflineTime: number
1277
+ * 文件上传类型时文件大小
1278
+ */
1279
+ FileSize?: number
1200
1280
 
1201
1281
  /**
1202
- * 设备创建时间
1203
- 注意:此字段可能返回 null,表示取不到有效值。
1204
- */
1205
- CreateTime: number
1282
+ * 随机创建时设备创建个数
1283
+ */
1284
+ BatchCount?: number
1206
1285
 
1207
1286
  /**
1208
- * 设备日志级别
1209
- 注意:此字段可能返回 null,表示取不到有效值。
1210
- */
1211
- LogLevel: number
1287
+ * 文件上传类型时文件md5值
1288
+ */
1289
+ Hash?: string
1290
+ }
1212
1291
 
1292
+ /**
1293
+ * DeleteDeviceResource返回参数结构体
1294
+ */
1295
+ export interface DeleteDeviceResourceResponse {
1213
1296
  /**
1214
- * 设备证书获取状态, 1 已获取过设备密钥,0 未获取过设备密钥
1215
- 注意:此字段可能返回 null,表示取不到有效值。
1216
- */
1217
- CertState: number
1297
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1298
+ */
1299
+ RequestId?: string
1300
+ }
1218
1301
 
1302
+ /**
1303
+ * DescribeFirmwareTaskStatistics返回参数结构体
1304
+ */
1305
+ export interface DescribeFirmwareTaskStatisticsResponse {
1219
1306
  /**
1220
- * 设备可用状态,0禁用,1启用
1307
+ * 升级成功的设备总数
1221
1308
  注意:此字段可能返回 null,表示取不到有效值。
1222
1309
  */
1223
- EnableState: number
1310
+ SuccessTotal: number
1224
1311
 
1225
1312
  /**
1226
- * 设备标签
1313
+ * 升级失败的设备总数
1227
1314
  注意:此字段可能返回 null,表示取不到有效值。
1228
1315
  */
1229
- Labels: Array<DeviceLabel>
1316
+ FailureTotal: number
1230
1317
 
1231
1318
  /**
1232
- * MQTT客户端IP地址
1319
+ * 正在升级的设备总数
1233
1320
  注意:此字段可能返回 null,表示取不到有效值。
1234
1321
  */
1235
- ClientIP: string
1322
+ UpgradingTotal: number
1236
1323
 
1237
1324
  /**
1238
- * ota最后更新时间
1239
- 注意:此字段可能返回 null,表示取不到有效值。
1240
- */
1241
- FirmwareUpdateTime: number
1325
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1326
+ */
1327
+ RequestId?: string
1242
1328
  }
1243
1329
 
1244
1330
  /**
1245
- * SetProductsForbiddenStatus请求参数结构体
1331
+ * DescribePushResourceTaskStatistics请求参数结构体
1246
1332
  */
1247
- export interface SetProductsForbiddenStatusRequest {
1333
+ export interface DescribePushResourceTaskStatisticsRequest {
1248
1334
  /**
1249
- * 要设置禁用状态的产品列表
1335
+ * 产品ID
1250
1336
  */
1251
- ProductId: Array<string>
1337
+ ProductID: string
1252
1338
 
1253
1339
  /**
1254
- * 0启用,1禁用
1340
+ * 资源名称
1255
1341
  */
1256
- Status: number
1342
+ Name: string
1257
1343
  }
1258
1344
 
1259
1345
  /**
1260
- * SDK日志项
1346
+ * UpdateDevicesEnableState请求参数结构体
1261
1347
  */
1262
- export interface SDKLogItem {
1348
+ export interface UpdateDevicesEnableStateRequest {
1263
1349
  /**
1264
- * 产品ID
1350
+ * 设备所属产品id
1265
1351
  */
1266
1352
  ProductId: string
1267
1353
 
1268
1354
  /**
1269
- * 设备名称
1270
- */
1271
- DeviceName: string
1272
-
1273
- /**
1274
- * 日志等级
1275
- */
1276
- Level: string
1277
-
1278
- /**
1279
- * 日志时间
1355
+ * 设备名称集合
1280
1356
  */
1281
- DateTime: string
1357
+ DeviceNames: Array<string>
1282
1358
 
1283
1359
  /**
1284
- * 日志内容
1360
+ * 要设置的设备状态,1为启用,0为禁用
1285
1361
  */
1286
- Content: string
1362
+ Status: number
1287
1363
  }
1288
1364
 
1289
1365
  /**
1290
- * ListLog请求参数结构体
1366
+ * ListSDKLog请求参数结构体
1291
1367
  */
1292
- export interface ListLogRequest {
1368
+ export interface ListSDKLogRequest {
1293
1369
  /**
1294
1370
  * 日志开始时间
1295
1371
  */
@@ -1301,10 +1377,13 @@ export interface ListLogRequest {
1301
1377
  MaxTime: number
1302
1378
 
1303
1379
  /**
1304
- * 查询关键字,可以同时支持键值查询和文本查询,例如,查询某key的值为value,并且包含某word的日志,该参数为:key:value word。键值或文本可以包含多个,以空格隔开。其中可以索引的key包括:requestid、productid、devicename、scene、content。
1305
- 一个典型的查询示例:productid:ABCDE12345 devicename:test scene:SHADOW content:Device%20connect publish
1380
+ * 查询关键字,可以同时支持键值查询和文本查询,
1381
+ 例如,查询某key的值为value,并且包含某word的日志,该参数为:key:value word。
1382
+ 键值或文本可以包含多个,以空格隔开。
1383
+ 其中可以索引的key包括:productid、devicename、loglevel
1384
+ 一个典型的查询示例:productid:7JK1G72JNE devicename:name publish loglevel:WARN一个典型的查询示例:productid:ABCDE12345 devicename:test scene:SHADOW publish
1306
1385
  */
1307
- Keywords?: string
1386
+ Keywords: string
1308
1387
 
1309
1388
  /**
1310
1389
  * 日志检索上下文
@@ -1318,143 +1397,277 @@ export interface ListLogRequest {
1318
1397
  }
1319
1398
 
1320
1399
  /**
1321
- * DescribeDevice返回参数结构体
1400
+ * SetProductsForbiddenStatus返回参数结构体
1322
1401
  */
1323
- export interface DescribeDeviceResponse {
1402
+ export interface SetProductsForbiddenStatusResponse {
1324
1403
  /**
1325
- * 设备名
1404
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1326
1405
  */
1327
- DeviceName: string
1406
+ RequestId?: string
1407
+ }
1328
1408
 
1409
+ /**
1410
+ * CreateProduct返回参数结构体
1411
+ */
1412
+ export interface CreateProductResponse {
1329
1413
  /**
1330
- * 设备是否在线,0不在线,1在线
1414
+ * 产品名称
1331
1415
  */
1332
- Online: number
1416
+ ProductName: string
1333
1417
 
1334
1418
  /**
1335
- * 设备登录时间
1419
+ * 产品 ID,腾讯云生成全局唯一 ID
1336
1420
  */
1337
- LoginTime: number
1421
+ ProductId: string
1338
1422
 
1339
1423
  /**
1340
- * 设备固件版本
1424
+ * 产品属性
1341
1425
  */
1342
- Version: string
1426
+ ProductProperties: ProductProperties
1343
1427
 
1344
1428
  /**
1345
- * 设备最后更新时间
1429
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1346
1430
  */
1347
- LastUpdateTime: number
1431
+ RequestId?: string
1432
+ }
1348
1433
 
1434
+ /**
1435
+ * 代理订阅信息
1436
+ */
1437
+ export interface BrokerSubscribe {
1349
1438
  /**
1350
- * 设备证书
1439
+ * 产品ID
1351
1440
  */
1352
- DeviceCert: string
1441
+ ProductId: string
1353
1442
 
1354
1443
  /**
1355
- * 设备密钥
1444
+ * 设备名
1356
1445
  */
1357
- DevicePsk: string
1446
+ DeviceName: string
1447
+ }
1358
1448
 
1449
+ /**
1450
+ * DescribeProductResource返回参数结构体
1451
+ */
1452
+ export interface DescribeProductResourceResponse {
1359
1453
  /**
1360
- * 设备属性
1454
+ * 资源详情
1455
+ 注意:此字段可能返回 null,表示取不到有效值。
1456
+ */
1457
+ Result: ProductResourceInfo
1458
+
1459
+ /**
1460
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1361
1461
  */
1362
- Tags: Array<DeviceTag>
1462
+ RequestId?: string
1463
+ }
1363
1464
 
1465
+ /**
1466
+ * CancelDeviceFirmwareTask返回参数结构体
1467
+ */
1468
+ export interface CancelDeviceFirmwareTaskResponse {
1364
1469
  /**
1365
- * 设备类型
1470
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1366
1471
  */
1367
- DeviceType: number
1472
+ RequestId?: string
1473
+ }
1368
1474
 
1475
+ /**
1476
+ * CreateTopicPolicy返回参数结构体
1477
+ */
1478
+ export interface CreateTopicPolicyResponse {
1369
1479
  /**
1370
- * 国际移动设备识别码 IMEI
1480
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1371
1481
  */
1372
- Imei: string
1482
+ RequestId?: string
1483
+ }
1373
1484
 
1485
+ /**
1486
+ * RetryDeviceFirmwareTask返回参数结构体
1487
+ */
1488
+ export interface RetryDeviceFirmwareTaskResponse {
1374
1489
  /**
1375
- * 运营商类型
1490
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1376
1491
  */
1377
- Isp: number
1492
+ RequestId?: string
1493
+ }
1378
1494
 
1495
+ /**
1496
+ * CreateDevice返回参数结构体
1497
+ */
1498
+ export interface CreateDeviceResponse {
1379
1499
  /**
1380
- * IP地址
1500
+ * 设备名称
1381
1501
  */
1382
- ConnIP: number
1502
+ DeviceName: string
1383
1503
 
1384
1504
  /**
1385
- * NB IoT运营商处的DeviceID
1505
+ * 对称加密密钥,base64编码。采用对称加密时返回该参数
1386
1506
  */
1387
- NbiotDeviceID: string
1507
+ DevicePsk: string
1388
1508
 
1389
1509
  /**
1390
- * Lora设备的dev eui
1510
+ * 设备证书,用于 TLS 建立链接时校验客户端身份。采用非对称加密时返回该参数
1511
+ */
1512
+ DeviceCert: string
1513
+
1514
+ /**
1515
+ * 设备私钥,用于 TLS 建立链接时校验客户端身份,腾讯云后台不保存,请妥善保管。采用非对称加密时返回该参数
1516
+ */
1517
+ DevicePrivateKey: string
1518
+
1519
+ /**
1520
+ * LoRa设备的DevEui,当设备是LoRa设备时,会返回该字段
1391
1521
  */
1392
1522
  LoraDevEui: string
1393
1523
 
1394
1524
  /**
1395
- * Lora设备的mote type
1525
+ * LoRa设备的MoteType,当设备是LoRa设备时,会返回该字段
1396
1526
  */
1397
1527
  LoraMoteType: number
1398
1528
 
1399
1529
  /**
1400
- * 设备的sdk日志等级
1401
- 注意:此字段可能返回 null,表示取不到有效值。
1402
- */
1403
- LogLevel: number
1530
+ * LoRa设备的AppKey,当设备是LoRa设备时,会返回该字段
1531
+ */
1532
+ LoraAppKey: string
1404
1533
 
1405
1534
  /**
1406
- * 首次上线时间
1407
- 注意:此字段可能返回 null,表示取不到有效值。
1408
- */
1409
- FirstOnlineTime: number
1535
+ * LoRa设备的NwkKey,当设备是LoRa设备时,会返回该字段
1536
+ */
1537
+ LoraNwkKey: string
1410
1538
 
1411
1539
  /**
1412
- * 最近下线时间
1540
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1541
+ */
1542
+ RequestId?: string
1543
+ }
1544
+
1545
+ /**
1546
+ * CreateDevice请求参数结构体
1547
+ */
1548
+ export interface CreateDeviceRequest {
1549
+ /**
1550
+ * 产品 ID 。创建产品时腾讯云为用户分配全局唯一的 ID
1551
+ */
1552
+ ProductId: string
1553
+
1554
+ /**
1555
+ * 设备名称。命名规则:[a-zA-Z0-9:_-]{1,48}。
1556
+ */
1557
+ DeviceName: string
1558
+
1559
+ /**
1560
+ * 设备属性
1561
+ */
1562
+ Attribute?: Attribute
1563
+
1564
+ /**
1565
+ * 是否使用自定义PSK,默认不使用
1566
+ */
1567
+ DefinedPsk?: string
1568
+
1569
+ /**
1570
+ * 运营商类型,当产品是NB-IoT产品时,此字段必填。1表示中国电信,2表示中国移动,3表示中国联通
1571
+ */
1572
+ Isp?: number
1573
+
1574
+ /**
1575
+ * IMEI,当产品是NB-IoT产品时,此字段必填
1576
+ */
1577
+ Imei?: string
1578
+
1579
+ /**
1580
+ * LoRa设备的DevEui,当创建LoRa时,此字段必填
1581
+ */
1582
+ LoraDevEui?: string
1583
+
1584
+ /**
1585
+ * LoRa设备的MoteType
1586
+ */
1587
+ LoraMoteType?: number
1588
+
1589
+ /**
1590
+ * 创建LoRa设备需要skey
1591
+ */
1592
+ Skey?: string
1593
+
1594
+ /**
1595
+ * LoRa设备的AppKey
1596
+ */
1597
+ LoraAppKey?: string
1598
+
1599
+ /**
1600
+ * 私有CA创建的设备证书
1601
+ */
1602
+ TlsCrt?: string
1603
+ }
1604
+
1605
+ /**
1606
+ * DescribeProductTask请求参数结构体
1607
+ */
1608
+ export interface DescribeProductTaskRequest {
1609
+ /**
1610
+ * 产品ID
1611
+ */
1612
+ ProductId: string
1613
+
1614
+ /**
1615
+ * 任务ID
1616
+ */
1617
+ TaskId: number
1618
+ }
1619
+
1620
+ /**
1621
+ * DescribeFirmwareTask返回参数结构体
1622
+ */
1623
+ export interface DescribeFirmwareTaskResponse {
1624
+ /**
1625
+ * 固件任务ID
1413
1626
  注意:此字段可能返回 null,表示取不到有效值。
1414
1627
  */
1415
- LastOfflineTime: number
1628
+ TaskId: number
1416
1629
 
1417
1630
  /**
1418
- * 设备创建时间
1631
+ * 固件任务状态
1419
1632
  注意:此字段可能返回 null,表示取不到有效值。
1420
1633
  */
1421
- CreateTime: number
1634
+ Status: number
1422
1635
 
1423
1636
  /**
1424
- * 设备证书获取状态,0 未获取过设备密钥, 1 已获取过设备密钥
1637
+ * 固件任务创建时间,单位:秒
1425
1638
  注意:此字段可能返回 null,表示取不到有效值。
1426
1639
  */
1427
- CertState: number
1640
+ CreateTime: number
1428
1641
 
1429
1642
  /**
1430
- * 设备启用状态
1643
+ * 固件任务升级类型
1431
1644
  注意:此字段可能返回 null,表示取不到有效值。
1432
1645
  */
1433
- EnableState: number
1646
+ Type: number
1434
1647
 
1435
1648
  /**
1436
- * 设备标签
1649
+ * 产品名称
1437
1650
  注意:此字段可能返回 null,表示取不到有效值。
1438
1651
  */
1439
- Labels: Array<DeviceLabel>
1652
+ ProductName: string
1440
1653
 
1441
1654
  /**
1442
- * MQTT客户端IP地址
1655
+ * 固件任务升级模式。originalVersion(按版本号升级)、filename(提交文件升级)、devicenames(按设备名称升级)
1443
1656
  注意:此字段可能返回 null,表示取不到有效值。
1444
1657
  */
1445
- ClientIP: string
1658
+ UpgradeMode: string
1446
1659
 
1447
1660
  /**
1448
- * 设备固件更新时间
1661
+ * 产品ID
1449
1662
  注意:此字段可能返回 null,表示取不到有效值。
1450
1663
  */
1451
- FirmwareUpdateTime: number
1664
+ ProductId: string
1452
1665
 
1453
1666
  /**
1454
- * 创建者账号ID
1667
+ * 升级前版本号
1455
1668
  注意:此字段可能返回 null,表示取不到有效值。
1456
1669
  */
1457
- CreateUserId: number
1670
+ OriginalVersion: string
1458
1671
 
1459
1672
  /**
1460
1673
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1463,51 +1676,2006 @@ export interface DescribeDeviceResponse {
1463
1676
  }
1464
1677
 
1465
1678
  /**
1466
- * PublishBroadcastMessage请求参数结构体
1679
+ * CreateProduct请求参数结构体
1467
1680
  */
1468
- export interface PublishBroadcastMessageRequest {
1681
+ export interface CreateProductRequest {
1682
+ /**
1683
+ * 产品名称,名称不能和已经存在的产品名称重复。命名规则:[a-zA-Z0-9:_-]{1,32}
1684
+ */
1685
+ ProductName: string
1686
+
1687
+ /**
1688
+ * 产品属性
1689
+ */
1690
+ ProductProperties?: ProductProperties
1691
+
1692
+ /**
1693
+ * 创建CLAA产品时,需要Skey
1694
+ */
1695
+ Skey?: string
1696
+ }
1697
+
1698
+ /**
1699
+ * DescribeFirmwareTasks请求参数结构体
1700
+ */
1701
+ export interface DescribeFirmwareTasksRequest {
1469
1702
  /**
1470
1703
  * 产品ID
1471
1704
  */
1472
1705
  ProductId: string
1473
1706
 
1474
1707
  /**
1475
- * 消息内容
1708
+ * 固件版本号
1476
1709
  */
1477
- Payload: string
1710
+ FirmwareVersion: string
1478
1711
 
1479
1712
  /**
1480
- * 消息质量等级
1713
+ * 查询偏移量
1481
1714
  */
1482
- Qos: number
1715
+ Offset: number
1483
1716
 
1484
1717
  /**
1485
- * Payload内容的编码格式,取值为base64或空。base64表示云端将收到的请求数据进行base64解码后下发到设备,空则直接将原始内容下发到设备
1718
+ * 返回查询结果条数
1486
1719
  */
1487
- PayloadEncoding?: string
1720
+ Limit: number
1721
+
1722
+ /**
1723
+ * 搜索过滤条件
1724
+ */
1725
+ Filters?: Array<SearchKeyword>
1488
1726
  }
1489
1727
 
1490
1728
  /**
1491
- * UpdateProductDynamicRegister返回参数结构体
1729
+ * DisableTopicRule返回参数结构体
1492
1730
  */
1493
- export interface UpdateProductDynamicRegisterResponse {
1731
+ export interface DisableTopicRuleResponse {
1494
1732
  /**
1495
- * 动态注册类型,0-关闭 1-预创建设备 2-自动创建设备
1733
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1496
1734
  */
1497
- RegisterType: number
1735
+ RequestId?: string
1736
+ }
1498
1737
 
1738
+ /**
1739
+ * GetCOSURL请求参数结构体
1740
+ */
1741
+ export interface GetCOSURLRequest {
1499
1742
  /**
1500
- * 动态注册产品密钥
1743
+ * 产品ID
1501
1744
  */
1502
- ProductSecret: string
1745
+ ProductId: string
1503
1746
 
1504
1747
  /**
1505
- * 动态注册设备上限
1748
+ * 固件版本
1506
1749
  */
1507
- RegisterLimit: number
1750
+ FirmwareVersion: string
1751
+
1752
+ /**
1753
+ * 固件版本大小
1754
+ */
1755
+ FileSize?: number
1756
+ }
1757
+
1758
+ /**
1759
+ * UpdateTopicPolicy返回参数结构体
1760
+ */
1761
+ export interface UpdateTopicPolicyResponse {
1762
+ /**
1763
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1764
+ */
1765
+ RequestId?: string
1766
+ }
1767
+
1768
+ /**
1769
+ * DescribeProductTask返回参数结构体
1770
+ */
1771
+ export interface DescribeProductTaskResponse {
1772
+ /**
1773
+ * 产品任务详细信息
1774
+ */
1775
+ TaskInfo: ProductTaskInfo
1508
1776
 
1509
1777
  /**
1510
1778
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1511
1779
  */
1512
1780
  RequestId?: string
1513
1781
  }
1782
+
1783
+ /**
1784
+ * DescribeDevice返回参数结构体
1785
+ */
1786
+ export interface DescribeDeviceResponse {
1787
+ /**
1788
+ * 设备名
1789
+ */
1790
+ DeviceName: string
1791
+
1792
+ /**
1793
+ * 设备是否在线,0不在线,1在线
1794
+ */
1795
+ Online: number
1796
+
1797
+ /**
1798
+ * 设备登录时间
1799
+ */
1800
+ LoginTime: number
1801
+
1802
+ /**
1803
+ * 设备固件版本
1804
+ */
1805
+ Version: string
1806
+
1807
+ /**
1808
+ * 设备最后更新时间
1809
+ */
1810
+ LastUpdateTime: number
1811
+
1812
+ /**
1813
+ * 设备证书
1814
+ */
1815
+ DeviceCert: string
1816
+
1817
+ /**
1818
+ * 设备密钥
1819
+ */
1820
+ DevicePsk: string
1821
+
1822
+ /**
1823
+ * 设备属性
1824
+ */
1825
+ Tags: Array<DeviceTag>
1826
+
1827
+ /**
1828
+ * 设备类型
1829
+ */
1830
+ DeviceType: number
1831
+
1832
+ /**
1833
+ * 国际移动设备识别码 IMEI
1834
+ */
1835
+ Imei: string
1836
+
1837
+ /**
1838
+ * 运营商类型
1839
+ */
1840
+ Isp: number
1841
+
1842
+ /**
1843
+ * IP地址
1844
+ */
1845
+ ConnIP: number
1846
+
1847
+ /**
1848
+ * NB IoT运营商处的DeviceID
1849
+ */
1850
+ NbiotDeviceID: string
1851
+
1852
+ /**
1853
+ * Lora设备的dev eui
1854
+ */
1855
+ LoraDevEui: string
1856
+
1857
+ /**
1858
+ * Lora设备的mote type
1859
+ */
1860
+ LoraMoteType: number
1861
+
1862
+ /**
1863
+ * 设备的sdk日志等级
1864
+ 注意:此字段可能返回 null,表示取不到有效值。
1865
+ */
1866
+ LogLevel: number
1867
+
1868
+ /**
1869
+ * 首次上线时间
1870
+ 注意:此字段可能返回 null,表示取不到有效值。
1871
+ */
1872
+ FirstOnlineTime: number
1873
+
1874
+ /**
1875
+ * 最近下线时间
1876
+ 注意:此字段可能返回 null,表示取不到有效值。
1877
+ */
1878
+ LastOfflineTime: number
1879
+
1880
+ /**
1881
+ * 设备创建时间
1882
+ 注意:此字段可能返回 null,表示取不到有效值。
1883
+ */
1884
+ CreateTime: number
1885
+
1886
+ /**
1887
+ * 设备证书获取状态,0 未获取过设备密钥, 1 已获取过设备密钥
1888
+ 注意:此字段可能返回 null,表示取不到有效值。
1889
+ */
1890
+ CertState: number
1891
+
1892
+ /**
1893
+ * 设备启用状态
1894
+ 注意:此字段可能返回 null,表示取不到有效值。
1895
+ */
1896
+ EnableState: number
1897
+
1898
+ /**
1899
+ * 设备标签
1900
+ 注意:此字段可能返回 null,表示取不到有效值。
1901
+ */
1902
+ Labels: Array<DeviceLabel>
1903
+
1904
+ /**
1905
+ * MQTT客户端IP地址
1906
+ 注意:此字段可能返回 null,表示取不到有效值。
1907
+ */
1908
+ ClientIP: string
1909
+
1910
+ /**
1911
+ * 设备固件更新时间
1912
+ 注意:此字段可能返回 null,表示取不到有效值。
1913
+ */
1914
+ FirmwareUpdateTime: number
1915
+
1916
+ /**
1917
+ * 创建者账号ID
1918
+ 注意:此字段可能返回 null,表示取不到有效值。
1919
+ */
1920
+ CreateUserId: number
1921
+
1922
+ /**
1923
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1924
+ */
1925
+ RequestId?: string
1926
+ }
1927
+
1928
+ /**
1929
+ * PublishBroadcastMessage请求参数结构体
1930
+ */
1931
+ export interface PublishBroadcastMessageRequest {
1932
+ /**
1933
+ * 产品ID
1934
+ */
1935
+ ProductId: string
1936
+
1937
+ /**
1938
+ * 消息内容
1939
+ */
1940
+ Payload: string
1941
+
1942
+ /**
1943
+ * 消息质量等级
1944
+ */
1945
+ Qos: number
1946
+
1947
+ /**
1948
+ * Payload内容的编码格式,取值为base64或空。base64表示云端将收到的请求数据进行base64解码后下发到设备,空则直接将原始内容下发到设备
1949
+ */
1950
+ PayloadEncoding?: string
1951
+ }
1952
+
1953
+ /**
1954
+ * ListLog返回参数结构体
1955
+ */
1956
+ export interface ListLogResponse {
1957
+ /**
1958
+ * 日志上下文
1959
+ */
1960
+ Context: string
1961
+
1962
+ /**
1963
+ * 是否还有日志,如有仍有日志,下次查询的请求带上当前请求返回的Context
1964
+ */
1965
+ Listover: boolean
1966
+
1967
+ /**
1968
+ * 日志列表
1969
+ */
1970
+ Results: Array<CLSLogItem>
1971
+
1972
+ /**
1973
+ * 日志总条数
1974
+ */
1975
+ TotalCount: number
1976
+
1977
+ /**
1978
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1979
+ */
1980
+ RequestId?: string
1981
+ }
1982
+
1983
+ /**
1984
+ * RetryDeviceFirmwareTask请求参数结构体
1985
+ */
1986
+ export interface RetryDeviceFirmwareTaskRequest {
1987
+ /**
1988
+ * 产品ID
1989
+ */
1990
+ ProductId: string
1991
+
1992
+ /**
1993
+ * 设备名称
1994
+ */
1995
+ DeviceName: string
1996
+
1997
+ /**
1998
+ * 固件版本号
1999
+ */
2000
+ FirmwareVersion: string
2001
+
2002
+ /**
2003
+ * 固件升级任务ID
2004
+ */
2005
+ TaskId: number
2006
+ }
2007
+
2008
+ /**
2009
+ * DescribeFirmwareTaskDevices返回参数结构体
2010
+ */
2011
+ export interface DescribeFirmwareTaskDevicesResponse {
2012
+ /**
2013
+ * 固件升级任务的设备总数
2014
+ 注意:此字段可能返回 null,表示取不到有效值。
2015
+ */
2016
+ Total: number
2017
+
2018
+ /**
2019
+ * 固件升级任务的设备列表
2020
+ 注意:此字段可能返回 null,表示取不到有效值。
2021
+ */
2022
+ Devices: Array<DeviceUpdateStatus>
2023
+
2024
+ /**
2025
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2026
+ */
2027
+ RequestId?: string
2028
+ }
2029
+
2030
+ /**
2031
+ * DescribeFirmwareTasks返回参数结构体
2032
+ */
2033
+ export interface DescribeFirmwareTasksResponse {
2034
+ /**
2035
+ * 固件升级任务列表
2036
+ 注意:此字段可能返回 null,表示取不到有效值。
2037
+ */
2038
+ TaskInfos: Array<FirmwareTaskInfo>
2039
+
2040
+ /**
2041
+ * 固件升级任务总数
2042
+ 注意:此字段可能返回 null,表示取不到有效值。
2043
+ */
2044
+ Total: number
2045
+
2046
+ /**
2047
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2048
+ */
2049
+ RequestId?: string
2050
+ }
2051
+
2052
+ /**
2053
+ * DescribePrivateCA请求参数结构体
2054
+ */
2055
+ export interface DescribePrivateCARequest {
2056
+ /**
2057
+ * 私有化CA名称
2058
+ */
2059
+ CertName: string
2060
+ }
2061
+
2062
+ /**
2063
+ * GetCOSURL返回参数结构体
2064
+ */
2065
+ export interface GetCOSURLResponse {
2066
+ /**
2067
+ * 固件URL
2068
+ */
2069
+ Url: string
2070
+
2071
+ /**
2072
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2073
+ */
2074
+ RequestId?: string
2075
+ }
2076
+
2077
+ /**
2078
+ * UpdateDeviceAvailableState返回参数结构体
2079
+ */
2080
+ export interface UpdateDeviceAvailableStateResponse {
2081
+ /**
2082
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2083
+ */
2084
+ RequestId?: string
2085
+ }
2086
+
2087
+ /**
2088
+ * EditFirmware返回参数结构体
2089
+ */
2090
+ export interface EditFirmwareResponse {
2091
+ /**
2092
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2093
+ */
2094
+ RequestId?: string
2095
+ }
2096
+
2097
+ /**
2098
+ * ListSDKLog返回参数结构体
2099
+ */
2100
+ export interface ListSDKLogResponse {
2101
+ /**
2102
+ * 日志检索上下文
2103
+ */
2104
+ Context: string
2105
+
2106
+ /**
2107
+ * 是否还有日志,如有仍有日志,下次查询的请求带上当前请求返回的Context
2108
+ */
2109
+ Listover: boolean
2110
+
2111
+ /**
2112
+ * 日志列表
2113
+ */
2114
+ Results: Array<SDKLogItem>
2115
+
2116
+ /**
2117
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2118
+ */
2119
+ RequestId?: string
2120
+ }
2121
+
2122
+ /**
2123
+ * UpdateDevicePSK请求参数结构体
2124
+ */
2125
+ export interface UpdateDevicePSKRequest {
2126
+ /**
2127
+ * 产品名
2128
+ */
2129
+ ProductId: string
2130
+
2131
+ /**
2132
+ * 设备名
2133
+ */
2134
+ DeviceName: string
2135
+
2136
+ /**
2137
+ * 设备的psk
2138
+ */
2139
+ Psk: string
2140
+ }
2141
+
2142
+ /**
2143
+ * DeleteProductPrivateCA请求参数结构体
2144
+ */
2145
+ export interface DeleteProductPrivateCARequest {
2146
+ /**
2147
+ * 产品ID
2148
+ */
2149
+ ProductId: string
2150
+ }
2151
+
2152
+ /**
2153
+ * UpdateDeviceAvailableState请求参数结构体
2154
+ */
2155
+ export interface UpdateDeviceAvailableStateRequest {
2156
+ /**
2157
+ * 设备所属产品id
2158
+ */
2159
+ ProductId: string
2160
+
2161
+ /**
2162
+ * 设备名称
2163
+ */
2164
+ DeviceName: string
2165
+
2166
+ /**
2167
+ * 要设置的设备状态,1为启用,0为禁用
2168
+ */
2169
+ EnableState: number
2170
+ }
2171
+
2172
+ /**
2173
+ * GetUserResourceInfo返回参数结构体
2174
+ */
2175
+ export interface GetUserResourceInfoResponse {
2176
+ /**
2177
+ * 已使用的资源字节数
2178
+ */
2179
+ UsedSize: number
2180
+
2181
+ /**
2182
+ * 可以使用资源的总大小
2183
+ */
2184
+ Limit: number
2185
+
2186
+ /**
2187
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2188
+ */
2189
+ RequestId?: string
2190
+ }
2191
+
2192
+ /**
2193
+ * DescribePrivateCABindedProducts返回参数结构体
2194
+ */
2195
+ export interface DescribePrivateCABindedProductsResponse {
2196
+ /**
2197
+ * 私有CA绑定的产品列表
2198
+ */
2199
+ Products: Array<BindProductInfo>
2200
+
2201
+ /**
2202
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2203
+ */
2204
+ RequestId?: string
2205
+ }
2206
+
2207
+ /**
2208
+ * DeleteProduct返回参数结构体
2209
+ */
2210
+ export interface DeleteProductResponse {
2211
+ /**
2212
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2213
+ */
2214
+ RequestId?: string
2215
+ }
2216
+
2217
+ /**
2218
+ * ListLogPayload返回参数结构体
2219
+ */
2220
+ export interface ListLogPayloadResponse {
2221
+ /**
2222
+ * 日志上下文
2223
+ */
2224
+ Context: string
2225
+
2226
+ /**
2227
+ * 是否还有日志,如有仍有日志,下次查询的请求带上当前请求返回的Context
2228
+ */
2229
+ Listover: boolean
2230
+
2231
+ /**
2232
+ * 日志列表
2233
+ */
2234
+ Results: Array<PayloadLogItem>
2235
+
2236
+ /**
2237
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2238
+ */
2239
+ RequestId?: string
2240
+ }
2241
+
2242
+ /**
2243
+ * SetProductsForbiddenStatus请求参数结构体
2244
+ */
2245
+ export interface SetProductsForbiddenStatusRequest {
2246
+ /**
2247
+ * 要设置禁用状态的产品列表
2248
+ */
2249
+ ProductId: Array<string>
2250
+
2251
+ /**
2252
+ * 0启用,1禁用
2253
+ */
2254
+ Status: number
2255
+ }
2256
+
2257
+ /**
2258
+ * DownloadDeviceResource返回参数结构体
2259
+ */
2260
+ export interface DownloadDeviceResourceResponse {
2261
+ /**
2262
+ * 设备资源的cos链接
2263
+ */
2264
+ Url: string
2265
+
2266
+ /**
2267
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2268
+ */
2269
+ RequestId?: string
2270
+ }
2271
+
2272
+ /**
2273
+ * 产品详细信息
2274
+ */
2275
+ export interface ProductInfo {
2276
+ /**
2277
+ * 产品ID
2278
+ */
2279
+ ProductId: string
2280
+
2281
+ /**
2282
+ * 产品名
2283
+ */
2284
+ ProductName: string
2285
+
2286
+ /**
2287
+ * 产品元数据
2288
+ */
2289
+ ProductMetadata: ProductMetadata
2290
+
2291
+ /**
2292
+ * 产品属性
2293
+ */
2294
+ ProductProperties: ProductProperties
2295
+ }
2296
+
2297
+ /**
2298
+ * DescribeFirmwareTaskDistribution返回参数结构体
2299
+ */
2300
+ export interface DescribeFirmwareTaskDistributionResponse {
2301
+ /**
2302
+ * 固件升级任务状态分布信息
2303
+ */
2304
+ StatusInfos: Array<StatusStatistic>
2305
+
2306
+ /**
2307
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2308
+ */
2309
+ RequestId?: string
2310
+ }
2311
+
2312
+ /**
2313
+ * PublishBroadcastMessage返回参数结构体
2314
+ */
2315
+ export interface PublishBroadcastMessageResponse {
2316
+ /**
2317
+ * 广播消息任务ID
2318
+ */
2319
+ TaskId: number
2320
+
2321
+ /**
2322
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2323
+ */
2324
+ RequestId?: string
2325
+ }
2326
+
2327
+ /**
2328
+ * CreatePrivateCA请求参数结构体
2329
+ */
2330
+ export interface CreatePrivateCARequest {
2331
+ /**
2332
+ * CA证书名称
2333
+ */
2334
+ CertName: string
2335
+
2336
+ /**
2337
+ * CA证书内容
2338
+ */
2339
+ CertText: string
2340
+
2341
+ /**
2342
+ * 校验CA证书的证书内容
2343
+ */
2344
+ VerifyCertText: string
2345
+ }
2346
+
2347
+ /**
2348
+ * UpdateDevicePSK返回参数结构体
2349
+ */
2350
+ export interface UpdateDevicePSKResponse {
2351
+ /**
2352
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2353
+ */
2354
+ RequestId?: string
2355
+ }
2356
+
2357
+ /**
2358
+ * DescribeDevice请求参数结构体
2359
+ */
2360
+ export interface DescribeDeviceRequest {
2361
+ /**
2362
+ * 产品ID
2363
+ */
2364
+ ProductId: string
2365
+
2366
+ /**
2367
+ * 设备名
2368
+ */
2369
+ DeviceName: string
2370
+ }
2371
+
2372
+ /**
2373
+ * CreateMultiDevicesTask返回参数结构体
2374
+ */
2375
+ export interface CreateMultiDevicesTaskResponse {
2376
+ /**
2377
+ * 任务ID
2378
+ */
2379
+ Id: number
2380
+
2381
+ /**
2382
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2383
+ */
2384
+ RequestId?: string
2385
+ }
2386
+
2387
+ /**
2388
+ * DescribeProductResources返回参数结构体
2389
+ */
2390
+ export interface DescribeProductResourcesResponse {
2391
+ /**
2392
+ * 资源总数
2393
+ */
2394
+ TotalCount: number
2395
+
2396
+ /**
2397
+ * 资源详情
2398
+ 注意:此字段可能返回 null,表示取不到有效值。
2399
+ */
2400
+ Result: Array<ProductResourceInfo>
2401
+
2402
+ /**
2403
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2404
+ */
2405
+ RequestId?: string
2406
+ }
2407
+
2408
+ /**
2409
+ * UpdateProductDynamicRegister请求参数结构体
2410
+ */
2411
+ export interface UpdateProductDynamicRegisterRequest {
2412
+ /**
2413
+ * 产品Id
2414
+ */
2415
+ ProductId: string
2416
+
2417
+ /**
2418
+ * 动态注册类型,0-关闭 1-预创建设备 2-自动创建设备
2419
+ */
2420
+ RegisterType: number
2421
+
2422
+ /**
2423
+ * 动态注册设备上限
2424
+ */
2425
+ RegisterLimit: number
2426
+ }
2427
+
2428
+ /**
2429
+ * CreateTopicPolicy请求参数结构体
2430
+ */
2431
+ export interface CreateTopicPolicyRequest {
2432
+ /**
2433
+ * 产品自身ID
2434
+ */
2435
+ ProductId: string
2436
+
2437
+ /**
2438
+ * Topic名称
2439
+ */
2440
+ TopicName: string
2441
+
2442
+ /**
2443
+ * Topic权限,1发布,2订阅,3订阅和发布
2444
+ */
2445
+ Privilege: number
2446
+
2447
+ /**
2448
+ * 代理订阅信息,网关产品为绑定的子产品创建topic时需要填写,内容为子产品的ID和设备信息。
2449
+ */
2450
+ BrokerSubscribe?: BrokerSubscribe
2451
+ }
2452
+
2453
+ /**
2454
+ * DescribeProductResource请求参数结构体
2455
+ */
2456
+ export interface DescribeProductResourceRequest {
2457
+ /**
2458
+ * 需要查看资源列表的产品 ID
2459
+ */
2460
+ ProductID?: string
2461
+
2462
+ /**
2463
+ * 需要过滤的资源名称
2464
+ */
2465
+ Name?: string
2466
+ }
2467
+
2468
+ /**
2469
+ * 产品级任务详细信息
2470
+ */
2471
+ export interface ProductTaskInfo {
2472
+ /**
2473
+ * 任务ID
2474
+ */
2475
+ Id: number
2476
+
2477
+ /**
2478
+ * 任务类型 0-批量创建设备类型
2479
+ */
2480
+ Type: number
2481
+
2482
+ /**
2483
+ * 任务状态 0-创建中 1-待执行 2-执行中 3-执行失败 4-子任务部分失败 5-执行成功
2484
+ */
2485
+ State: number
2486
+
2487
+ /**
2488
+ * 任务参数类型 cosfile-文件输入 random-随机生成
2489
+ */
2490
+ ParametersType: string
2491
+
2492
+ /**
2493
+ * 任务参数
2494
+ */
2495
+ Parameters: string
2496
+
2497
+ /**
2498
+ * 任务执行结果类型 cosfile-文件输出 errmsg-错误信息
2499
+ 注意:此字段可能返回 null,表示取不到有效值。
2500
+ */
2501
+ ResultType: string
2502
+
2503
+ /**
2504
+ * 任务执行结果
2505
+ 注意:此字段可能返回 null,表示取不到有效值。
2506
+ */
2507
+ Result: string
2508
+
2509
+ /**
2510
+ * 子任务总个数
2511
+ 注意:此字段可能返回 null,表示取不到有效值。
2512
+ */
2513
+ BatchCount: number
2514
+
2515
+ /**
2516
+ * 子任务已执行个数
2517
+ 注意:此字段可能返回 null,表示取不到有效值。
2518
+ */
2519
+ BatchOffset: number
2520
+
2521
+ /**
2522
+ * 任务创建时间
2523
+ */
2524
+ CreateTime: number
2525
+
2526
+ /**
2527
+ * 任务更新时间
2528
+ */
2529
+ UpdateTime: number
2530
+
2531
+ /**
2532
+ * 任务完成时间
2533
+ 注意:此字段可能返回 null,表示取不到有效值。
2534
+ */
2535
+ CompleteTime: number
2536
+ }
2537
+
2538
+ /**
2539
+ * ReplaceTopicRule请求参数结构体
2540
+ */
2541
+ export interface ReplaceTopicRuleRequest {
2542
+ /**
2543
+ * 规则名称
2544
+ */
2545
+ RuleName: string
2546
+
2547
+ /**
2548
+ * 替换的规则包体
2549
+ */
2550
+ TopicRulePayload: TopicRulePayload
2551
+ }
2552
+
2553
+ /**
2554
+ * PublishRRPCMessage返回参数结构体
2555
+ */
2556
+ export interface PublishRRPCMessageResponse {
2557
+ /**
2558
+ * RRPC消息ID
2559
+ */
2560
+ MessageId: number
2561
+
2562
+ /**
2563
+ * 设备回复的消息内容,采用base64编码
2564
+ */
2565
+ PayloadBase64: string
2566
+
2567
+ /**
2568
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2569
+ */
2570
+ RequestId?: string
2571
+ }
2572
+
2573
+ /**
2574
+ * UpdateTopicPolicy请求参数结构体
2575
+ */
2576
+ export interface UpdateTopicPolicyRequest {
2577
+ /**
2578
+ * 产品ID
2579
+ */
2580
+ ProductId: string
2581
+
2582
+ /**
2583
+ * 更新前Topic名
2584
+ */
2585
+ TopicName: string
2586
+
2587
+ /**
2588
+ * 更新后Topic名
2589
+ */
2590
+ NewTopicName: string
2591
+
2592
+ /**
2593
+ * Topic权限
2594
+ */
2595
+ Privilege: number
2596
+
2597
+ /**
2598
+ * 代理订阅信息
2599
+ */
2600
+ BrokerSubscribe?: BrokerSubscribe
2601
+ }
2602
+
2603
+ /**
2604
+ * UpdatePrivateCA返回参数结构体
2605
+ */
2606
+ export interface UpdatePrivateCAResponse {
2607
+ /**
2608
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2609
+ */
2610
+ RequestId?: string
2611
+ }
2612
+
2613
+ /**
2614
+ * 设备属性
2615
+ */
2616
+ export interface Attribute {
2617
+ /**
2618
+ * 属性列表
2619
+ */
2620
+ Tags?: Array<DeviceTag>
2621
+ }
2622
+
2623
+ /**
2624
+ * DescribeDeviceResources返回参数结构体
2625
+ */
2626
+ export interface DescribeDeviceResourcesResponse {
2627
+ /**
2628
+ * 资源总数
2629
+ */
2630
+ TotalCount: number
2631
+
2632
+ /**
2633
+ * 资源列表
2634
+ 注意:此字段可能返回 null,表示取不到有效值。
2635
+ */
2636
+ Result: Array<DeviceResourceInfo>
2637
+
2638
+ /**
2639
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2640
+ */
2641
+ RequestId?: string
2642
+ }
2643
+
2644
+ /**
2645
+ * UploadFirmware返回参数结构体
2646
+ */
2647
+ export interface UploadFirmwareResponse {
2648
+ /**
2649
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2650
+ */
2651
+ RequestId?: string
2652
+ }
2653
+
2654
+ /**
2655
+ * DeleteTopicRule请求参数结构体
2656
+ */
2657
+ export interface DeleteTopicRuleRequest {
2658
+ /**
2659
+ * 规则名
2660
+ */
2661
+ RuleName: string
2662
+ }
2663
+
2664
+ /**
2665
+ * ReplaceTopicRule返回参数结构体
2666
+ */
2667
+ export interface ReplaceTopicRuleResponse {
2668
+ /**
2669
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2670
+ */
2671
+ RequestId?: string
2672
+ }
2673
+
2674
+ /**
2675
+ * CancelDeviceFirmwareTask请求参数结构体
2676
+ */
2677
+ export interface CancelDeviceFirmwareTaskRequest {
2678
+ /**
2679
+ * 产品ID
2680
+ */
2681
+ ProductId: string
2682
+
2683
+ /**
2684
+ * 设备名称
2685
+ */
2686
+ DeviceName: string
2687
+
2688
+ /**
2689
+ * 固件版本号
2690
+ */
2691
+ FirmwareVersion: string
2692
+
2693
+ /**
2694
+ * 固件升级任务ID
2695
+ */
2696
+ TaskId: number
2697
+ }
2698
+
2699
+ /**
2700
+ * DeleteDeviceResource请求参数结构体
2701
+ */
2702
+ export interface DeleteDeviceResourceRequest {
2703
+ /**
2704
+ * 产品ID
2705
+ */
2706
+ ProductID: string
2707
+
2708
+ /**
2709
+ * 资源名称
2710
+ */
2711
+ Name: string
2712
+
2713
+ /**
2714
+ * 设备名称
2715
+ */
2716
+ DeviceName: string
2717
+ }
2718
+
2719
+ /**
2720
+ * DescribeDeviceShadow请求参数结构体
2721
+ */
2722
+ export interface DescribeDeviceShadowRequest {
2723
+ /**
2724
+ * 产品 ID
2725
+ */
2726
+ ProductId: string
2727
+
2728
+ /**
2729
+ * 设备名称。命名规则:[a-zA-Z0-9:_-]{1,60}
2730
+ */
2731
+ DeviceName: string
2732
+ }
2733
+
2734
+ /**
2735
+ * UpdateProductDynamicRegister返回参数结构体
2736
+ */
2737
+ export interface UpdateProductDynamicRegisterResponse {
2738
+ /**
2739
+ * 动态注册类型,0-关闭 1-预创建设备 2-自动创建设备
2740
+ */
2741
+ RegisterType: number
2742
+
2743
+ /**
2744
+ * 动态注册产品密钥
2745
+ */
2746
+ ProductSecret: string
2747
+
2748
+ /**
2749
+ * 动态注册设备上限
2750
+ */
2751
+ RegisterLimit: number
2752
+
2753
+ /**
2754
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2755
+ */
2756
+ RequestId?: string
2757
+ }
2758
+
2759
+ /**
2760
+ * UnbindDevices返回参数结构体
2761
+ */
2762
+ export interface UnbindDevicesResponse {
2763
+ /**
2764
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2765
+ */
2766
+ RequestId?: string
2767
+ }
2768
+
2769
+ /**
2770
+ * DescribePrivateCABindedProducts请求参数结构体
2771
+ */
2772
+ export interface DescribePrivateCABindedProductsRequest {
2773
+ /**
2774
+ * 证书名称
2775
+ */
2776
+ CertName: string
2777
+
2778
+ /**
2779
+ * 查询偏移量
2780
+ */
2781
+ Offset: number
2782
+
2783
+ /**
2784
+ * 查询的数据量,默认为20, 最大为200
2785
+ */
2786
+ Limit: number
2787
+ }
2788
+
2789
+ /**
2790
+ * DescribePrivateCAs返回参数结构体
2791
+ */
2792
+ export interface DescribePrivateCAsResponse {
2793
+ /**
2794
+ * 私有CA证书列表
2795
+ */
2796
+ CAs: Array<CertInfo>
2797
+
2798
+ /**
2799
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2800
+ */
2801
+ RequestId?: string
2802
+ }
2803
+
2804
+ /**
2805
+ * 设备详细信息
2806
+ */
2807
+ export interface DeviceInfo {
2808
+ /**
2809
+ * 设备名
2810
+ */
2811
+ DeviceName: string
2812
+
2813
+ /**
2814
+ * 设备是否在线,0不在线,1在线
2815
+ */
2816
+ Online: number
2817
+
2818
+ /**
2819
+ * 设备登录时间
2820
+ */
2821
+ LoginTime: number
2822
+
2823
+ /**
2824
+ * 设备版本
2825
+ */
2826
+ Version: string
2827
+
2828
+ /**
2829
+ * 设备证书,证书加密的设备返回
2830
+ */
2831
+ DeviceCert: string
2832
+
2833
+ /**
2834
+ * 设备密钥,密钥加密的设备返回
2835
+ */
2836
+ DevicePsk: string
2837
+
2838
+ /**
2839
+ * 设备属性
2840
+ */
2841
+ Tags: Array<DeviceTag>
2842
+
2843
+ /**
2844
+ * 设备类型
2845
+ */
2846
+ DeviceType: number
2847
+
2848
+ /**
2849
+ * 国际移动设备识别码 IMEI
2850
+ */
2851
+ Imei: string
2852
+
2853
+ /**
2854
+ * 运营商类型
2855
+ */
2856
+ Isp: number
2857
+
2858
+ /**
2859
+ * NB IOT运营商处的DeviceID
2860
+ */
2861
+ NbiotDeviceID: string
2862
+
2863
+ /**
2864
+ * IP地址
2865
+ */
2866
+ ConnIP: number
2867
+
2868
+ /**
2869
+ * 设备最后更新时间
2870
+ */
2871
+ LastUpdateTime: number
2872
+
2873
+ /**
2874
+ * LoRa设备的dev eui
2875
+ */
2876
+ LoraDevEui: string
2877
+
2878
+ /**
2879
+ * LoRa设备的Mote type
2880
+ */
2881
+ LoraMoteType: number
2882
+
2883
+ /**
2884
+ * 首次上线时间
2885
+ 注意:此字段可能返回 null,表示取不到有效值。
2886
+ */
2887
+ FirstOnlineTime: number
2888
+
2889
+ /**
2890
+ * 最近下线时间
2891
+ 注意:此字段可能返回 null,表示取不到有效值。
2892
+ */
2893
+ LastOfflineTime: number
2894
+
2895
+ /**
2896
+ * 设备创建时间
2897
+ 注意:此字段可能返回 null,表示取不到有效值。
2898
+ */
2899
+ CreateTime: number
2900
+
2901
+ /**
2902
+ * 设备日志级别
2903
+ 注意:此字段可能返回 null,表示取不到有效值。
2904
+ */
2905
+ LogLevel: number
2906
+
2907
+ /**
2908
+ * 设备证书获取状态, 1 已获取过设备密钥,0 未获取过设备密钥
2909
+ 注意:此字段可能返回 null,表示取不到有效值。
2910
+ */
2911
+ CertState: number
2912
+
2913
+ /**
2914
+ * 设备可用状态,0禁用,1启用
2915
+ 注意:此字段可能返回 null,表示取不到有效值。
2916
+ */
2917
+ EnableState: number
2918
+
2919
+ /**
2920
+ * 设备标签
2921
+ 注意:此字段可能返回 null,表示取不到有效值。
2922
+ */
2923
+ Labels: Array<DeviceLabel>
2924
+
2925
+ /**
2926
+ * MQTT客户端IP地址
2927
+ 注意:此字段可能返回 null,表示取不到有效值。
2928
+ */
2929
+ ClientIP: string
2930
+
2931
+ /**
2932
+ * ota最后更新时间
2933
+ 注意:此字段可能返回 null,表示取不到有效值。
2934
+ */
2935
+ FirmwareUpdateTime: number
2936
+ }
2937
+
2938
+ /**
2939
+ * CreateTaskFileUrl请求参数结构体
2940
+ */
2941
+ export interface CreateTaskFileUrlRequest {
2942
+ /**
2943
+ * 产品ID
2944
+ */
2945
+ ProductId: string
2946
+ }
2947
+
2948
+ /**
2949
+ * UpdateDeviceShadow返回参数结构体
2950
+ */
2951
+ export interface UpdateDeviceShadowResponse {
2952
+ /**
2953
+ * 设备影子数据,JSON字符串格式
2954
+ */
2955
+ Data: string
2956
+
2957
+ /**
2958
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2959
+ */
2960
+ RequestId?: string
2961
+ }
2962
+
2963
+ /**
2964
+ * BatchUpdateFirmware请求参数结构体
2965
+ */
2966
+ export interface BatchUpdateFirmwareRequest {
2967
+ /**
2968
+ * 产品ID
2969
+ */
2970
+ ProductId: string
2971
+
2972
+ /**
2973
+ * 固件新版本号
2974
+ */
2975
+ FirmwareVersion: string
2976
+
2977
+ /**
2978
+ * 固件原版本号,根据文件列表升级固件不需要填写此参数
2979
+ */
2980
+ FirmwareOriVersion?: string
2981
+
2982
+ /**
2983
+ * 升级方式,0 静默升级 1 用户确认升级。 不填默认为静默升级方式
2984
+ */
2985
+ UpgradeMethod?: number
2986
+
2987
+ /**
2988
+ * 设备列表文件名称,根据文件列表升级固件需要填写此参数
2989
+ */
2990
+ FileName?: string
2991
+
2992
+ /**
2993
+ * 设备列表的文件md5值
2994
+ */
2995
+ FileMd5?: string
2996
+
2997
+ /**
2998
+ * 设备列表的文件大小值
2999
+ */
3000
+ FileSize?: number
3001
+
3002
+ /**
3003
+ * 需要升级的设备名称列表
3004
+ */
3005
+ DeviceNames?: Array<string>
3006
+
3007
+ /**
3008
+ * 固件升级任务,默认超时时间。 最小取值60秒,最大为3600秒
3009
+ */
3010
+ TimeoutInterval?: number
3011
+ }
3012
+
3013
+ /**
3014
+ * X509证书信息
3015
+ */
3016
+ export interface CertInfo {
3017
+ /**
3018
+ * 证书名称
3019
+ */
3020
+ CertName: string
3021
+
3022
+ /**
3023
+ * 证书的序列号,16进制编码
3024
+ */
3025
+ CertSN: string
3026
+
3027
+ /**
3028
+ * 证书颁发着名称
3029
+ */
3030
+ IssuerName: string
3031
+
3032
+ /**
3033
+ * 证书主题
3034
+ */
3035
+ Subject: string
3036
+
3037
+ /**
3038
+ * 证书创建时间,秒级时间戳
3039
+ */
3040
+ CreateTime: number
3041
+
3042
+ /**
3043
+ * 证书生效时间,秒级时间戳
3044
+ */
3045
+ EffectiveTime: number
3046
+
3047
+ /**
3048
+ * 证书失效时间,秒级时间戳
3049
+ */
3050
+ ExpireTime: number
3051
+
3052
+ /**
3053
+ * X509证书内容
3054
+ */
3055
+ CertText: string
3056
+ }
3057
+
3058
+ /**
3059
+ * GetUserResourceInfo请求参数结构体
3060
+ */
3061
+ export type GetUserResourceInfoRequest = null
3062
+
3063
+ /**
3064
+ * 设备属性
3065
+ */
3066
+ export interface DeviceTag {
3067
+ /**
3068
+ * 属性名称
3069
+ */
3070
+ Tag: string
3071
+
3072
+ /**
3073
+ * 属性值的类型,1 int,2 string
3074
+ */
3075
+ Type: number
3076
+
3077
+ /**
3078
+ * 属性的值
3079
+ */
3080
+ Value: string
3081
+
3082
+ /**
3083
+ * 属性描述名称
3084
+ 注意:此字段可能返回 null,表示取不到有效值。
3085
+ */
3086
+ Name?: string
3087
+ }
3088
+
3089
+ /**
3090
+ * ListLog请求参数结构体
3091
+ */
3092
+ export interface ListLogRequest {
3093
+ /**
3094
+ * 日志开始时间,毫秒级时间戳
3095
+ */
3096
+ MinTime: number
3097
+
3098
+ /**
3099
+ * 日志结束时间,毫秒级时间戳
3100
+ */
3101
+ MaxTime: number
3102
+
3103
+ /**
3104
+ * 查询关键字,可以同时支持键值查询和文本查询,例如,查询某key的值为value,并且包含某word的日志,该参数为:key:value word。键值或文本可以包含多个,以空格隔开。其中可以索引的key包括:requestid、productid、devicename、scene、content。
3105
+ 一个典型的查询示例:productid:ABCDE12345 devicename:test scene:SHADOW content:Device%20connect publish
3106
+ */
3107
+ Keywords?: string
3108
+
3109
+ /**
3110
+ * 日志检索上下文
3111
+ */
3112
+ Context?: string
3113
+
3114
+ /**
3115
+ * 查询条数
3116
+ */
3117
+ MaxNum?: number
3118
+ }
3119
+
3120
+ /**
3121
+ * 产品元数据
3122
+ */
3123
+ export interface ProductMetadata {
3124
+ /**
3125
+ * 产品创建时间
3126
+ */
3127
+ CreationDate: number
3128
+ }
3129
+
3130
+ /**
3131
+ * DescribeProduct返回参数结构体
3132
+ */
3133
+ export interface DescribeProductResponse {
3134
+ /**
3135
+ * 产品ID
3136
+ */
3137
+ ProductId: string
3138
+
3139
+ /**
3140
+ * 产品名
3141
+ */
3142
+ ProductName: string
3143
+
3144
+ /**
3145
+ * 产品元数据
3146
+ */
3147
+ ProductMetadata: ProductMetadata
3148
+
3149
+ /**
3150
+ * 产品属性
3151
+ */
3152
+ ProductProperties: ProductProperties
3153
+
3154
+ /**
3155
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3156
+ */
3157
+ RequestId?: string
3158
+ }
3159
+
3160
+ /**
3161
+ * DescribeGatewayBindDevices请求参数结构体
3162
+ */
3163
+ export interface DescribeGatewayBindDevicesRequest {
3164
+ /**
3165
+ * 网关设备的产品ID
3166
+ */
3167
+ GatewayProductId: string
3168
+
3169
+ /**
3170
+ * 网关设备的设备名
3171
+ */
3172
+ GatewayDeviceName: string
3173
+
3174
+ /**
3175
+ * 偏移量,Offset从0开始
3176
+ */
3177
+ Offset: number
3178
+
3179
+ /**
3180
+ * 分页的页大小
3181
+ */
3182
+ Limit: number
3183
+
3184
+ /**
3185
+ * LoRa产品的ID
3186
+ */
3187
+ ProductId?: string
3188
+ }
3189
+
3190
+ /**
3191
+ * SDK日志项
3192
+ */
3193
+ export interface SDKLogItem {
3194
+ /**
3195
+ * 产品ID
3196
+ */
3197
+ ProductId: string
3198
+
3199
+ /**
3200
+ * 设备名称
3201
+ */
3202
+ DeviceName: string
3203
+
3204
+ /**
3205
+ * 日志等级
3206
+ */
3207
+ Level: string
3208
+
3209
+ /**
3210
+ * 日志时间
3211
+ */
3212
+ DateTime: string
3213
+
3214
+ /**
3215
+ * 日志内容
3216
+ */
3217
+ Content: string
3218
+ }
3219
+
3220
+ /**
3221
+ * PublishMessage返回参数结构体
3222
+ */
3223
+ export interface PublishMessageResponse {
3224
+ /**
3225
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3226
+ */
3227
+ RequestId?: string
3228
+ }
3229
+
3230
+ /**
3231
+ * DescribePrivateCAs请求参数结构体
3232
+ */
3233
+ export type DescribePrivateCAsRequest = null
3234
+
3235
+ /**
3236
+ * BindDevices返回参数结构体
3237
+ */
3238
+ export interface BindDevicesResponse {
3239
+ /**
3240
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3241
+ */
3242
+ RequestId?: string
3243
+ }
3244
+
3245
+ /**
3246
+ * 重置设备状态结果
3247
+ */
3248
+ export interface ResetDeviceResult {
3249
+ /**
3250
+ * 设备名
3251
+ */
3252
+ DeviceName: string
3253
+
3254
+ /**
3255
+ * 是否成功
3256
+ */
3257
+ Success: boolean
3258
+
3259
+ /**
3260
+ * 失败原因
3261
+ 注意:此字段可能返回 null,表示取不到有效值。
3262
+ */
3263
+ Reason: string
3264
+ }
3265
+
3266
+ /**
3267
+ * 搜索关键词
3268
+ */
3269
+ export interface SearchKeyword {
3270
+ /**
3271
+ * 搜索条件的Key
3272
+ */
3273
+ Key: string
3274
+
3275
+ /**
3276
+ * 搜索条件的值
3277
+ */
3278
+ Value?: string
3279
+ }
3280
+
3281
+ /**
3282
+ * DescribeDevices请求参数结构体
3283
+ */
3284
+ export interface DescribeDevicesRequest {
3285
+ /**
3286
+ * 需要查看设备列表的产品 ID
3287
+ */
3288
+ ProductId: string
3289
+
3290
+ /**
3291
+ * 偏移量,Offset从0开始
3292
+ */
3293
+ Offset: number
3294
+
3295
+ /**
3296
+ * 分页的大小,数值范围 10-250
3297
+ */
3298
+ Limit: number
3299
+
3300
+ /**
3301
+ * 设备固件版本号,若不带此参数会返回所有固件版本的设备。传"None-FirmwareVersion"查询无版本号的设备
3302
+ */
3303
+ FirmwareVersion?: string
3304
+
3305
+ /**
3306
+ * 需要过滤的设备名称
3307
+ */
3308
+ DeviceName?: string
3309
+
3310
+ /**
3311
+ * 设备是否启用,0禁用状态1启用状态,默认不区分
3312
+ */
3313
+ EnableState?: number
3314
+ }
3315
+
3316
+ /**
3317
+ * DescribeDeviceClientKey返回参数结构体
3318
+ */
3319
+ export interface DescribeDeviceClientKeyResponse {
3320
+ /**
3321
+ * 设备的私钥
3322
+ */
3323
+ ClientKey: string
3324
+
3325
+ /**
3326
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3327
+ */
3328
+ RequestId?: string
3329
+ }
3330
+
3331
+ /**
3332
+ * DescribePrivateCA返回参数结构体
3333
+ */
3334
+ export interface DescribePrivateCAResponse {
3335
+ /**
3336
+ * 私有化CA详情
3337
+ */
3338
+ CA: CertInfo
3339
+
3340
+ /**
3341
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3342
+ */
3343
+ RequestId?: string
3344
+ }
3345
+
3346
+ /**
3347
+ * UploadFirmware请求参数结构体
3348
+ */
3349
+ export interface UploadFirmwareRequest {
3350
+ /**
3351
+ * 产品ID
3352
+ */
3353
+ ProductId: string
3354
+
3355
+ /**
3356
+ * 固件版本号
3357
+ */
3358
+ FirmwareVersion: string
3359
+
3360
+ /**
3361
+ * 固件的MD5值
3362
+ */
3363
+ Md5sum: string
3364
+
3365
+ /**
3366
+ * 固件的大小
3367
+ */
3368
+ FileSize: number
3369
+
3370
+ /**
3371
+ * 固件名称
3372
+ */
3373
+ FirmwareName?: string
3374
+
3375
+ /**
3376
+ * 固件描述
3377
+ */
3378
+ FirmwareDescription?: string
3379
+ }
3380
+
3381
+ /**
3382
+ * UpdateDeviceLogLevel返回参数结构体
3383
+ */
3384
+ export interface UpdateDeviceLogLevelResponse {
3385
+ /**
3386
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3387
+ */
3388
+ RequestId?: string
3389
+ }
3390
+
3391
+ /**
3392
+ * DisableTopicRule请求参数结构体
3393
+ */
3394
+ export interface DisableTopicRuleRequest {
3395
+ /**
3396
+ * 规则名称
3397
+ */
3398
+ RuleName: string
3399
+ }
3400
+
3401
+ /**
3402
+ * ResetDeviceState返回参数结构体
3403
+ */
3404
+ export interface ResetDeviceStateResponse {
3405
+ /**
3406
+ * 批量重置设备成功数
3407
+ */
3408
+ SuccessCount: number
3409
+
3410
+ /**
3411
+ * 批量重置设备结果
3412
+ */
3413
+ ResetDeviceResults: Array<ResetDeviceResult>
3414
+
3415
+ /**
3416
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3417
+ */
3418
+ RequestId?: string
3419
+ }
3420
+
3421
+ /**
3422
+ * 固件升级任务信息
3423
+ */
3424
+ export interface FirmwareTaskInfo {
3425
+ /**
3426
+ * 任务ID
3427
+ 注意:此字段可能返回 null,表示取不到有效值。
3428
+ */
3429
+ TaskId: number
3430
+
3431
+ /**
3432
+ * 任务状态
3433
+ 注意:此字段可能返回 null,表示取不到有效值。
3434
+ */
3435
+ Status: number
3436
+
3437
+ /**
3438
+ * 任务类型
3439
+ 注意:此字段可能返回 null,表示取不到有效值。
3440
+ */
3441
+ Type: number
3442
+
3443
+ /**
3444
+ * 任务创建时间
3445
+ 注意:此字段可能返回 null,表示取不到有效值。
3446
+ */
3447
+ CreateTime: number
3448
+ }
3449
+
3450
+ /**
3451
+ * CreateTopicRule返回参数结构体
3452
+ */
3453
+ export interface CreateTopicRuleResponse {
3454
+ /**
3455
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3456
+ */
3457
+ RequestId?: string
3458
+ }
3459
+
3460
+ /**
3461
+ * ListLogPayload请求参数结构体
3462
+ */
3463
+ export interface ListLogPayloadRequest {
3464
+ /**
3465
+ * 日志开始时间,毫秒级时间戳
3466
+ */
3467
+ MinTime: number
3468
+
3469
+ /**
3470
+ * 日志结束时间,毫秒级时间戳
3471
+ */
3472
+ MaxTime: number
3473
+
3474
+ /**
3475
+ * 查询关键字,可以同时支持键值查询和文本查询,例如,查询某key的值为value,并且包含某word的日志,该参数为:key:value word。键值或文本可以包含多个,以空格隔开。其中可以索引的key比如:RequestID、ProductID、DeviceName等。
3476
+ 一个典型的查询示例:ProductID:ABCDE12345 DeviceName:test publish
3477
+ */
3478
+ Keywords: string
3479
+
3480
+ /**
3481
+ * 日志检索上下文
3482
+ */
3483
+ Context?: string
3484
+
3485
+ /**
3486
+ * 日志最大条数
3487
+ */
3488
+ MaxNum?: number
3489
+ }
3490
+
3491
+ /**
3492
+ * CreateTopicRule请求参数结构体
3493
+ */
3494
+ export interface CreateTopicRuleRequest {
3495
+ /**
3496
+ * 规则名称
3497
+ */
3498
+ RuleName: string
3499
+
3500
+ /**
3501
+ * 规则内容
3502
+ */
3503
+ TopicRulePayload: TopicRulePayload
3504
+ }
3505
+
3506
+ /**
3507
+ * DescribeResourceTasks返回参数结构体
3508
+ */
3509
+ export interface DescribeResourceTasksResponse {
3510
+ /**
3511
+ * 资源任务列表
3512
+ 注意:此字段可能返回 null,表示取不到有效值。
3513
+ */
3514
+ TaskInfos: Array<FirmwareTaskInfo>
3515
+
3516
+ /**
3517
+ * 资源任务总数
3518
+ 注意:此字段可能返回 null,表示取不到有效值。
3519
+ */
3520
+ Total: number
3521
+
3522
+ /**
3523
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3524
+ */
3525
+ RequestId?: string
3526
+ }
3527
+
3528
+ /**
3529
+ * DescribeFirmwareTaskStatistics请求参数结构体
3530
+ */
3531
+ export interface DescribeFirmwareTaskStatisticsRequest {
3532
+ /**
3533
+ * 产品ID
3534
+ */
3535
+ ProductId: string
3536
+
3537
+ /**
3538
+ * 固件版本号
3539
+ */
3540
+ FirmwareVersion: string
3541
+ }
3542
+
3543
+ /**
3544
+ * DeleteDevice返回参数结构体
3545
+ */
3546
+ export interface DeleteDeviceResponse {
3547
+ /**
3548
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3549
+ */
3550
+ RequestId?: string
3551
+ }
3552
+
3553
+ /**
3554
+ * DeletePrivateCA请求参数结构体
3555
+ */
3556
+ export interface DeletePrivateCARequest {
3557
+ /**
3558
+ * 私有CA证书名称
3559
+ */
3560
+ CertName: string
3561
+ }
3562
+
3563
+ /**
3564
+ * CreateTaskFileUrl返回参数结构体
3565
+ */
3566
+ export interface CreateTaskFileUrlResponse {
3567
+ /**
3568
+ * 任务文件上传链接
3569
+ */
3570
+ Url: string
3571
+
3572
+ /**
3573
+ * 任务文件名
3574
+ */
3575
+ FileName: string
3576
+
3577
+ /**
3578
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3579
+ */
3580
+ RequestId?: string
3581
+ }
3582
+
3583
+ /**
3584
+ * DescribeProductTasks返回参数结构体
3585
+ */
3586
+ export interface DescribeProductTasksResponse {
3587
+ /**
3588
+ * 符合条件的任务总个数
3589
+ */
3590
+ TotalCount: number
3591
+
3592
+ /**
3593
+ * 任务详细信息列表
3594
+ */
3595
+ TaskInfos: Array<ProductTaskInfo>
3596
+
3597
+ /**
3598
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3599
+ */
3600
+ RequestId?: string
3601
+ }
3602
+
3603
+ /**
3604
+ * EnableTopicRule请求参数结构体
3605
+ */
3606
+ export interface EnableTopicRuleRequest {
3607
+ /**
3608
+ * 规则名称
3609
+ */
3610
+ RuleName: string
3611
+ }
3612
+
3613
+ /**
3614
+ * 设备资源详细信息
3615
+ */
3616
+ export interface DeviceResourceInfo {
3617
+ /**
3618
+ * 产品ID
3619
+ */
3620
+ ProductID: string
3621
+
3622
+ /**
3623
+ * 产品名
3624
+ */
3625
+ ProductName: string
3626
+
3627
+ /**
3628
+ * 资源名称
3629
+ */
3630
+ Name: string
3631
+
3632
+ /**
3633
+ * 资源文件md5
3634
+ */
3635
+ Md5: string
3636
+
3637
+ /**
3638
+ * 资源文件大小
3639
+ */
3640
+ Size: number
3641
+
3642
+ /**
3643
+ * 资源更新时间
3644
+ */
3645
+ UpdateTime: string
3646
+
3647
+ /**
3648
+ * 设备名称
3649
+ */
3650
+ DeviceName: string
3651
+
3652
+ /**
3653
+ * 设备资源上传状态
3654
+ */
3655
+ Status: number
3656
+
3657
+ /**
3658
+ * 设备资源上传百分比
3659
+ */
3660
+ Percent: number
3661
+ }
3662
+
3663
+ /**
3664
+ * DescribeFirmwareTask请求参数结构体
3665
+ */
3666
+ export interface DescribeFirmwareTaskRequest {
3667
+ /**
3668
+ * 产品ID
3669
+ */
3670
+ ProductId: string
3671
+
3672
+ /**
3673
+ * 固件版本号
3674
+ */
3675
+ FirmwareVersion: string
3676
+
3677
+ /**
3678
+ * 固件任务ID
3679
+ */
3680
+ TaskId: number
3681
+ }