tencentcloud-sdk-nodejs-mqtt 4.0.1049 → 4.1.5

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.
@@ -17,6 +17,9 @@ export interface MQTTClientSubscription {
17
17
  TopicFilter?: string;
18
18
  /**
19
19
  * 服务质量等级
20
+ 0: 至多一次
21
+ 1: 至少一次
22
+ 2: 恰好一次
20
23
  */
21
24
  Qos?: number;
22
25
  /**
@@ -55,7 +58,7 @@ export interface ModifyJWTAuthenticatorResponse {
55
58
  */
56
59
  export interface CaCertificateItem {
57
60
  /**
58
- * common name
61
+ * 证书的公用名(Common Name)
59
62
  */
60
63
  CaCn?: string;
61
64
  /**
@@ -67,7 +70,7 @@ export interface CaCertificateItem {
67
70
  */
68
71
  CaSn?: string;
69
72
  /**
70
- * 证书格式
73
+ * 证书格式,当前仅支持 PEM 格式
71
74
  */
72
75
  Format?: string;
73
76
  /**
@@ -75,23 +78,27 @@ export interface CaCertificateItem {
75
78
  */
76
79
  VerificationCertificate?: string;
77
80
  /**
78
- * ca状态
81
+ * CA证书的状态
82
+ ACTIVE:激活
83
+ INACTIVE:未激活
84
+ REVOKED:吊销
85
+ PENDING_ACTIVATION:注册待激活
79
86
  */
80
87
  Status?: string;
81
88
  /**
82
- * 上次激活时间
89
+ * 上次激活时间,毫秒级时间戳 。
83
90
  */
84
91
  LastActivationTime?: number;
85
92
  /**
86
- * 创建时间
93
+ * 创建时间,毫秒级时间戳 。
87
94
  */
88
95
  CreatedTime?: number;
89
96
  /**
90
- * 预销毁时间
97
+ * 更新时间,毫秒级时间戳 。
91
98
  */
92
99
  UpdateTime?: number;
93
100
  /**
94
- * 上次去激活时间
101
+ * 上次去激活时间,毫秒级时间戳 。
95
102
  */
96
103
  LastInactivationTime?: number;
97
104
  /**
@@ -99,11 +106,11 @@ export interface CaCertificateItem {
99
106
  */
100
107
  CaIssuerCn?: string;
101
108
  /**
102
- * 生效时间
109
+ * 生效时间,毫秒级时间戳 。
103
110
  */
104
111
  NotBeforeTime?: number;
105
112
  /**
106
- * 失效时间
113
+ * 失效时间,毫秒级时间戳 。
107
114
  */
108
115
  NotAfterTime?: number;
109
116
  }
@@ -121,11 +128,11 @@ export interface ModifyAuthorizationPolicyResponse {
121
128
  */
122
129
  export interface ActivateDeviceCertificateRequest {
123
130
  /**
124
- * 集群id
131
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
125
132
  */
126
133
  InstanceId: string;
127
134
  /**
128
- * 设备证书序列号
135
+ * 设备证书的SN序列号,可以从 [DescribeDeviceCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
129
136
  */
130
137
  DeviceCertificateSn: string;
131
138
  }
@@ -147,7 +154,7 @@ export interface CreateInstanceResponse {
147
154
  */
148
155
  export interface ApplyRegistrationCodeRequest {
149
156
  /**
150
- * 集群id
157
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
151
158
  */
152
159
  InstanceId: string;
153
160
  }
@@ -224,7 +231,7 @@ export interface ModifyJWTAuthenticatorRequest {
224
231
  */
225
232
  export interface AuthorizationPolicyPriority {
226
233
  /**
227
- * 策略id
234
+ * 授权策略规则id,可以从 [DescribeAuthorizationPolicies](https://cloud.tencent.com/document/api/1778/111074)接口获得。
228
235
  */
229
236
  Id: number;
230
237
  /**
@@ -245,7 +252,7 @@ export interface DescribeInsPublicEndpointsResponse {
245
252
  */
246
253
  InstanceId?: string;
247
254
  /**
248
- * 带宽
255
+ * 带宽,单位Mbps
249
256
  */
250
257
  Bandwidth?: number;
251
258
  /**
@@ -363,11 +370,20 @@ export interface DescribeCaCertificateResponse {
363
370
  */
364
371
  export interface DescribeDeviceCertificatesRequest {
365
372
  /**
366
- * 集群ID
373
+ * 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
367
374
  */
368
375
  InstanceId: string;
369
376
  /**
370
- * 过滤器支持ClientId、CaSn、DeviceCertificateSn、Status搜索
377
+ * 支持搜索参数
378
+ ClientId:客户端id
379
+ CaSn:所属的CA证书SN
380
+ DeviceCertificateSn:设备证书SN
381
+ DeviceCertificateCn:设备证书CN
382
+ OrganizationalUnit:证书OU
383
+ NotAfterEnd:过期时间小于等于指定时间的证书
384
+ NotAfterStart:过期时间大于等于指定时间的证书
385
+ Status:证书状态
386
+
371
387
  */
372
388
  Filters?: Array<Filter>;
373
389
  /**
@@ -391,14 +407,14 @@ export interface DescribeDeviceCertificatesRequest {
391
407
  */
392
408
  export interface DeleteAuthenticatorRequest {
393
409
  /**
394
- * 实例ID
410
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
395
411
  */
396
412
  InstanceId: string;
397
413
  /**
398
414
  * 认证器类型:
399
415
  JWT:JWT认证器
400
416
  JWKS:JWKS认证器
401
- BYOC:一端一证认证器
417
+ HTTP:HTTP认证器
402
418
  */
403
419
  Type: string;
404
420
  }
@@ -580,23 +596,38 @@ export interface RegisterDeviceCertificateResponse {
580
596
  */
581
597
  export interface MQTTAuthenticatorItem {
582
598
  /**
583
- * 认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 BYOC:一端一证认证器
599
+ * 认证器类型
600
+ JWT:JWT认证器
601
+ JWKS:JWKS认证器
602
+ HTTP:HTTP认证器
584
603
  */
585
604
  Type?: string;
586
605
  /**
587
- * 认证器配置
606
+ * HTTP认证器
607
+ headers(请求头):标准请求头和自定义请求头
608
+ endpoint(接入点):认证服务器接入点
609
+ method(http请求方法):POST/GET
610
+ readTimeout(读超时时间):读取认证服务器数据超时时间,单位秒
611
+ connectTimeout(连接超时时间):连接认证服务器超时时间,单位秒
612
+ body(请求体):http请求体
613
+ concurrency(并发数):最大并发请求数
614
+ 样例:{"headers":[{"key":"Content-type","value":"application/json"},{"key":"username","value":"${Username}"}],"endpoint":"https://127.0.0.1:443","method":"POST","readTimeout":10,"connectTimeout":10,"body":[{"key":"client-id","value":"${ClientId}"}],"concurrency":8}
615
+
616
+ 参考 [认证管理概述](https://cloud.tencent.com/document/product/1778/114813)
588
617
  */
589
618
  Config?: string;
590
619
  /**
591
620
  * 认证器状态
621
+ open:认证器打开
622
+ close:认证器关闭
592
623
  */
593
624
  Status?: string;
594
625
  /**
595
- * 创建时间
626
+ * 创建时间,毫秒级时间戳 。
596
627
  */
597
628
  CreateTime?: number;
598
629
  /**
599
- * 说明
630
+ * 说明,最长 128 字符。
600
631
  */
601
632
  Remark?: string;
602
633
  }
@@ -677,8 +708,7 @@ export interface MQTTInstanceItem {
677
708
  */
678
709
  Version?: string;
679
710
  /**
680
- * 实例类型,
681
- EXPERIMENT,体验版
711
+ * 实例类型
682
712
  BASIC,基础版
683
713
  PRO,专业版
684
714
  PLATINUM,铂金版
@@ -719,7 +749,7 @@ export interface MQTTInstanceItem {
719
749
  */
720
750
  TpsLimit?: number;
721
751
  /**
722
- * 创建时间
752
+ * 创建时间,毫秒级时间戳
723
753
  */
724
754
  CreateTime?: number;
725
755
  /**
@@ -731,7 +761,9 @@ export interface MQTTInstanceItem {
731
761
  */
732
762
  ClientNumLimit?: number;
733
763
  /**
734
- * 是否自动续费
764
+ * 是否自动续费。仅包年包月就去那生效。
765
+ 1:自动续费
766
+ 0:非自动续费
735
767
  */
736
768
  RenewFlag?: number;
737
769
  /**
@@ -739,11 +771,11 @@ export interface MQTTInstanceItem {
739
771
  */
740
772
  PayMode?: string;
741
773
  /**
742
- * 到期时间,秒为单位
774
+ * 到期时间,毫秒级时间戳
743
775
  */
744
776
  ExpiryTime?: number;
745
777
  /**
746
- * 预销毁时间
778
+ * 预销毁时间,毫秒级时间戳
747
779
  */
748
780
  DestroyTime?: number;
749
781
  /**
@@ -981,11 +1013,11 @@ export interface DeactivateCaCertificateResponse {
981
1013
  */
982
1014
  export interface DeleteCaCertificateRequest {
983
1015
  /**
984
- * 集群id
1016
+ * 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
985
1017
  */
986
1018
  InstanceId: string;
987
1019
  /**
988
- * 证书序列号
1020
+ * 证书序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
989
1021
  */
990
1022
  CaSn: string;
991
1023
  }
@@ -1007,7 +1039,7 @@ export interface DeleteDeviceCertificateRequest {
1007
1039
  */
1008
1040
  export interface DescribeInsPublicEndpointsRequest {
1009
1041
  /**
1010
- * 实例ID
1042
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1011
1043
  */
1012
1044
  InstanceId: string;
1013
1045
  }
@@ -1160,15 +1192,15 @@ export interface DescribeAuthorizationPoliciesResponse {
1160
1192
  */
1161
1193
  export interface CreateTopicRequest {
1162
1194
  /**
1163
- * 实例ID
1195
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1164
1196
  */
1165
1197
  InstanceId: string;
1166
1198
  /**
1167
- * 主题
1199
+ * 主题,不能为空,只能包含字母、数字、“-”及“_”,3-100 字符。
1168
1200
  */
1169
1201
  Topic: string;
1170
1202
  /**
1171
- * 备注
1203
+ * 备注,最长 128 字符
1172
1204
  */
1173
1205
  Remark?: string;
1174
1206
  }
@@ -1246,11 +1278,11 @@ export interface MQTTUserItem {
1246
1278
  */
1247
1279
  Remark?: string;
1248
1280
  /**
1249
- * 创建时间,秒为单位
1281
+ * 创建时间,毫秒级时间戳 。
1250
1282
  */
1251
1283
  CreatedTime?: number;
1252
1284
  /**
1253
- * 修改时间,秒为单位
1285
+ * 修改时间,毫秒级时间戳 。
1254
1286
  */
1255
1287
  ModifiedTime?: number;
1256
1288
  }
@@ -1307,11 +1339,11 @@ export interface DescribeTopicRequest {
1307
1339
  */
1308
1340
  export interface PublishMessageRequest {
1309
1341
  /**
1310
- * 实例ID
1342
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1311
1343
  */
1312
1344
  InstanceId: string;
1313
1345
  /**
1314
- * 消息 payload,需要按 encoding 指定的编码方式进行编码
1346
+ * 消息负载 Payload,是消息的实际内容,需要按 encoding 指定的编码方式进行编码
1315
1347
  */
1316
1348
  Payload: string;
1317
1349
  /**
@@ -1328,6 +1360,9 @@ export interface PublishMessageRequest {
1328
1360
  Encoding?: string;
1329
1361
  /**
1330
1362
  * 消息的服务质量等级,默认为 1
1363
+ QoS 0(至多一次)消息发送后,不保证接收方一定收到,也不要求接收方确认。
1364
+ QoS 1(至少一次)消息至少被接收方成功接收一次,但可能重复。
1365
+ QoS 2(恰好一次)消息确保被接收方接收且仅接收一次,无重复。
1331
1366
  */
1332
1367
  Qos?: number;
1333
1368
  /**
@@ -1340,69 +1375,78 @@ export interface PublishMessageRequest {
1340
1375
  */
1341
1376
  export interface AuthorizationPolicyItem {
1342
1377
  /**
1343
- * 规则ID
1378
+ * 策略规则ID
1344
1379
  */
1345
1380
  Id?: number;
1346
1381
  /**
1347
- * 集群ID
1382
+ * MQTT集群ID
1348
1383
  */
1349
1384
  InstanceId?: string;
1350
1385
  /**
1351
- * 规则名
1386
+ * 策略规则名
1352
1387
  */
1353
1388
  PolicyName?: string;
1354
1389
  /**
1355
- * 规则语法版本
1390
+ * 规则语法版本,当前仅支持1,默认为1
1356
1391
  */
1357
1392
  Version?: number;
1358
1393
  /**
1359
- * 越小越优先
1394
+ * 策略优先级,优先级ID越小表示策略越优先检查生效。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
1360
1395
  */
1361
1396
  Priority?: number;
1362
1397
  /**
1363
- * allow/deny
1398
+ * 决策
1399
+ allow:允许符合该策略的设备的访问请求。
1400
+ deny:拒绝覆盖该策略的设备的访问请求。
1401
+ 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
1364
1402
  */
1365
1403
  Effect?: string;
1366
1404
  /**
1367
- * connect、pub、sub
1405
+ * 操作
1406
+ connect:连接
1407
+ pub:发布mqtt消息
1408
+ sub:订阅mqtt消息
1409
+ 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
1368
1410
  */
1369
1411
  Actions?: string;
1370
1412
  /**
1371
- * 资源
1413
+ * 资源,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
1372
1414
  */
1373
1415
  Resources?: string;
1374
1416
  /**
1375
- * client
1417
+ * 条件-连接设备ID,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
1376
1418
  */
1377
1419
  ClientId?: string;
1378
1420
  /**
1379
- * 用户
1421
+ * 条件-用户名,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
1422
+
1380
1423
  */
1381
1424
  Username?: string;
1382
1425
  /**
1383
- * IP地址
1426
+ * 条件-客户端IP地址,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
1384
1427
  */
1385
1428
  Ip?: string;
1386
1429
  /**
1387
- * 0,1,2
1430
+ * 条件-服务质量,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
1388
1431
  */
1389
1432
  Qos?: string;
1390
1433
  /**
1391
- * 1:表示匹配retain消息
1434
+ * 条件-保留消息,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
1435
+ 1:表示匹配retain消息
1392
1436
  2:表示匹配非retain消息
1393
1437
  3:表示匹配retain和非retain消息
1394
1438
  */
1395
1439
  Retain?: number;
1396
1440
  /**
1397
- * 描述
1441
+ * 备注,长度不超过128个字符。
1398
1442
  */
1399
1443
  Remark?: string;
1400
1444
  /**
1401
- * 1713164969433
1445
+ * 创建时间。毫秒级时间戳 。
1402
1446
  */
1403
1447
  CreatedTime?: number;
1404
1448
  /**
1405
- * 1713164969433
1449
+ * 更新时间。毫秒级时间戳 。
1406
1450
  */
1407
1451
  UpdateTime?: number;
1408
1452
  }
@@ -1411,7 +1455,7 @@ export interface AuthorizationPolicyItem {
1411
1455
  */
1412
1456
  export interface DescribeClientListRequest {
1413
1457
  /**
1414
- * 实例ID
1458
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1415
1459
  */
1416
1460
  InstanceId: string;
1417
1461
  /**
@@ -1470,7 +1514,7 @@ export interface MQTTEndpointItem {
1470
1514
  */
1471
1515
  export interface DescribeInsVPCEndpointsRequest {
1472
1516
  /**
1473
- * 实例ID
1517
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1474
1518
  */
1475
1519
  InstanceId: string;
1476
1520
  }
@@ -1479,7 +1523,7 @@ export interface DescribeInsVPCEndpointsRequest {
1479
1523
  */
1480
1524
  export interface DescribeTopicListRequest {
1481
1525
  /**
1482
- * 实例ID
1526
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1483
1527
  */
1484
1528
  InstanceId: string;
1485
1529
  /**
@@ -1488,11 +1532,11 @@ export interface DescribeTopicListRequest {
1488
1532
  */
1489
1533
  Filters?: Array<Filter>;
1490
1534
  /**
1491
- * 查询起始位置
1535
+ * 查询起始位置,默认0。
1492
1536
  */
1493
1537
  Offset?: number;
1494
1538
  /**
1495
- * 查询结果限制数量
1539
+ * 查询结果限制数量,默认0,最大20
1496
1540
  */
1497
1541
  Limit?: number;
1498
1542
  }
@@ -1540,11 +1584,14 @@ export interface CreateAuthorizationPolicyResponse {
1540
1584
  */
1541
1585
  export interface DescribeAuthenticatorRequest {
1542
1586
  /**
1543
- * 实例ID
1587
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1544
1588
  */
1545
1589
  InstanceId: string;
1546
1590
  /**
1547
- * 认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 HTTP:HTTP认证器
1591
+ * 认证器类型:
1592
+ JWT:JWT认证器
1593
+ JWKS:JWKS认证器
1594
+ HTTP:HTTP认证器
1548
1595
  */
1549
1596
  Type?: string;
1550
1597
  }
@@ -1696,11 +1743,11 @@ export interface Filter {
1696
1743
  */
1697
1744
  export interface DeactivateDeviceCertificateRequest {
1698
1745
  /**
1699
- * 集群id
1746
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1700
1747
  */
1701
1748
  InstanceId: string;
1702
1749
  /**
1703
- * 设备证书序列号
1750
+ * 设备证书的SN序列号,可以从 [DescribeDeviceCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、设备证书文件中获得。
1704
1751
  */
1705
1752
  DeviceCertificateSn: string;
1706
1753
  }
@@ -1726,15 +1773,15 @@ export interface DescribeDeviceCertificatesResponse {
1726
1773
  */
1727
1774
  export interface ModifyTopicRequest {
1728
1775
  /**
1729
- * 实例ID
1776
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1730
1777
  */
1731
1778
  InstanceId: string;
1732
1779
  /**
1733
- * 主题
1780
+ * 主题,不能为空,只能包含字母、数字、“-”及“_”,3-100 字符。
1734
1781
  */
1735
1782
  Topic: string;
1736
1783
  /**
1737
- * 备注信息
1784
+ * 备注信息,最长 128 字符
1738
1785
  */
1739
1786
  Remark?: string;
1740
1787
  }
@@ -1743,11 +1790,11 @@ export interface ModifyTopicRequest {
1743
1790
  */
1744
1791
  export interface CreateUserRequest {
1745
1792
  /**
1746
- * 实例ID
1793
+ * 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1747
1794
  */
1748
1795
  InstanceId: string;
1749
1796
  /**
1750
- * 用户名
1797
+ * 用户名,不能为空,只支持数字 大小写字母 分隔符("_","-"),不能超过 32 个字符
1751
1798
  */
1752
1799
  Username: string;
1753
1800
  /**
@@ -1755,7 +1802,7 @@ export interface CreateUserRequest {
1755
1802
  */
1756
1803
  Password?: string;
1757
1804
  /**
1758
- * 备注
1805
+ * 备注,长度不超过128个字符。
1759
1806
  */
1760
1807
  Remark?: string;
1761
1808
  }
@@ -1891,11 +1938,11 @@ export interface DescribeInsVPCEndpointsResponse {
1891
1938
  */
1892
1939
  export interface DescribeDeviceCertificateRequest {
1893
1940
  /**
1894
- * 设备证书sn
1941
+ * 设备证书的SN序列号,用于唯一标识一个设备证书。
1895
1942
  */
1896
1943
  DeviceCertificateSn: string;
1897
1944
  /**
1898
- * 集群id
1945
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1899
1946
  */
1900
1947
  InstanceId: string;
1901
1948
  }
@@ -1921,7 +1968,7 @@ export interface ModifyInsPublicEndpointRequest {
1921
1968
  */
1922
1969
  export interface DeleteInsPublicEndpointRequest {
1923
1970
  /**
1924
- * 实例ID
1971
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1925
1972
  */
1926
1973
  InstanceId: string;
1927
1974
  }
@@ -1930,20 +1977,20 @@ export interface DeleteInsPublicEndpointRequest {
1930
1977
  */
1931
1978
  export interface DescribeUserListRequest {
1932
1979
  /**
1933
- * 实例ID
1980
+ * 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1934
1981
  */
1935
1982
  InstanceId: string;
1936
1983
  /**
1937
1984
  * 查询条件列表支持字段
1938
- Username:Username模糊查询
1985
+ Username:按照【用户名】进行过滤,支持模糊过滤,类型:String
1939
1986
  */
1940
1987
  Filters?: Array<Filter>;
1941
1988
  /**
1942
- * 查询起始位置
1989
+ * 查询起始位置,默认值0
1943
1990
  */
1944
1991
  Offset?: number;
1945
1992
  /**
1946
- * 查询结果限制数量
1993
+ * 查询结果限制数量,默认值20,最大值100
1947
1994
  */
1948
1995
  Limit?: number;
1949
1996
  }
@@ -1965,7 +2012,7 @@ export interface DescribeCaCertificateRequest {
1965
2012
  */
1966
2013
  export interface UpdateAuthorizationPolicyPriorityRequest {
1967
2014
  /**
1968
- * 实例ID
2015
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1969
2016
  */
1970
2017
  InstanceId: string;
1971
2018
  /**
@@ -1987,11 +2034,11 @@ export interface CreateJWTAuthenticatorResponse {
1987
2034
  */
1988
2035
  export interface DeleteAuthorizationPolicyRequest {
1989
2036
  /**
1990
- * 实例ID
2037
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1991
2038
  */
1992
2039
  InstanceId: string;
1993
2040
  /**
1994
- * 策略规则id
2041
+ * 授权策略规则id,可以从 [DescribeAuthorizationPolicies](https://cloud.tencent.com/document/api/1778/111074)接口获得。
1995
2042
  */
1996
2043
  Id: number;
1997
2044
  }
@@ -2000,7 +2047,7 @@ export interface DeleteAuthorizationPolicyRequest {
2000
2047
  */
2001
2048
  export interface DescribeAuthorizationPoliciesRequest {
2002
2049
  /**
2003
- * 集群ID
2050
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2004
2051
  */
2005
2052
  InstanceId?: string;
2006
2053
  }
@@ -2084,27 +2131,31 @@ export interface DescribeTopicListResponse {
2084
2131
  */
2085
2132
  export interface DescribeDeviceCertificateResponse {
2086
2133
  /**
2087
- * 创建时间
2134
+ * 创建时间,毫秒级时间戳 。
2088
2135
  */
2089
2136
  CreatedTime?: number;
2090
2137
  /**
2091
- * 上次更新时间
2138
+ * 上次更新时间,毫秒级时间戳 。
2092
2139
  */
2093
2140
  UpdateTime?: number;
2094
2141
  /**
2095
- * 证书失效日期
2142
+ * 证书失效日期,毫秒级时间戳 。
2096
2143
  */
2097
2144
  NotAfterTime?: number;
2098
2145
  /**
2099
- * 上次激活时间
2146
+ * 上次激活时间,毫秒级时间戳 。
2100
2147
  */
2101
2148
  LastActivationTime?: number;
2102
2149
  /**
2103
- * 上次取消激活时间
2150
+ * 上次取消激活时间,毫秒级时间戳 。
2104
2151
  */
2105
2152
  LastInactivationTime?: number;
2106
2153
  /**
2107
- * 证书状态
2154
+ * 设备证书的状态
2155
+ ACTIVE:激活
2156
+ INACTIVE:未激活
2157
+ REVOKED:吊销
2158
+ PENDING_ACTIVATION:注册待激活
2108
2159
  */
2109
2160
  Status?: string;
2110
2161
  /**
@@ -2124,7 +2175,7 @@ export interface DescribeDeviceCertificateResponse {
2124
2175
  */
2125
2176
  DeviceCertificateCn?: string;
2126
2177
  /**
2127
- * 证书格式
2178
+ * 证书格式,当前仅支持PEM格式
2128
2179
  */
2129
2180
  Format?: string;
2130
2181
  /**
@@ -2132,12 +2183,13 @@ export interface DescribeDeviceCertificateResponse {
2132
2183
  */
2133
2184
  ClientId?: string;
2134
2185
  /**
2135
- * API, 手动注册
2136
- JITP 自动注册
2186
+ * 证书来源
2187
+ API:手动注册
2188
+ JITP:自动注册
2137
2189
  */
2138
2190
  CertificateSource?: string;
2139
2191
  /**
2140
- * 证书生效开始时间
2192
+ * 证书生效开始时间,毫秒级时间戳 。
2141
2193
  */
2142
2194
  NotBeforeTime?: number;
2143
2195
  /**
@@ -2154,18 +2206,18 @@ export interface DescribeDeviceCertificateResponse {
2154
2206
  */
2155
2207
  export interface DescribeInstanceListRequest {
2156
2208
  /**
2157
- * 查询条件列表,支持以下子弹
2209
+ * 查询条件列表,支持以下字段
2158
2210
  InstanceName:集群名模糊搜索
2159
2211
  InstanceId:集群id精确搜索
2160
- InstanceStatus:集群状态搜索
2212
+ InstanceStatus:集群状态搜索(RUNNING-运行中,CREATING-创建中,MODIFYING-变配中,DELETING-删除中)
2161
2213
  */
2162
2214
  Filters?: Array<Filter>;
2163
2215
  /**
2164
- * 查询起始位置
2216
+ * 查询起始位置,默认0
2165
2217
  */
2166
2218
  Offset?: number;
2167
2219
  /**
2168
- * 查询结果限制数量
2220
+ * 查询结果限制数量,默认20,最大100
2169
2221
  */
2170
2222
  Limit?: number;
2171
2223
  /**
@@ -2178,11 +2230,11 @@ export interface DescribeInstanceListRequest {
2178
2230
  */
2179
2231
  export interface DeactivateCaCertificateRequest {
2180
2232
  /**
2181
- * 集群id
2233
+ * 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2182
2234
  */
2183
2235
  InstanceId: string;
2184
2236
  /**
2185
- * 证书序列号
2237
+ * 证书序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
2186
2238
  */
2187
2239
  CaSn: string;
2188
2240
  }
@@ -2224,7 +2276,7 @@ export interface CreateJWTAuthenticatorRequest {
2224
2276
  */
2225
2277
  export interface DescribeCaCertificatesRequest {
2226
2278
  /**
2227
- * 集群ID
2279
+ * 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2228
2280
  */
2229
2281
  InstanceId: string;
2230
2282
  }
@@ -2304,7 +2356,7 @@ export interface DeviceCertificateItem {
2304
2356
  */
2305
2357
  export interface MQTTClientInfo {
2306
2358
  /**
2307
- * 客户端唯一标识
2359
+ * 客户端ID
2308
2360
  */
2309
2361
  ClientId?: string;
2310
2362
  /**
@@ -2312,7 +2364,10 @@ export interface MQTTClientInfo {
2312
2364
  */
2313
2365
  ClientAddress?: string;
2314
2366
  /**
2315
- * MQTT 协议版本,4 表示 MQTT 3.1.1
2367
+ * MQTT 协议版本
2368
+ 3:表示MQTT 3.1版本
2369
+ 4:表示 MQTT 3.1.1
2370
+ 5: 标识MQTT 5.0协议
2316
2371
  */
2317
2372
  ProtocolVersion?: number;
2318
2373
  /**
@@ -2324,15 +2379,15 @@ export interface MQTTClientInfo {
2324
2379
  */
2325
2380
  ConnectionStatus?: string;
2326
2381
  /**
2327
- * 客户端创建时间
2382
+ * 客户端创建时间,毫秒级时间戳 。
2328
2383
  */
2329
2384
  CreateTime?: number;
2330
2385
  /**
2331
- * 上次建立连接时间
2386
+ * 上次建立连接时间,毫秒级时间戳 。
2332
2387
  */
2333
2388
  ConnectTime?: number;
2334
2389
  /**
2335
- * 上次断开连接时间,仅对持久会话(cleanSession=false)并且客户端当前未连接时有意义
2390
+ * 上次断开连接时间,仅对持久会话(cleanSession=false)并且客户端当前未连接时有意义,毫秒级时间戳 。
2336
2391
  */
2337
2392
  DisconnectTime?: number;
2338
2393
  /**
@@ -2567,7 +2622,7 @@ export interface DescribeCaCertificatesResponse {
2567
2622
  */
2568
2623
  export interface ModifyUserRequest {
2569
2624
  /**
2570
- * 实例ID
2625
+ * 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2571
2626
  */
2572
2627
  InstanceId: string;
2573
2628
  /**
@@ -2575,7 +2630,7 @@ export interface ModifyUserRequest {
2575
2630
  */
2576
2631
  Username: string;
2577
2632
  /**
2578
- * 备注
2633
+ * 备注,长度不超过128个字符。
2579
2634
  */
2580
2635
  Remark?: string;
2581
2636
  }