@alicloud/cloud-siem20220616 6.0.1 → 6.1.0

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

package/src/models/ListCustomizeRuleTestResultRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCustomizeRuleTestResultRequest 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.
    * 
    * This parameter is required.
    * 
@@ -13,11 +13,25 @@ export class ListCustomizeRuleTestResultRequest extends $dara.Model {
    * 1
    */
   currentPage?: number;
+  /**
+   * @remarks
+   * The ID of the custom rule. You can obtain the rule ID from the rule list.
+   * 
+   * @example
+   * dr-53np4nguf5jmh1vc****
+   */
   detectionRuleId?: string;
+  /**
+   * @remarks
+   * The end time.
+   * 
+   * @example
+   * 1731797891000
+   */
   endTime?: number;
   /**
    * @remarks
-   * The ID of the rule.
+   * The ID of the custom rule.
    * 
    * @example
    * 123456789
@@ -25,7 +39,7 @@ export class ListCustomizeRuleTestResultRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The number of entries per page. Valid values: 1 to 100.
+   * The number of entries per page. The maximum value is 100.
    * 
    * This parameter is required.
    * 
@@ -35,10 +49,11 @@ export class ListCustomizeRuleTestResultRequest 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 Threat Analysis is located. Select a region based on the region where your assets are deployed. 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 and China (Hong Kong)
+   * 
+   * - ap-southeast-1: assets outside China
    * 
    * @example
    * cn-hangzhou
@@ -46,7 +61,7 @@ export class ListCustomizeRuleTestResultRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the account that you switch from the management account.
+   * The user ID of a member. This parameter is used by an administrator to switch to the perspective of the member.
    * 
    * @example
    * 113091674488****
@@ -54,15 +69,35 @@ export class ListCustomizeRuleTestResultRequest extends $dara.Model {
   roleFor?: number;
   /**
    * @remarks
-   * The type of the view. Valid values:
-   * - 0: the current Alibaba Cloud account
-   * - 1: the global account
+   * The type of the view.
+   * 
+   * - 0: the view of the current Alibaba Cloud account.
+   * 
+   * - 1: the view of all accounts that belong to the enterprise.
    * 
    * @example
    * 1
    */
   roleType?: number;
+  /**
+   * @remarks
+   * The start time.
+   * 
+   * @example
+   * 1723057091000
+   */
   startTime?: number;
+  /**
+   * @remarks
+   * The verification result for the accuracy of alert fields based on the alert template.
+   * 
+   * - true: The verification is passed. Alerts that are generated for enabled rules can be synchronized to the product.
+   * 
+   * - false: The verification failed. Alerts cannot be synchronized to the product.
+   * 
+   * @example
+   * true
+   */
   verifyType?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListCustomizeRuleTestResultResponseBody.ts

@@ -13,7 +13,7 @@ export class ListCustomizeRuleTestResultResponseBodyDataPageInfo extends $dara.M
   currentPage?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of entries returned per page.
    * 
    * @example
    * 10
@@ -21,12 +21,19 @@ export class ListCustomizeRuleTestResultResponseBodyDataPageInfo extends $dara.M
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 100
    */
   totalCount?: number;
+  /**
+   * @remarks
+   * The number of alerts that passed the verification.
+   * 
+   * @example
+   * 30
+   */
   verifiedCount?: number;
   static names(): { [key: string]: string } {
     return {
@@ -61,12 +68,12 @@ export class ListCustomizeRuleTestResultResponseBodyDataResponseData extends $da
    * The description of the alert.
    * 
    * @example
-   * The account you logged in this time is not in the legal account category defined by you. Please confirm the legality of the login behavior.
+   * The account you logged in this time is not in the legal account category defined by you. Please confirm the legality of the login behavior。
    */
   alertDesc?: string;
   /**
    * @remarks
-   * The alert details in the JSON format.
+   * The details of the alert, in JSON format.
    * 
    * @example
    * {"main_user_id": "165295629792****";"log_uuid_count": "99";"attack_ip": "218.92.XX.XX"}
@@ -74,7 +81,7 @@ export class ListCustomizeRuleTestResultResponseBodyDataResponseData extends $da
   alertDetail?: string;
   /**
    * @remarks
-   * The source of the alert.
+   * The source product of the alert that is associated with the event.
    * 
    * @example
    * sas
@@ -82,7 +89,7 @@ export class ListCustomizeRuleTestResultResponseBodyDataResponseData extends $da
   alertSrcProd?: string;
   /**
    * @remarks
-   * The sub-module of the source.
+   * The sub-module of the source product of the alert that is associated with the event.
    * 
    * @example
    * waf
@@ -90,7 +97,7 @@ export class ListCustomizeRuleTestResultResponseBodyDataResponseData extends $da
   alertSrcProdModule?: string;
   /**
    * @remarks
-   * The tag of the ATT\\&CK attack.
+   * The ATT\\&CK attack technique tag.
    * 
    * @example
    * T1595.002 Vulnerability Scanning
@@ -98,7 +105,7 @@ export class ListCustomizeRuleTestResultResponseBodyDataResponseData extends $da
   attCk?: string;
   /**
    * @remarks
-   * The name of the alert, which corresponds to the name of the custom rule.
+   * The name of the alert. This value corresponds to the name of the custom rule.
    * 
    * @example
    * waf_scan
@@ -106,7 +113,7 @@ export class ListCustomizeRuleTestResultResponseBodyDataResponseData extends $da
   eventName?: string;
   /**
    * @remarks
-   * The threat type, which indicates the alert type.
+   * The threat type. This parameter is equivalent to the alert type.
    * 
    * @example
    * WEBSHELL
@@ -116,9 +123,11 @@ export class ListCustomizeRuleTestResultResponseBodyDataResponseData extends $da
    * @remarks
    * The threat level. Valid values:
    * 
-   * *   serious: high.
-   * *   suspicious: medium.
-   * *   remind: low.
+   * - serious: high
+   * 
+   * - suspicious: medium
+   * 
+   * - remind: low
    * 
    * @example
    * remind
@@ -126,7 +135,7 @@ export class ListCustomizeRuleTestResultResponseBodyDataResponseData extends $da
   level?: string;
   /**
    * @remarks
-   * The log source of the rule.
+   * The log source that corresponds to the rule.
    * 
    * @example
    * cloud_siem_aegis_sas_alert
@@ -137,12 +146,12 @@ export class ListCustomizeRuleTestResultResponseBodyDataResponseData extends $da
    * The time when the alert was recorded.
    * 
    * @example
-   * 2021-01-06 16:37:29
+   * 2023-01-06 16:37:29
    */
   logTime?: string;
   /**
    * @remarks
-   * The log type of the rule.
+   * The log type that corresponds to the rule.
    * 
    * @example
    * ALERT_ACTIVITY
@@ -150,7 +159,7 @@ export class ListCustomizeRuleTestResultResponseBodyDataResponseData extends $da
   logType?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account that is associated with the alert in SIEM.
+   * The ID of the main Alibaba Cloud account for Security Information and Event Management (SIEM) that is associated with the alert.
    * 
    * @example
    * 127608589417****
@@ -160,8 +169,9 @@ export class ListCustomizeRuleTestResultResponseBodyDataResponseData extends $da
    * @remarks
    * The status of the alert data. Valid values:
    * 
-   * *   test: business test data.
-   * *   online: online data.
+   * - test: business test
+   * 
+   * - online: published
    * 
    * @example
    * test
@@ -169,7 +179,7 @@ export class ListCustomizeRuleTestResultResponseBodyDataResponseData extends $da
   onlineStatus?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account within which the alert is generated.
+   * The ID of the member account that is associated with the alert.
    * 
    * @example
    * 176555323***
@@ -183,6 +193,17 @@ export class ListCustomizeRuleTestResultResponseBodyDataResponseData extends $da
    * sas_71e24437d2797ce8fc59692905a4****
    */
   uuid?: string;
+  /**
+   * @remarks
+   * The result of verifying the alert based on the alert template.
+   * 
+   * - true: The verification is passed.
+   * 
+   * - false: The verification failed.
+   * 
+   * @example
+   * true
+   */
   verifyType?: string;
   static names(): { [key: string]: string } {
     return {
@@ -278,7 +299,7 @@ export class ListCustomizeRuleTestResultResponseBodyData extends $dara.Model {
 export class ListCustomizeRuleTestResultResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The status code of the request.
    * 
    * @example
    * 200
@@ -294,7 +315,7 @@ export class ListCustomizeRuleTestResultResponseBody extends $dara.Model {
   data?: ListCustomizeRuleTestResultResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The message returned for the request.
    * 
    * @example
    * success
@@ -312,8 +333,9 @@ export class ListCustomizeRuleTestResultResponseBody 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/ListDataSourceLogsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListDataSourceLogsRequest 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 ListDataSourceLogsRequest extends $dara.Model {
   accountId?: string;
   /**
    * @remarks
-   * The code that is used for multi-cloud environments. Valid values:
+   * The code for 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.
    * 
@@ -29,7 +31,7 @@ export class ListDataSourceLogsRequest extends $dara.Model {
   cloudCode?: string;
   /**
    * @remarks
-   * The ID of the data source. The value is obtained after the threat analysis feature calculates the MD5 hash value of a parameter.
+   * The ID of the data source. This ID is an MD5 hash value that is calculated by threat analysis based on specific parameters.
    * 
    * This parameter is required.
    * 
@@ -39,10 +41,11 @@ export class ListDataSourceLogsRequest extends $dara.Model {
   dataSourceInstanceId?: string;
   /**
    * @remarks
-   * The data management center of the threat analysis feature. Specify this parameter based on the region where your assets reside. Valid values:
+   * The region where the Data Management hub of threat analysis is deployed. Select a region based on the location of your assets. Valid values:
+   * 
+   * - cn-hangzhou: Your assets are in the Chinese mainland or Hong Kong (China).
    * 
-   * *   cn-hangzhou: Your assets reside in regions inside 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/ListDataSourceLogsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListDataSourceLogsResponseBodyDataDataSourceInstanceLogsLogParams extends $dara.Model {
   /**
    * @remarks
-   * The parameter code of the log.
+   * The code of the log parameter.
    * 
    * @example
    * region_code
@@ -13,7 +13,7 @@ export class ListDataSourceLogsResponseBodyDataDataSourceInstanceLogsLogParams e
   paraCode?: string;
   /**
    * @remarks
-   * The parameter value of the log.
+   * The value of the log parameter.
    * 
    * @example
    * ap-guangzhou
@@ -53,7 +53,7 @@ export class ListDataSourceLogsResponseBodyDataDataSourceInstanceLogs extends $d
   logCode?: string;
   /**
    * @remarks
-   * The ID of the log. The value is obtained after the threat analysis feature calculates the MD5 hash value of a parameter.
+   * The ID of the log. This ID is an MD5 hash value that is calculated by threat analysis based on specific parameters.
    * 
    * @example
    * 220ba97c9d1fdb0b9c7e8c7ca328d7ea
@@ -69,15 +69,16 @@ export class ListDataSourceLogsResponseBodyDataDataSourceInstanceLogs extends $d
   logMdsCode?: string;
   /**
    * @remarks
-   * The parameters of the log.
+   * The detailed parameters for the log.
    */
   logParams?: ListDataSourceLogsResponseBodyDataDataSourceInstanceLogsLogParams[];
   /**
    * @remarks
-   * Indicates whether the task for which logs are collected is enabled. Valid values:
+   * The status of the log collection task. Valid values:
    * 
-   * *   1: yes
-   * *   0: no
+   * - 1: collected.
+   * 
+   * - 0: not collected.
    * 
    * @example
    * 1
@@ -118,7 +119,7 @@ export class ListDataSourceLogsResponseBodyDataDataSourceInstanceLogs extends $d
 export class ListDataSourceLogsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The ID of the cloud account.
+   * The ID of the Alibaba Cloud account.
    * 
    * @example
    * 123xxxxxxx
@@ -126,11 +127,13 @@ export class ListDataSourceLogsResponseBodyData extends $dara.Model {
   accountId?: string;
   /**
    * @remarks
-   * The code that is used for multi-cloud environments. Valid values:
+   * The code for the cloud service provider. Valid values:
+   * 
+   * - qcloud: Tencent Cloud.
    * 
-   * *   qcloud: Tencent Cloud
-   * *   aliyun: Alibaba Cloud
-   * *   hcloud: Huawei Cloud
+   * - aliyun: Alibaba Cloud.
+   * 
+   * - hcloud: Huawei Cloud
    * 
    * @example
    * hcloud
@@ -138,7 +141,7 @@ export class ListDataSourceLogsResponseBodyData extends $dara.Model {
   cloudCode?: string;
   /**
    * @remarks
-   * The ID of the data source. The value is obtained after the threat analysis feature calculates the MD5 hash value of a parameter.
+   * 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
@@ -146,7 +149,7 @@ export class ListDataSourceLogsResponseBodyData extends $dara.Model {
   dataSourceInstanceId?: string;
   /**
    * @remarks
-   * The logs of the data source.
+   * The list of logs for the data source.
    */
   dataSourceInstanceLogs?: ListDataSourceLogsResponseBodyDataDataSourceInstanceLogs[];
   /**
@@ -159,7 +162,7 @@ export class ListDataSourceLogsResponseBodyData extends $dara.Model {
   dataSourceInstanceName?: string;
   /**
    * @remarks
-   * The remarks of the data source.
+   * The remarks on the data source.
    * 
    * @example
    * waf kafka
@@ -167,7 +170,7 @@ export class ListDataSourceLogsResponseBodyData extends $dara.Model {
   dataSourceInstanceRemark?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account.
+   * The ID of the Alibaba Cloud account to which the log belongs.
    * 
    * @example
    * 123XXXXXXXX
@@ -217,7 +220,7 @@ export class ListDataSourceLogsResponseBody extends $dara.Model {
   data?: ListDataSourceLogsResponseBodyData;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 6276D891-*****-55B2-87B9-74D413F7****

package/src/models/ListDataSourceTypesRequest.ts

@@ -5,12 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListDataSourceTypesRequest extends $dara.Model {
   /**
    * @remarks
-   * The code of the third-party cloud service.
-   * 
-   * Valid values:
-   * 
-   * *   qcloud
-   * *   hcloud
+   * The code of the multicloud service.
    * 
    * This parameter is required.
    * 
@@ -20,10 +15,11 @@ export class ListDataSourceTypesRequest 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 the region of the management center 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