@alicloud/cloud-siem20220616 6.0.2 → 6.2.0

package/src/models/DescribeCustomizeRuleTestRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCustomizeRuleTestRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the rule.
+   * The ID of the custom rule.
    * 
    * @example
    * 123456789
@@ -13,10 +13,11 @@ export class DescribeCustomizeRuleTestRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The region in which the data management center of the threat analysis feature resides. Specify this parameter based on the regions in which your assets reside. Valid values:
+   * The region of the Data Management center for Threat Analysis. Select a region based on where your assets are located. Valid values:
    * 
-   * *   cn-hangzhou: Your assets reside in regions in China.
-   * *   ap-southeast-1: Your assets reside in regions outside China.
+   * - cn-hangzhou: Your assets are in the Chinese mainland or China (Hong Kong).
+   * 
+   * - ap-southeast-1: Your assets are in regions outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -24,7 +25,7 @@ export class DescribeCustomizeRuleTestRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the account that you switch from the management account.
+   * The user ID of the member account to which the administrator switches.
    * 
    * @example
    * 113091674488****
@@ -32,9 +33,11 @@ export class DescribeCustomizeRuleTestRequest extends $dara.Model {
   roleFor?: number;
   /**
    * @remarks
-   * The type of the view. Valid values:
-   * - 0: the current Alibaba Cloud account
-   * - 1: the global account
+   * The view type.
+   * 
+   * - 0: The view of the current Alibaba Cloud account.
+   * 
+   * - 1: The view of all accounts within the enterprise.
    * 
    * @example
    * 1

package/src/models/DescribeCustomizeRuleTestResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCustomizeRuleTestResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The ID of the rule.
+   * The ID of the custom rule.
    * 
    * @example
    * 123456789
@@ -13,7 +13,7 @@ export class DescribeCustomizeRuleTestResponseBodyData extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The historical data that is used in the simulation test.
+   * The historical data of the simulated test case.
    * 
    * @example
    * [{"key1":"value1","key2":"value2","key3":"value3","key4":"value4","key5":"value5"}]
@@ -23,11 +23,15 @@ export class DescribeCustomizeRuleTestResponseBodyData extends $dara.Model {
    * @remarks
    * The status of the rule. Valid values:
    * 
-   * *   0: The rule is in the initial state.
-   * *   10: The simulation data is tested.
-   * *   15: The business data is being tested.
-   * *   20: The business data test ends.
-   * *   100: The rule takes effect.
+   * - 0: initial
+   * 
+   * - 10: simulated data test
+   * 
+   * - 15: real-time data test in progress
+   * 
+   * - 20: real-time data test complete
+   * 
+   * - 100: published
    * 
    * @example
    * 0
@@ -61,7 +65,7 @@ export class DescribeCustomizeRuleTestResponseBodyData extends $dara.Model {
 export class DescribeCustomizeRuleTestResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The HTTP status code returned.
    * 
    * @example
    * 200
@@ -95,8 +99,9 @@ export class DescribeCustomizeRuleTestResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the request was successful. Valid values:
    * 
-   * *   true
-   * *   false
+   * - true: The request was successful.
+   * 
+   * - false: The request failed.
    * 
    * @example
    * true

package/src/models/DescribeDataSourceInstanceRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDataSourceInstanceRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the cloud account.
+   * The ID of the Alibaba Cloud account.
    * 
    * This parameter is required.
    * 
@@ -15,11 +15,13 @@ export class DescribeDataSourceInstanceRequest extends $dara.Model {
   accountId?: string;
   /**
    * @remarks
-   * The code of the cloud service provider. Valid values:
+   * The code for the multicloud environment. Valid values:
    * 
-   * *   qcloud: Tencent Cloud
-   * *   aliyun: Alibaba Cloud
-   * *   hcloud: Huawei Cloud
+   * - qcloud: Tencent Cloud.
+   * 
+   * - aliyun: Alibaba Cloud.
+   * 
+   * - hcloud: Huawei Cloud.
    * 
    * This parameter is required.
    * 
@@ -29,7 +31,7 @@ export class DescribeDataSourceInstanceRequest extends $dara.Model {
   cloudCode?: string;
   /**
    * @remarks
-   * The ID of the data source. The ID is an MD5 hash value that is calculated by the threat analysis feature based on specific parameters. You can call the [ListDataSourceLogs](https://api.aliyun-inc.com/#/publishment/document/cloud-siem/863fdf54478f4cc5877e27c2a5fe9e44?tenantUuid=f382fccd88b94c5c8c864def6815b854\\&activeTabKey=api%7CListDataSourceLogs) operation to query the IDs of data sources.
+   * The ID of the data source. The threat analysis service generates the ID by calculating the MD5 hash of specific parameters. Call the [ListDataSourceLogs](https://api.aliyun-inc.com/#/publishment/document/cloud-siem/863fdf54478f4cc5877e27c2a5fe9e44?tenantUuid=f382fccd88b94c5c8c864def6815b854\\&activeTabKey=api%7CListDataSourceLogs) operation to obtain the data source ID.
    * 
    * This parameter is required.
    * 
@@ -39,10 +41,11 @@ export class DescribeDataSourceInstanceRequest extends $dara.Model {
   dataSourceInstanceId?: string;
   /**
    * @remarks
-   * The region in which the data management center of the threat analysis feature resides. Specify this parameter based on the regions in which your assets reside. Valid values:
+   * The region where the Data Management center of the threat analysis service is located. Select a region based on the region where your assets are located. Valid values:
+   * 
+   * - cn-hangzhou: Your assets are in the Chinese mainland or China (Hong Kong).
    * 
-   * *   cn-hangzhou: Your assets reside in regions in China.
-   * *   ap-southeast-1: Your assets reside in regions outside China.
+   * - ap-southeast-1: Your assets are in a region outside China.
    * 
    * @example
    * cn-hangzhou

package/src/models/DescribeDataSourceInstanceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDataSourceInstanceResponseBodyDataDataSourceInstanceParams extends $dara.Model {
   /**
    * @remarks
-   * The code of the parameter.
+   * The parameter code.
    * 
    * @example
    * region_code
@@ -13,7 +13,7 @@ export class DescribeDataSourceInstanceResponseBodyDataDataSourceInstanceParams
   paraCode?: string;
   /**
    * @remarks
-   * The value of the parameter.
+   * The parameter value.
    * 
    * @example
    * ap-guangzhou
@@ -45,7 +45,7 @@ export class DescribeDataSourceInstanceResponseBodyDataDataSourceInstanceParams
 export class DescribeDataSourceInstanceResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The ID of the cloud account.
+   * The ID of the Alibaba Cloud account.
    * 
    * @example
    * 123xxxxxxx
@@ -53,11 +53,13 @@ export class DescribeDataSourceInstanceResponseBodyData extends $dara.Model {
   accountId?: string;
   /**
    * @remarks
-   * The code of the cloud service provider. Valid values:
+   * The code for the multicloud environment. Valid values:
    * 
-   * *   qcloud: Tencent Cloud
-   * *   aliyun: Alibaba Cloud
-   * *   hcloud: Huawei Cloud
+   * - qcloud: Tencent Cloud.
+   * 
+   * - aliyun: Alibaba Cloud.
+   * 
+   * - hcloud: Huawei Cloud.
    * 
    * @example
    * hcloud
@@ -65,7 +67,7 @@ export class DescribeDataSourceInstanceResponseBodyData extends $dara.Model {
   cloudCode?: string;
   /**
    * @remarks
-   * The ID of the data source. The ID is an MD5 hash value that is calculated by the threat analysis feature based on specific parameters.
+   * The ID of the data source. The threat analysis service generates the ID by calculating the MD5 hash of specific parameters.
    * 
    * @example
    * 220ba97c9d1fdb0b9c7e8c7ca328d7ea
@@ -73,7 +75,7 @@ export class DescribeDataSourceInstanceResponseBodyData extends $dara.Model {
   dataSourceInstanceId?: string;
   /**
    * @remarks
-   * The parameters of the data source.
+   * The list of detailed parameters for the data source.
    */
   dataSourceInstanceParams?: DescribeDataSourceInstanceResponseBodyDataDataSourceInstanceParams[];
   static names(): { [key: string]: string } {
@@ -114,7 +116,7 @@ export class DescribeDataSourceInstanceResponseBody extends $dara.Model {
   data?: DescribeDataSourceInstanceResponseBodyData;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 6276D891-*****-55B2-87B9-74D413F7****

package/src/models/DescribeDataSourceParametersRequest.ts

@@ -5,13 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDataSourceParametersRequest extends $dara.Model {
   /**
    * @remarks
-   * The code of the cloud service provider.
-   * 
-   * Valid values:
-   * 
-   * *   qcloud
-   * *   hcloud
-   * *   aliyun
+   * The code for the multicloud environment.
    * 
    * This parameter is required.
    * 
@@ -23,9 +17,11 @@ export class DescribeDataSourceParametersRequest extends $dara.Model {
    * @remarks
    * The type of the data source. Valid values:
    * 
-   * *   **ckafka**: Tencent Cloud TDMQ for CKafka
-   * *   **obs**: Huawei Cloud Object Storage Service (OBS)
-   * *   **wafApi**: download API of Tencent Cloud Web Application Firewall (WAF)
+   * - **ckafka**: Tencent Cloud CKafka.
+   * 
+   * - **obs**: Huawei Cloud OBS.
+   * 
+   * - **wafApi**: Tencent Cloud WAF attack log download API.
    * 
    * This parameter is required.
    * 
@@ -35,10 +31,11 @@ export class DescribeDataSourceParametersRequest extends $dara.Model {
   dataSourceType?: string;
   /**
    * @remarks
-   * The region in which the data management center of the threat analysis feature resides. Specify this parameter based on the regions in which your assets reside. Valid values:
+   * The region where the Data Management center for threat analysis is deployed. Select a region based on the region where your assets are located. Valid values:
+   * 
+   * - cn-hangzhou: Your assets are in the Chinese mainland or China (Hong Kong).
    * 
-   * *   cn-hangzhou: Your assets reside in regions in China.
-   * *   ap-southeast-1: Your assets reside in regions outside China.
+   * - ap-southeast-1: Your assets are outside China.
    * 
    * @example
    * cn-hangzhou

package/src/models/DescribeDataSourceParametersResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDataSourceParametersResponseBodyDataParamValue extends $dara.Model {
   /**
    * @remarks
-   * The display value.
+   * The displayed content.
    * 
    * @example
    * guangzhou
@@ -13,7 +13,7 @@ export class DescribeDataSourceParametersResponseBodyDataParamValue extends $dar
   label?: string;
   /**
    * @remarks
-   * The actual value.
+   * The actual value of the parameter.
    * 
    * @example
    * ap-guangzhou
@@ -45,10 +45,11 @@ export class DescribeDataSourceParametersResponseBodyDataParamValue extends $dar
 export class DescribeDataSourceParametersResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the edit operation is supported. Valid values:
+   * Indicates whether the parameter is editable. Valid values:
    * 
-   * *   **0**
-   * *   **1**
+   * - **0**: The parameter cannot be modified.
+   * 
+   * - **1**: The parameter can be modified.
    * 
    * @example
    * wafApi
@@ -56,11 +57,13 @@ export class DescribeDataSourceParametersResponseBodyData extends $dara.Model {
   canEditted?: number;
   /**
    * @remarks
-   * The code of the cloud service provider. Valid values:
+   * The code for the multicloud environment. Valid values:
+   * 
+   * - **qcloud**: Tencent Cloud.
    * 
-   * *   **qcloud**: Tencent Cloud
-   * *   **aliyun**: Alibaba Cloud
-   * *   **hcloud**: Huawei Cloud
+   * - **aliyun**: Alibaba Cloud.
+   * 
+   * - **hcloud**: Huawei Cloud.
    * 
    * @example
    * hcloud
@@ -70,9 +73,11 @@ export class DescribeDataSourceParametersResponseBodyData extends $dara.Model {
    * @remarks
    * The type of the data source. Valid values:
    * 
-   * *   **obs**: Huawei Cloud Object Storage Service (OBS)
-   * *   **wafApi**: download API of Tencent Cloud Web Application Firewall (WAF)
-   * *   **ckafka**: Tencent Cloud TDMQ for CKafka
+   * - **obs**: Huawei Cloud OBS.
+   * 
+   * - **wafApi**: Tencent Cloud WAF download API.
+   * 
+   * - **ckafka**: Tencent Cloud CKafka.
    * 
    * @example
    * obs
@@ -88,10 +93,11 @@ export class DescribeDataSourceParametersResponseBodyData extends $dara.Model {
   defaultValue?: string;
   /**
    * @remarks
-   * Indicates whether the modification operation is forbidden. Valid values:
+   * Indicates whether the parameter can be modified. Valid values:
+   * 
+   * - **true**: The parameter cannot be modified.
    * 
-   * *   **true**
-   * *   **false**
+   * - **false**: The parameter can be modified.
    * 
    * @example
    * wafApi
@@ -99,7 +105,7 @@ export class DescribeDataSourceParametersResponseBodyData extends $dara.Model {
   disabled?: boolean;
   /**
    * @remarks
-   * The method that is used to check the parameter format.
+   * The format check method.
    * 
    * @example
    * email
@@ -107,7 +113,7 @@ export class DescribeDataSourceParametersResponseBodyData extends $dara.Model {
   formatCheck?: string;
   /**
    * @remarks
-   * The additional information.
+   * Additional information.
    * 
    * @example
    * obs docment
@@ -123,10 +129,11 @@ export class DescribeDataSourceParametersResponseBodyData extends $dara.Model {
   paraCode?: string;
   /**
    * @remarks
-   * The parameter level. Valid values:
+   * The level of the parameter. Valid values:
    * 
-   * *   **1**: the parameters of the data source
-   * *   **2**: the parameters of the log
+   * - **1**: data source parameter.
+   * 
+   * - **2**: log parameter.
    * 
    * @example
    * 1
@@ -142,7 +149,7 @@ export class DescribeDataSourceParametersResponseBodyData extends $dara.Model {
   paraName?: string;
   /**
    * @remarks
-   * The data type of the parameter.
+   * The type of the parameter.
    * 
    * @example
    * string
@@ -150,15 +157,16 @@ export class DescribeDataSourceParametersResponseBodyData extends $dara.Model {
   paraType?: string;
   /**
    * @remarks
-   * The value of the parameter.
+   * The list of parameters.
    */
   paramValue?: DescribeDataSourceParametersResponseBodyDataParamValue[];
   /**
    * @remarks
    * Indicates whether the parameter is required. Valid values:
    * 
-   * *   **1**: required
-   * *   **0**: optional
+   * - **1**: The parameter is required.
+   * 
+   * - **0**: The parameter is optional.
    * 
    * @example
    * string
@@ -166,7 +174,7 @@ export class DescribeDataSourceParametersResponseBodyData extends $dara.Model {
   required?: number;
   /**
    * @remarks
-   * The note for the parameter value.
+   * The prompt for the parameter value.
    * 
    * @example
    * obs bucket name
@@ -230,7 +238,7 @@ export class DescribeDataSourceParametersResponseBody extends $dara.Model {
   data?: DescribeDataSourceParametersResponseBodyData[];
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 6276D891-*****-55B2-87B9-74D413F7****

package/src/models/DescribeDisposeAndPlaybookRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDisposeAndPlaybookRequest extends $dara.Model {
   /**
    * @remarks
-   * The page number. Pages start from page 1.
+   * The page number. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -14,23 +14,25 @@ export class DescribeDisposeAndPlaybookRequest extends $dara.Model {
   /**
    * @remarks
    * The entity type. Valid values:
-   * 
-   * *   ip
-   * *   process
-   * *   file
+   * - ip: IP address
+   * - process: process
+   * - file: file
    * 
    * @example
    * ip
    */
   entityType?: string;
   /**
+   * @remarks
+   * The entity UUID.
+   * 
    * @example
    * 85ea4241-798f-4684-a876-65d4f0c3****
    */
   entityUuid?: string;
   /**
    * @remarks
-   * The UUID of the event.
+   * The event UUID.
    * 
    * @example
    * 85ea4241-798f-4684-a876-65d4f0c3****
@@ -38,7 +40,7 @@ export class DescribeDisposeAndPlaybookRequest extends $dara.Model {
   incidentUuid?: string;
   /**
    * @remarks
-   * The number of entries to return on each page. Maximum value: 100.
+   * The number of entries per page. Maximum value: 100.
    * 
    * @example
    * 10
@@ -46,10 +48,9 @@ export class DescribeDisposeAndPlaybookRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The data management center of the threat analysis feature. Specify this parameter based on the region in which your assets reside. Valid values:
-   * 
-   * *   cn-hangzhou: Your assets reside in regions inside China.
-   * *   ap-southeast-1: Your assets reside in regions outside China.
+   * The region in which the data management center of the threat analysis feature resides. Select the data management center based on the region of your assets. Valid values:
+   * - cn-hangzhou: Your assets reside in the Chinese mainland or Hong Kong (China).
+   * - ap-southeast-1: Your assets reside in regions outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -57,7 +58,7 @@ export class DescribeDisposeAndPlaybookRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the account that you switch from the management account.
+   * The user ID of the member to which the administrator switches the view.
    * 
    * @example
    * 113091674488****
@@ -65,9 +66,10 @@ export class DescribeDisposeAndPlaybookRequest extends $dara.Model {
   roleFor?: number;
   /**
    * @remarks
-   * The type of the view. Valid values:
-   * - 0: the current Alibaba Cloud account
-   * - 1: the global account
+   * The view type. Valid values:
+   * 
+   * - 0: the view of the current Alibaba Cloud account.
+   * - 1: the view of all accounts in the enterprise.
    * 
    * @example
    * 1