@alicloud/cloud-siem20220616 6.0.2 → 6.2.0

package/src/models/DescribeAlertsWithEventResponseBody.ts

@@ -13,7 +13,7 @@ export class DescribeAlertsWithEventResponseBodyDataPageInfo extends $dara.Model
   currentPage?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of entries returned per page.
    * 
    * @example
    * 10
@@ -21,7 +21,7 @@ export class DescribeAlertsWithEventResponseBodyDataPageInfo extends $dara.Model
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 100
@@ -55,7 +55,7 @@ export class DescribeAlertsWithEventResponseBodyDataPageInfo extends $dara.Model
 export class DescribeAlertsWithEventResponseBodyDataResponseDataAlertInfoList extends $dara.Model {
   /**
    * @remarks
-   * The attribute key.
+   * The key of the alert attribute.
    * 
    * @example
    * suspicious.wbd.wb.trojanpath
@@ -63,7 +63,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseDataAlertInfoList ex
   key?: string;
   /**
    * @remarks
-   * The name of the key.
+   * The display name of the alert attribute.
    * 
    * @example
    * Trojan Path
@@ -71,7 +71,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseDataAlertInfoList ex
   keyName?: string;
   /**
    * @remarks
-   * The value of the key.
+   * The value of the alert attribute.
    * 
    * @example
    * /root/test33.php
@@ -113,7 +113,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   alertDesc?: string;
   /**
    * @remarks
-   * The internal code of the alert description.
+   * The Medusa code of the alert description.
    * 
    * @example
    * security_event_config.event_name.webshell
@@ -121,7 +121,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   alertDescCode?: string;
   /**
    * @remarks
-   * The alert description in English.
+   * The English description of the alert.
    * 
    * @example
    * The detection model found a suspicious Webshell file on your server, which may be a backdoor file implanted to maintain permissions after the attacker successfully invaded the website.
@@ -129,7 +129,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   alertDescEn?: string;
   /**
    * @remarks
-   * The details of the alert.
+   * A JSON-formatted string that contains the alert details.
    * 
    * @example
    * {"main_user_id": "165295629792****";"log_uuid_count": "99";"attack_ip": "21.92.*.*"}
@@ -137,7 +137,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   alertDetail?: string;
   /**
    * @remarks
-   * The displayed details of the alert.
+   * A list of objects that contain detailed alert attributes.
    * 
    * @example
    * aliyun
@@ -145,11 +145,13 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   alertInfoList?: DescribeAlertsWithEventResponseBodyDataResponseDataAlertInfoList[];
   /**
    * @remarks
-   * The risk level. Valid values:
+   * The threat level of the alert. Valid values:
    * 
-   * *   serious: high.
-   * *   suspicious: medium.
-   * *   remind: low.
+   * - `serious`: high
+   * 
+   * - `suspicious`: medium
+   * 
+   * - `remind`: low
    * 
    * @example
    * remind
@@ -165,7 +167,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   alertName?: string;
   /**
    * @remarks
-   * The internal code of the alert name.
+   * The Medusa code of the alert name.
    * 
    * @example
    * security_event_config.event_name.webshell
@@ -173,7 +175,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   alertNameCode?: string;
   /**
    * @remarks
-   * The alert name in English.
+   * The English name of the alert.
    * 
    * @example
    * Try SNMP weak password
@@ -181,7 +183,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   alertNameEn?: string;
   /**
    * @remarks
-   * The source of the alert.
+   * The source product of the alert.
    * 
    * @example
    * sas
@@ -189,7 +191,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   alertSrcProd?: string;
   /**
    * @remarks
-   * The sub-module of the alert source.
+   * The submodule of the source product.
    * 
    * @example
    * waf
@@ -205,7 +207,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   alertTitle?: string;
   /**
    * @remarks
-   * The alert title in English.
+   * The English title of the alert.
    * 
    * @example
    * Scan-Try SNMP weak password
@@ -221,7 +223,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   alertType?: string;
   /**
    * @remarks
-   * The internal code of the alert type.
+   * The Medusa code of the alert type.
    * 
    * @example
    * security_event_config.event_name.webshellName
@@ -229,7 +231,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   alertTypeCode?: string;
   /**
    * @remarks
-   * The alert type in English.
+   * The English type of the alert.
    * 
    * @example
    * Scan
@@ -245,7 +247,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   alertUuid?: string;
   /**
    * @remarks
-   * The details of the asset.
+   * A JSON-formatted string that lists the assets associated with the alert.
    * 
    * @example
    * [
@@ -264,7 +266,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   assetList?: string;
   /**
    * @remarks
-   * The tag of the ATT\\&CK technique.
+   * The ATT\\&CK tag.
    * 
    * @example
    * T1595.002 Vulnerability Scanning
@@ -272,20 +274,29 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   attCk?: string;
   /**
    * @remarks
-   * The code of the cloud service provider. Valid values:
+   * The cloud service provider. Valid values:
+   * 
+   * - `aliyun`: Alibaba Cloud
    * 
-   * *   aliyun: Alibaba Cloud.
-   * *   qcloud: Tencent Cloud.
-   * *   hcloud: Huawei Cloud.
+   * - `qcloud`: Tencent Cloud
+   * 
+   * - `hcloud`: Huawei Cloud
    * 
    * @example
    * aliyun
    */
   cloudCode?: string;
+  /**
+   * @remarks
+   * The ID of the detection rule.
+   * 
+   * @example
+   * dr-48zs4tk7qfd4rjd9****
+   */
   detectionRuleId?: string;
   /**
    * @remarks
-   * The time when the alert was closed.
+   * The end time of the alert.
    * 
    * @example
    * 2021-01-06 16:37:29
@@ -293,16 +304,23 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   endTime?: string;
   /**
    * @remarks
-   * The details of the entity.
+   * A JSON-formatted string that lists the entities involved in the alert.
    * 
    * @example
    * [{"entity_user_id":"198921674491****","entity_account_id":"N/A","entity_uuid":"6245f979d5dd9ef8dd19bdc72228****","entity_type":"host","entity_name":"zhh-test-20240409","is_comprised":"1","os_type":"linux","entity_id":"a88f44dd-b8d4-4ded-831c-77a4835****","host_uuid":"a88f44dd-b8d4-4ded-831c-77a4835****","host_name":"zhh-test-2024****"}]
    */
   entityList?: string;
+  /**
+   * @remarks
+   * A JSON-formatted string that contains extended information about the alert.
+   * 
+   * @example
+   * {"main_user_id": "165295629792****";"log_uuid_count": "99****"}
+   */
   extendContent?: string;
   /**
    * @remarks
-   * The time when the alert was received.
+   * The time when the alert was created.
    * 
    * @example
    * 2021-01-06 16:37:29
@@ -326,19 +344,27 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   id?: number;
   /**
    * @remarks
-   * The UUID of the event.
+   * The universally unique identifier (UUID) of the event.
    * 
    * @example
    * 85ea4241-798f-4684-a876-65d4f0c3****
    */
   incidentUuid?: string;
+  /**
+   * @remarks
+   * A JSON-formatted string that contains the investigation report for the alert.
+   * 
+   * @example
+   * {"agent_attack_confidence": 90, "agent_judgement_category": "false_positive", "reason": "The command line contains \\"mediacenter\\" which is a normal startup behavior of Lark (Feishu) client, and the process path is in the standard user installation directory.", "start_time": 1774929064, "end_time": 1774929071}
+   */
   investigationReport?: string;
   /**
    * @remarks
-   * Indicates whether an attack is defended against. Valid values:
+   * Indicates whether the attack was blocked. Valid values:
    * 
-   * *   0: detected.
-   * *   1: blocked.
+   * - `0`: detected
+   * 
+   * - `1`: blocked
    * 
    * @example
    * 1
@@ -362,7 +388,7 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   logUuid?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account that is associated with the alert in SIEM.
+   * The ID of the main account associated with the alert.
    * 
    * @example
    * 127608589417****
@@ -370,16 +396,23 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   mainUserId?: number;
   /**
    * @remarks
-   * The time when the alert was triggered.
+   * The time when the alert occurred.
    * 
    * @example
    * 2021-01-06 16:37:29
    */
   occurTime?: string;
+  /**
+   * @remarks
+   * The cloud service ID.
+   * 
+   * @example
+   * alibaba_cloud_sas
+   */
   productId?: string;
   /**
    * @remarks
-   * The time at which the alert was first generated.
+   * The time when the alert first occurred.
    * 
    * @example
    * 2021-01-06 16:37:29
@@ -387,17 +420,33 @@ export class DescribeAlertsWithEventResponseBodyDataResponseData extends $dara.M
   startTime?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account within which the alert is generated.
+   * The ID of the sub-account that generated the alert.
    * 
    * @example
    * 176555323***
    */
   subUserId?: number;
   /**
+   * @remarks
+   * The name of the sub-account that generated the alert.
+   * 
    * @example
    * 176555323***
    */
   subUserName?: string;
+  /**
+   * @remarks
+   * The cloud service provider. Valid values:
+   * 
+   * - `aliyun`: Alibaba Cloud
+   * 
+   * - `qcloud`: Tencent Cloud
+   * 
+   * - `hcloud`: Huawei Cloud
+   * 
+   * @example
+   * aliyun
+   */
   vendorId?: string;
   static names(): { [key: string]: string } {
     return {
@@ -507,7 +556,7 @@ export class DescribeAlertsWithEventResponseBodyData extends $dara.Model {
   pageInfo?: DescribeAlertsWithEventResponseBodyDataPageInfo;
   /**
    * @remarks
-   * The detailed data.
+   * The details of the alerts.
    */
   responseData?: DescribeAlertsWithEventResponseBodyDataResponseData[];
   static names(): { [key: string]: string } {
@@ -542,7 +591,7 @@ export class DescribeAlertsWithEventResponseBodyData extends $dara.Model {
 export class DescribeAlertsWithEventResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The status code of the request.
    * 
    * @example
    * 200
@@ -550,7 +599,7 @@ export class DescribeAlertsWithEventResponseBody extends $dara.Model {
   code?: number;
   /**
    * @remarks
-   * The data returned.
+   * The response payload.
    * 
    * @example
    * 123456
@@ -558,7 +607,7 @@ export class DescribeAlertsWithEventResponseBody extends $dara.Model {
   data?: DescribeAlertsWithEventResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The response message.
    * 
    * @example
    * success
@@ -576,8 +625,9 @@ export class DescribeAlertsWithEventResponseBody 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/DescribeAuthRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAuthRequest extends $dara.Model {
   /**
    * @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 threat analysis center. 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: Select this value if your assets are deployed in the Chinese mainland or the China (Hong Kong) region.
+   * 
+   * - ap-southeast-1: Select this value if your assets are deployed in regions outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou

package/src/models/DescribeAuthResponseBody.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAuthResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the SIEM system is granted the required permissions. Valid values:
+   * Indicates whether the permissions are granted.
    * 
-   * *   true
-   * *   false
+   * - true: The permissions are granted.
+   * 
+   * - false: The permissions are not granted.
    * 
    * @example
    * true

package/src/models/DescribeAutomateResponseConfigCounterRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAutomateResponseConfigCounterRequest extends $dara.Model {
   /**
    * @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 Management Hub. Select the region based on the location 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 in a region outside China.
    * 
    * @example
    * cn-hangzhou
@@ -16,7 +17,7 @@ export class DescribeAutomateResponseConfigCounterRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the account that you switch from the management account.
+   * The user ID of the member whose view the administrator wants to switch to.
    * 
    * @example
    * 113091674488****
@@ -24,9 +25,11 @@ export class DescribeAutomateResponseConfigCounterRequest 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 in the enterprise.
    * 
    * @example
    * 1

package/src/models/DescribeAutomateResponseConfigCounterResponseBody.ts

@@ -45,7 +45,7 @@ export class DescribeAutomateResponseConfigCounterResponseBodyData extends $dara
 export class DescribeAutomateResponseConfigCounterResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The request status code.
    * 
    * @example
    * 200
@@ -61,7 +61,7 @@ export class DescribeAutomateResponseConfigCounterResponseBody extends $dara.Mod
   data?: DescribeAutomateResponseConfigCounterResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The message returned.
    * 
    * @example
    * success
@@ -79,8 +79,9 @@ export class DescribeAutomateResponseConfigCounterResponseBody extends $dara.Mod
    * @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/DescribeAutomateResponseConfigFeatureRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAutomateResponseConfigFeatureRequest extends $dara.Model {
   /**
    * @remarks
-   * The type of the automated response rule. Valid values:
+   * The type of automated response. Valid values:
    * 
-   * *   event
-   * *   alert
+   * - event: event
+   * 
+   * - alert: alert
    * 
    * @example
    * event
@@ -16,10 +17,11 @@ export class DescribeAutomateResponseConfigFeatureRequest extends $dara.Model {
   autoResponseType?: 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 a region based on the location of your assets. Valid values:
+   * 
+   * - cn-hangzhou: Assets in the Chinese mainland and Hong Kong (China).
    * 
-   * *   cn-hangzhou: Your assets reside in regions in China.
-   * *   ap-southeast-1: Your assets reside in regions outside China.
+   * - ap-southeast-1: Assets outside China.
    * 
    * @example
    * cn-hangzhou
@@ -27,7 +29,7 @@ export class DescribeAutomateResponseConfigFeatureRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the account that you switch from the management account.
+   * The user ID of the member. An administrator can use this parameter to switch to the perspective of the member.
    * 
    * @example
    * 113091674488****
@@ -35,9 +37,11 @@ export class DescribeAutomateResponseConfigFeatureRequest 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 view. Valid values:
+   * 
+   * - 0: the view of the current Alibaba Cloud account.
+   * 
+   * - 1: the view of all accounts that are managed by the administrator account.
    * 
    * @example
    * 1

package/src/models/DescribeAutomateResponseConfigFeatureResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAutomateResponseConfigFeatureResponseBodyDataRightValueEnums extends $dara.Model {
   /**
    * @remarks
-   * The enumerated value of the right operand.
+   * The enumeration value of the right operand.
    * 
    * @example
    * serious
@@ -13,7 +13,7 @@ export class DescribeAutomateResponseConfigFeatureResponseBodyDataRightValueEnum
   value?: string;
   /**
    * @remarks
-   * The internal code of the enumerated value.
+   * The Medusa code for the enumeration value of the right operand.
    * 
    * @example
    * aliyun.siem.automate.feature.alert_level.serious
@@ -45,10 +45,11 @@ export class DescribeAutomateResponseConfigFeatureResponseBodyDataRightValueEnum
 export class DescribeAutomateResponseConfigFeatureResponseBodyDataSupportOperators extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the right operand is required. Valid values:
+   * Indicates whether a right operand is required. Valid values:
    * 
-   * *   true
-   * *   false
+   * - true: A right operand is required.
+   * 
+   * - false: A right operand is not required.
    * 
    * @example
    * false
@@ -56,7 +57,7 @@ export class DescribeAutomateResponseConfigFeatureResponseBodyDataSupportOperato
   hasRightValue?: boolean;
   /**
    * @remarks
-   * The position of the operator in the operator list.
+   * The position of the operator in the list of operators.
    * 
    * @example
    * 3
@@ -88,7 +89,7 @@ export class DescribeAutomateResponseConfigFeatureResponseBodyDataSupportOperato
   operatorDescEn?: string;
   /**
    * @remarks
-   * The name of the operator.
+   * The display name of the operator.
    * 
    * @example
    * <=
@@ -96,7 +97,7 @@ export class DescribeAutomateResponseConfigFeatureResponseBodyDataSupportOperato
   operatorName?: string;
   /**
    * @remarks
-   * The data types that are supported by the operator. The data types are separated by commas (,).
+   * The data types that the operator supports. Multiple data types are separated by commas.
    * 
    * @example
    * varchar
@@ -104,7 +105,7 @@ export class DescribeAutomateResponseConfigFeatureResponseBodyDataSupportOperato
   supportDataType?: string;
   /**
    * @remarks
-   * The scenarios that are supported by the operator. Multiple scenarios are separated by commas (,), such as aggregation scenarios. By default, this parameter is empty.
+   * The scenarios that the operator supports. Multiple scenarios are separated by commas, such as aggregation. By default, this parameter is empty.
    * 
    * @example
    * [AGGREGATE]
@@ -151,7 +152,7 @@ export class DescribeAutomateResponseConfigFeatureResponseBodyDataSupportOperato
 export class DescribeAutomateResponseConfigFeatureResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The data type of the condition field in the automated response rule.
+   * The data type of the condition field for the automated response rule.
    * 
    * @example
    * varchar
@@ -159,7 +160,7 @@ export class DescribeAutomateResponseConfigFeatureResponseBodyData extends $dara
   dataType?: string;
   /**
    * @remarks
-   * The name of the condition field in the automated response rule.
+   * The name of the condition field for the automated response rule.
    * 
    * @example
    * alert_desc
@@ -167,12 +168,12 @@ export class DescribeAutomateResponseConfigFeatureResponseBodyData extends $dara
   feature?: string;
   /**
    * @remarks
-   * The enumerated values of the right operand for the field.
+   * The enumeration of the right operand that corresponds to the field.
    */
   rightValueEnums?: DescribeAutomateResponseConfigFeatureResponseBodyDataRightValueEnums[];
   /**
    * @remarks
-   * The operators that are supported for the condition field.
+   * The operators that the field supports.
    */
   supportOperators?: DescribeAutomateResponseConfigFeatureResponseBodyDataSupportOperators[];
   static names(): { [key: string]: string } {
@@ -211,7 +212,7 @@ export class DescribeAutomateResponseConfigFeatureResponseBodyData extends $dara
 export class DescribeAutomateResponseConfigFeatureResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The status code.
    * 
    * @example
    * 200
@@ -219,7 +220,7 @@ export class DescribeAutomateResponseConfigFeatureResponseBody extends $dara.Mod
   code?: number;
   /**
    * @remarks
-   * The data returned.
+   * The returned data.
    * 
    * @example
    * 123456
@@ -243,10 +244,11 @@ export class DescribeAutomateResponseConfigFeatureResponseBody extends $dara.Mod
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Indicates whether the request is successful. Valid values:
+   * 
+   * - true: The request is successful.
    * 
-   * *   true
-   * *   false
+   * - false: The request failed.
    * 
    * @example
    * true