tencentcloud-sdk-nodejs 4.0.1026 → 4.0.1027

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