tencentcloud-sdk-nodejs-mqtt 4.0.1046 → 4.0.1047

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-mqtt",
3
- "version": "4.0.1046",
3
+ "version": "4.0.1047",
4
4
  "description": "Tencent Cloud API NODEJS SDK",
5
5
  "main": "tencentcloud/index.js",
6
6
  "scripts": {
@@ -18,6 +18,7 @@
18
18
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common"
19
19
  import {
20
20
  UpdateAuthorizationPolicyPriorityResponse,
21
+ DescribeDeviceCertificatesResponse,
21
22
  DeleteUserRequest,
22
23
  ModifyJWTAuthenticatorResponse,
23
24
  CaCertificateItem,
@@ -25,9 +26,11 @@ import {
25
26
  ActivateDeviceCertificateRequest,
26
27
  CreateInstanceResponse,
27
28
  ApplyRegistrationCodeRequest,
29
+ DescribeMessageListRequest,
28
30
  ModifyJWTAuthenticatorRequest,
29
31
  AuthorizationPolicyPriority,
30
32
  DescribeInsPublicEndpointsResponse,
33
+ DescribeSharedSubscriptionLagResponse,
31
34
  DeleteTopicRequest,
32
35
  ModifyUserResponse,
33
36
  DescribeCaCertificateResponse,
@@ -43,12 +46,15 @@ import {
43
46
  ModifyInstanceRequest,
44
47
  RegisterDeviceCertificateResponse,
45
48
  MQTTAuthenticatorItem,
49
+ DescribeClientListResponse,
46
50
  Tag,
51
+ DescribeMessageListResponse,
47
52
  MQTTInstanceItem,
48
53
  DescribeInstanceListResponse,
49
54
  ApplyRegistrationCodeResponse,
50
55
  ModifyInstanceResponse,
51
56
  ModifyInsPublicEndpointResponse,
57
+ MQTTMessageItem,
52
58
  ModifyJWKSAuthenticatorResponse,
53
59
  CreateInsPublicEndpointResponse,
54
60
  CreateUserResponse,
@@ -80,6 +86,7 @@ import {
80
86
  DescribeTopicRequest,
81
87
  PublishMessageRequest,
82
88
  CreateTopicResponse,
89
+ DescribeClientListRequest,
83
90
  DeleteInsPublicEndpointResponse,
84
91
  MQTTEndpointItem,
85
92
  DescribeInsVPCEndpointsRequest,
@@ -94,7 +101,7 @@ import {
94
101
  RegisterDeviceCertificateRequest,
95
102
  Filter,
96
103
  DeactivateDeviceCertificateRequest,
97
- DescribeDeviceCertificatesResponse,
104
+ MQTTClientSubscription,
98
105
  ModifyTopicRequest,
99
106
  CreateUserRequest,
100
107
  DescribeInstanceResponse,
@@ -109,6 +116,7 @@ import {
109
116
  CreateJWTAuthenticatorResponse,
110
117
  DeleteAuthorizationPolicyRequest,
111
118
  DescribeAuthorizationPoliciesRequest,
119
+ RevokedDeviceCertificateResponse,
112
120
  DescribeProductSKUListRequest,
113
121
  DescribeTopicListResponse,
114
122
  DescribeDeviceCertificateResponse,
@@ -117,10 +125,11 @@ import {
117
125
  CreateJWTAuthenticatorRequest,
118
126
  DescribeCaCertificatesRequest,
119
127
  DeviceCertificateItem,
128
+ MQTTClientInfo,
120
129
  MQTTTopicItem,
121
130
  PriceTag,
122
131
  ModifyAuthorizationPolicyRequest,
123
- RevokedDeviceCertificateResponse,
132
+ DescribeSharedSubscriptionLagRequest,
124
133
  DeleteTopicResponse,
125
134
  ModifyInstanceCertBindingRequest,
126
135
  DescribeInstanceRequest,
@@ -342,6 +351,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
342
351
  return this.request("DescribeInsVPCEndpoints", req, cb)
343
352
  }
344
353
 
354
+ /**
355
+ * 查询 MQTT 客户端详情
356
+ */
357
+ async DescribeClientList(
358
+ req: DescribeClientListRequest,
359
+ cb?: (error: string, rep: DescribeClientListResponse) => void
360
+ ): Promise<DescribeClientListResponse> {
361
+ return this.request("DescribeClientList", req, cb)
362
+ }
363
+
345
364
  /**
346
365
  * 获取产品售卖规格
347
366
  */
@@ -580,6 +599,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
580
599
  return this.request("ActivateCaCertificate", req, cb)
581
600
  }
582
601
 
602
+ /**
603
+ * 查询消息列表,如查询死信,请设置ConsumerGroup参数
604
+ */
605
+ async DescribeMessageList(
606
+ req: DescribeMessageListRequest,
607
+ cb?: (error: string, rep: DescribeMessageListResponse) => void
608
+ ): Promise<DescribeMessageListResponse> {
609
+ return this.request("DescribeMessageList", req, cb)
610
+ }
611
+
583
612
  /**
584
613
  * 添加mqtt角色
585
614
  */
@@ -590,6 +619,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
590
619
  return this.request("CreateUser", req, cb)
591
620
  }
592
621
 
622
+ /**
623
+ * 查询共享订阅消息堆积量
624
+ */
625
+ async DescribeSharedSubscriptionLag(
626
+ req: DescribeSharedSubscriptionLagRequest,
627
+ cb?: (error: string, rep: DescribeSharedSubscriptionLagResponse) => void
628
+ ): Promise<DescribeSharedSubscriptionLagResponse> {
629
+ return this.request("DescribeSharedSubscriptionLag", req, cb)
630
+ }
631
+
593
632
  /**
594
633
  * 申请ca注册码
595
634
  */
@@ -25,6 +25,24 @@ export interface UpdateAuthorizationPolicyPriorityResponse {
25
25
  RequestId?: string
26
26
  }
27
27
 
28
+ /**
29
+ * DescribeDeviceCertificates返回参数结构体
30
+ */
31
+ export interface DescribeDeviceCertificatesResponse {
32
+ /**
33
+ * 总数
34
+ */
35
+ TotalCount?: number
36
+ /**
37
+ * 设备证书
38
+ */
39
+ Data?: Array<DeviceCertificateItem>
40
+ /**
41
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
42
+ */
43
+ RequestId?: string
44
+ }
45
+
28
46
  /**
29
47
  * DeleteUser请求参数结构体
30
48
  */
@@ -163,6 +181,40 @@ export interface ApplyRegistrationCodeRequest {
163
181
  InstanceId: string
164
182
  }
165
183
 
184
+ /**
185
+ * DescribeMessageList请求参数结构体
186
+ */
187
+ export interface DescribeMessageListRequest {
188
+ /**
189
+ * 实例ID
190
+ */
191
+ InstanceId: string
192
+ /**
193
+ * 主题
194
+ */
195
+ Topic: string
196
+ /**
197
+ * 开始时间
198
+ */
199
+ StartTime: number
200
+ /**
201
+ * 结束时间
202
+ */
203
+ EndTime: number
204
+ /**
205
+ * 请求任务id
206
+ */
207
+ TaskRequestId: string
208
+ /**
209
+ * 查询起始位置
210
+ */
211
+ Offset?: number
212
+ /**
213
+ * 查询结果限制数量
214
+ */
215
+ Limit?: number
216
+ }
217
+
166
218
  /**
167
219
  * ModifyJWTAuthenticator请求参数结构体
168
220
  */
@@ -250,6 +302,20 @@ export interface DescribeInsPublicEndpointsResponse {
250
302
  RequestId?: string
251
303
  }
252
304
 
305
+ /**
306
+ * DescribeSharedSubscriptionLag返回参数结构体
307
+ */
308
+ export interface DescribeSharedSubscriptionLagResponse {
309
+ /**
310
+ * 堆积值
311
+ */
312
+ Lag?: number
313
+ /**
314
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
315
+ */
316
+ RequestId?: string
317
+ }
318
+
253
319
  /**
254
320
  * DeleteTopic请求参数结构体
255
321
  */
@@ -604,6 +670,20 @@ export interface MQTTAuthenticatorItem {
604
670
  Remark?: string
605
671
  }
606
672
 
673
+ /**
674
+ * DescribeClientList返回参数结构体
675
+ */
676
+ export interface DescribeClientListResponse {
677
+ /**
678
+ * 客户端列表
679
+ */
680
+ Clients?: Array<MQTTClientInfo>
681
+ /**
682
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
683
+ */
684
+ RequestId?: string
685
+ }
686
+
607
687
  /**
608
688
  * 标签数据
609
689
  */
@@ -620,6 +700,30 @@ export interface Tag {
620
700
  TagValue: string
621
701
  }
622
702
 
703
+ /**
704
+ * DescribeMessageList返回参数结构体
705
+ */
706
+ export interface DescribeMessageListResponse {
707
+ /**
708
+ * 查询总数
709
+ 注意:此字段可能返回 null,表示取不到有效值。
710
+ */
711
+ TotalCount?: number
712
+ /**
713
+ * 消息记录列表
714
+ 注意:此字段可能返回 null,表示取不到有效值。
715
+ */
716
+ Data?: Array<MQTTMessageItem>
717
+ /**
718
+ * 请求任务id
719
+ */
720
+ TaskRequestId?: string
721
+ /**
722
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
723
+ */
724
+ RequestId?: string
725
+ }
726
+
623
727
  /**
624
728
  * MQTT 实例信息
625
729
  */
@@ -789,6 +893,57 @@ export interface ModifyInsPublicEndpointResponse {
789
893
  RequestId?: string
790
894
  }
791
895
 
896
+ /**
897
+ * 消息记录
898
+ */
899
+ export interface MQTTMessageItem {
900
+ /**
901
+ * 消息ID
902
+ 注意:此字段可能返回 null,表示取不到有效值。
903
+ */
904
+ MsgId?: string
905
+ /**
906
+ * 消息tag
907
+ 注意:此字段可能返回 null,表示取不到有效值。
908
+ */
909
+ Tags?: string
910
+ /**
911
+ * 消息key
912
+ 注意:此字段可能返回 null,表示取不到有效值。
913
+ */
914
+ Keys?: string
915
+ /**
916
+ * 客户端地址
917
+ 注意:此字段可能返回 null,表示取不到有效值。
918
+ */
919
+ ProducerAddr?: string
920
+ /**
921
+ * 消息发送时间
922
+ 注意:此字段可能返回 null,表示取不到有效值。
923
+ */
924
+ ProduceTime?: string
925
+ /**
926
+ * 死信重发次数
927
+ 注意:此字段可能返回 null,表示取不到有效值。
928
+ */
929
+ DeadLetterResendTimes?: number
930
+ /**
931
+ * 死信重发成功次数
932
+ 注意:此字段可能返回 null,表示取不到有效值。
933
+ */
934
+ DeadLetterResendSuccessTimes?: number
935
+ /**
936
+ * 子topic
937
+ 注意:此字段可能返回 null,表示取不到有效值。
938
+ */
939
+ SubTopic?: string
940
+ /**
941
+ * 消息质量等级
942
+ 注意:此字段可能返回 null,表示取不到有效值。
943
+ */
944
+ Qos?: string
945
+ }
946
+
792
947
  /**
793
948
  * ModifyJWKSAuthenticator返回参数结构体
794
949
  */
@@ -1292,6 +1447,24 @@ export interface CreateTopicResponse {
1292
1447
  RequestId?: string
1293
1448
  }
1294
1449
 
1450
+ /**
1451
+ * DescribeClientList请求参数结构体
1452
+ */
1453
+ export interface DescribeClientListRequest {
1454
+ /**
1455
+ * 实例ID
1456
+ */
1457
+ InstanceId: string
1458
+ /**
1459
+ * 客户端名
1460
+ */
1461
+ ClientId?: string
1462
+ /**
1463
+ * 客户端数量限制,最大1024,默认1024
1464
+ */
1465
+ Number?: string
1466
+ }
1467
+
1295
1468
  /**
1296
1469
  * DeleteInsPublicEndpoint返回参数结构体
1297
1470
  */
@@ -1661,21 +1834,25 @@ export interface DeactivateDeviceCertificateRequest {
1661
1834
  }
1662
1835
 
1663
1836
  /**
1664
- * DescribeDeviceCertificates返回参数结构体
1837
+ * MQTT 订阅关系
1665
1838
  */
1666
- export interface DescribeDeviceCertificatesResponse {
1839
+ export interface MQTTClientSubscription {
1667
1840
  /**
1668
- * 总数
1841
+ * topic 订阅
1669
1842
  */
1670
- TotalCount?: number
1843
+ TopicFilter?: string
1671
1844
  /**
1672
- * 设备证书
1845
+ * 服务质量等级
1673
1846
  */
1674
- Data?: Array<DeviceCertificateItem>
1847
+ Qos?: number
1675
1848
  /**
1676
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1849
+ * 堆积数量
1677
1850
  */
1678
- RequestId?: string
1851
+ Lag?: number
1852
+ /**
1853
+ * 投递未确认数量
1854
+ */
1855
+ Inflight?: number
1679
1856
  }
1680
1857
 
1681
1858
  /**
@@ -1975,6 +2152,16 @@ export interface DescribeAuthorizationPoliciesRequest {
1975
2152
  InstanceId?: string
1976
2153
  }
1977
2154
 
2155
+ /**
2156
+ * RevokedDeviceCertificate返回参数结构体
2157
+ */
2158
+ export interface RevokedDeviceCertificateResponse {
2159
+ /**
2160
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2161
+ */
2162
+ RequestId?: string
2163
+ }
2164
+
1978
2165
  /**
1979
2166
  * DescribeProductSKUList请求参数结构体
1980
2167
  */
@@ -2225,6 +2412,57 @@ JITP 自动注册
2225
2412
  NotBeforeTime?: number
2226
2413
  }
2227
2414
 
2415
+ /**
2416
+ * MQTT客户端信息
2417
+ */
2418
+ export interface MQTTClientInfo {
2419
+ /**
2420
+ * 客户端唯一标识
2421
+ 注意:此字段可能返回 null,表示取不到有效值。
2422
+ */
2423
+ ClientId?: string
2424
+ /**
2425
+ * 客户端网络地址
2426
+ 注意:此字段可能返回 null,表示取不到有效值。
2427
+ */
2428
+ ClientAddress?: string
2429
+ /**
2430
+ * MQTT 协议版本,4 表示 MQTT 3.1.1
2431
+ 注意:此字段可能返回 null,表示取不到有效值。
2432
+ */
2433
+ ProtocolVersion?: number
2434
+ /**
2435
+ * 保持连接时间,单位:秒
2436
+ 注意:此字段可能返回 null,表示取不到有效值。
2437
+ */
2438
+ Keepalive?: number
2439
+ /**
2440
+ * 连接状态,CONNECTED 已连接,DISCONNECTED 未连接
2441
+ 注意:此字段可能返回 null,表示取不到有效值。
2442
+ */
2443
+ ConnectionStatus?: string
2444
+ /**
2445
+ * 客户端创建时间
2446
+ 注意:此字段可能返回 null,表示取不到有效值。
2447
+ */
2448
+ CreateTime?: number
2449
+ /**
2450
+ * 上次建立连接时间
2451
+ 注意:此字段可能返回 null,表示取不到有效值。
2452
+ */
2453
+ ConnectTime?: number
2454
+ /**
2455
+ * 上次断开连接时间,仅对持久会话(cleanSession=false)并且客户端当前未连接时有意义
2456
+ 注意:此字段可能返回 null,表示取不到有效值。
2457
+ */
2458
+ DisconnectTime?: number
2459
+ /**
2460
+ * 客户端的订阅列表
2461
+ 注意:此字段可能返回 null,表示取不到有效值。
2462
+ */
2463
+ MQTTClientSubscriptions?: Array<MQTTClientSubscription>
2464
+ }
2465
+
2228
2466
  /**
2229
2467
  * MQTT 主题详情
2230
2468
  */
@@ -2330,13 +2568,17 @@ export interface ModifyAuthorizationPolicyRequest {
2330
2568
  }
2331
2569
 
2332
2570
  /**
2333
- * RevokedDeviceCertificate返回参数结构体
2571
+ * DescribeSharedSubscriptionLag请求参数结构体
2334
2572
  */
2335
- export interface RevokedDeviceCertificateResponse {
2573
+ export interface DescribeSharedSubscriptionLagRequest {
2336
2574
  /**
2337
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2575
+ * 集群id
2338
2576
  */
2339
- RequestId?: string
2577
+ InstanceId: string
2578
+ /**
2579
+ * 共享订阅表达式
2580
+ */
2581
+ SharedSubscription: string
2340
2582
  }
2341
2583
 
2342
2584
  /**
@@ -1,5 +1,5 @@
1
1
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
2
- import { UpdateAuthorizationPolicyPriorityResponse, DeleteUserRequest, ModifyJWTAuthenticatorResponse, ModifyAuthorizationPolicyResponse, ActivateDeviceCertificateRequest, CreateInstanceResponse, ApplyRegistrationCodeRequest, ModifyJWTAuthenticatorRequest, DescribeInsPublicEndpointsResponse, DeleteTopicRequest, ModifyUserResponse, DescribeCaCertificateResponse, DescribeDeviceCertificatesRequest, DeleteAuthenticatorRequest, DeleteAuthorizationPolicyResponse, ModifyJWKSAuthenticatorRequest, RegisterCaCertificateResponse, DeleteInstanceRequest, ModifyInstanceRequest, RegisterDeviceCertificateResponse, DescribeInstanceListResponse, ApplyRegistrationCodeResponse, ModifyInstanceResponse, ModifyInsPublicEndpointResponse, ModifyJWKSAuthenticatorResponse, CreateInsPublicEndpointResponse, CreateUserResponse, CreateAuthorizationPolicyRequest, PublishMessageResponse, DescribeAuthenticatorResponse, DeactivateCaCertificateResponse, DeleteCaCertificateRequest, DeleteDeviceCertificateRequest, DescribeInsPublicEndpointsRequest, DeleteUserResponse, ActivateCaCertificateResponse, DeleteDeviceCertificateResponse, DeleteInstanceResponse, DescribeProductSKUListResponse, CreateJWKSAuthenticatorRequest, DescribeTopicResponse, CreateJWKSAuthenticatorResponse, DescribeAuthorizationPoliciesResponse, CreateTopicRequest, DeleteCaCertificateResponse, DescribeUserListResponse, ModifyTopicResponse, DeactivateDeviceCertificateResponse, ActivateCaCertificateRequest, ActivateDeviceCertificateResponse, DescribeTopicRequest, PublishMessageRequest, CreateTopicResponse, DeleteInsPublicEndpointResponse, DescribeInsVPCEndpointsRequest, DescribeTopicListRequest, RevokedDeviceCertificateRequest, CreateAuthorizationPolicyResponse, DescribeAuthenticatorRequest, RegisterCaCertificateRequest, CreateInstanceRequest, CreateInsPublicEndpointRequest, RegisterDeviceCertificateRequest, DeactivateDeviceCertificateRequest, DescribeDeviceCertificatesResponse, ModifyTopicRequest, CreateUserRequest, DescribeInstanceResponse, ModifyInstanceCertBindingResponse, DescribeInsVPCEndpointsResponse, DescribeDeviceCertificateRequest, ModifyInsPublicEndpointRequest, DeleteInsPublicEndpointRequest, DescribeUserListRequest, DescribeCaCertificateRequest, UpdateAuthorizationPolicyPriorityRequest, CreateJWTAuthenticatorResponse, DeleteAuthorizationPolicyRequest, DescribeAuthorizationPoliciesRequest, DescribeProductSKUListRequest, DescribeTopicListResponse, DescribeDeviceCertificateResponse, DescribeInstanceListRequest, DeactivateCaCertificateRequest, CreateJWTAuthenticatorRequest, DescribeCaCertificatesRequest, ModifyAuthorizationPolicyRequest, RevokedDeviceCertificateResponse, DeleteTopicResponse, ModifyInstanceCertBindingRequest, DescribeInstanceRequest, DescribeCaCertificatesResponse, ModifyUserRequest, DeleteAuthenticatorResponse } from "./mqtt_models";
2
+ import { UpdateAuthorizationPolicyPriorityResponse, DescribeDeviceCertificatesResponse, DeleteUserRequest, ModifyJWTAuthenticatorResponse, ModifyAuthorizationPolicyResponse, ActivateDeviceCertificateRequest, CreateInstanceResponse, ApplyRegistrationCodeRequest, DescribeMessageListRequest, ModifyJWTAuthenticatorRequest, DescribeInsPublicEndpointsResponse, DescribeSharedSubscriptionLagResponse, DeleteTopicRequest, ModifyUserResponse, DescribeCaCertificateResponse, DescribeDeviceCertificatesRequest, DeleteAuthenticatorRequest, DeleteAuthorizationPolicyResponse, ModifyJWKSAuthenticatorRequest, RegisterCaCertificateResponse, DeleteInstanceRequest, ModifyInstanceRequest, RegisterDeviceCertificateResponse, DescribeClientListResponse, DescribeMessageListResponse, DescribeInstanceListResponse, ApplyRegistrationCodeResponse, ModifyInstanceResponse, ModifyInsPublicEndpointResponse, ModifyJWKSAuthenticatorResponse, CreateInsPublicEndpointResponse, CreateUserResponse, CreateAuthorizationPolicyRequest, PublishMessageResponse, DescribeAuthenticatorResponse, DeactivateCaCertificateResponse, DeleteCaCertificateRequest, DeleteDeviceCertificateRequest, DescribeInsPublicEndpointsRequest, DeleteUserResponse, ActivateCaCertificateResponse, DeleteDeviceCertificateResponse, DeleteInstanceResponse, DescribeProductSKUListResponse, CreateJWKSAuthenticatorRequest, DescribeTopicResponse, CreateJWKSAuthenticatorResponse, DescribeAuthorizationPoliciesResponse, CreateTopicRequest, DeleteCaCertificateResponse, DescribeUserListResponse, ModifyTopicResponse, DeactivateDeviceCertificateResponse, ActivateCaCertificateRequest, ActivateDeviceCertificateResponse, DescribeTopicRequest, PublishMessageRequest, CreateTopicResponse, DescribeClientListRequest, DeleteInsPublicEndpointResponse, DescribeInsVPCEndpointsRequest, DescribeTopicListRequest, RevokedDeviceCertificateRequest, CreateAuthorizationPolicyResponse, DescribeAuthenticatorRequest, RegisterCaCertificateRequest, CreateInstanceRequest, CreateInsPublicEndpointRequest, RegisterDeviceCertificateRequest, DeactivateDeviceCertificateRequest, ModifyTopicRequest, CreateUserRequest, DescribeInstanceResponse, ModifyInstanceCertBindingResponse, DescribeInsVPCEndpointsResponse, DescribeDeviceCertificateRequest, ModifyInsPublicEndpointRequest, DeleteInsPublicEndpointRequest, DescribeUserListRequest, DescribeCaCertificateRequest, UpdateAuthorizationPolicyPriorityRequest, CreateJWTAuthenticatorResponse, DeleteAuthorizationPolicyRequest, DescribeAuthorizationPoliciesRequest, RevokedDeviceCertificateResponse, DescribeProductSKUListRequest, DescribeTopicListResponse, DescribeDeviceCertificateResponse, DescribeInstanceListRequest, DeactivateCaCertificateRequest, CreateJWTAuthenticatorRequest, DescribeCaCertificatesRequest, ModifyAuthorizationPolicyRequest, DescribeSharedSubscriptionLagRequest, DeleteTopicResponse, ModifyInstanceCertBindingRequest, DescribeInstanceRequest, DescribeCaCertificatesResponse, ModifyUserRequest, DeleteAuthenticatorResponse } from "./mqtt_models";
3
3
  /**
4
4
  * mqtt client
5
5
  * @class
@@ -89,6 +89,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
89
89
  * 查询MQTT实例公网接入点
90
90
  */
91
91
  DescribeInsVPCEndpoints(req: DescribeInsVPCEndpointsRequest, cb?: (error: string, rep: DescribeInsVPCEndpointsResponse) => void): Promise<DescribeInsVPCEndpointsResponse>;
92
+ /**
93
+ * 查询 MQTT 客户端详情
94
+ */
95
+ DescribeClientList(req: DescribeClientListRequest, cb?: (error: string, rep: DescribeClientListResponse) => void): Promise<DescribeClientListResponse>;
92
96
  /**
93
97
  * 获取产品售卖规格
94
98
  */
@@ -189,10 +193,18 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
189
193
  * 激活Ca证书
190
194
  */
191
195
  ActivateCaCertificate(req: ActivateCaCertificateRequest, cb?: (error: string, rep: ActivateCaCertificateResponse) => void): Promise<ActivateCaCertificateResponse>;
196
+ /**
197
+ * 查询消息列表,如查询死信,请设置ConsumerGroup参数
198
+ */
199
+ DescribeMessageList(req: DescribeMessageListRequest, cb?: (error: string, rep: DescribeMessageListResponse) => void): Promise<DescribeMessageListResponse>;
192
200
  /**
193
201
  * 添加mqtt角色
194
202
  */
195
203
  CreateUser(req: CreateUserRequest, cb?: (error: string, rep: CreateUserResponse) => void): Promise<CreateUserResponse>;
204
+ /**
205
+ * 查询共享订阅消息堆积量
206
+ */
207
+ DescribeSharedSubscriptionLag(req: DescribeSharedSubscriptionLagRequest, cb?: (error: string, rep: DescribeSharedSubscriptionLagResponse) => void): Promise<DescribeSharedSubscriptionLagResponse>;
196
208
  /**
197
209
  * 申请ca注册码
198
210
  */
@@ -150,6 +150,12 @@ class Client extends TencentCloudCommon.AbstractClient {
150
150
  async DescribeInsVPCEndpoints(req, cb) {
151
151
  return this.request("DescribeInsVPCEndpoints", req, cb);
152
152
  }
153
+ /**
154
+ * 查询 MQTT 客户端详情
155
+ */
156
+ async DescribeClientList(req, cb) {
157
+ return this.request("DescribeClientList", req, cb);
158
+ }
153
159
  /**
154
160
  * 获取产品售卖规格
155
161
  */
@@ -296,12 +302,24 @@ class Client extends TencentCloudCommon.AbstractClient {
296
302
  async ActivateCaCertificate(req, cb) {
297
303
  return this.request("ActivateCaCertificate", req, cb);
298
304
  }
305
+ /**
306
+ * 查询消息列表,如查询死信,请设置ConsumerGroup参数
307
+ */
308
+ async DescribeMessageList(req, cb) {
309
+ return this.request("DescribeMessageList", req, cb);
310
+ }
299
311
  /**
300
312
  * 添加mqtt角色
301
313
  */
302
314
  async CreateUser(req, cb) {
303
315
  return this.request("CreateUser", req, cb);
304
316
  }
317
+ /**
318
+ * 查询共享订阅消息堆积量
319
+ */
320
+ async DescribeSharedSubscriptionLag(req, cb) {
321
+ return this.request("DescribeSharedSubscriptionLag", req, cb);
322
+ }
305
323
  /**
306
324
  * 申请ca注册码
307
325
  */
@@ -7,6 +7,23 @@ export interface UpdateAuthorizationPolicyPriorityResponse {
7
7
  */
8
8
  RequestId?: string;
9
9
  }
10
+ /**
11
+ * DescribeDeviceCertificates返回参数结构体
12
+ */
13
+ export interface DescribeDeviceCertificatesResponse {
14
+ /**
15
+ * 总数
16
+ */
17
+ TotalCount?: number;
18
+ /**
19
+ * 设备证书
20
+ */
21
+ Data?: Array<DeviceCertificateItem>;
22
+ /**
23
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
24
+ */
25
+ RequestId?: string;
26
+ }
10
27
  /**
11
28
  * DeleteUser请求参数结构体
12
29
  */
@@ -138,6 +155,39 @@ export interface ApplyRegistrationCodeRequest {
138
155
  */
139
156
  InstanceId: string;
140
157
  }
158
+ /**
159
+ * DescribeMessageList请求参数结构体
160
+ */
161
+ export interface DescribeMessageListRequest {
162
+ /**
163
+ * 实例ID
164
+ */
165
+ InstanceId: string;
166
+ /**
167
+ * 主题
168
+ */
169
+ Topic: string;
170
+ /**
171
+ * 开始时间
172
+ */
173
+ StartTime: number;
174
+ /**
175
+ * 结束时间
176
+ */
177
+ EndTime: number;
178
+ /**
179
+ * 请求任务id
180
+ */
181
+ TaskRequestId: string;
182
+ /**
183
+ * 查询起始位置
184
+ */
185
+ Offset?: number;
186
+ /**
187
+ * 查询结果限制数量
188
+ */
189
+ Limit?: number;
190
+ }
141
191
  /**
142
192
  * ModifyJWTAuthenticator请求参数结构体
143
193
  */
@@ -222,6 +272,19 @@ export interface DescribeInsPublicEndpointsResponse {
222
272
  */
223
273
  RequestId?: string;
224
274
  }
275
+ /**
276
+ * DescribeSharedSubscriptionLag返回参数结构体
277
+ */
278
+ export interface DescribeSharedSubscriptionLagResponse {
279
+ /**
280
+ * 堆积值
281
+ */
282
+ Lag?: number;
283
+ /**
284
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
285
+ */
286
+ RequestId?: string;
287
+ }
225
288
  /**
226
289
  * DeleteTopic请求参数结构体
227
290
  */
@@ -561,6 +624,19 @@ export interface MQTTAuthenticatorItem {
561
624
  */
562
625
  Remark?: string;
563
626
  }
627
+ /**
628
+ * DescribeClientList返回参数结构体
629
+ */
630
+ export interface DescribeClientListResponse {
631
+ /**
632
+ * 客户端列表
633
+ */
634
+ Clients?: Array<MQTTClientInfo>;
635
+ /**
636
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
637
+ */
638
+ RequestId?: string;
639
+ }
564
640
  /**
565
641
  * 标签数据
566
642
  */
@@ -576,6 +652,29 @@ export interface Tag {
576
652
  */
577
653
  TagValue: string;
578
654
  }
655
+ /**
656
+ * DescribeMessageList返回参数结构体
657
+ */
658
+ export interface DescribeMessageListResponse {
659
+ /**
660
+ * 查询总数
661
+ 注意:此字段可能返回 null,表示取不到有效值。
662
+ */
663
+ TotalCount?: number;
664
+ /**
665
+ * 消息记录列表
666
+ 注意:此字段可能返回 null,表示取不到有效值。
667
+ */
668
+ Data?: Array<MQTTMessageItem>;
669
+ /**
670
+ * 请求任务id
671
+ */
672
+ TaskRequestId?: string;
673
+ /**
674
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
675
+ */
676
+ RequestId?: string;
677
+ }
579
678
  /**
580
679
  * MQTT 实例信息
581
680
  */
@@ -740,6 +839,56 @@ export interface ModifyInsPublicEndpointResponse {
740
839
  */
741
840
  RequestId?: string;
742
841
  }
842
+ /**
843
+ * 消息记录
844
+ */
845
+ export interface MQTTMessageItem {
846
+ /**
847
+ * 消息ID
848
+ 注意:此字段可能返回 null,表示取不到有效值。
849
+ */
850
+ MsgId?: string;
851
+ /**
852
+ * 消息tag
853
+ 注意:此字段可能返回 null,表示取不到有效值。
854
+ */
855
+ Tags?: string;
856
+ /**
857
+ * 消息key
858
+ 注意:此字段可能返回 null,表示取不到有效值。
859
+ */
860
+ Keys?: string;
861
+ /**
862
+ * 客户端地址
863
+ 注意:此字段可能返回 null,表示取不到有效值。
864
+ */
865
+ ProducerAddr?: string;
866
+ /**
867
+ * 消息发送时间
868
+ 注意:此字段可能返回 null,表示取不到有效值。
869
+ */
870
+ ProduceTime?: string;
871
+ /**
872
+ * 死信重发次数
873
+ 注意:此字段可能返回 null,表示取不到有效值。
874
+ */
875
+ DeadLetterResendTimes?: number;
876
+ /**
877
+ * 死信重发成功次数
878
+ 注意:此字段可能返回 null,表示取不到有效值。
879
+ */
880
+ DeadLetterResendSuccessTimes?: number;
881
+ /**
882
+ * 子topic
883
+ 注意:此字段可能返回 null,表示取不到有效值。
884
+ */
885
+ SubTopic?: string;
886
+ /**
887
+ * 消息质量等级
888
+ 注意:此字段可能返回 null,表示取不到有效值。
889
+ */
890
+ Qos?: string;
891
+ }
743
892
  /**
744
893
  * ModifyJWKSAuthenticator返回参数结构体
745
894
  */
@@ -1212,6 +1361,23 @@ export interface CreateTopicResponse {
1212
1361
  */
1213
1362
  RequestId?: string;
1214
1363
  }
1364
+ /**
1365
+ * DescribeClientList请求参数结构体
1366
+ */
1367
+ export interface DescribeClientListRequest {
1368
+ /**
1369
+ * 实例ID
1370
+ */
1371
+ InstanceId: string;
1372
+ /**
1373
+ * 客户端名
1374
+ */
1375
+ ClientId?: string;
1376
+ /**
1377
+ * 客户端数量限制,最大1024,默认1024
1378
+ */
1379
+ Number?: string;
1380
+ }
1215
1381
  /**
1216
1382
  * DeleteInsPublicEndpoint返回参数结构体
1217
1383
  */
@@ -1567,21 +1733,25 @@ export interface DeactivateDeviceCertificateRequest {
1567
1733
  DeviceCertificateSn: string;
1568
1734
  }
1569
1735
  /**
1570
- * DescribeDeviceCertificates返回参数结构体
1736
+ * MQTT 订阅关系
1571
1737
  */
1572
- export interface DescribeDeviceCertificatesResponse {
1738
+ export interface MQTTClientSubscription {
1573
1739
  /**
1574
- * 总数
1740
+ * topic 订阅
1575
1741
  */
1576
- TotalCount?: number;
1742
+ TopicFilter?: string;
1577
1743
  /**
1578
- * 设备证书
1744
+ * 服务质量等级
1579
1745
  */
1580
- Data?: Array<DeviceCertificateItem>;
1746
+ Qos?: number;
1581
1747
  /**
1582
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1748
+ * 堆积数量
1583
1749
  */
1584
- RequestId?: string;
1750
+ Lag?: number;
1751
+ /**
1752
+ * 投递未确认数量
1753
+ */
1754
+ Inflight?: number;
1585
1755
  }
1586
1756
  /**
1587
1757
  * ModifyTopic请求参数结构体
@@ -1866,6 +2036,15 @@ export interface DescribeAuthorizationPoliciesRequest {
1866
2036
  */
1867
2037
  InstanceId?: string;
1868
2038
  }
2039
+ /**
2040
+ * RevokedDeviceCertificate返回参数结构体
2041
+ */
2042
+ export interface RevokedDeviceCertificateResponse {
2043
+ /**
2044
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2045
+ */
2046
+ RequestId?: string;
2047
+ }
1869
2048
  /**
1870
2049
  * DescribeProductSKUList请求参数结构体
1871
2050
  */
@@ -2108,6 +2287,56 @@ export interface DeviceCertificateItem {
2108
2287
  */
2109
2288
  NotBeforeTime?: number;
2110
2289
  }
2290
+ /**
2291
+ * MQTT客户端信息
2292
+ */
2293
+ export interface MQTTClientInfo {
2294
+ /**
2295
+ * 客户端唯一标识
2296
+ 注意:此字段可能返回 null,表示取不到有效值。
2297
+ */
2298
+ ClientId?: string;
2299
+ /**
2300
+ * 客户端网络地址
2301
+ 注意:此字段可能返回 null,表示取不到有效值。
2302
+ */
2303
+ ClientAddress?: string;
2304
+ /**
2305
+ * MQTT 协议版本,4 表示 MQTT 3.1.1
2306
+ 注意:此字段可能返回 null,表示取不到有效值。
2307
+ */
2308
+ ProtocolVersion?: number;
2309
+ /**
2310
+ * 保持连接时间,单位:秒
2311
+ 注意:此字段可能返回 null,表示取不到有效值。
2312
+ */
2313
+ Keepalive?: number;
2314
+ /**
2315
+ * 连接状态,CONNECTED 已连接,DISCONNECTED 未连接
2316
+ 注意:此字段可能返回 null,表示取不到有效值。
2317
+ */
2318
+ ConnectionStatus?: string;
2319
+ /**
2320
+ * 客户端创建时间
2321
+ 注意:此字段可能返回 null,表示取不到有效值。
2322
+ */
2323
+ CreateTime?: number;
2324
+ /**
2325
+ * 上次建立连接时间
2326
+ 注意:此字段可能返回 null,表示取不到有效值。
2327
+ */
2328
+ ConnectTime?: number;
2329
+ /**
2330
+ * 上次断开连接时间,仅对持久会话(cleanSession=false)并且客户端当前未连接时有意义
2331
+ 注意:此字段可能返回 null,表示取不到有效值。
2332
+ */
2333
+ DisconnectTime?: number;
2334
+ /**
2335
+ * 客户端的订阅列表
2336
+ 注意:此字段可能返回 null,表示取不到有效值。
2337
+ */
2338
+ MQTTClientSubscriptions?: Array<MQTTClientSubscription>;
2339
+ }
2111
2340
  /**
2112
2341
  * MQTT 主题详情
2113
2342
  */
@@ -2210,13 +2439,17 @@ export interface ModifyAuthorizationPolicyRequest {
2210
2439
  Remark?: string;
2211
2440
  }
2212
2441
  /**
2213
- * RevokedDeviceCertificate返回参数结构体
2442
+ * DescribeSharedSubscriptionLag请求参数结构体
2214
2443
  */
2215
- export interface RevokedDeviceCertificateResponse {
2444
+ export interface DescribeSharedSubscriptionLagRequest {
2216
2445
  /**
2217
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2446
+ * 集群id
2218
2447
  */
2219
- RequestId?: string;
2448
+ InstanceId: string;
2449
+ /**
2450
+ * 共享订阅表达式
2451
+ */
2452
+ SharedSubscription: string;
2220
2453
  }
2221
2454
  /**
2222
2455
  * DeleteTopic返回参数结构体