@alicloud/cloud-siem20220616 6.0.2 → 6.1.0

package/src/models/DescribeDisposeAndPlaybookResponseBody.ts

@@ -13,7 +13,7 @@ export class DescribeDisposeAndPlaybookResponseBodyDataPageInfo extends $dara.Mo
   currentPage?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of entries returned per page.
    * 
    * @example
    * 10
@@ -21,7 +21,7 @@ export class DescribeDisposeAndPlaybookResponseBodyDataPageInfo extends $dara.Mo
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 100
@@ -53,10 +53,21 @@ export class DescribeDisposeAndPlaybookResponseBodyDataPageInfo extends $dara.Mo
 }
 
 export class DescribeDisposeAndPlaybookResponseBodyDataResponseDataPlaybookList extends $dara.Model {
+  /**
+   * @remarks
+   * Indicates whether the playbook is available.
+   * 
+   * - 1: available
+   * 
+   * - 0: unavailable
+   * 
+   * @example
+   * 1
+   */
   available?: string;
   /**
    * @remarks
-   * The playbook description.
+   * The description of the playbook.
    * 
    * @example
    * WafBlockIP
@@ -72,7 +83,7 @@ export class DescribeDisposeAndPlaybookResponseBodyDataResponseDataPlaybookList
   displayName?: string;
   /**
    * @remarks
-   * The playbook name, which is the unique identifier of the playbook.
+   * The name of the playbook, which is the unique identifier of the playbook.
    * 
    * @example
    * kill_process_isolate_file
@@ -80,7 +91,7 @@ export class DescribeDisposeAndPlaybookResponseBodyDataResponseDataPlaybookList
   name?: string;
   /**
    * @remarks
-   * The opcode of the playbook, which corresponds to the opcode of the playbook recommended for entity handling.
+   * The opcode of the playbook. The value corresponds to the recommended playbook opcode of the entity.
    * 
    * @example
    * 7
@@ -88,10 +99,11 @@ export class DescribeDisposeAndPlaybookResponseBodyDataResponseDataPlaybookList
   opCode?: string;
   /**
    * @remarks
-   * Indicates whether quick event handling is selected by default. Valid values:
+   * Indicates whether the playbook is selected by default for one-click event disposition. Valid values:
    * 
-   * *   2: Quick event handling is selected.
-   * *   1: Quick event handling is displayed but not selected.
+   * - 2: selected
+   * 
+   * - 1: displayed but not selected
    * 
    * @example
    * 2
@@ -99,29 +111,44 @@ export class DescribeDisposeAndPlaybookResponseBodyDataResponseDataPlaybookList
   opLevel?: string;
   /**
    * @remarks
-   * The playbook parameters and the corresponding properties.
+   * The list of parameters for the playbook and the attributes of the parameters.
    */
   paramConfig?: any[];
   /**
    * @remarks
-   * The opcode configuration.
+   * The configuration of the opcode.
    * 
    * @example
    * {"opCode":"3"}
    */
   taskConfig?: string;
+  /**
+   * @remarks
+   * The reason why the playbook is unavailable.
+   * 
+   * - PARAM_INVALID: The input parameters are invalid.
+   * 
+   * - NO_INGESTION: The required service is not integrated.
+   * 
+   * @example
+   * PARAM_INVALID
+   */
   unAvailableCode?: string;
   /**
+   * @remarks
+   * The UUID of the playbook, which is the unique identifier of the playbook.
+   * 
    * @example
    * kill_process_isolate_file
    */
   uuid?: string;
   /**
    * @remarks
-   * Indicates whether the playbook is intended for Web Application Firewall (WAF). Valid values:
+   * Indicates whether the playbook is a WAF playbook. Valid values:
    * 
-   * *   true
-   * *   false
+   * - `true`: Yes
+   * 
+   * - `false`: No
    * 
    * @example
    * false
@@ -182,36 +209,51 @@ export class DescribeDisposeAndPlaybookResponseBodyDataResponseData extends $dar
   alertNum?: number;
   /**
    * @remarks
-   * The object for handling.
+   * The disposition object.
    * 
    * @example
-   * 192.168.1.1
+   * 192.168.*.*
    */
   dispose?: string;
   /**
    * @remarks
-   * The entity ID
+   * The ID of the entity.
    * 
    * @example
-   * 12345
+   * 12345****
    */
   entityId?: number;
   /**
    * @remarks
-   * The entity information.
+   * The information about the entity.
    * 
    * @example
-   * {"file_path": "c:/www/leixi.jsp","file_hash": "aa0ca926ad948cd820e0a3d9a18c09d0","host_uuid": "efed2cf7-0b77-45d9-a97b-d2cf246bcbb3","malware_type": "${aliyun.siem.sas.alert_tag.webshell}","host_name": "launch-advisor-20230531"}
+   * {"file_path": "c:/www/leixi.jsp","file_hash": "aa0ca926ad948cd820e0a3d9a18c****","host_uuid": "efed2cf7-0b77-45d9-a97b-d2cf246b****","malware_type": "${aliyun.siem.sas.alert_tag.webshell}","host_name": "launch-advisor-2023****"}
    */
   entityInfo?: { [key: string]: any };
   /**
+   * @remarks
+   * The type of the entity. Valid values:
+   * 
+   * - `ip`: IP address
+   * 
+   * - `domain`: Domain name
+   * 
+   * - `url`: URL
+   * 
+   * - `process`: Process
+   * 
+   * - `file`: File
+   * 
+   * - `host`: Host
+   * 
    * @example
    * ip
    */
   entityType?: string;
   /**
    * @remarks
-   * The key-value pairs each of which consists of opcode and oplevel.
+   * The opcode and the corresponding operation level.
    * 
    * @example
    * 12345
@@ -219,7 +261,7 @@ export class DescribeDisposeAndPlaybookResponseBodyDataResponseData extends $dar
   opcodeMap?: { [key: string]: string };
   /**
    * @remarks
-   * The codes of the playbooks that are recommended for entity handling.
+   * The recommended playbook opcode for the entity.
    * 
    * @example
    * [1,3]
@@ -227,12 +269,15 @@ export class DescribeDisposeAndPlaybookResponseBodyDataResponseData extends $dar
   opcodeSet?: string[];
   /**
    * @remarks
-   * The playbooks that can handle the entity.
+   * The list of playbooks that can be used to handle the entity.
+   * 
+   * @example
+   * [{"name":"云安全中心-云服务器安全","code":"1"}]
    */
   playbookList?: DescribeDisposeAndPlaybookResponseBodyDataResponseDataPlaybookList[];
   /**
    * @remarks
-   * The IDs of the users who can handle objects.
+   * The list of user IDs that are authorized to perform the disposition.
    * 
    * @example
    * 176618589410****
@@ -333,7 +378,7 @@ export class DescribeDisposeAndPlaybookResponseBodyData extends $dara.Model {
 export class DescribeDisposeAndPlaybookResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code that is returned.
+   * The HTTP status code.
    * 
    * @example
    * 200
@@ -341,7 +386,7 @@ export class DescribeDisposeAndPlaybookResponseBody extends $dara.Model {
   code?: number;
   /**
    * @remarks
-   * The data returned.
+   * The returned data.
    * 
    * @example
    * 123456
@@ -349,7 +394,7 @@ export class DescribeDisposeAndPlaybookResponseBody extends $dara.Model {
   data?: DescribeDisposeAndPlaybookResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The response message.
    * 
    * @example
    * success
@@ -367,8 +412,9 @@ export class DescribeDisposeAndPlaybookResponseBody 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/DescribeDisposeStrategyPlaybookRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDisposeStrategyPlaybookRequest extends $dara.Model {
   /**
    * @remarks
-   * The end of the time range to query. Unit: milliseconds.
+   * The end time of the query. This value is a UNIX timestamp in milliseconds.
    * 
    * This parameter is required.
    * 
@@ -15,10 +15,11 @@ export class DescribeDisposeStrategyPlaybookRequest extends $dara.Model {
   endTime?: number;
   /**
    * @remarks
-   * The data management center of the threat analysis feature. Specify this parameter based on the region in which your assets reside. Valid values:
+   * The region of the Data Management center for Threat Analysis. Select a region based on the location of your assets. Valid values:
    * 
-   * *   cn-hangzhou: Your assets reside in regions inside China.
-   * *   ap-southeast-1: Your assets reside in regions outside China.
+   * - cn-hangzhou: The assets are in the Chinese mainland or China (Hong Kong).
+   * 
+   * - ap-southeast-1: The assets are outside China.
    * 
    * @example
    * cn-hangzhou
@@ -26,7 +27,7 @@ export class DescribeDisposeStrategyPlaybookRequest 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 member\\"s view.
    * 
    * @example
    * 113091674488****
@@ -34,9 +35,11 @@ export class DescribeDisposeStrategyPlaybookRequest 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
@@ -44,7 +47,7 @@ export class DescribeDisposeStrategyPlaybookRequest extends $dara.Model {
   roleType?: number;
   /**
    * @remarks
-   * The beginning of the time range to query. Unit: milliseconds.
+   * The start time of the query. This value is a UNIX timestamp in milliseconds.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeDisposeStrategyPlaybookResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDisposeStrategyPlaybookResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The playbook name, which is the unique identifier of the playbook.
+   * The unique name of the playbook.
    * 
    * @example
    * WafBlockIP
@@ -45,7 +45,7 @@ export class DescribeDisposeStrategyPlaybookResponseBodyData extends $dara.Model
 export class DescribeDisposeStrategyPlaybookResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code that is returned.
+   * The status code of the request.
    * 
    * @example
    * 200
@@ -79,8 +79,9 @@ export class DescribeDisposeStrategyPlaybookResponseBody 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/DescribeEntityInfoRequest.ts

@@ -13,7 +13,7 @@ export class DescribeEntityInfoRequest extends $dara.Model {
   entityId?: number;
   /**
    * @remarks
-   * The feature value of the entity. Fuzzy match is supported.
+   * The feature value of the entity. You can perform a fuzzy search for the entity.
    * 
    * @example
    * test22.php
@@ -21,7 +21,7 @@ export class DescribeEntityInfoRequest extends $dara.Model {
   entityIdentity?: string;
   /**
    * @remarks
-   * The UUID of the event.
+   * The globally unique UUID of the event.
    * 
    * @example
    * 85ea4241-798f-4684-a876-65d4f0c3****
@@ -29,10 +29,11 @@ export class DescribeEntityInfoRequest 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 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 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
@@ -40,7 +41,7 @@ export class DescribeEntityInfoRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the account that you switch from the management account.
+   * The user ID of the member. The administrator can use this ID to switch to the view of this member.
    * 
    * @example
    * 113091674488****
@@ -48,9 +49,11 @@ export class DescribeEntityInfoRequest 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
@@ -58,7 +61,7 @@ export class DescribeEntityInfoRequest extends $dara.Model {
   roleType?: number;
   /**
    * @remarks
-   * The ID of the SOAR handling policy.
+   * The ID of the SOAR response policy.
    * 
    * @example
    * 577bbf90-a770-44a7-8154-586aa2d318fa

package/src/models/DescribeEntityInfoResponseBody.ts

@@ -13,7 +13,7 @@ export class DescribeEntityInfoResponseBodyData extends $dara.Model {
   entityId?: number;
   /**
    * @remarks
-   * The information about the entry.
+   * The information about the entity.
    * 
    * @example
    * { location: "xian", net_connect_dir: "in", malware_type: "${aliyun.siem.sas.alert_tag.login_unusual_account}" }
@@ -23,12 +23,17 @@ export class DescribeEntityInfoResponseBodyData extends $dara.Model {
    * @remarks
    * The type of the entity. Valid values:
    * 
-   * *   ip
-   * *   domain
-   * *   url
-   * *   process
-   * *   file
-   * *   host
+   * - ip: IP address
+   * 
+   * - domain: domain name
+   * 
+   * - url: URL
+   * 
+   * - process: process
+   * 
+   * - file: file
+   * 
+   * - host: host
    * 
    * @example
    * ip
@@ -36,7 +41,7 @@ export class DescribeEntityInfoResponseBodyData extends $dara.Model {
   entityType?: string;
   /**
    * @remarks
-   * The information about the risk Intelligence.
+   * The threat intelligence information.
    * 
    * @example
    * {
@@ -87,7 +92,7 @@ export class DescribeEntityInfoResponseBodyData extends $dara.Model {
 export class DescribeEntityInfoResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The status code of the request.
    * 
    * @example
    * 200
@@ -103,7 +108,7 @@ export class DescribeEntityInfoResponseBody extends $dara.Model {
   data?: DescribeEntityInfoResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The message returned for the request.
    * 
    * @example
    * success
@@ -121,8 +126,9 @@ export class DescribeEntityInfoResponseBody 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/DescribeEventCountByThreatLevelRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeEventCountByThreatLevelRequest extends $dara.Model {
   /**
    * @remarks
-   * The end of the time range to query. Unit: milliseconds.
+   * End time of the query, in milliseconds.
    * 
    * @example
    * 1577808000000
@@ -13,10 +13,11 @@ export class DescribeEventCountByThreatLevelRequest extends $dara.Model {
   endTime?: 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:
+   * Region where the Data Management Center for threat analysis 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: Assets are in the Chinese mainland or Hong Kong (China).
+   * 
+   * - ap-southeast-1: Assets are outside China.
    * 
    * @example
    * cn-hangzhou
@@ -24,7 +25,7 @@ export class DescribeEventCountByThreatLevelRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the member in the resource directory.
+   * Resource directory member account ID.
    * 
    * @example
    * 113091674488****
@@ -32,10 +33,11 @@ export class DescribeEventCountByThreatLevelRequest extends $dara.Model {
   roleFor?: number;
   /**
    * @remarks
-   * The type of the view.
+   * View type.
+   * 
+   * - 0: View for the current Alibaba Cloud account.
    * 
-   * *   0: view of the current Alibaba Cloud account.
-   * *   1: view of all accounts for the enterprise.
+   * - 1: View for all accounts in your enterprise.
    * 
    * @example
    * 1
@@ -43,7 +45,7 @@ export class DescribeEventCountByThreatLevelRequest extends $dara.Model {
   roleType?: number;
   /**
    * @remarks
-   * The beginning of the time range to query. Unit: milliseconds.
+   * Start time of the query, in milliseconds.
    * 
    * @example
    * 1577808000000

package/src/models/DescribeEventCountByThreatLevelResponseBody.ts

@@ -3,8 +3,29 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeEventCountByThreatLevelResponseBodyDataEventDailyNum extends $dara.Model {
+  /**
+   * @remarks
+   * Date.
+   * 
+   * @example
+   * 2025-10-06
+   */
   date?: string;
+  /**
+   * @remarks
+   * Total number of security events.
+   * 
+   * @example
+   * 100
+   */
   eventNum?: number;
+  /**
+   * @remarks
+   * Number of unhandled security events.
+   * 
+   * @example
+   * 34
+   */
   undealEventNum?: number;
   static names(): { [key: string]: string } {
     return {
@@ -32,10 +53,14 @@ export class DescribeEventCountByThreatLevelResponseBodyDataEventDailyNum extend
 }
 
 export class DescribeEventCountByThreatLevelResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * Daily event statistics.
+   */
   eventDailyNum?: DescribeEventCountByThreatLevelResponseBodyDataEventDailyNum[];
   /**
    * @remarks
-   * The total number of events.
+   * Total number of events.
    * 
    * @example
    * 100
@@ -43,16 +68,23 @@ export class DescribeEventCountByThreatLevelResponseBodyData extends $dara.Model
   eventNum?: number;
   /**
    * @remarks
-   * The number of high-risk events.
+   * Number of high-risk events.
    * 
    * @example
    * 20
    */
   highLevelEventNum?: number;
+  /**
+   * @remarks
+   * Number of informational events.
+   * 
+   * @example
+   * 0
+   */
   infoLevelEventNum?: number;
   /**
    * @remarks
-   * The number of low-risk events.
+   * Number of low-risk events.
    * 
    * @example
    * 52
@@ -60,16 +92,23 @@ export class DescribeEventCountByThreatLevelResponseBodyData extends $dara.Model
   lowLevelEventNum?: number;
   /**
    * @remarks
-   * The number of medium-risk events.
+   * Number of medium-risk events.
    * 
    * @example
    * 3
    */
   mediumLevelEventNum?: number;
+  /**
+   * @remarks
+   * Number of critical events.
+   * 
+   * @example
+   * 0
+   */
   seriousLevelEventNum?: number;
   /**
    * @remarks
-   * The number of unhandled events.
+   * Number of unhandled events.
    * 
    * @example
    * 75
@@ -116,7 +155,7 @@ export class DescribeEventCountByThreatLevelResponseBodyData extends $dara.Model
 export class DescribeEventCountByThreatLevelResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * HTTP status code.
    * 
    * @example
    * 200
@@ -124,7 +163,7 @@ export class DescribeEventCountByThreatLevelResponseBody extends $dara.Model {
   code?: number;
   /**
    * @remarks
-   * The data returned.
+   * Response data.
    * 
    * @example
    * 123456
@@ -132,7 +171,7 @@ export class DescribeEventCountByThreatLevelResponseBody extends $dara.Model {
   data?: DescribeEventCountByThreatLevelResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * Response message.
    * 
    * @example
    * success
@@ -140,7 +179,7 @@ export class DescribeEventCountByThreatLevelResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * 9AAA9ED9-78F4-5021-86DC-D51C7511****
@@ -148,10 +187,11 @@ export class DescribeEventCountByThreatLevelResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Indicates whether the request succeeded. Valid values:
+   * 
+   * - true: The request succeeded.
    * 
-   * *   true
-   * *   false
+   * - false: The request failed.
    * 
    * @example
    * true