tencentcloud-sdk-nodejs-cloudaudit 4.0.388 → 4.0.431

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.
@@ -19,85 +19,92 @@
19
19
  * InquireAuditCredit返回参数结构体
20
20
  */
21
21
  export interface InquireAuditCreditResponse {
22
- /**
23
- * 可创建跟踪集的数量
24
- */
25
- AuditAmount: number
26
22
 
27
- /**
28
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
29
- */
30
- RequestId?: string
23
+ /**
24
+ * 可创建跟踪集的数量
25
+ */
26
+ AuditAmount: number;
27
+
28
+ /**
29
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
30
+ */
31
+ RequestId?: string;
31
32
  }
32
33
 
33
34
  /**
34
35
  * StopLogging请求参数结构体
35
36
  */
36
37
  export interface StopLoggingRequest {
37
- /**
38
- * 跟踪集名称
39
- */
40
- AuditName: string
38
+
39
+ /**
40
+ * 跟踪集名称
41
+ */
42
+ AuditName: string;
41
43
  }
42
44
 
43
45
  /**
44
46
  * cmq地域信息
45
47
  */
46
48
  export interface CmqRegionInfo {
47
- /**
48
- * 地域描述
49
- */
50
- CmqRegionName?: string
51
49
 
52
- /**
53
- * cmq地域
54
- */
55
- CmqRegion?: string
50
+ /**
51
+ * 地域描述
52
+ */
53
+ CmqRegionName?: string;
54
+
55
+ /**
56
+ * cmq地域
57
+ */
58
+ CmqRegion?: string;
56
59
  }
57
60
 
58
61
  /**
59
62
  * GetAttributeKey请求参数结构体
60
63
  */
61
64
  export interface GetAttributeKeyRequest {
62
- /**
63
- * 网站类型,取值范围是zh和en。如果不传值默认zh
64
- */
65
- WebsiteType?: string
65
+
66
+ /**
67
+ * 网站类型,取值范围是zh和en。如果不传值默认zh
68
+ */
69
+ WebsiteType?: string;
66
70
  }
67
71
 
68
72
  /**
69
73
  * DescribeAuditTracks返回参数结构体
70
74
  */
71
75
  export interface DescribeAuditTracksResponse {
72
- /**
73
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
74
- */
75
- RequestId?: string
76
+
77
+ /**
78
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
79
+ */
80
+ RequestId?: string;
76
81
  }
77
82
 
78
83
  /**
79
84
  * DeleteAudit返回参数结构体
80
85
  */
81
86
  export interface DeleteAuditResponse {
82
- /**
83
- * 是否删除成功
84
- */
85
- IsSuccess: number
86
87
 
87
- /**
88
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
89
- */
90
- RequestId?: string
88
+ /**
89
+ * 是否删除成功
90
+ */
91
+ IsSuccess: number;
92
+
93
+ /**
94
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
95
+ */
96
+ RequestId?: string;
91
97
  }
92
98
 
93
99
  /**
94
100
  * ModifyAuditTrack返回参数结构体
95
101
  */
96
102
  export interface ModifyAuditTrackResponse {
97
- /**
98
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
99
- */
100
- RequestId?: string
103
+
104
+ /**
105
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
106
+ */
107
+ RequestId?: string;
101
108
  }
102
109
 
103
110
  /**
@@ -109,162 +116,167 @@ export type InquireAuditCreditRequest = null
109
116
  * DescribeEvents返回参数结构体
110
117
  */
111
118
  export interface DescribeEventsResponse {
112
- /**
113
- * 日志集合是否结束。true表示结束,无需进行翻页。
114
- */
115
- ListOver: boolean
116
119
 
117
- /**
118
- * 查看更多日志的凭证
119
- */
120
- NextToken: number
121
-
122
- /**
120
+ /**
121
+ * 日志集合是否结束。true表示结束,无需进行翻页。
122
+ */
123
+ ListOver: boolean;
124
+
125
+ /**
126
+ * 查看更多日志的凭证
127
+ */
128
+ NextToken: number;
129
+
130
+ /**
123
131
  * 日志集合
124
132
  注意:此字段可能返回 null,表示取不到有效值。
125
133
  */
126
- Events: Array<Event>
127
-
128
- /**
134
+ Events: Array<Event>;
135
+
136
+ /**
129
137
  * 此字段已经废弃。翻页请使用ListOver配合NextToken,在ListOver为false进行下一页数据读取。
130
138
  注意:此字段可能返回 null,表示取不到有效值。
131
139
  */
132
- TotalCount: number
133
-
134
- /**
135
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
136
- */
137
- RequestId?: string
140
+ TotalCount: number;
141
+
142
+ /**
143
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
144
+ */
145
+ RequestId?: string;
138
146
  }
139
147
 
140
148
  /**
141
149
  * ListCosEnableRegion返回参数结构体
142
150
  */
143
151
  export interface ListCosEnableRegionResponse {
144
- /**
145
- * 云审计支持的cos可用区
146
- */
147
- EnableRegions: Array<CosRegionInfo>
148
152
 
149
- /**
150
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
151
- */
152
- RequestId?: string
153
+ /**
154
+ * 云审计支持的cos可用区
155
+ */
156
+ EnableRegions: Array<CosRegionInfo>;
157
+
158
+ /**
159
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
160
+ */
161
+ RequestId?: string;
153
162
  }
154
163
 
155
164
  /**
156
165
  * LookUpEvents请求参数结构体
157
166
  */
158
167
  export interface LookUpEventsRequest {
159
- /**
160
- * 开始时间
161
- */
162
- StartTime: number
163
-
164
- /**
165
- * 结束时间
166
- */
167
- EndTime: number
168
-
169
- /**
170
- * 检索条件
171
- */
172
- LookupAttributes?: Array<LookupAttribute>
173
168
 
174
- /**
175
- * 查看更多日志的凭证
176
- */
177
- NextToken?: string
178
-
179
- /**
180
- * 返回日志的最大条数
181
- */
182
- MaxResults?: number
183
-
184
- /**
185
- * 云审计模式,有效值:standard | quick,其中standard是标准模式,quick是极速模式。默认为标准模式
186
- */
187
- Mode?: string
169
+ /**
170
+ * 开始时间
171
+ */
172
+ StartTime: number;
173
+
174
+ /**
175
+ * 结束时间
176
+ */
177
+ EndTime: number;
178
+
179
+ /**
180
+ * 检索条件
181
+ */
182
+ LookupAttributes?: Array<LookupAttribute>;
183
+
184
+ /**
185
+ * 查看更多日志的凭证
186
+ */
187
+ NextToken?: string;
188
+
189
+ /**
190
+ * 返回日志的最大条数
191
+ */
192
+ MaxResults?: number;
193
+
194
+ /**
195
+ * 云审计模式,有效值:standard | quick,其中standard是标准模式,quick是极速模式。默认为标准模式
196
+ */
197
+ Mode?: string;
188
198
  }
189
199
 
190
200
  /**
191
201
  * StartLogging请求参数结构体
192
202
  */
193
203
  export interface StartLoggingRequest {
194
- /**
195
- * 跟踪集名称
196
- */
197
- AuditName: string
204
+
205
+ /**
206
+ * 跟踪集名称
207
+ */
208
+ AuditName: string;
198
209
  }
199
210
 
200
211
  /**
201
212
  * UpdateAudit请求参数结构体
202
213
  */
203
214
  export interface UpdateAuditRequest {
204
- /**
205
- * 跟踪集名称
206
- */
207
- AuditName: string
208
-
209
- /**
210
- * 是否开启cmq消息通知。1:是,0:否。目前仅支持cmq的队列服务。如果开启cmq消息通知服务,云审计会将您的日志内容实时投递到您指定地域的指定队列中。
211
- */
212
- IsEnableCmqNotify?: number
213
-
214
- /**
215
- * 管理事件的读写属性。1:只读,2:只写,3:全部。
216
- */
217
- ReadWriteAttribute?: number
218
-
219
- /**
220
- * CMK的全局唯一标识符,如果不是新创建的kms,该值是必填值。可以通过ListKeyAliasByRegion来获取。云审计不会校验KeyId的合法性,请您谨慎填写,避免给您的数据造成损失。
221
- */
222
- KeyId?: string
223
-
224
- /**
225
- * cos地域。目前支持的地域可以使用ListCosEnableRegion来获取。
226
- */
227
- CosRegion?: string
228
-
229
- /**
230
- * 队列名称。队列名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。如果IsEnableCmqNotify值是1的话,此值属于必填字段。如果不是新创建的队列,云审计不会去校验该队列是否真的存在,请谨慎填写,避免日志通知不成功,导致您的数据丢失。
231
- */
232
- CmqQueueName?: string
233
-
234
- /**
235
- * 是否创建新的cos存储桶。1:是,0:否。
236
- */
237
- IsCreateNewBucket?: number
238
-
239
- /**
240
- * kms地域。目前支持的地域可以使用ListKmsEnableRegion来获取。必须要和cos的地域保持一致。
241
- */
242
- KmsRegion?: string
243
-
244
- /**
245
- * 是否开启kms加密。1:是,0:否。如果开启KMS加密,数据在投递到cos时,会将数据加密。
246
- */
247
- IsEnableKmsEncry?: number
248
-
249
- /**
250
- * cos的存储桶名称。仅支持小写英文字母和数字即[a-z,0-9]、中划线“-”及其组合。用户自定义的字符串支持1 - 40个字符。存储桶命名不能以“-”开头或结尾。如果不是新创建的存储桶,云审计不会去校验该存储桶是否真的存在,请谨慎填写,避免日志投递不成功,导致您的数据丢失。
251
- */
252
- CosBucketName?: string
253
-
254
- /**
255
- * 队列所在的地域。可以通过ListCmqEnableRegion获取支持的cmq地域。如果IsEnableCmqNotify值是1的话,此值属于必填字段。
256
- */
257
- CmqRegion?: string
258
-
259
- /**
260
- * 日志文件前缀。3-40个字符,只能包含 ASCII 编码字母 a-z,A-Z,数字 0-9。
261
- */
262
- LogFilePrefix?: string
263
-
264
- /**
265
- * 是否创建新的队列。1:是,0:否。如果IsEnableCmqNotify值是1的话,此值属于必填字段。
266
- */
267
- IsCreateNewQueue?: number
215
+
216
+ /**
217
+ * 跟踪集名称
218
+ */
219
+ AuditName: string;
220
+
221
+ /**
222
+ * 是否开启cmq消息通知。1:是,0:否。目前仅支持cmq的队列服务。如果开启cmq消息通知服务,云审计会将您的日志内容实时投递到您指定地域的指定队列中。
223
+ */
224
+ IsEnableCmqNotify?: number;
225
+
226
+ /**
227
+ * 管理事件的读写属性。1:只读,2:只写,3:全部。
228
+ */
229
+ ReadWriteAttribute?: number;
230
+
231
+ /**
232
+ * CMK的全局唯一标识符,如果不是新创建的kms,该值是必填值。可以通过ListKeyAliasByRegion来获取。云审计不会校验KeyId的合法性,请您谨慎填写,避免给您的数据造成损失。
233
+ */
234
+ KeyId?: string;
235
+
236
+ /**
237
+ * cos地域。目前支持的地域可以使用ListCosEnableRegion来获取。
238
+ */
239
+ CosRegion?: string;
240
+
241
+ /**
242
+ * 队列名称。队列名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。如果IsEnableCmqNotify值是1的话,此值属于必填字段。如果不是新创建的队列,云审计不会去校验该队列是否真的存在,请谨慎填写,避免日志通知不成功,导致您的数据丢失。
243
+ */
244
+ CmqQueueName?: string;
245
+
246
+ /**
247
+ * 是否创建新的cos存储桶。1:是,0:否。
248
+ */
249
+ IsCreateNewBucket?: number;
250
+
251
+ /**
252
+ * kms地域。目前支持的地域可以使用ListKmsEnableRegion来获取。必须要和cos的地域保持一致。
253
+ */
254
+ KmsRegion?: string;
255
+
256
+ /**
257
+ * 是否开启kms加密。1:是,0:否。如果开启KMS加密,数据在投递到cos时,会将数据加密。
258
+ */
259
+ IsEnableKmsEncry?: number;
260
+
261
+ /**
262
+ * cos的存储桶名称。仅支持小写英文字母和数字即[a-z,0-9]、中划线“-”及其组合。用户自定义的字符串支持1 - 40个字符。存储桶命名不能以“-”开头或结尾。如果不是新创建的存储桶,云审计不会去校验该存储桶是否真的存在,请谨慎填写,避免日志投递不成功,导致您的数据丢失。
263
+ */
264
+ CosBucketName?: string;
265
+
266
+ /**
267
+ * 队列所在的地域。可以通过ListCmqEnableRegion获取支持的cmq地域。如果IsEnableCmqNotify值是1的话,此值属于必填字段。
268
+ */
269
+ CmqRegion?: string;
270
+
271
+ /**
272
+ * 日志文件前缀。3-40个字符,只能包含 ASCII 编码字母 a-z,A-Z,数字 0-9。
273
+ */
274
+ LogFilePrefix?: string;
275
+
276
+ /**
277
+ * 是否创建新的队列。1:是,0:否。如果IsEnableCmqNotify值是1的话,此值属于必填字段。
278
+ */
279
+ IsCreateNewQueue?: number;
268
280
  }
269
281
 
270
282
  /**
@@ -276,15 +288,16 @@ export type DescribeAuditTracksRequest = null
276
288
  * CreateAudit返回参数结构体
277
289
  */
278
290
  export interface CreateAuditResponse {
279
- /**
280
- * 是否创建成功。
281
- */
282
- IsSuccess: number
283
291
 
284
- /**
285
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
286
- */
287
- RequestId?: string
292
+ /**
293
+ * 是否创建成功。
294
+ */
295
+ IsSuccess: number;
296
+
297
+ /**
298
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
299
+ */
300
+ RequestId?: string;
288
301
  }
289
302
 
290
303
  /**
@@ -296,101 +309,107 @@ export type DeleteAuditTrackRequest = null
296
309
  * StartLogging返回参数结构体
297
310
  */
298
311
  export interface StartLoggingResponse {
299
- /**
300
- * 是否开启成功
301
- */
302
- IsSuccess: number
303
312
 
304
- /**
305
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
306
- */
307
- RequestId?: string
313
+ /**
314
+ * 是否开启成功
315
+ */
316
+ IsSuccess: number;
317
+
318
+ /**
319
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
320
+ */
321
+ RequestId?: string;
308
322
  }
309
323
 
310
324
  /**
311
325
  * AttributeKey值详情
312
326
  */
313
327
  export interface AttributeKeyDetail {
314
- /**
315
- * 输入框类型
316
- */
317
- LabelType: string
318
-
319
- /**
320
- * 初始化展示
321
- */
322
- Starter: string
323
328
 
324
- /**
325
- * 展示排序
326
- */
327
- Order: number
328
-
329
- /**
330
- * AttributeKey值
331
- */
332
- Value: string
333
-
334
- /**
335
- * 中文标签
336
- */
337
- Label: string
329
+ /**
330
+ * 输入框类型
331
+ */
332
+ LabelType: string;
333
+
334
+ /**
335
+ * 初始化展示
336
+ */
337
+ Starter: string;
338
+
339
+ /**
340
+ * 展示排序
341
+ */
342
+ Order: number;
343
+
344
+ /**
345
+ * AttributeKey值
346
+ */
347
+ Value: string;
348
+
349
+ /**
350
+ * 中文标签
351
+ */
352
+ Label: string;
338
353
  }
339
354
 
340
355
  /**
341
356
  * ListCosEnableRegion请求参数结构体
342
357
  */
343
358
  export interface ListCosEnableRegionRequest {
344
- /**
345
- * 站点类型。zh表示中国区,en表示国际区。默认中国区。
346
- */
347
- WebsiteType?: string
359
+
360
+ /**
361
+ * 站点类型。zh表示中国区,en表示国际区。默认中国区。
362
+ */
363
+ WebsiteType?: string;
348
364
  }
349
365
 
350
366
  /**
351
367
  * ListKeyAliasByRegion返回参数结构体
352
368
  */
353
369
  export interface ListKeyAliasByRegionResponse {
354
- /**
355
- * CMK的总数量
356
- */
357
- TotalCount: number
358
370
 
359
- /**
360
- * 密钥别名
361
- */
362
- KeyMetadatas: Array<KeyMetadata>
363
-
364
- /**
365
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
366
- */
367
- RequestId?: string
371
+ /**
372
+ * CMK的总数量
373
+ */
374
+ TotalCount: number;
375
+
376
+ /**
377
+ * 密钥别名
378
+ */
379
+ KeyMetadatas: Array<KeyMetadata>;
380
+
381
+ /**
382
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
383
+ */
384
+ RequestId?: string;
368
385
  }
369
386
 
370
387
  /**
371
388
  * CreateAuditTrack返回参数结构体
372
389
  */
373
390
  export interface CreateAuditTrackResponse {
374
- /**
375
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
376
- */
377
- RequestId?: string
391
+
392
+ /**
393
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
394
+ */
395
+ RequestId?: string;
378
396
  }
379
397
 
380
398
  /**
381
399
  * 资源类型
382
400
  */
383
401
  export interface Resource {
384
- /**
385
- * 资源类型
386
- */
387
- ResourceType?: string
388
402
 
389
- /**
403
+ /**
404
+ * 资源类型
405
+ */
406
+ ResourceType?: string;
407
+
408
+ /**
390
409
  * 资源名称
391
410
  注意:此字段可能返回 null,表示取不到有效值。
392
411
  */
393
- ResourceName?: string
412
+ ResourceName?: string;
394
413
  }
395
414
 
396
415
  /**
@@ -407,15 +426,16 @@ export type ModifyAuditTrackRequest = null
407
426
  * StopLogging返回参数结构体
408
427
  */
409
428
  export interface StopLoggingResponse {
410
- /**
411
- * 是否关闭成功
412
- */
413
- IsSuccess: number
414
429
 
415
- /**
416
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
417
- */
418
- RequestId?: string
430
+ /**
431
+ * 是否关闭成功
432
+ */
433
+ IsSuccess: number;
434
+
435
+ /**
436
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
437
+ */
438
+ RequestId?: string;
419
439
  }
420
440
 
421
441
  /**
@@ -427,491 +447,510 @@ export type CreateAuditTrackRequest = null
427
447
  * 检索条件
428
448
  */
429
449
  export interface LookupAttribute {
430
- /**
450
+
451
+ /**
431
452
  * AttributeKey的有效取值范围是:RequestId、EventName、ReadOnly、Username、ResourceType、ResourceName和AccessKeyId,EventId
432
453
  注意:此字段可能返回 null,表示取不到有效值。
433
454
  */
434
- AttributeKey: string
435
-
436
- /**
455
+ AttributeKey: string;
456
+
457
+ /**
437
458
  * AttributeValue的值
438
459
  注意:此字段可能返回 null,表示取不到有效值。
439
460
  */
440
- AttributeValue?: string
461
+ AttributeValue?: string;
441
462
  }
442
463
 
443
464
  /**
444
465
  * ListAudits返回参数结构体
445
466
  */
446
467
  export interface ListAuditsResponse {
447
- /**
468
+
469
+ /**
448
470
  * 查询跟踪集概要集合
449
471
  注意:此字段可能返回 null,表示取不到有效值。
450
472
  */
451
- AuditSummarys: Array<AuditSummary>
452
-
453
- /**
454
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
455
- */
456
- RequestId?: string
473
+ AuditSummarys: Array<AuditSummary>;
474
+
475
+ /**
476
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
477
+ */
478
+ RequestId?: string;
457
479
  }
458
480
 
459
481
  /**
460
482
  * CMK属性
461
483
  */
462
484
  export interface KeyMetadata {
463
- /**
464
- * 作为密钥更容易辨识,更容易被人看懂的别名
465
- */
466
- Alias?: string
467
485
 
468
- /**
469
- * CMK的全局唯一标识
470
- */
471
- KeyId?: string
486
+ /**
487
+ * 作为密钥更容易辨识,更容易被人看懂的别名
488
+ */
489
+ Alias?: string;
490
+
491
+ /**
492
+ * CMK的全局唯一标识
493
+ */
494
+ KeyId?: string;
472
495
  }
473
496
 
474
497
  /**
475
498
  * DescribeEvents请求参数结构体
476
499
  */
477
500
  export interface DescribeEventsRequest {
478
- /**
479
- * 起始时间戳(单位秒,不超过当前时间 90 天)
480
- */
481
- StartTime: number
482
-
483
- /**
484
- * 结束时间戳(单位秒,查询时间跨度小于 30 天)
485
- */
486
- EndTime: number
487
-
488
- /**
489
- * 查看更多日志的凭证
490
- */
491
- NextToken?: number
492
-
493
- /**
494
- * 返回日志的最大条数(最大 50 条)
495
- */
496
- MaxResults?: number
497
501
 
498
- /**
499
- * 检索条件(目前支持 RequestId:请求 ID、EventName:事件名称、ActionType:操作类型(Write:写;Read:读)、PrincipalId:子账号、ResourceType:资源类型、ResourceName:资源名称、AccessKeyId:密钥 ID、SensitiveAction:是否敏感操作、ApiErrorCode:API 错误码、CamErrorCode:CAM 错误码、Tags:标签(AttributeValue格式:[{"key":"*","value":"*"}]))
500
- */
501
- LookupAttributes?: Array<LookupAttribute>
502
-
503
- /**
504
- * 是否返回 IP 归属地(1 返回,0 不返回)
505
- */
506
- IsReturnLocation?: number
502
+ /**
503
+ * 起始时间戳(单位秒,不超过当前时间 90 天)
504
+ */
505
+ StartTime: number;
506
+
507
+ /**
508
+ * 结束时间戳(单位秒,查询时间跨度小于 30 天)
509
+ */
510
+ EndTime: number;
511
+
512
+ /**
513
+ * 查看更多日志的凭证
514
+ */
515
+ NextToken?: number;
516
+
517
+ /**
518
+ * 返回日志的最大条数(最大 50 条)
519
+ */
520
+ MaxResults?: number;
521
+
522
+ /**
523
+ * 检索条件(目前支持 RequestId:请求 ID、EventName:事件名称、ActionType:操作类型(Write:写;Read:读)、PrincipalId:子账号、ResourceType:资源类型、ResourceName:资源名称、AccessKeyId:密钥 ID、SensitiveAction:是否敏感操作、ApiErrorCode:API 错误码、CamErrorCode:CAM 错误码、Tags:标签(AttributeValue格式:[{"key":"*","value":"*"}]))
524
+ */
525
+ LookupAttributes?: Array<LookupAttribute>;
526
+
527
+ /**
528
+ * 是否返回 IP 归属地(1 返回,0 不返回)
529
+ */
530
+ IsReturnLocation?: number;
507
531
  }
508
532
 
509
533
  /**
510
534
  * UpdateAudit返回参数结构体
511
535
  */
512
536
  export interface UpdateAuditResponse {
513
- /**
514
- * 是否更新成功
515
- */
516
- IsSuccess: number
517
537
 
518
- /**
519
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
520
- */
521
- RequestId?: string
538
+ /**
539
+ * 是否更新成功
540
+ */
541
+ IsSuccess: number;
542
+
543
+ /**
544
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
545
+ */
546
+ RequestId?: string;
522
547
  }
523
548
 
524
549
  /**
525
550
  * DescribeAudit请求参数结构体
526
551
  */
527
552
  export interface DescribeAuditRequest {
528
- /**
529
- * 跟踪集名称
530
- */
531
- AuditName: string
553
+
554
+ /**
555
+ * 跟踪集名称
556
+ */
557
+ AuditName: string;
532
558
  }
533
559
 
534
560
  /**
535
561
  * ListKeyAliasByRegion请求参数结构体
536
562
  */
537
563
  export interface ListKeyAliasByRegionRequest {
538
- /**
539
- * Kms地域
540
- */
541
- KmsRegion: string
542
-
543
- /**
544
- * 含义跟 SQL 查询的 Limit 一致,表示本次获最多获取 Limit 个元素。缺省值为10,最大值为200
545
- */
546
- Limit?: number
547
564
 
548
- /**
549
- * 含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0
550
- */
551
- Offset?: number
565
+ /**
566
+ * Kms地域
567
+ */
568
+ KmsRegion: string;
569
+
570
+ /**
571
+ * 含义跟 SQL 查询的 Limit 一致,表示本次获最多获取 Limit 个元素。缺省值为10,最大值为200
572
+ */
573
+ Limit?: number;
574
+
575
+ /**
576
+ * 含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0
577
+ */
578
+ Offset?: number;
552
579
  }
553
580
 
554
581
  /**
555
582
  * CreateAudit请求参数结构体
556
583
  */
557
584
  export interface CreateAuditRequest {
558
- /**
559
- * 是否开启cmq消息通知。1:是,0:否。目前仅支持cmq的队列服务。如果开启cmq消息通知服务,云审计会将您的日志内容实时投递到您指定地域的指定队列中。
560
- */
561
- IsEnableCmqNotify: number
562
-
563
- /**
564
- * 管理事件的读写属性。1:只读,2:只写,3:全部。
565
- */
566
- ReadWriteAttribute: number
567
-
568
- /**
569
- * 跟踪集名称。3-128字符,只能包含 ASCII 编码字母 a-z,A-Z,数字 0-9,下划线 _。
570
- */
571
- AuditName: string
572
-
573
- /**
574
- * cos地域。目前支持的地域可以使用ListCosEnableRegion来获取。
575
- */
576
- CosRegion: string
577
-
578
- /**
579
- * 是否创建新的cos存储桶。1:是,0:否。
580
- */
581
- IsCreateNewBucket: number
582
-
583
- /**
584
- * cos的存储桶名称。仅支持小写英文字母和数字即[a-z,0-9]、中划线“-”及其组合。用户自定义的字符串支持1 - 40个字符。存储桶命名不能以“-”开头或结尾。如果不是新创建的存储桶,云审计不会去校验该存储桶是否真的存在,请谨慎填写,避免日志投递不成功,导致您的数据丢失。
585
- */
586
- CosBucketName: string
587
-
588
- /**
589
- * CMK的全局唯一标识符,如果不是新创建的kms,该值是必填值。可以通过ListKeyAliasByRegion来获取。云审计不会校验KeyId的合法性,请您谨慎填写,避免给您的数据造成损失。
590
- */
591
- KeyId?: string
592
-
593
- /**
594
- * 队列名称。队列名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。如果IsEnableCmqNotify值是1的话,此值属于必填字段。如果不是新创建的队列,云审计不会去校验该队列是否真的存在,请谨慎填写,避免日志通知不成功,导致您的数据丢失。
595
- */
596
- CmqQueueName?: string
597
-
598
- /**
599
- * kms地域。目前支持的地域可以使用ListKmsEnableRegion来获取。必须要和cos的地域保持一致。
600
- */
601
- KmsRegion?: string
602
-
603
- /**
604
- * 是否开启kms加密。1:是,0:否。如果开启KMS加密,数据在投递到cos时,会将数据加密。
605
- */
606
- IsEnableKmsEncry?: number
607
-
608
- /**
609
- * 队列所在的地域。可以通过ListCmqEnableRegion获取支持的cmq地域。如果IsEnableCmqNotify值是1的话,此值属于必填字段。
610
- */
611
- CmqRegion?: string
612
-
613
- /**
614
- * 日志文件前缀。3-40个字符,只能包含 ASCII 编码字母 a-z,A-Z,数字 0-9。可以不填,默认以账号ID作为日志前缀。
615
- */
616
- LogFilePrefix?: string
617
-
618
- /**
619
- * 是否创建新的队列。1:是,0:否。如果IsEnableCmqNotify值是1的话,此值属于必填字段。
620
- */
621
- IsCreateNewQueue?: number
585
+
586
+ /**
587
+ * 是否开启cmq消息通知。1:是,0:否。目前仅支持cmq的队列服务。如果开启cmq消息通知服务,云审计会将您的日志内容实时投递到您指定地域的指定队列中。
588
+ */
589
+ IsEnableCmqNotify: number;
590
+
591
+ /**
592
+ * 管理事件的读写属性。1:只读,2:只写,3:全部。
593
+ */
594
+ ReadWriteAttribute: number;
595
+
596
+ /**
597
+ * 跟踪集名称。3-128字符,只能包含 ASCII 编码字母 a-z,A-Z,数字 0-9,下划线 _。
598
+ */
599
+ AuditName: string;
600
+
601
+ /**
602
+ * cos地域。目前支持的地域可以使用ListCosEnableRegion来获取。
603
+ */
604
+ CosRegion: string;
605
+
606
+ /**
607
+ * 是否创建新的cos存储桶。1:是,0:否。
608
+ */
609
+ IsCreateNewBucket: number;
610
+
611
+ /**
612
+ * cos的存储桶名称。仅支持小写英文字母和数字即[a-z,0-9]、中划线“-”及其组合。用户自定义的字符串支持1 - 40个字符。存储桶命名不能以“-”开头或结尾。如果不是新创建的存储桶,云审计不会去校验该存储桶是否真的存在,请谨慎填写,避免日志投递不成功,导致您的数据丢失。
613
+ */
614
+ CosBucketName: string;
615
+
616
+ /**
617
+ * CMK的全局唯一标识符,如果不是新创建的kms,该值是必填值。可以通过ListKeyAliasByRegion来获取。云审计不会校验KeyId的合法性,请您谨慎填写,避免给您的数据造成损失。
618
+ */
619
+ KeyId?: string;
620
+
621
+ /**
622
+ * 队列名称。队列名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。如果IsEnableCmqNotify值是1的话,此值属于必填字段。如果不是新创建的队列,云审计不会去校验该队列是否真的存在,请谨慎填写,避免日志通知不成功,导致您的数据丢失。
623
+ */
624
+ CmqQueueName?: string;
625
+
626
+ /**
627
+ * kms地域。目前支持的地域可以使用ListKmsEnableRegion来获取。必须要和cos的地域保持一致。
628
+ */
629
+ KmsRegion?: string;
630
+
631
+ /**
632
+ * 是否开启kms加密。1:是,0:否。如果开启KMS加密,数据在投递到cos时,会将数据加密。
633
+ */
634
+ IsEnableKmsEncry?: number;
635
+
636
+ /**
637
+ * 队列所在的地域。可以通过ListCmqEnableRegion获取支持的cmq地域。如果IsEnableCmqNotify值是1的话,此值属于必填字段。
638
+ */
639
+ CmqRegion?: string;
640
+
641
+ /**
642
+ * 日志文件前缀。3-40个字符,只能包含 ASCII 编码字母 a-z,A-Z,数字 0-9。可以不填,默认以账号ID作为日志前缀。
643
+ */
644
+ LogFilePrefix?: string;
645
+
646
+ /**
647
+ * 是否创建新的队列。1:是,0:否。如果IsEnableCmqNotify值是1的话,此值属于必填字段。
648
+ */
649
+ IsCreateNewQueue?: number;
622
650
  }
623
651
 
624
652
  /**
625
653
  * DeleteAudit请求参数结构体
626
654
  */
627
655
  export interface DeleteAuditRequest {
628
- /**
629
- * 跟踪集名称
630
- */
631
- AuditName: string
656
+
657
+ /**
658
+ * 跟踪集名称
659
+ */
660
+ AuditName: string;
632
661
  }
633
662
 
634
663
  /**
635
664
  * ListCmqEnableRegion请求参数结构体
636
665
  */
637
666
  export interface ListCmqEnableRegionRequest {
638
- /**
639
- * 站点类型。zh表示中国区,en表示国际区。默认中国区。
640
- */
641
- WebsiteType?: string
667
+
668
+ /**
669
+ * 站点类型。zh表示中国区,en表示国际区。默认中国区。
670
+ */
671
+ WebsiteType?: string;
642
672
  }
643
673
 
644
674
  /**
645
675
  * GetAttributeKey返回参数结构体
646
676
  */
647
677
  export interface GetAttributeKeyResponse {
648
- /**
649
- * AttributeKey的有效取值范围
650
- */
651
- AttributeKeyDetails: Array<AttributeKeyDetail>
652
678
 
653
- /**
654
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
655
- */
656
- RequestId?: string
679
+ /**
680
+ * AttributeKey的有效取值范围
681
+ */
682
+ AttributeKeyDetails: Array<AttributeKeyDetail>;
683
+
684
+ /**
685
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
686
+ */
687
+ RequestId?: string;
657
688
  }
658
689
 
659
690
  /**
660
691
  * ListCmqEnableRegion返回参数结构体
661
692
  */
662
693
  export interface ListCmqEnableRegionResponse {
663
- /**
664
- * 云审计支持的cmq的可用区
665
- */
666
- EnableRegions: Array<CmqRegionInfo>
667
694
 
668
- /**
669
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
670
- */
671
- RequestId?: string
695
+ /**
696
+ * 云审计支持的cmq的可用区
697
+ */
698
+ EnableRegions: Array<CmqRegionInfo>;
699
+
700
+ /**
701
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
702
+ */
703
+ RequestId?: string;
672
704
  }
673
705
 
674
706
  /**
675
707
  * LookUpEvents返回参数结构体
676
708
  */
677
709
  export interface LookUpEventsResponse {
678
- /**
710
+
711
+ /**
679
712
  * 查看更多日志的凭证
680
713
  注意:此字段可能返回 null,表示取不到有效值。
681
714
  */
682
- NextToken: string
683
-
684
- /**
715
+ NextToken: string;
716
+
717
+ /**
685
718
  * 日志集合
686
719
  注意:此字段可能返回 null,表示取不到有效值。
687
720
  */
688
- Events: Array<Event>
689
-
690
- /**
721
+ Events: Array<Event>;
722
+
723
+ /**
691
724
  * 日志集合是否结束
692
725
  注意:此字段可能返回 null,表示取不到有效值。
693
726
  */
694
- ListOver: boolean
695
-
696
- /**
697
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
698
- */
699
- RequestId?: string
727
+ ListOver: boolean;
728
+
729
+ /**
730
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
731
+ */
732
+ RequestId?: string;
700
733
  }
701
734
 
702
735
  /**
703
736
  * DeleteAuditTrack返回参数结构体
704
737
  */
705
738
  export interface DeleteAuditTrackResponse {
706
- /**
707
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
708
- */
709
- RequestId?: string
739
+
740
+ /**
741
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
742
+ */
743
+ RequestId?: string;
710
744
  }
711
745
 
712
746
  /**
713
747
  * cos地域信息
714
748
  */
715
749
  export interface CosRegionInfo {
716
- /**
717
- * cos地域
718
- */
719
- CosRegion?: string
720
750
 
721
- /**
722
- * 地域描述
723
- */
724
- CosRegionName?: string
751
+ /**
752
+ * cos地域
753
+ */
754
+ CosRegion?: string;
755
+
756
+ /**
757
+ * 地域描述
758
+ */
759
+ CosRegionName?: string;
725
760
  }
726
761
 
727
762
  /**
728
763
  * DescribeAudit返回参数结构体
729
764
  */
730
765
  export interface DescribeAuditResponse {
731
- /**
732
- * 是否开启cmq消息通知。1:是,0:否。
733
- */
734
- IsEnableCmqNotify: number
735
-
736
- /**
737
- * 管理事件读写属性,1:只读,2:只写,3:全部
738
- */
739
- ReadWriteAttribute: number
740
-
741
- /**
742
- * CMK的全局唯一标识符。
743
- */
744
- KeyId: string
745
-
746
- /**
747
- * 跟踪集状态,1:开启,0:停止。
748
- */
749
- AuditStatus: number
750
-
751
- /**
752
- * 跟踪集名称。
753
- */
754
- AuditName: string
755
-
756
- /**
757
- * cos存储桶所在地域。
758
- */
759
- CosRegion: string
760
-
761
- /**
762
- * 队列名称。
763
- */
764
- CmqQueueName: string
765
-
766
- /**
767
- * CMK别名。
768
- */
769
- KmsAlias: string
770
-
771
- /**
772
- * kms地域。
773
- */
774
- KmsRegion: string
775
-
776
- /**
777
- * 是否开启kms加密。1:是,0:否。如果开启KMS加密,数据在投递到cos时,会将数据加密。
778
- */
779
- IsEnableKmsEncry: number
780
-
781
- /**
782
- * cos存储桶名称。
783
- */
784
- CosBucketName: string
785
-
786
- /**
787
- * 队列所在地域。
788
- */
789
- CmqRegion: string
790
-
791
- /**
792
- * 日志前缀。
793
- */
794
- LogFilePrefix: string
795
-
796
- /**
797
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
798
- */
799
- RequestId?: string
766
+
767
+ /**
768
+ * 是否开启cmq消息通知。1:是,0:否。
769
+ */
770
+ IsEnableCmqNotify: number;
771
+
772
+ /**
773
+ * 管理事件读写属性,1:只读,2:只写,3:全部
774
+ */
775
+ ReadWriteAttribute: number;
776
+
777
+ /**
778
+ * CMK的全局唯一标识符。
779
+ */
780
+ KeyId: string;
781
+
782
+ /**
783
+ * 跟踪集状态,1:开启,0:停止。
784
+ */
785
+ AuditStatus: number;
786
+
787
+ /**
788
+ * 跟踪集名称。
789
+ */
790
+ AuditName: string;
791
+
792
+ /**
793
+ * cos存储桶所在地域。
794
+ */
795
+ CosRegion: string;
796
+
797
+ /**
798
+ * 队列名称。
799
+ */
800
+ CmqQueueName: string;
801
+
802
+ /**
803
+ * CMK别名。
804
+ */
805
+ KmsAlias: string;
806
+
807
+ /**
808
+ * kms地域。
809
+ */
810
+ KmsRegion: string;
811
+
812
+ /**
813
+ * 是否开启kms加密。1:是,0:否。如果开启KMS加密,数据在投递到cos时,会将数据加密。
814
+ */
815
+ IsEnableKmsEncry: number;
816
+
817
+ /**
818
+ * cos存储桶名称。
819
+ */
820
+ CosBucketName: string;
821
+
822
+ /**
823
+ * 队列所在地域。
824
+ */
825
+ CmqRegion: string;
826
+
827
+ /**
828
+ * 日志前缀。
829
+ */
830
+ LogFilePrefix: string;
831
+
832
+ /**
833
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
834
+ */
835
+ RequestId?: string;
800
836
  }
801
837
 
802
838
  /**
803
839
  * 日志详情
804
840
  */
805
841
  export interface Event {
806
- /**
807
- * 日志ID
808
- */
809
- EventId?: string
810
-
811
- /**
812
- * 用户名
813
- */
814
- Username?: string
815
-
816
- /**
817
- * 事件时间
818
- */
819
- EventTime?: string
820
-
821
- /**
822
- * 日志详情
823
- */
824
- CloudAuditEvent?: string
825
-
826
- /**
827
- * 资源类型中文描述(此字段请按需使用,如果您是其他语言使用者,可以忽略该字段描述)
828
- */
829
- ResourceTypeCn?: string
830
-
831
- /**
832
- * 鉴权错误码
833
- */
834
- ErrorCode?: number
835
-
836
- /**
837
- * 事件名称
838
- */
839
- EventName?: string
840
-
841
- /**
842
+
843
+ /**
844
+ * 日志ID
845
+ */
846
+ EventId?: string;
847
+
848
+ /**
849
+ * 用户名
850
+ */
851
+ Username?: string;
852
+
853
+ /**
854
+ * 事件时间
855
+ */
856
+ EventTime?: string;
857
+
858
+ /**
859
+ * 日志详情
860
+ */
861
+ CloudAuditEvent?: string;
862
+
863
+ /**
864
+ * 资源类型中文描述(此字段请按需使用,如果您是其他语言使用者,可以忽略该字段描述)
865
+ */
866
+ ResourceTypeCn?: string;
867
+
868
+ /**
869
+ * 鉴权错误码
870
+ */
871
+ ErrorCode?: number;
872
+
873
+ /**
874
+ * 事件名称
875
+ */
876
+ EventName?: string;
877
+
878
+ /**
842
879
  * 证书ID
843
880
  注意:此字段可能返回 null,表示取不到有效值。
844
881
  */
845
- SecretId?: string
846
-
847
- /**
848
- * 请求来源
849
- */
850
- EventSource?: string
851
-
852
- /**
853
- * 请求ID
854
- */
855
- RequestID?: string
856
-
857
- /**
858
- * 资源地域
859
- */
860
- ResourceRegion?: string
861
-
862
- /**
863
- * 主账号ID
864
- */
865
- AccountID?: number
866
-
867
- /**
882
+ SecretId?: string;
883
+
884
+ /**
885
+ * 请求来源
886
+ */
887
+ EventSource?: string;
888
+
889
+ /**
890
+ * 请求ID
891
+ */
892
+ RequestID?: string;
893
+
894
+ /**
895
+ * 资源地域
896
+ */
897
+ ResourceRegion?: string;
898
+
899
+ /**
900
+ * 主账号ID
901
+ */
902
+ AccountID?: number;
903
+
904
+ /**
868
905
  * 源IP
869
906
  注意:此字段可能返回 null,表示取不到有效值。
870
907
  */
871
- SourceIPAddress?: string
872
-
873
- /**
874
- * 事件名称中文描述(此字段请按需使用,如果您是其他语言使用者,可以忽略该字段描述)
875
- */
876
- EventNameCn?: string
877
-
878
- /**
879
- * 资源对
880
- */
881
- Resources?: Resource
882
-
883
- /**
884
- * 事件地域
885
- */
886
- EventRegion?: string
887
-
888
- /**
889
- * IP 归属地
890
- */
891
- Location?: string
908
+ SourceIPAddress?: string;
909
+
910
+ /**
911
+ * 事件名称中文描述(此字段请按需使用,如果您是其他语言使用者,可以忽略该字段描述)
912
+ */
913
+ EventNameCn?: string;
914
+
915
+ /**
916
+ * 资源对
917
+ */
918
+ Resources?: Resource;
919
+
920
+ /**
921
+ * 事件地域
922
+ */
923
+ EventRegion?: string;
924
+
925
+ /**
926
+ * IP 归属地
927
+ */
928
+ Location?: string;
892
929
  }
893
930
 
894
931
  /**
895
932
  * 跟踪集概览
896
933
  */
897
934
  export interface AuditSummary {
898
- /**
899
- * 跟踪集状态,1:开启,0:关闭
900
- */
901
- AuditStatus?: number
902
-
903
- /**
904
- * COS存储桶名称
905
- */
906
- CosBucketName?: string
907
-
908
- /**
909
- * 跟踪集名称
910
- */
911
- AuditName?: string
912
-
913
- /**
914
- * 日志前缀
915
- */
916
- LogFilePrefix?: string
935
+
936
+ /**
937
+ * 跟踪集状态,1:开启,0:关闭
938
+ */
939
+ AuditStatus?: number;
940
+
941
+ /**
942
+ * COS存储桶名称
943
+ */
944
+ CosBucketName?: string;
945
+
946
+ /**
947
+ * 跟踪集名称
948
+ */
949
+ AuditName?: string;
950
+
951
+ /**
952
+ * 日志前缀
953
+ */
954
+ LogFilePrefix?: string;
917
955
  }
956
+