tencentcloud-sdk-nodejs 4.0.1026 → 4.0.1028

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