@alicloud/cloud-siem20220616 6.0.2 → 6.2.0

package/src/models/ListAutomateResponseConfigsRequest.ts

@@ -7,9 +7,11 @@ export class ListAutomateResponseConfigsRequest extends $dara.Model {
    * @remarks
    * The type of the handling action. Valid values:
    * 
-   * *   doPlaybook: runs a playbook.
-   * *   changeEventStatus: changes the status of an event.
-   * *   changeThreatLevel: changes the risk level of an event.
+   * - **doPlaybook**: executes a playbook.
+   * 
+   * - **changeEventStatus**: changes the status of an event.
+   * 
+   * - **changeThreatLevel**: changes the threat level of an event.
    * 
    * @example
    * doPlaybook
@@ -17,10 +19,11 @@ export class ListAutomateResponseConfigsRequest extends $dara.Model {
   actionType?: string;
   /**
    * @remarks
-   * The type of the automated response rule. Valid values:
+   * The type of the automated response. Valid values:
    * 
-   * *   event
-   * *   alert
+   * - **event**
+   * 
+   * - **alert**
    * 
    * @example
    * event
@@ -28,7 +31,7 @@ export class ListAutomateResponseConfigsRequest extends $dara.Model {
   autoResponseType?: string;
   /**
    * @remarks
-   * The page number. Pages start from page 1.
+   * The page number. The value must be 1 or greater.
    * 
    * This parameter is required.
    * 
@@ -46,7 +49,7 @@ export class ListAutomateResponseConfigsRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The number of entries per page. Maximum value: 100.
+   * The number of entries per page. The maximum value is 100.
    * 
    * This parameter is required.
    * 
@@ -56,7 +59,7 @@ export class ListAutomateResponseConfigsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The UUID of the playbook.
+   * The unique identifier of the playbook.
    * 
    * @example
    * system_aliyun_aegis_kill_quara_book
@@ -64,19 +67,31 @@ export class ListAutomateResponseConfigsRequest extends $dara.Model {
   playbookUuid?: 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 of the Data Management center. 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
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The type of the response rule.
+   * 
+   * - preset: predefined
+   * 
+   * - custom: custom
+   * 
+   * @example
+   * custom
+   */
   responseRuleType?: string;
   /**
    * @remarks
-   * The ID of the account that you switch from the management account.
+   * The ID of the member to which the administrator switches.
    * 
    * @example
    * 113091674488****
@@ -84,9 +99,11 @@ export class ListAutomateResponseConfigsRequest 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 that belong to the enterprise.
    * 
    * @example
    * 1
@@ -104,8 +121,9 @@ export class ListAutomateResponseConfigsRequest extends $dara.Model {
    * @remarks
    * The status of the rule. Valid values:
    * 
-   * *   0: disabled
-   * *   100: enabled
+   * - **0**: disabled
+   * 
+   * - **100**: enabled
    * 
    * @example
    * 0

package/src/models/ListAutomateResponseConfigsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListAutomateResponseConfigsResponseBodyDataPageInfo extends $dara.Model {
   /**
    * @remarks
-   * The current page number.
+   * The page number of the returned page.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class ListAutomateResponseConfigsResponseBodyDataPageInfo extends $dara.M
   currentPage?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of entries returned per page.
    * 
    * @example
    * 10
@@ -21,7 +21,7 @@ export class ListAutomateResponseConfigsResponseBodyDataPageInfo extends $dara.M
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 100
@@ -55,7 +55,7 @@ export class ListAutomateResponseConfigsResponseBodyDataPageInfo extends $dara.M
 export class ListAutomateResponseConfigsResponseBodyDataResponseData extends $dara.Model {
   /**
    * @remarks
-   * The configuration of the action that is performed after the automated response rule is hit. The value is in the JSON format.
+   * The action configuration of the automated response rule. The value is a JSON array.
    * 
    * @example
    * [
@@ -69,11 +69,13 @@ export class ListAutomateResponseConfigsResponseBodyDataResponseData extends $da
   actionConfig?: string;
   /**
    * @remarks
-   * The type of the handling action. Multiple types are separated by commas (,). Valid values:
+   * The handling action. Multiple values are separated by commas. Valid values:
    * 
-   * *   **doPlaybook**: runs the playbook.
-   * *   **changeEventStatus**: changes the event status.
-   * *   **changeThreatLevel**: changes the risk level of the event.
+   * - **doPlaybook**: executes a playbook.
+   * 
+   * - **changeEventStatus**: changes the status of an event.
+   * 
+   * - **changeThreatLevel**: changes the threat level of an event.
    * 
    * @example
    * doPlaybook,changeEventStatus
@@ -81,7 +83,7 @@ export class ListAutomateResponseConfigsResponseBodyDataResponseData extends $da
   actionType?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account that is associated with the rule in SIEM.
+   * The ID of the Alibaba Cloud account that is associated with the rule.
    * 
    * @example
    * 127608589417****
@@ -89,10 +91,11 @@ export class ListAutomateResponseConfigsResponseBodyDataResponseData extends $da
   aliuid?: number;
   /**
    * @remarks
-   * The type of the automated response rule. Valid values:
+   * The type of the automated response. Valid values:
    * 
-   * *   **event**
-   * *   **alert**
+   * - **event**
+   * 
+   * - **alert**
    * 
    * @example
    * event
@@ -100,13 +103,10 @@ export class ListAutomateResponseConfigsResponseBodyDataResponseData extends $da
   autoResponseType?: string;
   /**
    * @remarks
-   * The type of the view. Valid values:
-   * 
-   * 0: the current Alibaba Cloud account
-   * 1: the global account
+   * The data type of the condition field in the automated response rule.
    * 
    * @example
-   * 1
+   * varchar
    */
   dataType?: number;
   /**
@@ -119,7 +119,7 @@ export class ListAutomateResponseConfigsResponseBodyDataResponseData extends $da
   executionCondition?: string;
   /**
    * @remarks
-   * The creation time.
+   * The time when the rule was created.
    * 
    * @example
    * 2021-01-06 16:37:29
@@ -127,7 +127,7 @@ export class ListAutomateResponseConfigsResponseBodyDataResponseData extends $da
   gmtCreate?: string;
   /**
    * @remarks
-   * The update time.
+   * The time when the rule was last modified.
    * 
    * @example
    * 2021-01-06 16:37:29
@@ -141,6 +141,17 @@ export class ListAutomateResponseConfigsResponseBodyDataResponseData extends $da
    * 123
    */
   id?: number;
+  /**
+   * @remarks
+   * The type of the response rule.
+   * 
+   * - preset: predefined
+   * 
+   * - custom: custom
+   * 
+   * @example
+   * custom
+   */
   responseRuleType?: string;
   /**
    * @remarks
@@ -154,8 +165,9 @@ export class ListAutomateResponseConfigsResponseBodyDataResponseData extends $da
    * @remarks
    * The status of the rule. Valid values:
    * 
-   * *   **0**: disabled.
-   * *   **100**: enabled.
+   * - **0**: disabled
+   * 
+   * - **100**: enabled
    * 
    * @example
    * 0
@@ -257,7 +269,7 @@ export class ListAutomateResponseConfigsResponseBodyData extends $dara.Model {
 export class ListAutomateResponseConfigsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The request status code.
    * 
    * @example
    * 200
@@ -291,8 +303,9 @@ export class ListAutomateResponseConfigsResponseBody 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/ListBindAccountRequest.ts

@@ -7,9 +7,11 @@ export class ListBindAccountRequest extends $dara.Model {
    * @remarks
    * The code of the cloud service provider. Valid values:
    * 
-   * *   qcloud: Tencent Cloud
-   * *   aliyun: Alibaba Cloud
-   * *   hcloud: Huawei Cloud
+   * - qcloud: Tencent Cloud.
+   * 
+   * - aliyun: Alibaba Cloud.
+   * 
+   * - hcloud: Huawei Cloud.
    * 
    * This parameter is required.
    * 
@@ -19,16 +21,35 @@ export class ListBindAccountRequest extends $dara.Model {
   cloudCode?: 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 Threat Analysis is deployed. Select the region of the data management center based on the region of your assets. 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 outside China.
    * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The user ID of the member whose perspective the administrator wants to switch to.
+   * 
+   * @example
+   * 113091674488****
+   */
   roleFor?: number;
+  /**
+   * @remarks
+   * The view type.
+   * 
+   * - 0: The view of the current Alibaba Cloud account.
+   * 
+   * - 1: The view of all accounts that are managed by the enterprise.
+   * 
+   * @example
+   * 1
+   */
   roleType?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListBindAccountResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListBindAccountResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The AccessKey ID of the cloud account.
+   * The AccessKey ID of the account.
    * 
    * @example
    * ABCXXXXXXXX
@@ -21,15 +21,15 @@ export class ListBindAccountResponseBodyData extends $dara.Model {
   accountId?: string;
   /**
    * @remarks
-   * The username of the cloud account.
+   * The name of the account.
    * 
    * @example
-   * sas_account_xxx
+   * XXXX Company
    */
   accountName?: string;
   /**
    * @remarks
-   * The ID that is generated when the cloud account is added.
+   * The binding ID.
    * 
    * @example
    * 123xxxxxxx
@@ -39,9 +39,11 @@ export class ListBindAccountResponseBodyData extends $dara.Model {
    * @remarks
    * The code of the cloud service provider. Valid values:
    * 
-   * *   qcloud: Tencent Cloud
-   * *   aliyun: Alibaba Cloud
-   * *   hcloud: Huawei Cloud
+   * - qcloud: Tencent Cloud.
+   * 
+   * - aliyun: Alibaba Cloud.
+   * 
+   * - hcloud: Huawei Cloud.
    * 
    * @example
    * hcloud
@@ -49,7 +51,7 @@ export class ListBindAccountResponseBodyData extends $dara.Model {
   cloudCode?: string;
   /**
    * @remarks
-   * The ID of the account that is used to add the cloud account.
+   * The user who bound the account.
    * 
    * @example
    * 123xxxxxxx
@@ -57,7 +59,7 @@ export class ListBindAccountResponseBodyData extends $dara.Model {
   createUser?: string;
   /**
    * @remarks
-   * The number of data sources that are added to the threat analysis feature within the cloud account.
+   * The number of data sources that are bound to the account.
    * 
    * @example
    * 2
@@ -65,7 +67,7 @@ export class ListBindAccountResponseBodyData extends $dara.Model {
   dataSourceCount?: number;
   /**
    * @remarks
-   * The modification time.
+   * The time when the binding was modified.
    * 
    * @example
    * 2023-11-10 12:20:35
@@ -109,7 +111,7 @@ export class ListBindAccountResponseBodyData extends $dara.Model {
 export class ListBindAccountResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The data returned.
+   * The result set.
    */
   data?: ListBindAccountResponseBodyData[];
   /**

package/src/models/ListBindDataSourcesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListBindDataSourcesRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the cloud account.
+   * The ID of the Alibaba Cloud account.
    * 
    * This parameter is required.
    * 
@@ -15,13 +15,7 @@ export class ListBindDataSourcesRequest extends $dara.Model {
   accountId?: string;
   /**
    * @remarks
-   * The code of the cloud service provider.
-   * 
-   * Valid values:
-   * 
-   * *   qcloud
-   * *   hcloud
-   * *   aliyun
+   * The code of the multicloud environment.
    * 
    * This parameter is required.
    * 
@@ -31,10 +25,11 @@ export class ListBindDataSourcesRequest extends $dara.Model {
   cloudCode?: 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 Threat Analysis is located. Select a region based on the location of your assets. 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/ListBindDataSourcesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListBindDataSourcesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The ID of the cloud account.
+   * The ID of the Alibaba Cloud account.
    * 
    * @example
    * 123xxxxxxx
@@ -13,7 +13,7 @@ export class ListBindDataSourcesResponseBodyData extends $dara.Model {
   accountId?: string;
   /**
    * @remarks
-   * The username of the cloud account.
+   * The name of the multicloud account.
    * 
    * @example
    * sas_tq_account_xxxx
@@ -21,11 +21,13 @@ export class ListBindDataSourcesResponseBodyData extends $dara.Model {
   accountName?: string;
   /**
    * @remarks
-   * The code of the cloud service provider. Valid values:
+   * The code of 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
@@ -33,7 +35,7 @@ export class ListBindDataSourcesResponseBodyData 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. This ID is an MD5 hash value that is calculated by Threat Analysis based on specific parameters.
    * 
    * @example
    * 220ba97c9d1fdb0b9c7e8c7ca328d7ea
@@ -49,7 +51,7 @@ export class ListBindDataSourcesResponseBodyData extends $dara.Model {
   dataSourceName?: string;
   /**
    * @remarks
-   * The remarks on the data source.
+   * The remarks of the data source.
    * 
    * @example
    * waf_kafka
@@ -59,9 +61,11 @@ export class ListBindDataSourcesResponseBodyData 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 Kafka (CKafka)
+   * - obs: Huawei Cloud OBS.
+   * 
+   * - wafApi: Tencent Cloud WAF download API.
+   * 
+   * - ckafka: Tencent Cloud CKafka.
    * 
    * @example
    * obs
@@ -69,7 +73,7 @@ export class ListBindDataSourcesResponseBodyData extends $dara.Model {
   dataSourceType?: string;
   /**
    * @remarks
-   * The number of logs that are added within the data source.
+   * The number of logs added to the data source.
    * 
    * @example
    * 1
@@ -77,7 +81,7 @@ export class ListBindDataSourcesResponseBodyData extends $dara.Model {
   logCount?: number;
   /**
    * @remarks
-   * The number of existing tasks that are created to add logs within the data source.
+   * The number of log collection tasks created for the data source.
    * 
    * @example
    * 0

package/src/models/ListCloudSiemCustomizeRulesRequest.ts

@@ -23,7 +23,7 @@ export class ListCloudSiemCustomizeRulesRequest extends $dara.Model {
   currentPage?: number;
   /**
    * @remarks
-   * The end of the time range to query. Unit: milliseconds.
+   * The end time of the query. The value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1577808000000
@@ -39,10 +39,11 @@ export class ListCloudSiemCustomizeRulesRequest extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The sort method. Valid values:
+   * The order in which you want to sort the custom rules. Valid values:
    * 
-   * *   desc: descending order.
-   * *   asc: ascending order.
+   * - desc: descending order
+   * 
+   * - asc: ascending order
    * 
    * @example
    * desc
@@ -50,10 +51,11 @@ export class ListCloudSiemCustomizeRulesRequest extends $dara.Model {
   order?: string;
   /**
    * @remarks
-   * The field that is used to sort the rules. Valid values:
+   * The field that you use to sort the custom rules. Valid values:
+   * 
+   * - GmtModified: sorts the rules by modification time.
    * 
-   * *   GmtModified: The rules are sorted based on the modification time.
-   * *   Id (default): The rules are sorted based on the rule ID.
+   * - Id: sorts the rules by rule ID. This is the default value.
    * 
    * @example
    * Id
@@ -61,7 +63,7 @@ export class ListCloudSiemCustomizeRulesRequest extends $dara.Model {
   orderField?: string;
   /**
    * @remarks
-   * The number of entries per page. The value can be up to 100.
+   * The number of entries per page. Maximum value: 100.
    * 
    * This parameter is required.
    * 
@@ -71,10 +73,11 @@ export class ListCloudSiemCustomizeRulesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The data management center of the threat analysis feature. Specify this parameter based on the regions in which your assets reside. Valid values:
+   * The region where the data management center of Threat Analysis is deployed. You must select the region where your assets reside. 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 Hong Kong (China).
+   * 
+   * - **ap-southeast-1**: your assets are outside China.
    * 
    * @example
    * cn-hangzhou
@@ -82,7 +85,7 @@ export class ListCloudSiemCustomizeRulesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the destination account to which you switch the view from the management account.
+   * The user ID that is used to switch the administrator\\"s view to the view of a member.
    * 
    * @example
    * 113091674488****
@@ -90,13 +93,14 @@ export class ListCloudSiemCustomizeRulesRequest extends $dara.Model {
   roleFor?: number;
   /**
    * @remarks
-   * The type of the view. Valid values:
+   * The view type.
+   * 
+   * - 0: the view of the current Alibaba Cloud account.
    * 
-   * *   0: view of the current Alibaba Cloud account.
-   * *   1: view of all accounts for the enterprise.
+   * - 1: the view of all members in the enterprise.
    * 
    * @example
-   * 0
+   * 1
    */
   roleType?: number;
   /**
@@ -111,8 +115,9 @@ export class ListCloudSiemCustomizeRulesRequest extends $dara.Model {
    * @remarks
    * The type of the rule. Valid values:
    * 
-   * *   **predefine**
-   * *   **customize**
+   * - **predefine**: predefined
+   * 
+   * - **customize**: custom
    * 
    * @example
    * customize
@@ -120,7 +125,7 @@ export class ListCloudSiemCustomizeRulesRequest extends $dara.Model {
   ruleType?: string;
   /**
    * @remarks
-   * The beginning of the time range to query. Unit: milliseconds.
+   * The start time of the query. The value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1577808000000
@@ -130,11 +135,15 @@ export class ListCloudSiemCustomizeRulesRequest 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 is complete.
-   * *   **100**: The rule is in effect.
+   * - **0**: initial
+   * 
+   * - **10**: testing with simulated data
+   * 
+   * - **15**: testing with business data
+   * 
+   * - **20**: testing with business data is complete
+   * 
+   * - **100**: published
    * 
    * @example
    * 0
@@ -142,11 +151,13 @@ export class ListCloudSiemCustomizeRulesRequest extends $dara.Model {
   status?: number;
   /**
    * @remarks
-   * The threat level. The value must be a JSON array. Valid values:
+   * The threat level. The value is a JSON array. Valid values:
+   * 
+   * - **serious**: high
+   * 
+   * - **suspicious**: medium
    * 
-   * *   **serious**: high-risk.
-   * *   **suspicious**: medium-risk.
-   * *   **remind**: low-risk.
+   * - **remind**: low
    * 
    * @example
    * ["serious","suspicious","remind"]