tencentcloud-sdk-nodejs-mqtt 4.0.992 → 4.0.1033

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.
@@ -1,487 +1,1232 @@
1
1
  /**
2
- * UpdateAuthorizationPolicyPriority返回参数结构体
2
+ * DeleteUser请求参数结构体
3
3
  */
4
- export interface UpdateAuthorizationPolicyPriorityResponse {
4
+ export interface DeleteUserRequest {
5
+ /**
6
+ * 实例ID
7
+ */
8
+ InstanceId: string;
9
+ /**
10
+ * 用户名
11
+ */
12
+ Username: string;
13
+ }
14
+ /**
15
+ * ModifyJWTAuthenticator返回参数结构体
16
+ */
17
+ export interface ModifyJWTAuthenticatorResponse {
5
18
  /**
6
19
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7
20
  */
8
21
  RequestId?: string;
9
22
  }
10
23
  /**
11
- * UpdateAuthorizationPolicyPriority请求参数结构体
24
+ * CA证书信息
12
25
  */
13
- export interface UpdateAuthorizationPolicyPriorityRequest {
26
+ export interface CaCertificateItem {
14
27
  /**
15
- * 实例ID
28
+ * common name
16
29
  */
17
- InstanceId: string;
30
+ CaCn?: string;
18
31
  /**
19
- * 策略ID和优先级
32
+ * 证书内容
20
33
  */
21
- Priorities?: Array<AuthorizationPolicyPriority>;
22
- }
23
- /**
24
- * AuthorizationPolicyItem
25
- */
26
- export interface AuthorizationPolicyItem {
34
+ CaCertificate?: string;
27
35
  /**
28
- * 规则ID
36
+ * 证书序列号
29
37
  */
30
- Id?: number;
38
+ CaSn?: string;
31
39
  /**
32
- * 集群ID
40
+ * 证书格式
33
41
  */
34
- InstanceId?: string;
42
+ Format?: string;
35
43
  /**
36
- * 规则名
37
- 注意:此字段可能返回 null,表示取不到有效值。
44
+ * 验证证书内容
38
45
  */
39
- PolicyName?: string;
46
+ VerificationCertificate?: string;
40
47
  /**
41
- * 规则语法版本
48
+ * ca状态
42
49
  注意:此字段可能返回 null,表示取不到有效值。
43
50
  */
44
- Version?: number;
51
+ Status?: string;
45
52
  /**
46
- * 越小越优先
53
+ * 上次激活时间
47
54
  注意:此字段可能返回 null,表示取不到有效值。
48
55
  */
49
- Priority?: number;
56
+ LastActivationTime?: number;
50
57
  /**
51
- * allow/deny
58
+ * 创建时间
52
59
  注意:此字段可能返回 null,表示取不到有效值。
53
60
  */
54
- Effect?: string;
61
+ CreatedTime?: number;
55
62
  /**
56
- * connect、pub、sub
63
+ * 预销毁时间
57
64
  注意:此字段可能返回 null,表示取不到有效值。
58
65
  */
59
- Actions?: string;
66
+ UpdateTime?: number;
60
67
  /**
61
- * 资源
68
+ * 上次去激活时间
62
69
  注意:此字段可能返回 null,表示取不到有效值。
63
70
  */
64
- Resources?: string;
71
+ LastInactivationTime?: number;
65
72
  /**
66
- * client
73
+ * Ca证书颁发者CN
67
74
  注意:此字段可能返回 null,表示取不到有效值。
68
75
  */
69
- ClientId?: string;
76
+ CaIssuerCn?: string;
70
77
  /**
71
- * 用户
78
+ * 生效时间
72
79
  注意:此字段可能返回 null,表示取不到有效值。
73
80
  */
74
- Username?: string;
81
+ NotBeforeTime?: number;
75
82
  /**
76
- * IP地址
83
+ * 失效时间
77
84
  注意:此字段可能返回 null,表示取不到有效值。
78
85
  */
79
- Ip?: string;
86
+ NotAfterTime?: number;
87
+ }
88
+ /**
89
+ * ModifyAuthorizationPolicy返回参数结构体
90
+ */
91
+ export interface ModifyAuthorizationPolicyResponse {
80
92
  /**
81
- * 0,1,2
82
- 注意:此字段可能返回 null,表示取不到有效值。
93
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
83
94
  */
84
- Qos?: string;
95
+ RequestId?: string;
96
+ }
97
+ /**
98
+ * ActivateDeviceCertificate请求参数结构体
99
+ */
100
+ export interface ActivateDeviceCertificateRequest {
85
101
  /**
86
- * 1:表示匹配retain消息
87
- 2:表示匹配非retain消息
88
- 3:表示匹配retain和非retain消息
89
- 注意:此字段可能返回 null,表示取不到有效值。
102
+ * 集群id
90
103
  */
91
- Retain?: number;
104
+ InstanceId: string;
92
105
  /**
93
- * 描述
94
- 注意:此字段可能返回 null,表示取不到有效值。
106
+ * 设备证书序列号
95
107
  */
96
- Remark?: string;
108
+ DeviceCertificateSn: string;
109
+ }
110
+ /**
111
+ * CreateInstance返回参数结构体
112
+ */
113
+ export interface CreateInstanceResponse {
97
114
  /**
98
- * 1713164969433
115
+ * 实例ID
99
116
  */
100
- CreatedTime?: number;
117
+ InstanceId?: string;
101
118
  /**
102
- * 1713164969433
119
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
103
120
  */
104
- UpdateTime?: number;
121
+ RequestId?: string;
105
122
  }
106
123
  /**
107
- * 设备证书信息
124
+ * ApplyRegistrationCode请求参数结构体
108
125
  */
109
- export interface DeviceCertificateItem {
126
+ export interface ApplyRegistrationCodeRequest {
110
127
  /**
111
- * 客户端id
112
- 注意:此字段可能返回 null,表示取不到有效值。
128
+ * 集群id
113
129
  */
114
- ClientId?: string;
130
+ InstanceId: string;
131
+ }
132
+ /**
133
+ * ModifyJWTAuthenticator请求参数结构体
134
+ */
135
+ export interface ModifyJWTAuthenticatorRequest {
115
136
  /**
116
- * 设备证书
137
+ * 实例ID
117
138
  */
118
- DeviceCertificate?: string;
139
+ InstanceId: string;
119
140
  /**
120
- * 设备证书Sn
141
+ * 算法:hmac-based,public-key
121
142
  */
122
- DeviceCertificateSn?: string;
143
+ Algorithm?: string;
123
144
  /**
124
- * 设备证书Cn
145
+ * 设备连接时传递jwt的key;
146
+ username-使用用户名字段传递;
147
+ password-使用密码字段传递
125
148
  */
126
- DeviceCertificateCn?: string;
149
+ From?: string;
127
150
  /**
128
- * 签发ca的序列号
151
+ * 密码
129
152
  */
130
- CaSn?: string;
153
+ Secret?: string;
131
154
  /**
132
- * 证书格式
155
+ * 公钥
133
156
  */
134
- Format?: string;
157
+ PublicKey?: string;
135
158
  /**
136
- * 证书状态
137
- ACTIVE,//激活
138
- INACTIVE,//未激活
139
- REVOKED,//吊销
140
- PENDING_ACTIVATION,//注册待激活
159
+ * JSKS文本
141
160
  */
142
- Status?: string;
161
+ Text?: string;
143
162
  /**
144
- * 上次激活时间
163
+ * 说明
164
+ */
165
+ Remark?: string;
166
+ }
167
+ /**
168
+ * 策略规则优先级
169
+ */
170
+ export interface AuthorizationPolicyPriority {
171
+ /**
172
+ * 策略id
145
173
  注意:此字段可能返回 null,表示取不到有效值。
146
174
  */
147
- LastActivationTime?: number;
175
+ Id: number;
148
176
  /**
149
- * 上次取消激活时间
177
+ * 优先级
150
178
  注意:此字段可能返回 null,表示取不到有效值。
151
179
  */
152
- LastInactivationTime?: number;
180
+ Priority: number;
181
+ }
182
+ /**
183
+ * ModifyInstance请求参数结构体
184
+ */
185
+ export interface ModifyInstanceRequest {
153
186
  /**
154
- * 创建时间
187
+ * 实例ID
155
188
  */
156
- CreatedTime?: number;
189
+ InstanceId: string;
157
190
  /**
158
- * 预销毁时间
159
- 注意:此字段可能返回 null,表示取不到有效值。
191
+ * 要修改实例名称
160
192
  */
161
- UpdateTime?: number;
193
+ Name?: string;
162
194
  /**
163
- * 证书来源:
164
- API, 手动注册
165
- JITP 自动注册
166
- 注意:此字段可能返回 null,表示取不到有效值。
195
+ * 要修改的备注信息
167
196
  */
168
- CertificateSource?: string;
197
+ Remark?: string;
169
198
  /**
170
- * 证书失效日期
171
- 注意:此字段可能返回 null,表示取不到有效值。
199
+ * 要变更的配置规格
172
200
  */
173
- NotAfterTime?: number;
201
+ SkuCode?: string;
174
202
  /**
175
- * 证书生效开始日期
176
- 注意:此字段可能返回 null,表示取不到有效值。
203
+ * 客户端证书注册方式:
204
+ JITP:自动注册
205
+ API:手动通过API注册
177
206
  */
178
- NotBeforeTime?: number;
179
- }
180
- /**
181
- * CreateJWTAuthenticator返回参数结构体
182
- */
183
- export interface CreateJWTAuthenticatorResponse {
207
+ DeviceCertificateProvisionType?: string;
184
208
  /**
185
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
209
+ * 自动注册证书是否自动激活
186
210
  */
187
- RequestId?: string;
211
+ AutomaticActivation?: boolean;
188
212
  }
189
213
  /**
190
- * DeleteAuthorizationPolicy请求参数结构体
214
+ * DeleteTopic请求参数结构体
191
215
  */
192
- export interface DeleteAuthorizationPolicyRequest {
216
+ export interface DeleteTopicRequest {
193
217
  /**
194
218
  * 实例ID
195
219
  */
196
220
  InstanceId: string;
197
221
  /**
198
- * 策略规则id
222
+ * 主题
199
223
  */
200
- Id: number;
224
+ Topic: string;
201
225
  }
202
226
  /**
203
- * ModifyJWKSAuthenticator返回参数结构体
227
+ * ModifyUser返回参数结构体
204
228
  */
205
- export interface ModifyJWKSAuthenticatorResponse {
229
+ export interface ModifyUserResponse {
206
230
  /**
207
231
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
208
232
  */
209
233
  RequestId?: string;
210
234
  }
211
235
  /**
212
- * RegisterDeviceCertificate返回参数结构体
236
+ * DescribeCaCertificate返回参数结构体
213
237
  */
214
- export interface RegisterDeviceCertificateResponse {
238
+ export interface DescribeCaCertificateResponse {
215
239
  /**
216
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
240
+ * 创建时间
217
241
  */
218
- RequestId?: string;
219
- }
220
- /**
221
- * ModifyJWTAuthenticator返回参数结构体
222
- */
223
- export interface ModifyJWTAuthenticatorResponse {
242
+ CreatedTime?: number;
224
243
  /**
225
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
244
+ * 上次更新时间
226
245
  */
227
- RequestId?: string;
228
- }
229
- /**
230
- * DescribeAuthorizationPolicies请求参数结构体
231
- */
232
- export interface DescribeAuthorizationPoliciesRequest {
246
+ UpdateTime?: number;
233
247
  /**
234
- * 集群ID
248
+ * 失效日期
235
249
  */
236
- InstanceId?: string;
237
- }
238
- /**
239
- * DescribeTopicList请求参数结构体
240
- */
241
- export interface DescribeTopicListRequest {
250
+ NotAfterTime?: number;
242
251
  /**
243
- * 实例ID
252
+ * 上次激活时间
244
253
  */
245
- InstanceId: string;
254
+ LastActivationTime?: number;
246
255
  /**
247
- * 查询条件列表:
248
- 支持TopicName模糊查询
256
+ * 上次吊销时间
249
257
  */
250
- Filters?: Array<Filter>;
258
+ LastInactivationTime?: number;
251
259
  /**
252
- * 查询起始位置
260
+ * 证书状态
253
261
  */
254
- Offset?: number;
262
+ Status?: string;
255
263
  /**
256
- * 查询结果限制数量
264
+ * 证书序列号
257
265
  */
258
- Limit?: number;
259
- }
260
- /**
261
- * DescribeInstanceList请求参数结构体
262
- */
263
- export interface DescribeInstanceListRequest {
266
+ CaSn?: string;
264
267
  /**
265
- * 查询条件列表,支持以下子弹
266
- InstanceName:集群名模糊搜索
267
- InstanceId:集群id精确搜索
268
- InstanceStatus:集群状态搜索
268
+ * common name
269
269
  */
270
- Filters?: Array<Filter>;
270
+ CaCn?: string;
271
271
  /**
272
- * 查询起始位置
272
+ * 证书内容
273
273
  */
274
- Offset?: number;
274
+ CaCertificate?: string;
275
275
  /**
276
- * 查询结果限制数量
276
+ * 证书格式
277
+ */
278
+ Format?: string;
279
+ /**
280
+ * Ca证书颁发者CN
281
+ 注意:此字段可能返回 null,表示取不到有效值。
282
+ */
283
+ CaIssuerCn?: string;
284
+ /**
285
+ * 生效开始时间
286
+ */
287
+ NotBeforeTime?: number;
288
+ /**
289
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
290
+ */
291
+ RequestId?: string;
292
+ }
293
+ /**
294
+ * DescribeDeviceCertificates请求参数结构体
295
+ */
296
+ export interface DescribeDeviceCertificatesRequest {
297
+ /**
298
+ * 集群ID
299
+ */
300
+ InstanceId: string;
301
+ /**
302
+ * 过滤器支持ClientId、CaSn、DeviceCertificateSn、Status搜索
303
+ */
304
+ Filters?: Array<Filter>;
305
+ /**
306
+ * 分页limit
277
307
  */
278
308
  Limit?: number;
279
309
  /**
280
- * 标签过滤器
310
+ * 分页偏移量
281
311
  */
282
- TagFilters?: Array<TagFilter>;
312
+ Offset?: number;
313
+ /**
314
+ * CREATE_TIME_DESC, 创建时间降序
315
+ CREATE_TIME_ASC,创建时间升序
316
+ UPDATE_TIME_DESC,更新时间降序
317
+ UPDATE_TIME_ASC,更新时间升序
318
+ */
319
+ OrderBy?: string;
283
320
  }
284
321
  /**
285
- * ModifyAuthorizationPolicy返回参数结构体
322
+ * DeleteAuthenticator请求参数结构体
286
323
  */
287
- export interface ModifyAuthorizationPolicyResponse {
324
+ export interface DeleteAuthenticatorRequest {
325
+ /**
326
+ * 实例ID
327
+ */
328
+ InstanceId: string;
329
+ /**
330
+ * 认证器类型:
331
+ JWT:JWT认证器
332
+ JWKS:JWKS认证器
333
+ BYOC:一端一证认证器
334
+ */
335
+ Type: string;
336
+ }
337
+ /**
338
+ * 公网访问安全规则
339
+ */
340
+ export interface PublicAccessRule {
341
+ /**
342
+ * ip网段信息
343
+ 注意:此字段可能返回 null,表示取不到有效值。
344
+ */
345
+ IpRule: string;
346
+ /**
347
+ * 允许或者拒绝
348
+ 注意:此字段可能返回 null,表示取不到有效值。
349
+ */
350
+ Allow: boolean;
351
+ /**
352
+ * 备注信息
353
+ 注意:此字段可能返回 null,表示取不到有效值。
354
+ */
355
+ Remark?: string;
356
+ }
357
+ /**
358
+ * VPC信息
359
+ */
360
+ export interface VpcInfo {
361
+ /**
362
+ * VPC ID
363
+ */
364
+ VpcId: string;
365
+ /**
366
+ * 子网ID
367
+ */
368
+ SubnetId: string;
369
+ }
370
+ /**
371
+ * DeleteAuthorizationPolicy返回参数结构体
372
+ */
373
+ export interface DeleteAuthorizationPolicyResponse {
288
374
  /**
289
375
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
290
376
  */
291
377
  RequestId?: string;
292
378
  }
293
379
  /**
294
- * CreateAuthorizationPolicy请求参数结构体
380
+ * ModifyJWKSAuthenticator请求参数结构体
295
381
  */
296
- export interface CreateAuthorizationPolicyRequest {
382
+ export interface ModifyJWKSAuthenticatorRequest {
297
383
  /**
298
384
  * 实例ID
299
385
  */
300
386
  InstanceId: string;
301
387
  /**
302
- * 策略名称
388
+ * 端点
303
389
  */
304
- PolicyName: string;
390
+ Endpoint?: string;
305
391
  /**
306
- * 策略版本
392
+ * 认证器状态:open-启用;close-关闭
307
393
  */
308
- PolicyVersion: number;
394
+ Status?: string;
395
+ /**
396
+ * 刷新时间
397
+ */
398
+ RefreshInterval?: number;
399
+ /**
400
+ * JSKS文本
401
+ */
402
+ Text?: string;
403
+ /**
404
+ * 设备连接时传递jwt的key;username-使用用户名字段传递;password-使用密码字段传递
405
+ */
406
+ From?: string;
407
+ /**
408
+ * 说明
409
+ */
410
+ Remark?: string;
411
+ }
412
+ /**
413
+ * RegisterCaCertificate返回参数结构体
414
+ */
415
+ export interface RegisterCaCertificateResponse {
416
+ /**
417
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
418
+ */
419
+ RequestId?: string;
420
+ }
421
+ /**
422
+ * RegisterDeviceCertificate返回参数结构体
423
+ */
424
+ export interface RegisterDeviceCertificateResponse {
425
+ /**
426
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
427
+ */
428
+ RequestId?: string;
429
+ }
430
+ /**
431
+ * MQTT认证器信息
432
+ */
433
+ export interface MQTTAuthenticatorItem {
434
+ /**
435
+ * 认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 BYOC:一端一证认证器
436
+ 注意:此字段可能返回 null,表示取不到有效值。
437
+ */
438
+ Type?: string;
439
+ /**
440
+ * 认证器配置
441
+ 注意:此字段可能返回 null,表示取不到有效值。
442
+ */
443
+ Config?: string;
444
+ /**
445
+ * 认证器状态
446
+ 注意:此字段可能返回 null,表示取不到有效值。
447
+ */
448
+ Status?: string;
449
+ /**
450
+ * 创建时间
451
+ 注意:此字段可能返回 null,表示取不到有效值。
452
+ */
453
+ CreateTime?: number;
454
+ /**
455
+ * 说明
456
+ 注意:此字段可能返回 null,表示取不到有效值。
457
+ */
458
+ Remark?: string;
459
+ }
460
+ /**
461
+ * 标签数据
462
+ */
463
+ export interface Tag {
464
+ /**
465
+ * 标签名称
466
+ 注意:此字段可能返回 null,表示取不到有效值。
467
+ */
468
+ TagKey: string;
469
+ /**
470
+ * 标签值
471
+ 注意:此字段可能返回 null,表示取不到有效值。
472
+ */
473
+ TagValue: string;
474
+ }
475
+ /**
476
+ * DescribeDeviceCertificate请求参数结构体
477
+ */
478
+ export interface DescribeDeviceCertificateRequest {
479
+ /**
480
+ * 设备证书sn
481
+ */
482
+ DeviceCertificateSn: string;
483
+ /**
484
+ * 集群id
485
+ */
486
+ InstanceId: string;
487
+ }
488
+ /**
489
+ * MQTT 实例信息
490
+ */
491
+ export interface MQTTInstanceItem {
492
+ /**
493
+ * 实例ID
494
+ */
495
+ InstanceId?: string;
496
+ /**
497
+ * 实例名称
498
+ */
499
+ InstanceName?: string;
500
+ /**
501
+ * 实例版本
502
+ */
503
+ Version?: string;
504
+ /**
505
+ * 实例类型,
506
+ EXPERIMENT,体验版
507
+ BASIC,基础版
508
+ PRO,专业版
509
+ PLATINUM,铂金版
510
+ */
511
+ InstanceType?: string;
512
+ /**
513
+ * 实例状态,
514
+ RUNNING, 运行中
515
+ MAINTAINING,维护中
516
+ ABNORMAL,异常
517
+ OVERDUE,欠费
518
+ DESTROYED,已删除
519
+ CREATING,创建中
520
+ MODIFYING,变配中
521
+ CREATE_FAILURE,创建失败
522
+ MODIFY_FAILURE,变配失败
523
+ DELETING,删除中
524
+ */
525
+ InstanceStatus?: string;
526
+ /**
527
+ * 实例主题数上限
528
+ */
529
+ TopicNumLimit?: number;
530
+ /**
531
+ * 备注信息
532
+ 注意:此字段可能返回 null,表示取不到有效值。
533
+ */
534
+ Remark?: string;
535
+ /**
536
+ * 主题数量
537
+ */
538
+ TopicNum?: number;
539
+ /**
540
+ * 商品规格
541
+ */
542
+ SkuCode?: string;
543
+ /**
544
+ * 弹性TPS限流值
545
+ 注意:此字段可能返回 null,表示取不到有效值。
546
+ */
547
+ TpsLimit?: number;
548
+ /**
549
+ * 创建时间
550
+ 注意:此字段可能返回 null,表示取不到有效值。
551
+ */
552
+ CreateTime?: number;
553
+ /**
554
+ * 单客户端最大订阅数量
555
+ 注意:此字段可能返回 null,表示取不到有效值。
556
+ */
557
+ MaxSubscriptionPerClient?: number;
558
+ /**
559
+ * 客户端连接数上线
560
+ 注意:此字段可能返回 null,表示取不到有效值。
561
+ */
562
+ ClientNumLimit?: number;
563
+ /**
564
+ * 是否自动续费
565
+ 注意:此字段可能返回 null,表示取不到有效值。
566
+ */
567
+ RenewFlag?: number;
568
+ /**
569
+ * 计费模式, POSTPAID,按量计费 PREPAID,包年包月
570
+ 注意:此字段可能返回 null,表示取不到有效值。
571
+ */
572
+ PayMode?: string;
573
+ /**
574
+ * 到期时间,秒为单位
575
+ 注意:此字段可能返回 null,表示取不到有效值。
576
+ */
577
+ ExpiryTime?: number;
578
+ /**
579
+ * 预销毁时间
580
+ 注意:此字段可能返回 null,表示取不到有效值。
581
+ */
582
+ DestroyTime?: number;
583
+ /**
584
+ * 授权规则条数限制
585
+ 注意:此字段可能返回 null,表示取不到有效值。
586
+ */
587
+ AuthorizationPolicyLimit?: number;
588
+ /**
589
+ * 最大ca配额
590
+ 注意:此字段可能返回 null,表示取不到有效值。
591
+ */
592
+ MaxCaNum?: number;
593
+ /**
594
+ * 最大订阅数
595
+ 注意:此字段可能返回 null,表示取不到有效值。
596
+ */
597
+ MaxSubscription?: number;
598
+ }
599
+ /**
600
+ * DescribeInstanceList返回参数结构体
601
+ */
602
+ export interface DescribeInstanceListResponse {
603
+ /**
604
+ * 查询总数
605
+ 注意:此字段可能返回 null,表示取不到有效值。
606
+ */
607
+ TotalCount?: number;
608
+ /**
609
+ * 实例列表
610
+ */
611
+ Data?: Array<MQTTInstanceItem>;
612
+ /**
613
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
614
+ */
615
+ RequestId?: string;
616
+ }
617
+ /**
618
+ * ApplyRegistrationCode返回参数结构体
619
+ */
620
+ export interface ApplyRegistrationCodeResponse {
621
+ /**
622
+ * 集群ID
623
+ */
624
+ InstanceId?: string;
625
+ /**
626
+ * 注册码
627
+ */
628
+ RegistrationCode?: string;
629
+ /**
630
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
631
+ */
632
+ RequestId?: string;
633
+ }
634
+ /**
635
+ * ModifyInstance返回参数结构体
636
+ */
637
+ export interface ModifyInstanceResponse {
638
+ /**
639
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
640
+ */
641
+ RequestId?: string;
642
+ }
643
+ /**
644
+ * ModifyInsPublicEndpoint返回参数结构体
645
+ */
646
+ export interface ModifyInsPublicEndpointResponse {
647
+ /**
648
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
649
+ */
650
+ RequestId?: string;
651
+ }
652
+ /**
653
+ * ModifyJWKSAuthenticator返回参数结构体
654
+ */
655
+ export interface ModifyJWKSAuthenticatorResponse {
656
+ /**
657
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
658
+ */
659
+ RequestId?: string;
660
+ }
661
+ /**
662
+ * CreateInsPublicEndpoint返回参数结构体
663
+ */
664
+ export interface CreateInsPublicEndpointResponse {
665
+ /**
666
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
667
+ */
668
+ RequestId?: string;
669
+ }
670
+ /**
671
+ * CreateUser返回参数结构体
672
+ */
673
+ export interface CreateUserResponse {
674
+ /**
675
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
676
+ */
677
+ RequestId?: string;
678
+ }
679
+ /**
680
+ * CreateAuthorizationPolicy请求参数结构体
681
+ */
682
+ export interface CreateAuthorizationPolicyRequest {
683
+ /**
684
+ * 实例ID
685
+ */
686
+ InstanceId: string;
687
+ /**
688
+ * 策略名称
689
+ */
690
+ PolicyName: string;
691
+ /**
692
+ * 策略版本
693
+ */
694
+ PolicyVersion: number;
695
+ /**
696
+ * 策略优先级,越小越优先
697
+ */
698
+ Priority: number;
699
+ /**
700
+ * allow、deny
701
+ */
702
+ Effect: string;
703
+ /**
704
+ * connect、pub、sub
705
+ */
706
+ Actions: string;
707
+ /**
708
+ * 1,匹配保留消息;2,匹配非保留消息,3.匹配所有消息
709
+ */
710
+ Retain: number;
711
+ /**
712
+ * 0、1、2
713
+ */
714
+ Qos: string;
715
+ /**
716
+ * 资源
717
+ */
718
+ Resources?: string;
719
+ /**
720
+ * 用户名
721
+ */
722
+ Username?: string;
723
+ /**
724
+ * 客户端
725
+ */
726
+ ClientId?: string;
727
+ /**
728
+ * IP地址
729
+ */
730
+ Ip?: string;
731
+ /**
732
+ * 备注信息
733
+ */
734
+ Remark?: string;
735
+ }
736
+ /**
737
+ * DescribeAuthenticator返回参数结构体
738
+ */
739
+ export interface DescribeAuthenticatorResponse {
740
+ /**
741
+ * 集群认证器列表
742
+ */
743
+ Authenticators?: Array<MQTTAuthenticatorItem>;
744
+ /**
745
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
746
+ */
747
+ RequestId?: string;
748
+ }
749
+ /**
750
+ * DeactivateCaCertificate返回参数结构体
751
+ */
752
+ export interface DeactivateCaCertificateResponse {
753
+ /**
754
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
755
+ */
756
+ RequestId?: string;
757
+ }
758
+ /**
759
+ * DeleteCaCertificate请求参数结构体
760
+ */
761
+ export interface DeleteCaCertificateRequest {
762
+ /**
763
+ * 集群id
764
+ */
765
+ InstanceId: string;
766
+ /**
767
+ * 证书序列号
768
+ */
769
+ CaSn: string;
770
+ }
771
+ /**
772
+ * DeleteDeviceCertificate请求参数结构体
773
+ */
774
+ export interface DeleteDeviceCertificateRequest {
775
+ /**
776
+ * 集群id
777
+ */
778
+ InstanceId: string;
779
+ /**
780
+ * 设备证书序列号
781
+ */
782
+ DeviceCertificateSn: string;
783
+ }
784
+ /**
785
+ * DescribeInsPublicEndpoints请求参数结构体
786
+ */
787
+ export interface DescribeInsPublicEndpointsRequest {
788
+ /**
789
+ * 实例ID
790
+ */
791
+ InstanceId: string;
792
+ }
793
+ /**
794
+ * DeleteUser返回参数结构体
795
+ */
796
+ export interface DeleteUserResponse {
797
+ /**
798
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
799
+ */
800
+ RequestId?: string;
801
+ }
802
+ /**
803
+ * ActivateCaCertificate返回参数结构体
804
+ */
805
+ export interface ActivateCaCertificateResponse {
806
+ /**
807
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
808
+ */
809
+ RequestId?: string;
810
+ }
811
+ /**
812
+ * DeleteDeviceCertificate返回参数结构体
813
+ */
814
+ export interface DeleteDeviceCertificateResponse {
815
+ /**
816
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
817
+ */
818
+ RequestId?: string;
819
+ }
820
+ /**
821
+ * DeleteInstance返回参数结构体
822
+ */
823
+ export interface DeleteInstanceResponse {
824
+ /**
825
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
826
+ */
827
+ RequestId?: string;
828
+ }
829
+ /**
830
+ * CreateJWKSAuthenticator请求参数结构体
831
+ */
832
+ export interface CreateJWKSAuthenticatorRequest {
833
+ /**
834
+ * 实例ID
835
+ */
836
+ InstanceId: string;
837
+ /**
838
+ * jwks端点
839
+ */
840
+ Endpoint?: string;
841
+ /**
842
+ * jwks刷新间隔,单位:秒
843
+ */
844
+ RefreshInterval?: number;
845
+ /**
846
+ * jwks文本
847
+ */
848
+ Text?: string;
849
+ /**
850
+ * 认证器是否开启:open-启用;close-关闭
851
+ */
852
+ Status?: string;
853
+ /**
854
+ * 说明
855
+ */
856
+ Remark?: string;
857
+ /**
858
+ * 设备连接时传递jwt的key;
859
+ username-使用用户名字段传递;
860
+ password-使用密码字段传递
861
+ */
862
+ From?: string;
863
+ }
864
+ /**
865
+ * DescribeTopic返回参数结构体
866
+ */
867
+ export interface DescribeTopicResponse {
868
+ /**
869
+ * 实例ID
870
+ */
871
+ InstanceId?: string;
872
+ /**
873
+ * 主题名称
874
+ */
875
+ Topic?: string;
876
+ /**
877
+ * 备注
878
+ */
879
+ Remark?: string;
880
+ /**
881
+ * 创建时间,秒为单位
882
+ */
883
+ CreatedTime?: number;
884
+ /**
885
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
886
+ */
887
+ RequestId?: string;
888
+ }
889
+ /**
890
+ * CreateJWKSAuthenticator返回参数结构体
891
+ */
892
+ export interface CreateJWKSAuthenticatorResponse {
893
+ /**
894
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
895
+ */
896
+ RequestId?: string;
897
+ }
898
+ /**
899
+ * DescribeAuthorizationPolicies返回参数结构体
900
+ */
901
+ export interface DescribeAuthorizationPoliciesResponse {
902
+ /**
903
+ * 规则
904
+ */
905
+ Data?: Array<AuthorizationPolicyItem>;
906
+ /**
907
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
908
+ */
909
+ RequestId?: string;
910
+ }
911
+ /**
912
+ * CreateTopic请求参数结构体
913
+ */
914
+ export interface CreateTopicRequest {
915
+ /**
916
+ * 实例ID
917
+ */
918
+ InstanceId: string;
919
+ /**
920
+ * 主题
921
+ */
922
+ Topic: string;
923
+ /**
924
+ * 备注
925
+ */
926
+ Remark?: string;
927
+ }
928
+ /**
929
+ * DeleteCaCertificate返回参数结构体
930
+ */
931
+ export interface DeleteCaCertificateResponse {
932
+ /**
933
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
934
+ */
935
+ RequestId?: string;
936
+ }
937
+ /**
938
+ * 标签过滤器
939
+ */
940
+ export interface TagFilter {
941
+ /**
942
+ * 标签键名称
943
+ */
944
+ TagKey?: string;
945
+ /**
946
+ * 标签键名称
947
+ */
948
+ TagValues?: Array<string>;
949
+ }
950
+ /**
951
+ * DescribeUserList返回参数结构体
952
+ */
953
+ export interface DescribeUserListResponse {
954
+ /**
955
+ * 查询总数
956
+ 注意:此字段可能返回 null,表示取不到有效值。
957
+ */
958
+ TotalCount?: number;
959
+ /**
960
+ * 角色信息列表
961
+ */
962
+ Data?: Array<MQTTUserItem>;
963
+ /**
964
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
965
+ */
966
+ RequestId?: string;
967
+ }
968
+ /**
969
+ * ModifyTopic返回参数结构体
970
+ */
971
+ export interface ModifyTopicResponse {
972
+ /**
973
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
974
+ */
975
+ RequestId?: string;
976
+ }
977
+ /**
978
+ * DeactivateDeviceCertificate返回参数结构体
979
+ */
980
+ export interface DeactivateDeviceCertificateResponse {
981
+ /**
982
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
983
+ */
984
+ RequestId?: string;
985
+ }
986
+ /**
987
+ * MQTT集群用户信息
988
+ */
989
+ export interface MQTTUserItem {
990
+ /**
991
+ * 用户名
992
+ */
993
+ Username?: string;
994
+ /**
995
+ * 密码
996
+ */
997
+ Password?: string;
998
+ /**
999
+ * 备注信息
1000
+ */
1001
+ Remark?: string;
1002
+ /**
1003
+ * 创建时间,秒为单位
1004
+ */
1005
+ CreatedTime?: number;
309
1006
  /**
310
- * 策略优先级,越小越优先
1007
+ * 修改时间,秒为单位
311
1008
  */
312
- Priority: number;
1009
+ ModifiedTime?: number;
1010
+ }
1011
+ /**
1012
+ * ActivateCaCertificate请求参数结构体
1013
+ */
1014
+ export interface ActivateCaCertificateRequest {
313
1015
  /**
314
- * allow、deny
1016
+ * 集群id
315
1017
  */
316
- Effect: string;
1018
+ InstanceId: string;
317
1019
  /**
318
- * connect、pub、sub
1020
+ * 证书序列号
319
1021
  */
320
- Actions: string;
1022
+ CaSn: string;
1023
+ }
1024
+ /**
1025
+ * ActivateDeviceCertificate返回参数结构体
1026
+ */
1027
+ export interface ActivateDeviceCertificateResponse {
321
1028
  /**
322
- * 1,匹配保留消息;2,匹配非保留消息,3.匹配所有消息
1029
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
323
1030
  */
324
- Retain: number;
1031
+ RequestId?: string;
1032
+ }
1033
+ /**
1034
+ * DescribeTopic请求参数结构体
1035
+ */
1036
+ export interface DescribeTopicRequest {
325
1037
  /**
326
- * 0、1、2
1038
+ * 实例ID
327
1039
  */
328
- Qos: string;
1040
+ InstanceId: string;
329
1041
  /**
330
- * 资源
1042
+ * 主题
331
1043
  */
332
- Resources?: string;
1044
+ Topic: string;
1045
+ }
1046
+ /**
1047
+ * UpdateAuthorizationPolicyPriority返回参数结构体
1048
+ */
1049
+ export interface UpdateAuthorizationPolicyPriorityResponse {
333
1050
  /**
334
- * 用户名
1051
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
335
1052
  */
336
- Username?: string;
1053
+ RequestId?: string;
1054
+ }
1055
+ /**
1056
+ * CreateTopic返回参数结构体
1057
+ */
1058
+ export interface CreateTopicResponse {
337
1059
  /**
338
- * 客户端
1060
+ * 实例ID
339
1061
  */
340
- ClientId?: string;
1062
+ InstanceId?: string;
341
1063
  /**
342
- * IP地址
1064
+ * 主题
343
1065
  */
344
- Ip?: string;
1066
+ Topic?: string;
345
1067
  /**
346
- * 备注信息
1068
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
347
1069
  */
348
- Remark?: string;
1070
+ RequestId?: string;
349
1071
  }
350
1072
  /**
351
- * ActivateDeviceCertificate请求参数结构体
1073
+ * DeleteInsPublicEndpoint返回参数结构体
352
1074
  */
353
- export interface ActivateDeviceCertificateRequest {
354
- /**
355
- * 集群id
356
- */
357
- InstanceId: string;
1075
+ export interface DeleteInsPublicEndpointResponse {
358
1076
  /**
359
- * 设备证书序列号
1077
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
360
1078
  */
361
- DeviceCertificateSn: string;
1079
+ RequestId?: string;
362
1080
  }
363
1081
  /**
364
- * DescribeInstance返回参数结构体
1082
+ * MQTTEndpoint
365
1083
  */
366
- export interface DescribeInstanceResponse {
1084
+ export interface MQTTEndpointItem {
367
1085
  /**
368
- * 实例类型
369
- BASIC 基础版
370
- PRO 专业版
1086
+ * 类型
1087
+ 注意:此字段可能返回 null,表示取不到有效值。
371
1088
  */
372
- InstanceType?: string;
1089
+ Type?: string;
373
1090
  /**
374
- * 实例ID
1091
+ * 接入点
1092
+ 注意:此字段可能返回 null,表示取不到有效值。
375
1093
  */
376
- InstanceId?: string;
1094
+ Url?: string;
377
1095
  /**
378
- * 实例名称
1096
+ * vpc信息
1097
+ 注意:此字段可能返回 null,表示取不到有效值。
379
1098
  */
380
- InstanceName?: string;
1099
+ VpcId?: string;
381
1100
  /**
382
- * 主题数量
1101
+ * 子网信息
1102
+ 注意:此字段可能返回 null,表示取不到有效值。
383
1103
  */
384
- TopicNum?: number;
1104
+ SubnetId?: string;
385
1105
  /**
386
- * 实例最大主题数量
1106
+ * 主机
1107
+ 注意:此字段可能返回 null,表示取不到有效值。
387
1108
  */
388
- TopicNumLimit?: number;
1109
+ Host?: string;
389
1110
  /**
390
- * TPS限流值
1111
+ * 端口
1112
+ 注意:此字段可能返回 null,表示取不到有效值。
391
1113
  */
392
- TpsLimit?: number;
1114
+ Port?: number;
393
1115
  /**
394
- * 创建时间,秒为单位
1116
+ * 接入点ip
1117
+ 注意:此字段可能返回 null,表示取不到有效值。
395
1118
  */
396
- CreatedTime?: number;
1119
+ Ip?: string;
1120
+ }
1121
+ /**
1122
+ * DescribeTopicList请求参数结构体
1123
+ */
1124
+ export interface DescribeTopicListRequest {
397
1125
  /**
398
- * 备注信息
1126
+ * 实例ID
399
1127
  */
400
- Remark?: string;
1128
+ InstanceId: string;
401
1129
  /**
402
- * 实例状态
1130
+ * 查询条件列表:
1131
+ 支持TopicName模糊查询
403
1132
  */
404
- InstanceStatus?: string;
1133
+ Filters?: Array<Filter>;
405
1134
  /**
406
- * 实例规格
1135
+ * 查询起始位置
407
1136
  */
408
- SkuCode?: string;
1137
+ Offset?: number;
409
1138
  /**
410
- * 单客户端最大订阅数
1139
+ * 查询结果限制数量
411
1140
  */
412
- MaxSubscriptionPerClient?: number;
1141
+ Limit?: number;
1142
+ }
1143
+ /**
1144
+ * AuthorizationPolicyItem
1145
+ */
1146
+ export interface AuthorizationPolicyItem {
413
1147
  /**
414
- * 授权规则条数
1148
+ * 规则ID
415
1149
  */
416
- AuthorizationPolicyLimit?: number;
1150
+ Id?: number;
417
1151
  /**
418
- * 客户端数量上限
1152
+ * 集群ID
419
1153
  */
420
- ClientNumLimit?: number;
1154
+ InstanceId?: string;
421
1155
  /**
422
- * 客户端证书注册方式:
423
- JITP:自动注册
424
- API:通过API手动注册
1156
+ * 规则名
1157
+ 注意:此字段可能返回 null,表示取不到有效值。
425
1158
  */
426
- DeviceCertificateProvisionType?: string;
1159
+ PolicyName?: string;
427
1160
  /**
428
- * 自动注册设备证书时是否自动激活
1161
+ * 规则语法版本
1162
+ 注意:此字段可能返回 null,表示取不到有效值。
429
1163
  */
430
- AutomaticActivation?: boolean;
1164
+ Version?: number;
431
1165
  /**
432
- * 是否自动续费
1166
+ * 越小越优先
1167
+ 注意:此字段可能返回 null,表示取不到有效值。
433
1168
  */
434
- RenewFlag?: number;
1169
+ Priority?: number;
435
1170
  /**
436
- * 计费模式, POSTPAID,按量计费 PREPAID,包年包月
1171
+ * allow/deny
1172
+ 注意:此字段可能返回 null,表示取不到有效值。
437
1173
  */
438
- PayMode?: string;
1174
+ Effect?: string;
439
1175
  /**
440
- * 到期时间,秒为单位
1176
+ * connect、pub、sub
1177
+ 注意:此字段可能返回 null,表示取不到有效值。
441
1178
  */
442
- ExpiryTime?: number;
1179
+ Actions?: string;
443
1180
  /**
444
- * 预销毁时间
1181
+ * 资源
1182
+ 注意:此字段可能返回 null,表示取不到有效值。
445
1183
  */
446
- DestroyTime?: number;
1184
+ Resources?: string;
447
1185
  /**
448
- * TLS,单向认证 mTLS,双向认证 BYOC;一机一证
1186
+ * client
1187
+ 注意:此字段可能返回 null,表示取不到有效值。
449
1188
  */
450
- X509Mode?: string;
1189
+ ClientId?: string;
451
1190
  /**
452
- * 最大Ca配额
1191
+ * 用户
1192
+ 注意:此字段可能返回 null,表示取不到有效值。
453
1193
  */
454
- MaxCaNum?: number;
1194
+ Username?: string;
455
1195
  /**
456
- * 证书注册码
1196
+ * IP地址
1197
+ 注意:此字段可能返回 null,表示取不到有效值。
457
1198
  */
458
- RegistrationCode?: string;
1199
+ Ip?: string;
459
1200
  /**
460
- * 集群最大订阅数
1201
+ * 0,1,2
1202
+ 注意:此字段可能返回 null,表示取不到有效值。
461
1203
  */
462
- MaxSubscription?: number;
1204
+ Qos?: string;
463
1205
  /**
464
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1206
+ * 1:表示匹配retain消息
1207
+ 2:表示匹配非retain消息
1208
+ 3:表示匹配retain和非retain消息
1209
+ 注意:此字段可能返回 null,表示取不到有效值。
465
1210
  */
466
- RequestId?: string;
467
- }
468
- /**
469
- * DescribeAuthenticator返回参数结构体
470
- */
471
- export interface DescribeAuthenticatorResponse {
1211
+ Retain?: number;
472
1212
  /**
473
- * 集群认证器列表
1213
+ * 描述
1214
+ 注意:此字段可能返回 null,表示取不到有效值。
474
1215
  */
475
- Authenticators?: Array<MQTTAuthenticatorItem>;
1216
+ Remark?: string;
476
1217
  /**
477
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1218
+ * 1713164969433
478
1219
  */
479
- RequestId?: string;
1220
+ CreatedTime?: number;
1221
+ /**
1222
+ * 1713164969433
1223
+ */
1224
+ UpdateTime?: number;
480
1225
  }
481
1226
  /**
482
- * DeleteDeviceCertificate请求参数结构体
1227
+ * RevokedDeviceCertificate请求参数结构体
483
1228
  */
484
- export interface DeleteDeviceCertificateRequest {
1229
+ export interface RevokedDeviceCertificateRequest {
485
1230
  /**
486
1231
  * 集群id
487
1232
  */
@@ -492,207 +1237,204 @@ export interface DeleteDeviceCertificateRequest {
492
1237
  DeviceCertificateSn: string;
493
1238
  }
494
1239
  /**
495
- * CreateTopic返回参数结构体
1240
+ * CreateAuthorizationPolicy返回参数结构体
496
1241
  */
497
- export interface CreateTopicResponse {
498
- /**
499
- * 实例ID
500
- */
501
- InstanceId?: string;
502
- /**
503
- * 主题
504
- */
505
- Topic?: string;
1242
+ export interface CreateAuthorizationPolicyResponse {
506
1243
  /**
507
1244
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
508
1245
  */
509
1246
  RequestId?: string;
510
1247
  }
511
1248
  /**
512
- * ModifyJWTAuthenticator请求参数结构体
1249
+ * DescribeAuthenticator请求参数结构体
513
1250
  */
514
- export interface ModifyJWTAuthenticatorRequest {
1251
+ export interface DescribeAuthenticatorRequest {
515
1252
  /**
516
1253
  * 实例ID
517
1254
  */
518
1255
  InstanceId: string;
519
1256
  /**
520
- * 算法:hmac-based,public-key
1257
+ * 认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 HTTP:HTTP认证器
521
1258
  */
522
- Algorithm?: string;
1259
+ Type?: string;
1260
+ }
1261
+ /**
1262
+ * RegisterCaCertificate请求参数结构体
1263
+ */
1264
+ export interface RegisterCaCertificateRequest {
523
1265
  /**
524
- * 设备连接时传递jwt的key;
525
- username-使用用户名字段传递;
526
- password-使用密码字段传递
1266
+ * 集群id
527
1267
  */
528
- From?: string;
1268
+ InstanceId: string;
529
1269
  /**
530
- * 密码
1270
+ * CA证书
531
1271
  */
532
- Secret?: string;
1272
+ CaCertificate: string;
533
1273
  /**
534
- * 公钥
1274
+ * 验证证书
535
1275
  */
536
- PublicKey?: string;
1276
+ VerificationCertificate: string;
537
1277
  /**
538
- * JSKS文本
1278
+ * 证书格式,不传默认PEM格式
539
1279
  */
540
- Text?: string;
1280
+ Format?: string;
541
1281
  /**
542
- * 说明
1282
+ * 证书状态,不传默认ACTIVE状态
1283
+ ACTIVE,//激活
1284
+ INACTIVE,//未激活
1285
+ REVOKED,//吊销
1286
+ PENDING_ACTIVATION,//注册待激活
543
1287
  */
544
- Remark?: string;
1288
+ Status?: string;
545
1289
  }
546
1290
  /**
547
- * DescribeDeviceCertificate返回参数结构体
1291
+ * CreateInstance请求参数结构体
548
1292
  */
549
- export interface DescribeDeviceCertificateResponse {
1293
+ export interface CreateInstanceRequest {
550
1294
  /**
551
- * 创建时间
1295
+ * 实例类型,
1296
+ BASIC 基础版
1297
+ PRO 专业版
552
1298
  */
553
- CreatedTime?: number;
1299
+ InstanceType: string;
554
1300
  /**
555
- * 上次更新时间
1301
+ * 实例名称
556
1302
  */
557
- UpdateTime?: number;
1303
+ Name: string;
558
1304
  /**
559
- * 证书失效日期
1305
+ * 商品规格,可用规格可通过接口DescribeProductSKUList查询
560
1306
  */
561
- NotAfterTime?: number;
1307
+ SkuCode: string;
562
1308
  /**
563
- * 上次激活时间
1309
+ * 备注信息
564
1310
  */
565
- LastActivationTime?: number;
1311
+ Remark?: string;
566
1312
  /**
567
- * 上次取消激活时间
1313
+ * 标签列表
568
1314
  */
569
- LastInactivationTime?: number;
1315
+ TagList?: Array<Tag>;
570
1316
  /**
571
- * 证书状态
1317
+ * 实例绑定的VPC信息
572
1318
  */
573
- Status?: string;
1319
+ VpcList?: Array<VpcInfo>;
574
1320
  /**
575
- * Ca证书序列号
1321
+ * 是否开启公网
576
1322
  */
577
- CaSn?: string;
1323
+ EnablePublic?: boolean;
578
1324
  /**
579
- * 设备证书序列号
1325
+ * 公网带宽(单位:兆)
580
1326
  */
581
- DeviceCertificateSn?: string;
1327
+ Bandwidth?: number;
582
1328
  /**
583
- * 设备证书内容
1329
+ * 公网访问白名单
584
1330
  */
585
- DeviceCertificate?: string;
1331
+ IpRules?: Array<IpRule>;
586
1332
  /**
587
- * 设备证书common name
1333
+ * 是否自动续费(0: 不自动续费;1: 自动续费)
588
1334
  */
589
- DeviceCertificateCn?: string;
1335
+ RenewFlag?: number;
590
1336
  /**
591
- * 证书格式
1337
+ * 购买时长(单位:月)
592
1338
  */
593
- Format?: string;
1339
+ TimeSpan?: number;
594
1340
  /**
595
- * 客户端id
596
- 注意:此字段可能返回 null,表示取不到有效值。
1341
+ * 付费模式(0: 后付费;1: 预付费)
597
1342
  */
598
- ClientId?: string;
1343
+ PayMode?: number;
1344
+ }
1345
+ /**
1346
+ * CreateInsPublicEndpoint请求参数结构体
1347
+ */
1348
+ export interface CreateInsPublicEndpointRequest {
599
1349
  /**
600
- * API, 手动注册
601
- JITP 自动注册
1350
+ * 实例ID
602
1351
  */
603
- CertificateSource?: string;
1352
+ InstanceId: string;
604
1353
  /**
605
- * 证书生效开始时间
1354
+ * 带宽,单位Mbps
606
1355
  */
607
- NotBeforeTime?: number;
1356
+ Bandwidth: number;
608
1357
  /**
609
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1358
+ * 公网访问规则
610
1359
  */
611
- RequestId?: string;
1360
+ Rules?: Array<PublicAccessRule>;
612
1361
  }
613
1362
  /**
614
- * RevokedDeviceCertificate请求参数结构体
1363
+ * RegisterDeviceCertificate请求参数结构体
615
1364
  */
616
- export interface RevokedDeviceCertificateRequest {
1365
+ export interface RegisterDeviceCertificateRequest {
617
1366
  /**
618
1367
  * 集群id
619
1368
  */
620
1369
  InstanceId: string;
621
1370
  /**
622
- * 设备证书序列号
1371
+ * 设备证书
623
1372
  */
624
- DeviceCertificateSn: string;
625
- }
626
- /**
627
- * 策略规则优先级
628
- */
629
- export interface AuthorizationPolicyPriority {
1373
+ DeviceCertificate: string;
630
1374
  /**
631
- * 策略id
632
- 注意:此字段可能返回 null,表示取不到有效值。
1375
+ * 关联的CA证书SN
633
1376
  */
634
- Id: number;
1377
+ CaSn: string;
635
1378
  /**
636
- * 优先级
637
- 注意:此字段可能返回 null,表示取不到有效值。
1379
+ * 客户端ID
638
1380
  */
639
- Priority: number;
640
- }
641
- /**
642
- * CreateAuthorizationPolicy返回参数结构体
643
- */
644
- export interface CreateAuthorizationPolicyResponse {
1381
+ ClientId?: string;
645
1382
  /**
646
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1383
+ * 证书格式
647
1384
  */
648
- RequestId?: string;
649
- }
650
- /**
651
- * DeleteDeviceCertificate返回参数结构体
652
- */
653
- export interface DeleteDeviceCertificateResponse {
1385
+ Format?: string;
654
1386
  /**
655
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1387
+ * ACTIVE,//激活 INACTIVE,//未激活 REVOKED,//吊销 PENDING_ACTIVATION,//注册待激活
656
1388
  */
657
- RequestId?: string;
1389
+ Status?: string;
658
1390
  }
659
1391
  /**
660
- * CreateJWTAuthenticator请求参数结构体
1392
+ * 查询过滤器
661
1393
  */
662
- export interface CreateJWTAuthenticatorRequest {
1394
+ export interface Filter {
663
1395
  /**
664
- * 实例ID
1396
+ * 过滤条件名
665
1397
  */
666
- InstanceId: string;
1398
+ Name: string;
667
1399
  /**
668
- * 算法:hmac-based,public-key
1400
+ * 过滤条件的值
669
1401
  */
670
- Algorithm: string;
1402
+ Values: Array<string>;
1403
+ }
1404
+ /**
1405
+ * DeactivateDeviceCertificate请求参数结构体
1406
+ */
1407
+ export interface DeactivateDeviceCertificateRequest {
671
1408
  /**
672
- * 设备连接时传递jwt的key;username-使用用户名字段传递;password-使用密码字段传递
1409
+ * 集群id
673
1410
  */
674
- From: string;
1411
+ InstanceId: string;
675
1412
  /**
676
- * 密码
1413
+ * 设备证书序列号
677
1414
  */
678
- Secret?: string;
1415
+ DeviceCertificateSn: string;
1416
+ }
1417
+ /**
1418
+ * DescribeDeviceCertificates返回参数结构体
1419
+ */
1420
+ export interface DescribeDeviceCertificatesResponse {
679
1421
  /**
680
- * 公钥
1422
+ * 总数
681
1423
  */
682
- PublicKey?: string;
1424
+ TotalCount?: number;
683
1425
  /**
684
- * 认证器是否开启:open-启用;close-关闭
1426
+ * 设备证书
685
1427
  */
686
- Status?: string;
1428
+ Data?: Array<DeviceCertificateItem>;
687
1429
  /**
688
- * 说明
1430
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
689
1431
  */
690
- Remark?: string;
1432
+ RequestId?: string;
691
1433
  }
692
1434
  /**
693
- * DeleteTopic请求参数结构体
1435
+ * ModifyTopic请求参数结构体
694
1436
  */
695
- export interface DeleteTopicRequest {
1437
+ export interface ModifyTopicRequest {
696
1438
  /**
697
1439
  * 实例ID
698
1440
  */
@@ -701,550 +1443,549 @@ export interface DeleteTopicRequest {
701
1443
  * 主题
702
1444
  */
703
1445
  Topic: string;
1446
+ /**
1447
+ * 备注信息
1448
+ */
1449
+ Remark?: string;
704
1450
  }
705
1451
  /**
706
- * CreateJWKSAuthenticator请求参数结构体
1452
+ * CreateUser请求参数结构体
707
1453
  */
708
- export interface CreateJWKSAuthenticatorRequest {
1454
+ export interface CreateUserRequest {
709
1455
  /**
710
1456
  * 实例ID
711
1457
  */
712
1458
  InstanceId: string;
713
1459
  /**
714
- * jwks端点
715
- */
716
- Endpoint?: string;
717
- /**
718
- * jwks刷新间隔,单位:秒
719
- */
720
- RefreshInterval?: number;
721
- /**
722
- * jwks文本
1460
+ * 用户名
723
1461
  */
724
- Text?: string;
1462
+ Username: string;
725
1463
  /**
726
- * 认证器是否开启:open-启用;close-关闭
1464
+ * 密码,该字段为空时候则后端会默认生成
727
1465
  */
728
- Status?: string;
1466
+ Password?: string;
729
1467
  /**
730
- * 说明
1468
+ * 备注
731
1469
  */
732
1470
  Remark?: string;
733
- /**
734
- * 设备连接时传递jwt的key;
735
- username-使用用户名字段传递;
736
- password-使用密码字段传递
737
- */
738
- From?: string;
739
1471
  }
740
1472
  /**
741
- * ModifyTopic返回参数结构体
1473
+ * DescribeInstance返回参数结构体
742
1474
  */
743
- export interface ModifyTopicResponse {
1475
+ export interface DescribeInstanceResponse {
744
1476
  /**
745
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1477
+ * 实例类型
1478
+ BASIC 基础版
1479
+ PRO 专业版
746
1480
  */
747
- RequestId?: string;
748
- }
749
- /**
750
- * DescribeTopic返回参数结构体
751
- */
752
- export interface DescribeTopicResponse {
1481
+ InstanceType?: string;
753
1482
  /**
754
1483
  * 实例ID
755
1484
  */
756
1485
  InstanceId?: string;
757
1486
  /**
758
- * 主题名称
1487
+ * 实例名称
759
1488
  */
760
- Topic?: string;
1489
+ InstanceName?: string;
761
1490
  /**
762
- * 备注
1491
+ * 主题数量
763
1492
  */
764
- Remark?: string;
1493
+ TopicNum?: number;
1494
+ /**
1495
+ * 实例最大主题数量
1496
+ */
1497
+ TopicNumLimit?: number;
1498
+ /**
1499
+ * TPS限流值
1500
+ */
1501
+ TpsLimit?: number;
765
1502
  /**
766
1503
  * 创建时间,秒为单位
767
1504
  */
768
1505
  CreatedTime?: number;
769
1506
  /**
770
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1507
+ * 备注信息
771
1508
  */
772
- RequestId?: string;
773
- }
774
- /**
775
- * DescribeDeviceCertificates请求参数结构体
776
- */
777
- export interface DescribeDeviceCertificatesRequest {
1509
+ Remark?: string;
778
1510
  /**
779
- * 集群ID
1511
+ * 实例状态
780
1512
  */
781
- InstanceId: string;
1513
+ InstanceStatus?: string;
782
1514
  /**
783
- * 过滤器支持ClientId、CaSn、DeviceCertificateSn、Status搜索
1515
+ * 实例规格
784
1516
  */
785
- Filters?: Array<Filter>;
1517
+ SkuCode?: string;
786
1518
  /**
787
- * 分页limit
1519
+ * 单客户端最大订阅数
788
1520
  */
789
- Limit?: number;
1521
+ MaxSubscriptionPerClient?: number;
790
1522
  /**
791
- * 分页偏移量
1523
+ * 授权规则条数
792
1524
  */
793
- Offset?: number;
1525
+ AuthorizationPolicyLimit?: number;
794
1526
  /**
795
- * CREATE_TIME_DESC, 创建时间降序
796
- CREATE_TIME_ASC,创建时间升序
797
- UPDATE_TIME_DESC,更新时间降序
798
- UPDATE_TIME_ASC,更新时间升序
1527
+ * 客户端数量上限
799
1528
  */
800
- OrderBy?: string;
801
- }
802
- /**
803
- * CreateJWKSAuthenticator返回参数结构体
804
- */
805
- export interface CreateJWKSAuthenticatorResponse {
1529
+ ClientNumLimit?: number;
806
1530
  /**
807
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1531
+ * 客户端证书注册方式:
1532
+ JITP:自动注册
1533
+ API:通过API手动注册
808
1534
  */
809
- RequestId?: string;
810
- }
811
- /**
812
- * DeleteAuthenticator请求参数结构体
813
- */
814
- export interface DeleteAuthenticatorRequest {
1535
+ DeviceCertificateProvisionType?: string;
815
1536
  /**
816
- * 实例ID
1537
+ * 自动注册设备证书时是否自动激活
817
1538
  */
818
- InstanceId: string;
1539
+ AutomaticActivation?: boolean;
819
1540
  /**
820
- * 认证器类型:
821
- JWT:JWT认证器
822
- JWKS:JWKS认证器
823
- BYOC:一端一证认证器
1541
+ * 是否自动续费
824
1542
  */
825
- Type: string;
826
- }
827
- /**
828
- * DescribeAuthorizationPolicies返回参数结构体
829
- */
830
- export interface DescribeAuthorizationPoliciesResponse {
1543
+ RenewFlag?: number;
831
1544
  /**
832
- * 规则
1545
+ * 计费模式, POSTPAID,按量计费 PREPAID,包年包月
833
1546
  */
834
- Data?: Array<AuthorizationPolicyItem>;
1547
+ PayMode?: string;
835
1548
  /**
836
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1549
+ * 到期时间,秒为单位
837
1550
  */
838
- RequestId?: string;
839
- }
840
- /**
841
- * RegisterDeviceCertificate请求参数结构体
842
- */
843
- export interface RegisterDeviceCertificateRequest {
1551
+ ExpiryTime?: number;
844
1552
  /**
845
- * 集群id
1553
+ * 预销毁时间
846
1554
  */
847
- InstanceId: string;
1555
+ DestroyTime?: number;
848
1556
  /**
849
- * 设备证书
1557
+ * TLS,单向认证 mTLS,双向认证 BYOC;一机一证
850
1558
  */
851
- DeviceCertificate: string;
1559
+ X509Mode?: string;
852
1560
  /**
853
- * 关联的CA证书SN
1561
+ * 最大Ca配额
854
1562
  */
855
- CaSn: string;
1563
+ MaxCaNum?: number;
856
1564
  /**
857
- * 客户端ID
1565
+ * 证书注册码
858
1566
  */
859
- ClientId?: string;
1567
+ RegistrationCode?: string;
860
1568
  /**
861
- * 证书格式
1569
+ * 集群最大订阅数
862
1570
  */
863
- Format?: string;
1571
+ MaxSubscription?: number;
864
1572
  /**
865
- * ACTIVE,//激活 INACTIVE,//未激活 REVOKED,//吊销 PENDING_ACTIVATION,//注册待激活
1573
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
866
1574
  */
867
- Status?: string;
1575
+ RequestId?: string;
868
1576
  }
869
1577
  /**
870
- * CreateTopic请求参数结构体
1578
+ * ModifyInstanceCertBinding返回参数结构体
871
1579
  */
872
- export interface CreateTopicRequest {
1580
+ export interface ModifyInstanceCertBindingResponse {
873
1581
  /**
874
- * 实例ID
875
- */
876
- InstanceId: string;
877
- /**
878
- * 主题
1582
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
879
1583
  */
880
- Topic: string;
1584
+ RequestId?: string;
1585
+ }
1586
+ /**
1587
+ * DeleteInstance请求参数结构体
1588
+ */
1589
+ export interface DeleteInstanceRequest {
881
1590
  /**
882
- * 备注
1591
+ * 实例ID
883
1592
  */
884
- Remark?: string;
1593
+ InstanceId: string;
885
1594
  }
886
1595
  /**
887
- * MQTT 主题详情
1596
+ * DescribeInsPublicEndpoints返回参数结构体
888
1597
  */
889
- export interface MQTTTopicItem {
1598
+ export interface DescribeInsPublicEndpointsResponse {
890
1599
  /**
891
- * 实例 ID
1600
+ * 接入点
892
1601
  */
893
- InstanceId?: string;
1602
+ Endpoints?: Array<MQTTEndpointItem>;
894
1603
  /**
895
- * 主题名称
1604
+ * 实例id
896
1605
  */
897
- Topic?: string;
1606
+ InstanceId?: string;
898
1607
  /**
899
- * 主题描述
900
- 注意:此字段可能返回 null,表示取不到有效值。
1608
+ * 带宽
901
1609
  */
902
- Remark?: string;
903
- }
904
- /**
905
- * 查询过滤器
906
- */
907
- export interface Filter {
1610
+ Bandwidth?: number;
908
1611
  /**
909
- * 过滤条件名
1612
+ * 公网访问规则
910
1613
  */
911
- Name: string;
1614
+ Rules?: Array<PublicAccessRule>;
912
1615
  /**
913
- * 过滤条件的值
1616
+ * 公网状态:
1617
+ NORMAL-正常
1618
+ CLOSING-关闭中
1619
+ MODIFYING-修改中
1620
+ CREATING-开启中
1621
+ CLOSE-关闭
914
1622
  */
915
- Values: Array<string>;
916
- }
917
- /**
918
- * DeleteAuthorizationPolicy返回参数结构体
919
- */
920
- export interface DeleteAuthorizationPolicyResponse {
1623
+ Status?: string;
921
1624
  /**
922
1625
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
923
1626
  */
924
1627
  RequestId?: string;
925
1628
  }
926
1629
  /**
927
- * DescribeDeviceCertificates返回参数结构体
1630
+ * ModifyInsPublicEndpoint请求参数结构体
928
1631
  */
929
- export interface DescribeDeviceCertificatesResponse {
1632
+ export interface ModifyInsPublicEndpointRequest {
930
1633
  /**
931
- * 总数
1634
+ * 实例ID
932
1635
  */
933
- TotalCount?: number;
1636
+ InstanceId: string;
934
1637
  /**
935
- * 设备证书
1638
+ * 带宽,单位:Mbps
936
1639
  */
937
- Data?: Array<DeviceCertificateItem>;
1640
+ Bandwidth: number;
938
1641
  /**
939
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1642
+ * 公网访问规则
940
1643
  */
941
- RequestId?: string;
1644
+ Rules: Array<PublicAccessRule>;
942
1645
  }
943
1646
  /**
944
- * ModifyJWKSAuthenticator请求参数结构体
1647
+ * DeleteInsPublicEndpoint请求参数结构体
945
1648
  */
946
- export interface ModifyJWKSAuthenticatorRequest {
1649
+ export interface DeleteInsPublicEndpointRequest {
947
1650
  /**
948
1651
  * 实例ID
949
1652
  */
950
1653
  InstanceId: string;
1654
+ }
1655
+ /**
1656
+ * DescribeUserList请求参数结构体
1657
+ */
1658
+ export interface DescribeUserListRequest {
951
1659
  /**
952
- * 端点
1660
+ * 实例ID
953
1661
  */
954
- Endpoint?: string;
1662
+ InstanceId: string;
955
1663
  /**
956
- * 认证器状态:open-启用;close-关闭
1664
+ * 查询条件列表支持字段
1665
+ Username:Username模糊查询
957
1666
  */
958
- Status?: string;
1667
+ Filters?: Array<Filter>;
959
1668
  /**
960
- * 刷新时间
1669
+ * 查询起始位置
961
1670
  */
962
- RefreshInterval?: number;
1671
+ Offset?: number;
963
1672
  /**
964
- * JSKS文本
1673
+ * 查询结果限制数量
965
1674
  */
966
- Text?: string;
1675
+ Limit?: number;
1676
+ }
1677
+ /**
1678
+ * DescribeCaCertificate请求参数结构体
1679
+ */
1680
+ export interface DescribeCaCertificateRequest {
967
1681
  /**
968
- * 设备连接时传递jwt的key;username-使用用户名字段传递;password-使用密码字段传递
1682
+ * ca证书sn
969
1683
  */
970
- From?: string;
1684
+ CaSn: string;
971
1685
  /**
972
- * 说明
1686
+ * 集群id
973
1687
  */
974
- Remark?: string;
1688
+ InstanceId: string;
975
1689
  }
976
1690
  /**
977
- * ModifyTopic请求参数结构体
1691
+ * UpdateAuthorizationPolicyPriority请求参数结构体
978
1692
  */
979
- export interface ModifyTopicRequest {
1693
+ export interface UpdateAuthorizationPolicyPriorityRequest {
980
1694
  /**
981
1695
  * 实例ID
982
1696
  */
983
1697
  InstanceId: string;
984
1698
  /**
985
- * 主题
986
- */
987
- Topic: string;
988
- /**
989
- * 备注信息
1699
+ * 策略ID和优先级
990
1700
  */
991
- Remark?: string;
1701
+ Priorities?: Array<AuthorizationPolicyPriority>;
992
1702
  }
993
1703
  /**
994
- * DescribeTopicList返回参数结构体
1704
+ * CreateJWTAuthenticator返回参数结构体
995
1705
  */
996
- export interface DescribeTopicListResponse {
997
- /**
998
- * 查询总数
999
- 注意:此字段可能返回 null,表示取不到有效值。
1000
- */
1001
- TotalCount?: number;
1002
- /**
1003
- * 主题列表
1004
- */
1005
- Data?: Array<MQTTTopicItem>;
1706
+ export interface CreateJWTAuthenticatorResponse {
1006
1707
  /**
1007
1708
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1008
1709
  */
1009
1710
  RequestId?: string;
1010
1711
  }
1011
1712
  /**
1012
- * DescribeAuthenticator请求参数结构体
1713
+ * DeleteAuthorizationPolicy请求参数结构体
1013
1714
  */
1014
- export interface DescribeAuthenticatorRequest {
1715
+ export interface DeleteAuthorizationPolicyRequest {
1015
1716
  /**
1016
1717
  * 实例ID
1017
1718
  */
1018
1719
  InstanceId: string;
1019
1720
  /**
1020
- * 认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 HTTP:HTTP认证器
1721
+ * 策略规则id
1021
1722
  */
1022
- Type?: string;
1723
+ Id: number;
1023
1724
  }
1024
1725
  /**
1025
- * MQTT 实例信息
1726
+ * DescribeAuthorizationPolicies请求参数结构体
1026
1727
  */
1027
- export interface MQTTInstanceItem {
1728
+ export interface DescribeAuthorizationPoliciesRequest {
1028
1729
  /**
1029
- * 实例ID
1730
+ * 集群ID
1030
1731
  */
1031
1732
  InstanceId?: string;
1733
+ }
1734
+ /**
1735
+ * DescribeTopicList返回参数结构体
1736
+ */
1737
+ export interface DescribeTopicListResponse {
1032
1738
  /**
1033
- * 实例名称
1034
- */
1035
- InstanceName?: string;
1036
- /**
1037
- * 实例版本
1038
- */
1039
- Version?: string;
1040
- /**
1041
- * 实例类型,
1042
- EXPERIMENT,体验版
1043
- BASIC,基础版
1044
- PRO,专业版
1045
- PLATINUM,铂金版
1739
+ * 查询总数
1740
+ 注意:此字段可能返回 null,表示取不到有效值。
1046
1741
  */
1047
- InstanceType?: string;
1742
+ TotalCount?: number;
1048
1743
  /**
1049
- * 实例状态,
1050
- RUNNING, 运行中
1051
- MAINTAINING,维护中
1052
- ABNORMAL,异常
1053
- OVERDUE,欠费
1054
- DESTROYED,已删除
1055
- CREATING,创建中
1056
- MODIFYING,变配中
1057
- CREATE_FAILURE,创建失败
1058
- MODIFY_FAILURE,变配失败
1059
- DELETING,删除中
1744
+ * 主题列表
1060
1745
  */
1061
- InstanceStatus?: string;
1746
+ Data?: Array<MQTTTopicItem>;
1062
1747
  /**
1063
- * 实例主题数上限
1748
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1064
1749
  */
1065
- TopicNumLimit?: number;
1750
+ RequestId?: string;
1751
+ }
1752
+ /**
1753
+ * DescribeDeviceCertificate返回参数结构体
1754
+ */
1755
+ export interface DescribeDeviceCertificateResponse {
1066
1756
  /**
1067
- * 备注信息
1068
- 注意:此字段可能返回 null,表示取不到有效值。
1757
+ * 创建时间
1069
1758
  */
1070
- Remark?: string;
1759
+ CreatedTime?: number;
1071
1760
  /**
1072
- * 主题数量
1761
+ * 上次更新时间
1073
1762
  */
1074
- TopicNum?: number;
1763
+ UpdateTime?: number;
1075
1764
  /**
1076
- * 商品规格
1765
+ * 证书失效日期
1077
1766
  */
1078
- SkuCode?: string;
1767
+ NotAfterTime?: number;
1079
1768
  /**
1080
- * 弹性TPS限流值
1081
- 注意:此字段可能返回 null,表示取不到有效值。
1769
+ * 上次激活时间
1082
1770
  */
1083
- TpsLimit?: number;
1771
+ LastActivationTime?: number;
1084
1772
  /**
1085
- * 创建时间
1086
- 注意:此字段可能返回 null,表示取不到有效值。
1773
+ * 上次取消激活时间
1087
1774
  */
1088
- CreateTime?: number;
1775
+ LastInactivationTime?: number;
1089
1776
  /**
1090
- * 单客户端最大订阅数量
1091
- 注意:此字段可能返回 null,表示取不到有效值。
1777
+ * 证书状态
1092
1778
  */
1093
- MaxSubscriptionPerClient?: number;
1779
+ Status?: string;
1094
1780
  /**
1095
- * 客户端连接数上线
1096
- 注意:此字段可能返回 null,表示取不到有效值。
1781
+ * Ca证书序列号
1097
1782
  */
1098
- ClientNumLimit?: number;
1783
+ CaSn?: string;
1099
1784
  /**
1100
- * 是否自动续费
1101
- 注意:此字段可能返回 null,表示取不到有效值。
1785
+ * 设备证书序列号
1102
1786
  */
1103
- RenewFlag?: number;
1787
+ DeviceCertificateSn?: string;
1104
1788
  /**
1105
- * 计费模式, POSTPAID,按量计费 PREPAID,包年包月
1106
- 注意:此字段可能返回 null,表示取不到有效值。
1789
+ * 设备证书内容
1107
1790
  */
1108
- PayMode?: string;
1791
+ DeviceCertificate?: string;
1109
1792
  /**
1110
- * 到期时间,秒为单位
1111
- 注意:此字段可能返回 null,表示取不到有效值。
1793
+ * 设备证书common name
1112
1794
  */
1113
- ExpiryTime?: number;
1795
+ DeviceCertificateCn?: string;
1114
1796
  /**
1115
- * 预销毁时间
1116
- 注意:此字段可能返回 null,表示取不到有效值。
1797
+ * 证书格式
1117
1798
  */
1118
- DestroyTime?: number;
1799
+ Format?: string;
1119
1800
  /**
1120
- * 授权规则条数限制
1801
+ * 客户端id
1121
1802
  注意:此字段可能返回 null,表示取不到有效值。
1122
1803
  */
1123
- AuthorizationPolicyLimit?: number;
1804
+ ClientId?: string;
1124
1805
  /**
1125
- * 最大ca配额
1126
- 注意:此字段可能返回 null,表示取不到有效值。
1806
+ * API, 手动注册
1807
+ JITP 自动注册
1127
1808
  */
1128
- MaxCaNum?: number;
1809
+ CertificateSource?: string;
1129
1810
  /**
1130
- * 最大订阅数
1131
- 注意:此字段可能返回 null,表示取不到有效值。
1811
+ * 证书生效开始时间
1132
1812
  */
1133
- MaxSubscription?: number;
1134
- }
1135
- /**
1136
- * RevokedDeviceCertificate返回参数结构体
1137
- */
1138
- export interface RevokedDeviceCertificateResponse {
1813
+ NotBeforeTime?: number;
1139
1814
  /**
1140
1815
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1141
1816
  */
1142
1817
  RequestId?: string;
1143
1818
  }
1144
1819
  /**
1145
- * DeleteTopic返回参数结构体
1820
+ * DescribeInstanceList请求参数结构体
1146
1821
  */
1147
- export interface DeleteTopicResponse {
1822
+ export interface DescribeInstanceListRequest {
1148
1823
  /**
1149
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1824
+ * 查询条件列表,支持以下子弹
1825
+ InstanceName:集群名模糊搜索
1826
+ InstanceId:集群id精确搜索
1827
+ InstanceStatus:集群状态搜索
1150
1828
  */
1151
- RequestId?: string;
1152
- }
1153
- /**
1154
- * DeactivateDeviceCertificate返回参数结构体
1155
- */
1156
- export interface DeactivateDeviceCertificateResponse {
1829
+ Filters?: Array<Filter>;
1157
1830
  /**
1158
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1831
+ * 查询起始位置
1159
1832
  */
1160
- RequestId?: string;
1833
+ Offset?: number;
1834
+ /**
1835
+ * 查询结果限制数量
1836
+ */
1837
+ Limit?: number;
1838
+ /**
1839
+ * 标签过滤器
1840
+ */
1841
+ TagFilters?: Array<TagFilter>;
1161
1842
  }
1162
1843
  /**
1163
- * DescribeDeviceCertificate请求参数结构体
1844
+ * DeactivateCaCertificate请求参数结构体
1164
1845
  */
1165
- export interface DescribeDeviceCertificateRequest {
1166
- /**
1167
- * 设备证书sn
1168
- */
1169
- DeviceCertificateSn: string;
1846
+ export interface DeactivateCaCertificateRequest {
1170
1847
  /**
1171
1848
  * 集群id
1172
1849
  */
1173
1850
  InstanceId: string;
1851
+ /**
1852
+ * 证书序列号
1853
+ */
1854
+ CaSn: string;
1174
1855
  }
1175
1856
  /**
1176
- * DeactivateDeviceCertificate请求参数结构体
1857
+ * CreateJWTAuthenticator请求参数结构体
1177
1858
  */
1178
- export interface DeactivateDeviceCertificateRequest {
1859
+ export interface CreateJWTAuthenticatorRequest {
1179
1860
  /**
1180
- * 集群id
1861
+ * 实例ID
1181
1862
  */
1182
1863
  InstanceId: string;
1183
1864
  /**
1184
- * 设备证书序列号
1865
+ * 算法:hmac-based,public-key
1185
1866
  */
1186
- DeviceCertificateSn: string;
1867
+ Algorithm: string;
1868
+ /**
1869
+ * 设备连接时传递jwt的key;username-使用用户名字段传递;password-使用密码字段传递
1870
+ */
1871
+ From: string;
1872
+ /**
1873
+ * 密码
1874
+ */
1875
+ Secret?: string;
1876
+ /**
1877
+ * 公钥
1878
+ */
1879
+ PublicKey?: string;
1880
+ /**
1881
+ * 认证器是否开启:open-启用;close-关闭
1882
+ */
1883
+ Status?: string;
1884
+ /**
1885
+ * 说明
1886
+ */
1887
+ Remark?: string;
1187
1888
  }
1188
1889
  /**
1189
- * DescribeInstance请求参数结构体
1890
+ * DescribeCaCertificates请求参数结构体
1190
1891
  */
1191
- export interface DescribeInstanceRequest {
1892
+ export interface DescribeCaCertificatesRequest {
1192
1893
  /**
1193
- * 实例ID
1894
+ * 集群ID
1194
1895
  */
1195
1896
  InstanceId: string;
1196
1897
  }
1197
1898
  /**
1198
- * MQTT认证器信息
1899
+ * 设备证书信息
1199
1900
  */
1200
- export interface MQTTAuthenticatorItem {
1901
+ export interface DeviceCertificateItem {
1201
1902
  /**
1202
- * 认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 BYOC:一端一证认证器
1903
+ * 客户端id
1203
1904
  注意:此字段可能返回 null,表示取不到有效值。
1204
1905
  */
1205
- Type?: string;
1906
+ ClientId?: string;
1206
1907
  /**
1207
- * 认证器配置
1908
+ * 设备证书
1909
+ */
1910
+ DeviceCertificate?: string;
1911
+ /**
1912
+ * 设备证书Sn
1913
+ */
1914
+ DeviceCertificateSn?: string;
1915
+ /**
1916
+ * 设备证书Cn
1917
+ */
1918
+ DeviceCertificateCn?: string;
1919
+ /**
1920
+ * 签发ca的序列号
1921
+ */
1922
+ CaSn?: string;
1923
+ /**
1924
+ * 证书格式
1925
+ */
1926
+ Format?: string;
1927
+ /**
1928
+ * 证书状态
1929
+ ACTIVE,//激活
1930
+ INACTIVE,//未激活
1931
+ REVOKED,//吊销
1932
+ PENDING_ACTIVATION,//注册待激活
1933
+ */
1934
+ Status?: string;
1935
+ /**
1936
+ * 上次激活时间
1208
1937
  注意:此字段可能返回 null,表示取不到有效值。
1209
1938
  */
1210
- Config?: string;
1939
+ LastActivationTime?: number;
1211
1940
  /**
1212
- * 认证器状态
1941
+ * 上次取消激活时间
1213
1942
  注意:此字段可能返回 null,表示取不到有效值。
1214
1943
  */
1215
- Status?: string;
1944
+ LastInactivationTime?: number;
1216
1945
  /**
1217
1946
  * 创建时间
1947
+ */
1948
+ CreatedTime?: number;
1949
+ /**
1950
+ * 预销毁时间
1218
1951
  注意:此字段可能返回 null,表示取不到有效值。
1219
1952
  */
1220
- CreateTime?: number;
1953
+ UpdateTime?: number;
1221
1954
  /**
1222
- * 说明
1955
+ * 证书来源:
1956
+ API, 手动注册
1957
+ JITP 自动注册
1223
1958
  注意:此字段可能返回 null,表示取不到有效值。
1224
1959
  */
1225
- Remark?: string;
1226
- }
1227
- /**
1228
- * DeleteAuthenticator返回参数结构体
1229
- */
1230
- export interface DeleteAuthenticatorResponse {
1960
+ CertificateSource?: string;
1231
1961
  /**
1232
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1962
+ * 证书失效日期
1963
+ 注意:此字段可能返回 null,表示取不到有效值。
1233
1964
  */
1234
- RequestId?: string;
1965
+ NotAfterTime?: number;
1966
+ /**
1967
+ * 证书生效开始日期
1968
+ 注意:此字段可能返回 null,表示取不到有效值。
1969
+ */
1970
+ NotBeforeTime?: number;
1235
1971
  }
1236
1972
  /**
1237
- * 标签过滤器
1973
+ * MQTT 主题详情
1238
1974
  */
1239
- export interface TagFilter {
1975
+ export interface MQTTTopicItem {
1240
1976
  /**
1241
- * 标签键名称
1977
+ * 实例 ID
1242
1978
  */
1243
- TagKey?: string;
1979
+ InstanceId?: string;
1244
1980
  /**
1245
- * 标签键名称
1981
+ * 主题名称
1246
1982
  */
1247
- TagValues?: Array<string>;
1983
+ Topic?: string;
1984
+ /**
1985
+ * 主题描述
1986
+ 注意:此字段可能返回 null,表示取不到有效值。
1987
+ */
1988
+ Remark?: string;
1248
1989
  }
1249
1990
  /**
1250
1991
  * ModifyAuthorizationPolicy请求参数结构体
@@ -1308,42 +2049,120 @@ export interface ModifyAuthorizationPolicyRequest {
1308
2049
  Remark?: string;
1309
2050
  }
1310
2051
  /**
1311
- * ActivateDeviceCertificate返回参数结构体
2052
+ * RevokedDeviceCertificate返回参数结构体
1312
2053
  */
1313
- export interface ActivateDeviceCertificateResponse {
2054
+ export interface RevokedDeviceCertificateResponse {
1314
2055
  /**
1315
2056
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1316
2057
  */
1317
2058
  RequestId?: string;
1318
2059
  }
1319
2060
  /**
1320
- * DescribeInstanceList返回参数结构体
2061
+ * DeleteTopic返回参数结构体
1321
2062
  */
1322
- export interface DescribeInstanceListResponse {
2063
+ export interface DeleteTopicResponse {
1323
2064
  /**
1324
- * 查询总数
1325
- 注意:此字段可能返回 null,表示取不到有效值。
2065
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1326
2066
  */
1327
- TotalCount?: number;
2067
+ RequestId?: string;
2068
+ }
2069
+ /**
2070
+ * ModifyInstanceCertBinding请求参数结构体
2071
+ */
2072
+ export interface ModifyInstanceCertBindingRequest {
1328
2073
  /**
1329
- * 实例列表
2074
+ * 实例ID
1330
2075
  */
1331
- Data?: Array<MQTTInstanceItem>;
2076
+ InstanceId: string;
2077
+ /**
2078
+ * 服务端证书id
2079
+ */
2080
+ SSLServerCertId: string;
2081
+ /**
2082
+ * CA证书id
2083
+ */
2084
+ SSLCaCertId: string;
2085
+ /**
2086
+ * 加密通信方式
2087
+ TLS:单向证书认证
2088
+ mTLS:双向证书认证
2089
+ BYOC:一设备一证书认证
2090
+ */
2091
+ X509Mode: string;
2092
+ /**
2093
+ * 设备证书注册类型:
2094
+ JITP,自动注册;
2095
+ MANUAL 手动注册
2096
+ */
2097
+ DeviceCertificateProvisionType?: string;
2098
+ /**
2099
+ * 是否自动激活,默认为false
2100
+ */
2101
+ AutomaticActivation?: boolean;
2102
+ }
2103
+ /**
2104
+ * DescribeInstance请求参数结构体
2105
+ */
2106
+ export interface DescribeInstanceRequest {
2107
+ /**
2108
+ * 实例ID
2109
+ */
2110
+ InstanceId: string;
2111
+ }
2112
+ /**
2113
+ * DescribeCaCertificates返回参数结构体
2114
+ */
2115
+ export interface DescribeCaCertificatesResponse {
2116
+ /**
2117
+ * ca证书列表
2118
+ */
2119
+ Data?: Array<CaCertificateItem>;
1332
2120
  /**
1333
2121
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1334
2122
  */
1335
2123
  RequestId?: string;
1336
2124
  }
1337
2125
  /**
1338
- * DescribeTopic请求参数结构体
2126
+ * ModifyUser请求参数结构体
1339
2127
  */
1340
- export interface DescribeTopicRequest {
2128
+ export interface ModifyUserRequest {
1341
2129
  /**
1342
2130
  * 实例ID
1343
2131
  */
1344
2132
  InstanceId: string;
1345
2133
  /**
1346
- * 主题
2134
+ * 用户名
1347
2135
  */
1348
- Topic: string;
2136
+ Username: string;
2137
+ /**
2138
+ * 备注
2139
+ */
2140
+ Remark?: string;
2141
+ }
2142
+ /**
2143
+ * DeleteAuthenticator返回参数结构体
2144
+ */
2145
+ export interface DeleteAuthenticatorResponse {
2146
+ /**
2147
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2148
+ */
2149
+ RequestId?: string;
2150
+ }
2151
+ /**
2152
+ * IP规则
2153
+ */
2154
+ export interface IpRule {
2155
+ /**
2156
+ * IP地址
2157
+ */
2158
+ Ip: string;
2159
+ /**
2160
+ * 是否允许放行
2161
+ */
2162
+ Allow: boolean;
2163
+ /**
2164
+ * 备注信息
2165
+ 注意:此字段可能返回 null,表示取不到有效值。
2166
+ */
2167
+ Remark: string;
1349
2168
  }