@alicloud/cloud-siem20220616 6.0.2 → 6.2.0

package/src/models/ListCloudSiemCustomizeRulesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCloudSiemCustomizeRulesResponseBodyDataPageInfo extends $dara.Model {
   /**
    * @remarks
-   * The current page number.
+   * The page number.
    * 
    * @example
    * 1
@@ -21,7 +21,7 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataPageInfo 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 ListCloudSiemCustomizeRulesResponseBodyDataPageInfo extends $dara.M
 export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $dara.Model {
   /**
    * @remarks
-   * The type of the risk.
+   * The threat type.
    * 
    * @example
    * WEBSHELL
@@ -63,7 +63,7 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   alertType?: string;
   /**
    * @remarks
-   * The internal code of the risk type.
+   * The Medusa code of the threat type.
    * 
    * @example
    * ${siem_rule_type_process_abnormal_command}
@@ -71,7 +71,7 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   alertTypeMds?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account in SIEM.
+   * The ID of the Alibaba Cloud account.
    * 
    * @example
    * 127608589417****
@@ -79,7 +79,7 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   aliuid?: number;
   /**
    * @remarks
-   * The alert additional field for ATT\\&CK.
+   * The ATT\\&CK attack technique.
    * 
    * @example
    * T1595.002 Vulnerability Scanning
@@ -87,9 +87,10 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   attCk?: string;
   /**
    * @remarks
-   * The type of the view. Valid values:
+   * The view type.
    * 
-   * 0: view of the current Alibaba Cloud account. 1: view of all accounts for the enterprise.
+   * 0: the view of the current Alibaba Cloud account.
+   * 1: the view of all members in the enterprise.
    * 
    * @example
    * 1
@@ -97,7 +98,7 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   dataType?: number;
   /**
    * @remarks
-   * The extended information about event generation. If the value of **eventTransferType** is **allToSingle**, the value of this parameter indicates the length and unit of the alert aggregation window. The HTML escape characters are reversed.
+   * The extended information for event generation. This parameter is returned only when **EventTransferType** is set to **allToSingle**. The value is a JSON-formatted string that indicates the window length and unit for alert aggregation. You must unescape the HTML escape characters in the string.
    * 
    * @example
    * {"time":"1","unit":"MINUTE"}
@@ -105,10 +106,11 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   eventTransferExt?: string;
   /**
    * @remarks
-   * Indicates whether the system generates an event for the alert. Valid values:
+   * Indicates whether to convert alerts into events. Valid values:
    * 
-   * *   **0**: no.
-   * *   **1**: yes.
+   * - **0**: no
+   * 
+   * - **1**: yes
    * 
    * @example
    * 1
@@ -116,11 +118,13 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   eventTransferSwitch?: number;
   /**
    * @remarks
-   * The method that is used to generate an event. Valid values:
+   * The event generation method. Valid values:
+   * 
+   * - **default**: the default method
+   * 
+   * - **singleToSingle**: An event is generated for each alert.
    * 
-   * *   **default**: built-in method.
-   * *   **singleToSingle**: The system generates an event for each alert.
-   * *   **allToSingle**: The system generates an event for alerts within a period of time.
+   * - **allToSingle**: An event is generated for all alerts within a period.
    * 
    * @example
    * allToSingle
@@ -152,7 +156,7 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   id?: number;
   /**
    * @remarks
-   * The log source of the rule.
+   * The log source that is associated with the rule.
    * 
    * @example
    * cloud_siem_aegis_sas_alert
@@ -160,7 +164,7 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   logSource?: string;
   /**
    * @remarks
-   * The internal code of the log source.
+   * The Medusa code of the log source that is associated with the rule.
    * 
    * @example
    * ${sas.cloudsiem.prod.cloud_siem_aegis_sas_alert}
@@ -168,7 +172,7 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   logSourceMds?: string;
   /**
    * @remarks
-   * The log type of the rule.
+   * The log type that is associated with the rule.
    * 
    * @example
    * ALERT_ACTIVITY
@@ -176,7 +180,7 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   logType?: string;
   /**
    * @remarks
-   * The internal code of the log type.
+   * The Medusa code of the log type that is associated with the rule.
    * 
    * @example
    * ${sas.cloudsiem.prod.alert_activity}
@@ -184,7 +188,7 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   logTypeMds?: string;
   /**
    * @remarks
-   * The window length of the rule. The HTML escape characters are reversed.
+   * The window length of the rule, which is a JSON-formatted string. You must unescape the HTML escape characters in the string.
    * 
    * @example
    * {"time":"1","unit":"HOUR"}
@@ -192,7 +196,7 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   queryCycle?: string;
   /**
    * @remarks
-   * The query condition of the rule. The value is in the JSON format. The HTML escape characters are reversed.
+   * The query condition of the rule, which is a JSON-formatted string that represents an array. You must unescape the HTML escape characters in the string.
    * 
    * @example
    * [[{"not":false,"left":"alert_name","operator":"=","right":"WEBSHELL"}]]
@@ -208,7 +212,7 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   ruleDesc?: string;
   /**
    * @remarks
-   * The log aggregation field. The value is in the JSON format. The HTML escape characters are reversed.
+   * The aggregation field of the log, which is a JSON-formatted string that represents an array. You must unescape the HTML escape characters in the string.
    * 
    * @example
    * ["asset_id"]
@@ -224,7 +228,7 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   ruleName?: string;
   /**
    * @remarks
-   * The threshold configurations of the rule in the JSON format. The HTML escape characters are reversed.
+   * The threshold of the rule, which is a JSON-formatted string. You must unescape the HTML escape characters in the string.
    * 
    * @example
    * {"aggregateFunction":"count","aggregateFunctionName":"count","field":"activity_name","operator":"<=","value":1}
@@ -234,8 +238,9 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
    * @remarks
    * The type of the rule. Valid values:
    * 
-   * *   **predefine**
-   * *   **customize**
+   * - **predefine**: predefined
+   * 
+   * - **customize**: custom
    * 
    * @example
    * customize
@@ -245,11 +250,15 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
    * @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
@@ -257,11 +266,13 @@ export class ListCloudSiemCustomizeRulesResponseBodyDataResponseData extends $da
   status?: number;
   /**
    * @remarks
-   * The risk level. Valid values:
+   * The threat level. Valid values:
+   * 
+   * - **serious**: high
    * 
-   * *   **serious**: high-risk.
-   * *   **suspicious**: medium-risk.
-   * *   **remind**: low-risk.
+   * - **suspicious**: medium
+   * 
+   * - **remind**: low
    * 
    * @example
    * remind
@@ -411,8 +422,9 @@ export class ListCloudSiemCustomizeRulesResponseBody 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/ListCloudSiemPredefinedRulesRequest.ts

@@ -13,7 +13,7 @@ export class ListCloudSiemPredefinedRulesRequest extends $dara.Model {
   alertType?: string;
   /**
    * @remarks
-   * The ATT\\&CK information.
+   * The ATT\\&CK technique.
    * 
    * @example
    * T1595.002 Vulnerability Scanning
@@ -21,7 +21,7 @@ export class ListCloudSiemPredefinedRulesRequest extends $dara.Model {
   attCk?: string;
   /**
    * @remarks
-   * The page number. Pages start from page 1.
+   * The page number. The value must be greater than or equal to 1.
    * 
    * This parameter is required.
    * 
@@ -31,7 +31,7 @@ export class ListCloudSiemPredefinedRulesRequest extends $dara.Model {
   currentPage?: number;
   /**
    * @remarks
-   * The end of the time range to query. Unit: milliseconds.
+   * The end of the time range to query. This value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1577808000000
@@ -39,11 +39,13 @@ export class ListCloudSiemPredefinedRulesRequest extends $dara.Model {
   endTime?: number;
   /**
    * @remarks
-   * The method that is used to generate an event. Valid values:
+   * The event generation method. Valid values:
    * 
-   * *   default: built-in method.
-   * *   singleToSingle: The system generates an event for each alert.
-   * *   allToSingle: The system generates an event for alerts within a period of time.
+   * - default: the default built-in method
+   * 
+   * - singleToSingle: An event is generated for each alert.
+   * 
+   * - allToSingle: An event is generated for all alerts in an epoch.
    * 
    * @example
    * allToSingle
@@ -51,7 +53,7 @@ export class ListCloudSiemPredefinedRulesRequest extends $dara.Model {
   eventTransferType?: string;
   /**
    * @remarks
-   * The ID of the rule.
+   * The rule ID.
    * 
    * @example
    * 10223
@@ -62,15 +64,16 @@ export class ListCloudSiemPredefinedRulesRequest extends $dara.Model {
    * The log source.
    * 
    * @example
-   * cloud_siem_aegis_sas_alert
+   * cloud_siem_alb_flow_log
    */
   logSource?: string;
   /**
    * @remarks
-   * The sort method. Valid values:
+   * The sort order. Valid values:
    * 
-   * *   desc: descending order.
-   * *   asc: ascending order.
+   * - desc: descending
+   * 
+   * - asc: ascending
    * 
    * @example
    * desc
@@ -78,10 +81,11 @@ export class ListCloudSiemPredefinedRulesRequest extends $dara.Model {
   order?: string;
   /**
    * @remarks
-   * The field that is used to sort the rules. Valid values:
+   * The field to sort the rules by. Valid values:
+   * 
+   * - GmtModified: Sorts 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 by rule ID. This is the default value.
    * 
    * @example
    * Id
@@ -89,7 +93,7 @@ export class ListCloudSiemPredefinedRulesRequest extends $dara.Model {
   orderField?: string;
   /**
    * @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.
    * 
@@ -99,10 +103,11 @@ export class ListCloudSiemPredefinedRulesRequest extends $dara.Model {
   pageSize?: 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 where the Data Management center of the threat analysis feature is located. Select the region 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: assets in the Chinese mainland or China (Hong Kong)
+   * 
+   * - ap-southeast-1: assets outside China
    * 
    * @example
    * cn-hangzhou
@@ -110,7 +115,7 @@ export class ListCloudSiemPredefinedRulesRequest 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 the administrator uses to switch to the perspective of a member.
    * 
    * @example
    * 113091674488****
@@ -118,10 +123,11 @@ export class ListCloudSiemPredefinedRulesRequest extends $dara.Model {
   roleFor?: number;
   /**
    * @remarks
-   * The type of the view.
+   * 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 accounts in the enterprise.
    * 
    * @example
    * 1
@@ -129,7 +135,7 @@ export class ListCloudSiemPredefinedRulesRequest extends $dara.Model {
   roleType?: number;
   /**
    * @remarks
-   * The name of the rule. The name can contain letters, digits, underscores (_), and periods (.).
+   * The rule name. The name can contain only letters, digits, underscores (_), and periods (.).
    * 
    * @example
    * waf_scan
@@ -137,10 +143,11 @@ export class ListCloudSiemPredefinedRulesRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The type of the rule. Valid values:
+   * The rule type. Valid values:
+   * 
+   * - predefine: predefined
    * 
-   * *   predefine
-   * *   customize
+   * - customize: custom
    * 
    * @example
    * customize
@@ -148,7 +155,7 @@ export class ListCloudSiemPredefinedRulesRequest extends $dara.Model {
   ruleType?: string;
   /**
    * @remarks
-   * The beginning of the time range to query. Unit: milliseconds.
+   * The start of the time range to query. This value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1577808000000
@@ -156,13 +163,17 @@ export class ListCloudSiemPredefinedRulesRequest extends $dara.Model {
   startTime?: number;
   /**
    * @remarks
-   * The status of the rule. Valid values:
+   * The rule status. 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: testing with simulated data
+   * 
+   * - 15: testing with production data
+   * 
+   * - 20: testing with production data is complete
+   * 
+   * - 100: published
    * 
    * @example
    * 0
@@ -170,11 +181,13 @@ export class ListCloudSiemPredefinedRulesRequest extends $dara.Model {
   status?: number;
   /**
    * @remarks
-   * The risk level. The value is a JSON array. Valid values:
+   * The threat level. The value is a JSON array. Valid values:
+   * 
+   * - serious: high
+   * 
+   * - suspicious: medium
    * 
-   * *   serious: high
-   * *   suspicious: medium
-   * *   remind: low
+   * - remind: low
    * 
    * @example
    * ["serious","suspicious","remind"]

package/src/models/ListCloudSiemPredefinedRulesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCloudSiemPredefinedRulesResponseBodyDataPageInfo extends $dara.Model {
   /**
    * @remarks
-   * The current page number.
+   * The page number.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class ListCloudSiemPredefinedRulesResponseBodyDataPageInfo extends $dara.
   currentPage?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of entries returned per page.
    * 
    * @example
    * 10
@@ -21,7 +21,7 @@ export class ListCloudSiemPredefinedRulesResponseBodyDataPageInfo extends $dara.
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 100
@@ -55,7 +55,7 @@ export class ListCloudSiemPredefinedRulesResponseBodyDataPageInfo extends $dara.
 export class ListCloudSiemPredefinedRulesResponseBodyDataResponseData extends $dara.Model {
   /**
    * @remarks
-   * The type of the risk.
+   * The threat type.
    * 
    * @example
    * WEBSHELL
@@ -63,7 +63,7 @@ export class ListCloudSiemPredefinedRulesResponseBodyDataResponseData extends $d
   alertType?: string;
   /**
    * @remarks
-   * The alert additional field for ATT\\&CK.
+   * The ATT\\&CK technique.
    * 
    * @example
    * T1595.002 Vulnerability Scanning
@@ -71,11 +71,13 @@ export class ListCloudSiemPredefinedRulesResponseBodyDataResponseData extends $d
   attCk?: string;
   /**
    * @remarks
-   * The method that is used to generate an event. Valid values:
+   * The event generation method. Valid values:
    * 
-   * *   default: built-in method.
-   * *   singleToSingle: The system generates an event for each alert.
-   * *   allToSingle: The system generates an event for alerts within a period of time.
+   * - default: the default built-in method
+   * 
+   * - singleToSingle: An event is generated for each alert.
+   * 
+   * - allToSingle: An event is generated for all alerts in an epoch.
    * 
    * @example
    * allToSingle
@@ -91,7 +93,7 @@ export class ListCloudSiemPredefinedRulesResponseBodyDataResponseData extends $d
   gmtCreate?: string;
   /**
    * @remarks
-   * The time when the rule was modified.
+   * The time when the rule was last modified.
    * 
    * @example
    * 2021-01-06 16:37:29
@@ -107,7 +109,7 @@ export class ListCloudSiemPredefinedRulesResponseBodyDataResponseData extends $d
   id?: number;
   /**
    * @remarks
-   * The internal code of the rule description.
+   * The Medusa code of the rule description.
    * 
    * @example
    * ${siem_rule_description_siem_cfw-attack-count-level-up_cfw-attack}
@@ -115,7 +117,7 @@ export class ListCloudSiemPredefinedRulesResponseBodyDataResponseData extends $d
   ruleDescMds?: string;
   /**
    * @remarks
-   * The name of the rule.
+   * The rule name.
    * 
    * @example
    * siem_base64-command-exec_aegis-proc
@@ -123,7 +125,7 @@ export class ListCloudSiemPredefinedRulesResponseBodyDataResponseData extends $d
   ruleName?: string;
   /**
    * @remarks
-   * The rule name in Chinese.
+   * The Chinese name of the rule.
    * 
    * @example
    * siem_base64-command-exec_aegis-proc
@@ -131,7 +133,7 @@ export class ListCloudSiemPredefinedRulesResponseBodyDataResponseData extends $d
   ruleNameCn?: string;
   /**
    * @remarks
-   * The rule name in English.
+   * The English name of the rule.
    * 
    * @example
    * siem_base64-command-exec_aegis-proc
@@ -139,7 +141,7 @@ export class ListCloudSiemPredefinedRulesResponseBodyDataResponseData extends $d
   ruleNameEn?: string;
   /**
    * @remarks
-   * The internal code of the rule name.
+   * The Medusa code of the rule name.
    * 
    * @example
    * ${siem_rule_name_siem_cfw-attack-count-level-up_cfw-attack}
@@ -157,8 +159,9 @@ export class ListCloudSiemPredefinedRulesResponseBodyDataResponseData extends $d
    * @remarks
    * The status of the predefined rule. Valid values:
    * 
-   * *   0: The rule is in the initial state.
-   * *   100: The rule takes effect.
+   * - 0: initial
+   * 
+   * - 100: published
    * 
    * @example
    * 0
@@ -166,11 +169,13 @@ export class ListCloudSiemPredefinedRulesResponseBodyDataResponseData extends $d
   status?: number;
   /**
    * @remarks
-   * The risk level. Valid values:
+   * The threat level. Valid values:
    * 
-   * *   serious: high.
-   * *   suspicious: medium.
-   * *   remind: low.
+   * - serious: high
+   * 
+   * - suspicious: medium
+   * 
+   * - remind: low
    * 
    * @example
    * remind
@@ -300,8 +305,9 @@ export class ListCloudSiemPredefinedRulesResponseBody 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