tencentcloud-sdk-nodejs-mqtt 4.0.966 → 4.0.987

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.
@@ -123,6 +123,81 @@ export interface AuthorizationPolicyItem {
123
123
  UpdateTime?: number
124
124
  }
125
125
 
126
+ /**
127
+ * 设备证书信息
128
+ */
129
+ export interface DeviceCertificateItem {
130
+ /**
131
+ * 客户端id
132
+ 注意:此字段可能返回 null,表示取不到有效值。
133
+ */
134
+ ClientId?: string
135
+ /**
136
+ * 设备证书
137
+ */
138
+ DeviceCertificate?: string
139
+ /**
140
+ * 设备证书Sn
141
+ */
142
+ DeviceCertificateSn?: string
143
+ /**
144
+ * 设备证书Cn
145
+ */
146
+ DeviceCertificateCn?: string
147
+ /**
148
+ * 签发ca的序列号
149
+ */
150
+ CaSn?: string
151
+ /**
152
+ * 证书格式
153
+ */
154
+ Format?: string
155
+ /**
156
+ * 证书状态
157
+ ACTIVE,//激活
158
+ INACTIVE,//未激活
159
+ REVOKED,//吊销
160
+ PENDING_ACTIVATION,//注册待激活
161
+ */
162
+ Status?: string
163
+ /**
164
+ * 上次激活时间
165
+ 注意:此字段可能返回 null,表示取不到有效值。
166
+ */
167
+ LastActivationTime?: number
168
+ /**
169
+ * 上次取消激活时间
170
+ 注意:此字段可能返回 null,表示取不到有效值。
171
+ */
172
+ LastInactivationTime?: number
173
+ /**
174
+ * 创建时间
175
+ */
176
+ CreatedTime?: number
177
+ /**
178
+ * 预销毁时间
179
+ 注意:此字段可能返回 null,表示取不到有效值。
180
+ */
181
+ UpdateTime?: number
182
+ /**
183
+ * 证书来源:
184
+ API, 手动注册
185
+ JITP 自动注册
186
+ 注意:此字段可能返回 null,表示取不到有效值。
187
+ */
188
+ CertificateSource?: string
189
+ /**
190
+ * 证书失效日期
191
+ 注意:此字段可能返回 null,表示取不到有效值。
192
+ */
193
+ NotAfterTime?: number
194
+ /**
195
+ * 证书生效开始日期
196
+ 注意:此字段可能返回 null,表示取不到有效值。
197
+ */
198
+ NotBeforeTime?: number
199
+ }
200
+
126
201
  /**
127
202
  * CreateJWTAuthenticator返回参数结构体
128
203
  */
@@ -196,7 +271,8 @@ export interface DescribeTopicListRequest {
196
271
  */
197
272
  InstanceId: string
198
273
  /**
199
- * 查询条件列表
274
+ * 查询条件列表:
275
+ 支持TopicName模糊查询
200
276
  */
201
277
  Filters?: Array<Filter>
202
278
  /**
@@ -214,7 +290,10 @@ export interface DescribeTopicListRequest {
214
290
  */
215
291
  export interface DescribeInstanceListRequest {
216
292
  /**
217
- * 查询条件列表
293
+ * 查询条件列表,支持以下子弹
294
+ InstanceName:集群名模糊搜索
295
+ InstanceId:集群id精确搜索
296
+ InstanceStatus:集群状态搜索
218
297
  */
219
298
  Filters?: Array<Filter>
220
299
  /**
@@ -299,6 +378,20 @@ export interface CreateAuthorizationPolicyRequest {
299
378
  Remark?: string
300
379
  }
301
380
 
381
+ /**
382
+ * ActivateDeviceCertificate请求参数结构体
383
+ */
384
+ export interface ActivateDeviceCertificateRequest {
385
+ /**
386
+ * 集群id
387
+ */
388
+ InstanceId: string
389
+ /**
390
+ * 设备证书序列号
391
+ */
392
+ DeviceCertificateSn: string
393
+ }
394
+
302
395
  /**
303
396
  * DescribeInstance返回参数结构体
304
397
  */
@@ -452,7 +545,9 @@ export interface ModifyJWTAuthenticatorRequest {
452
545
  */
453
546
  Algorithm?: string
454
547
  /**
455
- * 设备连接时传递jwt的key;username-使用用户名字段传递;password-使用密码字段传递
548
+ * 设备连接时传递jwt的key;
549
+ username-使用用户名字段传递;
550
+ password-使用密码字段传递
456
551
  */
457
552
  From?: string
458
553
  /**
@@ -617,6 +712,35 @@ export interface DescribeTopicResponse {
617
712
  RequestId?: string
618
713
  }
619
714
 
715
+ /**
716
+ * DescribeDeviceCertificates请求参数结构体
717
+ */
718
+ export interface DescribeDeviceCertificatesRequest {
719
+ /**
720
+ * 集群ID
721
+ */
722
+ InstanceId: string
723
+ /**
724
+ * 过滤器支持ClientId、CaSn、DeviceCertificateSn、Status搜索
725
+ */
726
+ Filters?: Array<Filter>
727
+ /**
728
+ * 分页limit
729
+ */
730
+ Limit?: number
731
+ /**
732
+ * 分页偏移量
733
+ */
734
+ Offset?: number
735
+ /**
736
+ * CREATE_TIME_DESC, 创建时间降序
737
+ CREATE_TIME_ASC,创建时间升序
738
+ UPDATE_TIME_DESC,更新时间降序
739
+ UPDATE_TIME_ASC,更新时间升序
740
+ */
741
+ OrderBy?: string
742
+ }
743
+
620
744
  /**
621
745
  * CreateJWKSAuthenticator返回参数结构体
622
746
  */
@@ -746,6 +870,24 @@ export interface DeleteAuthorizationPolicyResponse {
746
870
  RequestId?: string
747
871
  }
748
872
 
873
+ /**
874
+ * DescribeDeviceCertificates返回参数结构体
875
+ */
876
+ export interface DescribeDeviceCertificatesResponse {
877
+ /**
878
+ * 总数
879
+ */
880
+ TotalCount?: number
881
+ /**
882
+ * 设备证书
883
+ */
884
+ Data?: Array<DeviceCertificateItem>
885
+ /**
886
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
887
+ */
888
+ RequestId?: string
889
+ }
890
+
749
891
  /**
750
892
  * ModifyJWKSAuthenticator请求参数结构体
751
893
  */
@@ -831,6 +973,118 @@ export interface DescribeAuthenticatorRequest {
831
973
  Type?: string
832
974
  }
833
975
 
976
+ /**
977
+ * MQTT 实例信息
978
+ */
979
+ export interface MQTTInstanceItem {
980
+ /**
981
+ * 实例ID
982
+ */
983
+ InstanceId?: string
984
+ /**
985
+ * 实例名称
986
+ */
987
+ InstanceName?: string
988
+ /**
989
+ * 实例版本
990
+ */
991
+ Version?: string
992
+ /**
993
+ * 实例类型,
994
+ EXPERIMENT,体验版
995
+ BASIC,基础版
996
+ PRO,专业版
997
+ PLATINUM,铂金版
998
+ */
999
+ InstanceType?: string
1000
+ /**
1001
+ * 实例状态,
1002
+ RUNNING, 运行中
1003
+ MAINTAINING,维护中
1004
+ ABNORMAL,异常
1005
+ OVERDUE,欠费
1006
+ DESTROYED,已删除
1007
+ CREATING,创建中
1008
+ MODIFYING,变配中
1009
+ CREATE_FAILURE,创建失败
1010
+ MODIFY_FAILURE,变配失败
1011
+ DELETING,删除中
1012
+ */
1013
+ InstanceStatus?: string
1014
+ /**
1015
+ * 实例主题数上限
1016
+ */
1017
+ TopicNumLimit?: number
1018
+ /**
1019
+ * 备注信息
1020
+ 注意:此字段可能返回 null,表示取不到有效值。
1021
+ */
1022
+ Remark?: string
1023
+ /**
1024
+ * 主题数量
1025
+ */
1026
+ TopicNum?: number
1027
+ /**
1028
+ * 商品规格
1029
+ */
1030
+ SkuCode?: string
1031
+ /**
1032
+ * 弹性TPS限流值
1033
+ 注意:此字段可能返回 null,表示取不到有效值。
1034
+ */
1035
+ TpsLimit?: number
1036
+ /**
1037
+ * 创建时间
1038
+ 注意:此字段可能返回 null,表示取不到有效值。
1039
+ */
1040
+ CreateTime?: number
1041
+ /**
1042
+ * 单客户端最大订阅数量
1043
+ 注意:此字段可能返回 null,表示取不到有效值。
1044
+ */
1045
+ MaxSubscriptionPerClient?: number
1046
+ /**
1047
+ * 客户端连接数上线
1048
+ 注意:此字段可能返回 null,表示取不到有效值。
1049
+ */
1050
+ ClientNumLimit?: number
1051
+ /**
1052
+ * 是否自动续费
1053
+ 注意:此字段可能返回 null,表示取不到有效值。
1054
+ */
1055
+ RenewFlag?: number
1056
+ /**
1057
+ * 计费模式, POSTPAID,按量计费 PREPAID,包年包月
1058
+ 注意:此字段可能返回 null,表示取不到有效值。
1059
+ */
1060
+ PayMode?: string
1061
+ /**
1062
+ * 到期时间,秒为单位
1063
+ 注意:此字段可能返回 null,表示取不到有效值。
1064
+ */
1065
+ ExpiryTime?: number
1066
+ /**
1067
+ * 预销毁时间
1068
+ 注意:此字段可能返回 null,表示取不到有效值。
1069
+ */
1070
+ DestroyTime?: number
1071
+ /**
1072
+ * 授权规则条数限制
1073
+ 注意:此字段可能返回 null,表示取不到有效值。
1074
+ */
1075
+ AuthorizationPolicyLimit?: number
1076
+ /**
1077
+ * 最大ca配额
1078
+ 注意:此字段可能返回 null,表示取不到有效值。
1079
+ */
1080
+ MaxCaNum?: number
1081
+ /**
1082
+ * 最大订阅数
1083
+ 注意:此字段可能返回 null,表示取不到有效值。
1084
+ */
1085
+ MaxSubscription?: number
1086
+ }
1087
+
834
1088
  /**
835
1089
  * DeleteTopic返回参数结构体
836
1090
  */
@@ -969,115 +1223,13 @@ export interface TagFilter {
969
1223
  }
970
1224
 
971
1225
  /**
972
- * MQTT 实例信息
1226
+ * ActivateDeviceCertificate返回参数结构体
973
1227
  */
974
- export interface MQTTInstanceItem {
975
- /**
976
- * 实例ID
977
- */
978
- InstanceId?: string
979
- /**
980
- * 实例名称
981
- */
982
- InstanceName?: string
983
- /**
984
- * 实例版本
985
- */
986
- Version?: string
987
- /**
988
- * 实例类型,
989
- EXPERIMENT,体验版
990
- BASIC,基础版
991
- PRO,专业版
992
- PLATINUM,铂金版
993
- */
994
- InstanceType?: string
995
- /**
996
- * 实例状态,
997
- RUNNING, 运行中
998
- MAINTAINING,维护中
999
- ABNORMAL,异常
1000
- OVERDUE,欠费
1001
- DESTROYED,已删除
1002
- CREATING,创建中
1003
- MODIFYING,变配中
1004
- CREATE_FAILURE,创建失败
1005
- MODIFY_FAILURE,变配失败
1006
- DELETING,删除中
1007
- */
1008
- InstanceStatus?: string
1009
- /**
1010
- * 实例主题数上限
1011
- */
1012
- TopicNumLimit?: number
1013
- /**
1014
- * 备注信息
1015
- 注意:此字段可能返回 null,表示取不到有效值。
1016
- */
1017
- Remark?: string
1018
- /**
1019
- * 主题数量
1020
- */
1021
- TopicNum?: number
1022
- /**
1023
- * 商品规格
1024
- */
1025
- SkuCode?: string
1026
- /**
1027
- * 弹性TPS限流值
1028
- 注意:此字段可能返回 null,表示取不到有效值。
1029
- */
1030
- TpsLimit?: number
1031
- /**
1032
- * 创建时间
1033
- 注意:此字段可能返回 null,表示取不到有效值。
1034
- */
1035
- CreateTime?: number
1036
- /**
1037
- * 单客户端最大订阅数量
1038
- 注意:此字段可能返回 null,表示取不到有效值。
1039
- */
1040
- MaxSubscriptionPerClient?: number
1041
- /**
1042
- * 客户端连接数上线
1043
- 注意:此字段可能返回 null,表示取不到有效值。
1044
- */
1045
- ClientNumLimit?: number
1046
- /**
1047
- * 是否自动续费
1048
- 注意:此字段可能返回 null,表示取不到有效值。
1049
- */
1050
- RenewFlag?: number
1051
- /**
1052
- * 计费模式, POSTPAID,按量计费 PREPAID,包年包月
1053
- 注意:此字段可能返回 null,表示取不到有效值。
1054
- */
1055
- PayMode?: string
1056
- /**
1057
- * 到期时间,秒为单位
1058
- 注意:此字段可能返回 null,表示取不到有效值。
1059
- */
1060
- ExpiryTime?: number
1228
+ export interface ActivateDeviceCertificateResponse {
1061
1229
  /**
1062
- * 预销毁时间
1063
- 注意:此字段可能返回 null,表示取不到有效值。
1064
- */
1065
- DestroyTime?: number
1066
- /**
1067
- * 授权规则条数限制
1068
- 注意:此字段可能返回 null,表示取不到有效值。
1069
- */
1070
- AuthorizationPolicyLimit?: number
1071
- /**
1072
- * 最大ca配额
1073
- 注意:此字段可能返回 null,表示取不到有效值。
1074
- */
1075
- MaxCaNum?: number
1076
- /**
1077
- * 最大订阅数
1078
- 注意:此字段可能返回 null,表示取不到有效值。
1230
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1079
1231
  */
1080
- MaxSubscription?: number
1232
+ RequestId?: string
1081
1233
  }
1082
1234
 
1083
1235
  /**
@@ -1,5 +1,5 @@
1
1
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
2
- import { UpdateAuthorizationPolicyPriorityResponse, UpdateAuthorizationPolicyPriorityRequest, CreateJWTAuthenticatorResponse, DeleteAuthorizationPolicyRequest, ModifyJWKSAuthenticatorResponse, RegisterDeviceCertificateResponse, ModifyJWTAuthenticatorResponse, DescribeAuthorizationPoliciesRequest, DescribeTopicListRequest, DescribeInstanceListRequest, ModifyAuthorizationPolicyResponse, CreateAuthorizationPolicyRequest, DescribeInstanceResponse, DescribeAuthenticatorResponse, CreateTopicResponse, ModifyJWTAuthenticatorRequest, CreateAuthorizationPolicyResponse, CreateJWTAuthenticatorRequest, DeleteTopicRequest, CreateJWKSAuthenticatorRequest, ModifyTopicResponse, DescribeTopicResponse, CreateJWKSAuthenticatorResponse, DeleteAuthenticatorRequest, DescribeAuthorizationPoliciesResponse, RegisterDeviceCertificateRequest, CreateTopicRequest, DeleteAuthorizationPolicyResponse, ModifyJWKSAuthenticatorRequest, ModifyTopicRequest, DescribeTopicListResponse, DescribeAuthenticatorRequest, DeleteTopicResponse, ModifyAuthorizationPolicyRequest, DescribeInstanceRequest, DeleteAuthenticatorResponse, DescribeInstanceListResponse, DescribeTopicRequest } from "./mqtt_models";
2
+ import { UpdateAuthorizationPolicyPriorityResponse, UpdateAuthorizationPolicyPriorityRequest, CreateJWTAuthenticatorResponse, DeleteAuthorizationPolicyRequest, ModifyJWKSAuthenticatorResponse, RegisterDeviceCertificateResponse, ModifyJWTAuthenticatorResponse, DescribeAuthorizationPoliciesRequest, DescribeTopicListRequest, DescribeInstanceListRequest, ModifyAuthorizationPolicyResponse, CreateAuthorizationPolicyRequest, ActivateDeviceCertificateRequest, DescribeInstanceResponse, DescribeAuthenticatorResponse, CreateTopicResponse, ModifyJWTAuthenticatorRequest, CreateAuthorizationPolicyResponse, CreateJWTAuthenticatorRequest, DeleteTopicRequest, CreateJWKSAuthenticatorRequest, ModifyTopicResponse, DescribeTopicResponse, DescribeDeviceCertificatesRequest, CreateJWKSAuthenticatorResponse, DeleteAuthenticatorRequest, DescribeAuthorizationPoliciesResponse, RegisterDeviceCertificateRequest, CreateTopicRequest, DeleteAuthorizationPolicyResponse, DescribeDeviceCertificatesResponse, ModifyJWKSAuthenticatorRequest, ModifyTopicRequest, DescribeTopicListResponse, DescribeAuthenticatorRequest, DeleteTopicResponse, ModifyAuthorizationPolicyRequest, DescribeInstanceRequest, DeleteAuthenticatorResponse, ActivateDeviceCertificateResponse, DescribeInstanceListResponse, DescribeTopicRequest } from "./mqtt_models";
3
3
  /**
4
4
  * mqtt client
5
5
  * @class
@@ -15,13 +15,17 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
15
15
  */
16
16
  CreateTopic(req: CreateTopicRequest, cb?: (error: string, rep: CreateTopicResponse) => void): Promise<CreateTopicResponse>;
17
17
  /**
18
- * 注册设备证书
18
+ * 生效设备证书
19
19
  */
20
- RegisterDeviceCertificate(req: RegisterDeviceCertificateRequest, cb?: (error: string, rep: RegisterDeviceCertificateResponse) => void): Promise<RegisterDeviceCertificateResponse>;
20
+ ActivateDeviceCertificate(req: ActivateDeviceCertificateRequest, cb?: (error: string, rep: ActivateDeviceCertificateResponse) => void): Promise<ActivateDeviceCertificateResponse>;
21
21
  /**
22
22
  * 查询授权规则
23
23
  */
24
24
  DescribeAuthorizationPolicies(req: DescribeAuthorizationPoliciesRequest, cb?: (error: string, rep: DescribeAuthorizationPoliciesResponse) => void): Promise<DescribeAuthorizationPoliciesResponse>;
25
+ /**
26
+ * 注册设备证书
27
+ */
28
+ RegisterDeviceCertificate(req: RegisterDeviceCertificateRequest, cb?: (error: string, rep: RegisterDeviceCertificateResponse) => void): Promise<RegisterDeviceCertificateResponse>;
25
29
  /**
26
30
  * 修改主题属性
27
31
  */
@@ -34,7 +38,6 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
34
38
  * 获取实例列表,Filters参数使用说明如下:
35
39
  1. InstanceName, 名称模糊查询
36
40
  2. InstanceId,实例ID查询
37
- 3. InstanceType, 实例类型查询,支持多选
38
41
  3. InstanceStatus,实例状态查询,支持多选
39
42
 
40
43
  当使用TagFilters查询时,Filters参数失效。
@@ -79,6 +82,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
79
82
  * 删除MQTT主题
80
83
  */
81
84
  DeleteTopic(req: DeleteTopicRequest, cb?: (error: string, rep: DeleteTopicResponse) => void): Promise<DeleteTopicResponse>;
85
+ /**
86
+ * 分页查询设备证书
87
+ */
88
+ DescribeDeviceCertificates(req: DescribeDeviceCertificatesRequest, cb?: (error: string, rep: DescribeDeviceCertificatesResponse) => void): Promise<DescribeDeviceCertificatesResponse>;
82
89
  /**
83
90
  * 创建MQTT实例的性能测试任务
84
91
  */
@@ -40,10 +40,10 @@ class Client extends TencentCloudCommon.AbstractClient {
40
40
  return this.request("CreateTopic", req, cb);
41
41
  }
42
42
  /**
43
- * 注册设备证书
43
+ * 生效设备证书
44
44
  */
45
- async RegisterDeviceCertificate(req, cb) {
46
- return this.request("RegisterDeviceCertificate", req, cb);
45
+ async ActivateDeviceCertificate(req, cb) {
46
+ return this.request("ActivateDeviceCertificate", req, cb);
47
47
  }
48
48
  /**
49
49
  * 查询授权规则
@@ -51,6 +51,12 @@ class Client extends TencentCloudCommon.AbstractClient {
51
51
  async DescribeAuthorizationPolicies(req, cb) {
52
52
  return this.request("DescribeAuthorizationPolicies", req, cb);
53
53
  }
54
+ /**
55
+ * 注册设备证书
56
+ */
57
+ async RegisterDeviceCertificate(req, cb) {
58
+ return this.request("RegisterDeviceCertificate", req, cb);
59
+ }
54
60
  /**
55
61
  * 修改主题属性
56
62
  */
@@ -67,7 +73,6 @@ class Client extends TencentCloudCommon.AbstractClient {
67
73
  * 获取实例列表,Filters参数使用说明如下:
68
74
  1. InstanceName, 名称模糊查询
69
75
  2. InstanceId,实例ID查询
70
- 3. InstanceType, 实例类型查询,支持多选
71
76
  3. InstanceStatus,实例状态查询,支持多选
72
77
 
73
78
  当使用TagFilters查询时,Filters参数失效。
@@ -132,6 +137,12 @@ class Client extends TencentCloudCommon.AbstractClient {
132
137
  async DeleteTopic(req, cb) {
133
138
  return this.request("DeleteTopic", req, cb);
134
139
  }
140
+ /**
141
+ * 分页查询设备证书
142
+ */
143
+ async DescribeDeviceCertificates(req, cb) {
144
+ return this.request("DescribeDeviceCertificates", req, cb);
145
+ }
135
146
  /**
136
147
  * 创建MQTT实例的性能测试任务
137
148
  */