@alicloud/cloud-siem20220616 6.0.2 → 6.1.0

package/src/models/DescribeAlertSourceRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAlertSourceRequest extends $dara.Model {
   /**
    * @remarks
-   * The end of the time range to query. Unit: milliseconds.
+   * The end of the query time range. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1577808000000
@@ -13,11 +13,13 @@ export class DescribeAlertSourceRequest extends $dara.Model {
   endTime?: number;
   /**
    * @remarks
-   * The risk levels. The value is a JSON array. Valid values:
+   * The threat levels. Valid values:
    * 
-   * *   serious: high
-   * *   suspicious: medium
-   * *   remind: low
+   * - `serious`: High
+   * 
+   * - `suspicious`: Medium
+   * 
+   * - `remind`: Low
    * 
    * @example
    * ["serious","suspicious","remind"]
@@ -25,10 +27,11 @@ export class DescribeAlertSourceRequest extends $dara.Model {
   level?: 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 for threat analysis. Select the data management center that corresponds to the region where your assets are located. Valid values:
+   * 
+   * - `cn-hangzhou`: for 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`: for assets in regions outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -36,7 +39,7 @@ export class DescribeAlertSourceRequest 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 data you want to view. An administrator uses this parameter to view data from the perspective of a specific member.
    * 
    * @example
    * 113091674488****
@@ -44,9 +47,11 @@ export class DescribeAlertSourceRequest 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`: View data for the current Alibaba Cloud account.
+   * 
+   * - `1`: View data for all accounts in the enterprise.
    * 
    * @example
    * 1
@@ -54,7 +59,7 @@ export class DescribeAlertSourceRequest extends $dara.Model {
   roleType?: number;
   /**
    * @remarks
-   * The beginning of the time range to query. Unit: milliseconds.
+   * The start of the query time range. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1577808000000

package/src/models/DescribeAlertSourceResponseBody.ts

@@ -3,10 +3,14 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeAlertSourceResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The list of modules.
+   */
   modules?: string[];
   /**
    * @remarks
-   * The internal code of the alert data source.
+   * The internal code for the alert source.
    * 
    * @example
    * aliyun.siem.alert_datasource.sas
@@ -14,7 +18,7 @@ export class DescribeAlertSourceResponseBodyData extends $dara.Model {
   source?: string;
   /**
    * @remarks
-   * The name of the alert data source.
+   * The name of the alert source.
    * 
    * @example
    * sas
@@ -51,7 +55,7 @@ export class DescribeAlertSourceResponseBodyData extends $dara.Model {
 export class DescribeAlertSourceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The status code of the response. A value of 200 indicates success.
    * 
    * @example
    * 200
@@ -59,7 +63,7 @@ export class DescribeAlertSourceResponseBody extends $dara.Model {
   code?: number;
   /**
    * @remarks
-   * The data returned.
+   * The list of alert sources.
    * 
    * @example
    * 123456
@@ -67,7 +71,7 @@ export class DescribeAlertSourceResponseBody extends $dara.Model {
   data?: DescribeAlertSourceResponseBodyData[];
   /**
    * @remarks
-   * The returned message.
+   * The response message.
    * 
    * @example
    * success
@@ -85,8 +89,9 @@ export class DescribeAlertSourceResponseBody 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/DescribeAlertSourceWithEventRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAlertSourceWithEventRequest extends $dara.Model {
   /**
    * @remarks
-   * The UUID of the event.
+   * The globally unique ID of the event.
    * 
    * @example
    * 85ea4241-798f-4684-a876-65d4f0c3****
@@ -13,10 +13,11 @@ export class DescribeAlertSourceWithEventRequest extends $dara.Model {
   incidentUuid?: string;
   /**
    * @remarks
-   * The region in which the data management center of the threat analysis feature resides. Specify this parameter based on the region where 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:
    * 
-   * *   Valid values: Your assets reside in regions in China.
-   * *   ap-southeast-1: Your assets reside in regions outside China.
+   * - cn-hangzhou: Your assets are in China.
+   * 
+   * - ap-southeast-1: Your assets are outside China.
    * 
    * @example
    * cn-hangzhou
@@ -24,7 +25,7 @@ export class DescribeAlertSourceWithEventRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the account that you switch from the management account.
+   * The ID of the member whose data you want to view. An administrator can use this parameter to switch to the perspective of a member.
    * 
    * @example
    * 113091674488****
@@ -32,9 +33,11 @@ export class DescribeAlertSourceWithEventRequest 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 are managed by the enterprise.
    * 
    * @example
    * 1

package/src/models/DescribeAlertSourceWithEventResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAlertSourceWithEventResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The internal code of the alert data source.
+   * The Medusa code for the alert data source.
    * 
    * @example
    * aliyun.siem.alert_datasource.sas
@@ -45,7 +45,7 @@ export class DescribeAlertSourceWithEventResponseBodyData extends $dara.Model {
 export class DescribeAlertSourceWithEventResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The status code of the request.
    * 
    * @example
    * 200
@@ -79,8 +79,9 @@ export class DescribeAlertSourceWithEventResponseBody 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/DescribeAlertTypeRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAlertTypeRequest 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 where the Data Management center is located. Select a 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 DescribeAlertTypeRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the account that you switch from the management account.
+   * The user ID of a member. An administrator can use this parameter to switch to the perspective of the member.
    * 
    * @example
    * 113091674488****
@@ -24,9 +25,11 @@ export class DescribeAlertTypeRequest 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 in your enterprise.
    * 
    * @example
    * 1
@@ -34,9 +37,11 @@ export class DescribeAlertTypeRequest extends $dara.Model {
   roleType?: number;
   /**
    * @remarks
-   * The type of rule. Valid values:
-   * - predefine: the defined rule by system
-   * - customize: the customed rule by user
+   * The type of the rule. Valid values:
+   * 
+   * - predefine: predefined
+   * 
+   * - customize: custom
    * 
    * @example
    * customize

package/src/models/DescribeAlertTypeResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAlertTypeResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The type of the risk.
+   * The threat type.
    * 
    * @example
    * WEBSHELL
@@ -13,7 +13,7 @@ export class DescribeAlertTypeResponseBodyData extends $dara.Model {
   alertType?: string;
   /**
    * @remarks
-   * The internal code of the risk type.
+   * The Medusa code of the threat type.
    * 
    * @example
    * siem_rule_type_process_abnormal_command
@@ -45,7 +45,7 @@ export class DescribeAlertTypeResponseBodyData extends $dara.Model {
 export class DescribeAlertTypeResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The request status code.
    * 
    * @example
    * 200
@@ -79,8 +79,9 @@ export class DescribeAlertTypeResponseBody 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/DescribeAlertsCountRequest.ts

@@ -5,23 +5,27 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAlertsCountRequest extends $dara.Model {
   /**
    * @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
    */
   endTime?: number;
   /**
+   * @remarks
+   * The query type.
+   * 
    * @example
    * bySrcProd
    */
   queryType?: 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 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
@@ -29,7 +33,7 @@ export class DescribeAlertsCountRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the account that you switch from the management account.
+   * The user ID of a member. An administrator can specify this parameter to query alerts from the perspective of the member.
    * 
    * @example
    * 113091674488****
@@ -37,9 +41,11 @@ export class DescribeAlertsCountRequest 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
@@ -47,7 +53,7 @@ export class DescribeAlertsCountRequest extends $dara.Model {
   roleType?: number;
   /**
    * @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

package/src/models/DescribeAlertsCountResponseBody.ts

@@ -11,6 +11,10 @@ export class DescribeAlertsCountResponseBodyData extends $dara.Model {
    * 75
    */
   all?: number;
+  /**
+   * @remarks
+   * The number of alerts for each severity level.
+   */
   countMap?: { [key: string]: number };
   /**
    * @remarks
@@ -38,7 +42,7 @@ export class DescribeAlertsCountResponseBodyData extends $dara.Model {
   medium?: number;
   /**
    * @remarks
-   * The number of connected services.
+   * The number of connected products.
    * 
    * @example
    * 3
@@ -81,7 +85,7 @@ export class DescribeAlertsCountResponseBodyData extends $dara.Model {
 export class DescribeAlertsCountResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The HTTP status code returned.
    * 
    * @example
    * 200
@@ -97,7 +101,7 @@ export class DescribeAlertsCountResponseBody extends $dara.Model {
   data?: DescribeAlertsCountResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The message returned.
    * 
    * @example
    * success
@@ -115,8 +119,9 @@ export class DescribeAlertsCountResponseBody 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/DescribeAlertsRequest.ts

@@ -3,7 +3,18 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeAlertsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the alert.
+   * 
+   * @example
+   * Try SNMP weak password
+   */
   alertName?: string;
+  /**
+   * @remarks
+   * The status of the alert.
+   */
   alertStatus?: string[];
   /**
    * @remarks
@@ -13,20 +24,41 @@ export class DescribeAlertsRequest extends $dara.Model {
    * Unusual Logon-login_common_account
    */
   alertTitle?: string;
+  /**
+   * @remarks
+   * The type of the alert.
+   * 
+   * @example
+   * Scan
+   */
   alertType?: string;
   /**
    * @remarks
-   * The UUID of the alert.
+   * The unique ID of the alert.
    * 
    * @example
    * sas_71e24437d2797ce8fc59692905a4****
    */
   alertUuid?: string;
+  /**
+   * @remarks
+   * The ID of the asset.
+   * 
+   * @example
+   * F3385128-69A5-3EE8-BD05-FBEE7DB2****
+   */
   assetId?: string;
+  /**
+   * @remarks
+   * The name of the asset.
+   * 
+   * @example
+   * hostname-****
+   */
   assetName?: 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.
    * 
@@ -36,37 +68,69 @@ export class DescribeAlertsRequest 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 representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.
    * 
    * @example
    * 1577808000000
    */
   endTime?: number;
+  /**
+   * @remarks
+   * The ID of the entity.
+   * 
+   * @example
+   * f366e287ea530e7a324cbe987993****
+   */
   entityId?: string;
+  /**
+   * @remarks
+   * The name of the entity.
+   * 
+   * @example
+   * launch-advisor-*****
+   */
   entityName?: string;
   /**
    * @remarks
-   * Specifies whether an attack is defended. Valid values:
+   * Specifies whether the threat is defended. Valid values:
    * 
-   * *   0: detected.
-   * *   1: blocked.
+   * - `0`: detected
+   * 
+   * - `1`: blocked
    * 
    * @example
    * 1
    */
   isDefend?: string;
   /**
+   * @remarks
+   * The alert type. Valid values:
+   * 
+   * - `system`: An alert generated from aggregated analysis
+   * 
+   * - `custom`: An alert generated from custom analysis
+   * 
+   * - `cfw`: firewall
+   * 
+   * - `waf`: web application firewall
+   * 
+   * - `edr`: endpoint detection and response
+   * 
+   * - `other`: other
+   * 
    * @example
-   * 176555323***
+   * custom
    */
   labelType?: string;
   /**
    * @remarks
-   * The risk level. The value is a JSON array. Valid values:
+   * The threat levels. This parameter is a JSON array. Valid values:
+   * 
+   * - `serious`: high
+   * 
+   * - `suspicious`: medium
    * 
-   * *   serious: high
-   * *   suspicious: medium
-   * *   remind: low
+   * - `remind`: low
    * 
    * @example
    * ["serious","suspicious","remind"]
@@ -84,10 +148,11 @@ export class DescribeAlertsRequest 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 resides. You are required to specify this parameter based on 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 reside in the Chinese mainland or Hong Kong (China).
+   * 
+   * - `ap-southeast-1`: Your assets reside outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -95,7 +160,7 @@ export class DescribeAlertsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the account that you switch from the management account.
+   * The ID of the user who is used to switch the account to view the data of the member.
    * 
    * @example
    * 113091674488****
@@ -103,9 +168,11 @@ export class DescribeAlertsRequest 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 of the alert. Valid values:
+   * 
+   * - `0`: current account
+   * 
+   * - `1`: all accounts
    * 
    * @example
    * 1
@@ -121,7 +188,7 @@ export class DescribeAlertsRequest extends $dara.Model {
   source?: string;
   /**
    * @remarks
-   * The beginning of the time range to query. Unit: milliseconds.
+   * The beginning of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.
    * 
    * @example
    * 1577808000000
@@ -129,7 +196,7 @@ export class DescribeAlertsRequest extends $dara.Model {
   startTime?: number;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account within which the alert is generated.
+   * The ID of the Alibaba Cloud account that is associated with the alert.
    * 
    * @example
    * 176555323***