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