@alicloud/cloud-siem20220616 6.0.2 → 6.2.0

package/src/models/DescribeCloudSiemEventsRequest.ts

@@ -13,7 +13,7 @@ export class DescribeCloudSiemEventsRequest extends $dara.Model {
   assetId?: 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.
    * 
@@ -23,13 +23,16 @@ export class DescribeCloudSiemEventsRequest extends $dara.Model {
   currentPage?: number;
   /**
    * @remarks
-   * The end of the time range to query. Unit: milliseconds.
+   * The end time of the query. This value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1577808000000
    */
   endTime?: number;
   /**
+   * @remarks
+   * The UUID of the entity that is associated with the event.
+   * 
    * @example
    * 6c740667-80b2-476d-8924-2e706feb****
    */
@@ -44,7 +47,7 @@ export class DescribeCloudSiemEventsRequest extends $dara.Model {
   eventName?: string;
   /**
    * @remarks
-   * The ID of the event.
+   * The event ID.
    * 
    * @example
    * 85ea4241-798f-4684-a876-65d4f0c3****
@@ -54,8 +57,9 @@ export class DescribeCloudSiemEventsRequest extends $dara.Model {
    * @remarks
    * The sort order. Valid values:
    * 
-   * *   desc: descending order
-   * *   asc: ascending order
+   * - desc: descending
+   * 
+   * - asc: ascending
    * 
    * @example
    * desc
@@ -63,10 +67,11 @@ export class DescribeCloudSiemEventsRequest extends $dara.Model {
   order?: string;
   /**
    * @remarks
-   * The sort field. Valid values:
+   * The field to sort the event list by. Valid values:
    * 
-   * *   GmtModified: sorts the events by creation time. This is the default value.
-   * *   ThreatScore: sorts the events by risk score.
+   * - GmtModified: Sorts by modification time. This is the default value.
+   * 
+   * - ThreatScore: Sorts by threat score.
    * 
    * @example
    * ThreatScore
@@ -74,7 +79,7 @@ export class DescribeCloudSiemEventsRequest 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.
    * 
@@ -84,10 +89,11 @@ export class DescribeCloudSiemEventsRequest 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 & Response is located. Select the region 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 regions outside China.
    * 
    * @example
    * cn-hangzhou
@@ -95,7 +101,7 @@ export class DescribeCloudSiemEventsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the account that you switch from the management account.
+   * The ID of the member. The administrator can use this ID to view the data of the member.
    * 
    * @example
    * 113091674488****
@@ -103,9 +109,11 @@ export class DescribeCloudSiemEventsRequest 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 are managed by the administrator account.
    * 
    * @example
    * 1
@@ -113,7 +121,7 @@ export class DescribeCloudSiemEventsRequest 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. Unit: milliseconds.
    * 
    * @example
    * 1577808000000
@@ -123,10 +131,13 @@ export class DescribeCloudSiemEventsRequest extends $dara.Model {
    * @remarks
    * The status of the event. Valid values:
    * 
-   * *   0: unhandled
-   * *   1: handling
-   * *   5: handling failed
-   * *   10: handled
+   * - 0: unhandled
+   * 
+   * - 1: in progress
+   * 
+   * - 5: failed
+   * 
+   * - 10: handled
    * 
    * @example
    * 0
@@ -134,11 +145,13 @@ export class DescribeCloudSiemEventsRequest extends $dara.Model {
   status?: number;
   /**
    * @remarks
-   * The risk levels of the events. The value is a JSON array. Valid values:
+   * The threat level of the event. 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/DescribeCloudSiemEventsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCloudSiemEventsResponseBodyDataPageInfo extends $dara.Model {
   /**
    * @remarks
-   * The current page number.
+   * The page number of the returned page.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class DescribeCloudSiemEventsResponseBodyDataPageInfo 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 DescribeCloudSiemEventsResponseBodyDataPageInfo extends $dara.Model
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 100
@@ -53,8 +53,29 @@ export class DescribeCloudSiemEventsResponseBodyDataPageInfo extends $dara.Model
 }
 
 export class DescribeCloudSiemEventsResponseBodyDataResponseDataAttckStages extends $dara.Model {
+  /**
+   * @remarks
+   * The number of alerts that are associated with the attack stage.
+   * 
+   * @example
+   * 21
+   */
   alertNum?: number;
+  /**
+   * @remarks
+   * The ID of the ATT\\&CK attack stage.
+   * 
+   * @example
+   * TA0001
+   */
   tacticId?: string;
+  /**
+   * @remarks
+   * The name of the attack stage.
+   * 
+   * @example
+   * Persistence
+   */
   tacticName?: string;
   static names(): { [key: string]: string } {
     return {
@@ -108,16 +129,20 @@ export class DescribeCloudSiemEventsResponseBodyDataResponseData extends $dara.M
   assetNum?: number;
   /**
    * @remarks
-   * The tags of the ATT\\&CK techniques.
+   * The tags of the ATT\\&CK attack technique.
    * 
    * @example
    * ["T1595.002 Vulnerability Scanning"]
    */
   attCkLabels?: string[];
+  /**
+   * @remarks
+   * The list of attack stages.
+   */
   attckStages?: DescribeCloudSiemEventsResponseBodyDataResponseDataAttckStages[];
   /**
    * @remarks
-   * The sources of the alert.
+   * The cloud services that generated the alerts, which are associated with the event.
    * 
    * @example
    * [sas,waf]
@@ -133,7 +158,7 @@ export class DescribeCloudSiemEventsResponseBodyDataResponseData extends $dara.M
   description?: string;
   /**
    * @remarks
-   * The event description in English.
+   * The English description of the event.
    * 
    * @example
    * The threat event contains 13 Miner Network,1 Execute suspicious encoded commands on Linux, etc
@@ -141,7 +166,7 @@ export class DescribeCloudSiemEventsResponseBodyDataResponseData extends $dara.M
   descriptionEn?: string;
   /**
    * @remarks
-   * The extended event information in the JSON format.
+   * The extended information about the event, in the JSON format.
    * 
    * @example
    * {"event_transfer_type":"customize_rule"}
@@ -173,16 +198,27 @@ export class DescribeCloudSiemEventsResponseBodyDataResponseData extends $dara.M
   incidentName?: string;
   /**
    * @remarks
-   * The event name in English.
+   * The English name of the event.
    * 
    * @example
    * Multiple type of alerts, including Miner Network, Command line download and run malicious files, Backdoor Process, etc
    */
   incidentNameEn?: string;
+  /**
+   * @remarks
+   * The event type.
+   * 
+   * - net-attack: expert rule
+   * 
+   * - graph: graph computing
+   * 
+   * @example
+   * graph
+   */
   incidentType?: string;
   /**
    * @remarks
-   * The UUID of the event.
+   * The globally unique UUID of the event.
    * 
    * @example
    * 85ea4241-798f-4684-a876-65d4f0c3****
@@ -190,7 +226,7 @@ export class DescribeCloudSiemEventsResponseBodyDataResponseData extends $dara.M
   incidentUuid?: string;
   /**
    * @remarks
-   * the refer account info.
+   * The linked account.
    * 
    * @example
    * 127608589417****
@@ -198,21 +234,31 @@ export class DescribeCloudSiemEventsResponseBodyDataResponseData extends $dara.M
   referAccount?: string;
   /**
    * @remarks
-   * The remarks of the event.
+   * The remarks on the event.
    * 
    * @example
    * dealed
    */
   remark?: string;
+  /**
+   * @remarks
+   * The rule ID.
+   * 
+   * @example
+   * crecr-21d7pogu9v4a****
+   */
   ruleId?: string;
   /**
    * @remarks
    * The status of the event. Valid values:
    * 
-   * *   0: unhandled.
-   * *   1: handling.
-   * *   5: handling failed.
-   * *   10: handled.
+   * - 0: unhandled
+   * 
+   * - 1: in progress
+   * 
+   * - 5: failed
+   * 
+   * - 10: handled
    * 
    * @example
    * 0
@@ -220,11 +266,13 @@ export class DescribeCloudSiemEventsResponseBodyDataResponseData extends $dara.M
   status?: number;
   /**
    * @remarks
-   * The risk level. Valid values:
+   * The threat level. Valid values:
+   * 
+   * - serious: high
    * 
-   * *   serious: high.
-   * *   suspicious: medium.
-   * *   remind: low.
+   * - suspicious: medium
+   * 
+   * - remind: low
    * 
    * @example
    * remind
@@ -232,7 +280,7 @@ export class DescribeCloudSiemEventsResponseBodyDataResponseData extends $dara.M
   threatLevel?: string;
   /**
    * @remarks
-   * The risk score of the event. Valid values: 0 to 100. A higher value indicates a higher risk level.
+   * The threat score of the event. The score ranges from 0 to 100. A higher score indicates a higher risk level.
    * 
    * @example
    * 90.2
@@ -351,7 +399,7 @@ export class DescribeCloudSiemEventsResponseBodyData extends $dara.Model {
 export class DescribeCloudSiemEventsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The request status code.
    * 
    * @example
    * 200
@@ -359,7 +407,7 @@ export class DescribeCloudSiemEventsResponseBody extends $dara.Model {
   code?: number;
   /**
    * @remarks
-   * The data returned.
+   * The return value of the request.
    * 
    * @example
    * 123456
@@ -367,7 +415,7 @@ export class DescribeCloudSiemEventsResponseBody extends $dara.Model {
   data?: DescribeCloudSiemEventsResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The message returned for the request.
    * 
    * @example
    * success
@@ -385,8 +433,9 @@ export class DescribeCloudSiemEventsResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the request was successful. Valid values:
    * 
-   * *   true
-   * *   false
+   * - true: successful
+   * 
+   * - false: failed
    * 
    * @example
    * true

package/src/models/DescribeCustomizeRuleCountRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCustomizeRuleCountRequest extends $dara.Model {
   /**
    * @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 management center for threat analysis. Select a region based on where your assets are located. Valid values:
    * 
-   * *   cn-hangzhou: Your assets reside in regions inside China.
-   * *   ap-southeast-1: Your assets reside in regions outside China.
+   * - cn-hangzhou: Assets are in the Chinese mainland or China (Hong Kong).
+   * 
+   * - ap-southeast-1: Assets are in regions outside China.
    * 
    * @example
    * cn-hangzhou
@@ -16,7 +17,7 @@ export class DescribeCustomizeRuleCountRequest 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 ID to switch to the member\\"s perspective.
    * 
    * @example
    * 113091674488****
@@ -24,9 +25,11 @@ export class DescribeCustomizeRuleCountRequest 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 in the enterprise.
    * 
    * @example
    * 1

package/src/models/DescribeCustomizeRuleCountResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCustomizeRuleCountResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * 同类聚合规则数。
+   * The number of rules for intra-class aggregation.
    * 
    * @example
    * 3
@@ -13,7 +13,7 @@ export class DescribeCustomizeRuleCountResponseBodyData extends $dara.Model {
   aggregationRuleNum?: number;
   /**
    * @remarks
-   * 自定义规则数。
+   * The number of custom rules.
    * 
    * @example
    * 10
@@ -21,7 +21,7 @@ export class DescribeCustomizeRuleCountResponseBodyData extends $dara.Model {
   customizeRuleNum?: number;
   /**
    * @remarks
-   * 专家规则数。
+   * The number of expert rules.
    * 
    * @example
    * 7
@@ -29,7 +29,7 @@ export class DescribeCustomizeRuleCountResponseBodyData extends $dara.Model {
   expertRuleNum?: number;
   /**
    * @remarks
-   * 图计算规则数。
+   * The number of graph computing rules.
    * 
    * @example
    * 2
@@ -37,7 +37,7 @@ export class DescribeCustomizeRuleCountResponseBodyData extends $dara.Model {
   graphComputingRuleNum?: number;
   /**
    * @remarks
-   * The number of rules that are used to identify high-risk threats.
+   * The number of high-risk rules.
    * 
    * @example
    * 12
@@ -45,7 +45,7 @@ export class DescribeCustomizeRuleCountResponseBodyData extends $dara.Model {
   highRuleNum?: number;
   /**
    * @remarks
-   * The total number of rules.
+   * The number of rules in use.
    * 
    * @example
    * 20
@@ -53,7 +53,7 @@ export class DescribeCustomizeRuleCountResponseBodyData extends $dara.Model {
   inUseRuleNum?: number;
   /**
    * @remarks
-   * The number of rules that are used to identify low-risk threats.
+   * The number of low-risk rules.
    * 
    * @example
    * 3
@@ -61,7 +61,7 @@ export class DescribeCustomizeRuleCountResponseBodyData extends $dara.Model {
   lowRuleNum?: number;
   /**
    * @remarks
-   * The number of rules that are used to identify medium-risk threats.
+   * The number of medium-risk rules.
    * 
    * @example
    * 5
@@ -69,7 +69,7 @@ export class DescribeCustomizeRuleCountResponseBodyData extends $dara.Model {
   mediumRuleNum?: number;
   /**
    * @remarks
-   * 预定义规则数。
+   * The number of predefined rules.
    * 
    * @example
    * 10
@@ -77,7 +77,7 @@ export class DescribeCustomizeRuleCountResponseBodyData extends $dara.Model {
   predefinedRuleNum?: number;
   /**
    * @remarks
-   * 告警透传规则数。
+   * The number of alert pass-through rules.
    * 
    * @example
    * 3
@@ -85,7 +85,7 @@ export class DescribeCustomizeRuleCountResponseBodyData extends $dara.Model {
   singleAlertRuleNum?: number;
   /**
    * @remarks
-   * 总规则数。
+   * The total number of rules.
    * 
    * @example
    * 10
@@ -93,7 +93,7 @@ export class DescribeCustomizeRuleCountResponseBodyData extends $dara.Model {
   totalRuleNum?: number;
   /**
    * @remarks
-   * 不产生事件规则数。
+   * The number of rules that do not generate events.
    * 
    * @example
    * 3
@@ -145,7 +145,7 @@ export class DescribeCustomizeRuleCountResponseBodyData extends $dara.Model {
 export class DescribeCustomizeRuleCountResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code that is returned.
+   * The status code of the request.
    * 
    * @example
    * 200
@@ -161,7 +161,7 @@ export class DescribeCustomizeRuleCountResponseBody extends $dara.Model {
   data?: DescribeCustomizeRuleCountResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The message returned.
    * 
    * @example
    * success
@@ -179,8 +179,9 @@ export class DescribeCustomizeRuleCountResponseBody 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/DescribeCustomizeRuleTestHistogramRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCustomizeRuleTestHistogramRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the rule.
+   * The ID of the custom rule.
    * 
    * @example
    * 123456789
@@ -13,10 +13,11 @@ export class DescribeCustomizeRuleTestHistogramRequest extends $dara.Model {
   id?: 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 Management Hub of threat analysis is located. Select the region of the Management Hub 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 regions outside China.
    * 
    * @example
    * cn-hangzhou
@@ -24,7 +25,7 @@ export class DescribeCustomizeRuleTestHistogramRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the account that you switch from the management account.
+   * The user ID of the member. This parameter is used when an administrator switches to the perspective of a member.
    * 
    * @example
    * 113091674488****
@@ -32,9 +33,11 @@ export class DescribeCustomizeRuleTestHistogramRequest 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 your enterprise.
    * 
    * @example
    * 1

package/src/models/DescribeCustomizeRuleTestHistogramResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCustomizeRuleTestHistogramResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The number of alerts that are generated in the query time range.
+   * The number of alerts generated in the subinterval.
    * 
    * @example
    * 125
@@ -13,7 +13,7 @@ export class DescribeCustomizeRuleTestHistogramResponseBodyData extends $dara.Mo
   count?: number;
   /**
    * @remarks
-   * The start of the time range for querying alerts. The value is a UNIX timestamp. Unit: seconds.
+   * The start of the time range for the alert. This value is a UNIX timestamp. Unit: seconds.
    * 
    * @example
    * 1599897188
@@ -21,7 +21,7 @@ export class DescribeCustomizeRuleTestHistogramResponseBodyData extends $dara.Mo
   from?: number;
   /**
    * @remarks
-   * The end of the time range for querying alerts. The value is a UNIX timestamp. Unit: seconds.
+   * The end of the time range for the alert. This value is a UNIX timestamp. Unit: seconds.
    * 
    * @example
    * 1599997188
@@ -55,7 +55,7 @@ export class DescribeCustomizeRuleTestHistogramResponseBodyData extends $dara.Mo
 export class DescribeCustomizeRuleTestHistogramResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The status code of the request.
    * 
    * @example
    * 200
@@ -63,7 +63,7 @@ export class DescribeCustomizeRuleTestHistogramResponseBody extends $dara.Model
   code?: number;
   /**
    * @remarks
-   * The return value for the request.
+   * The data returned.
    * 
    * @example
    * 123456
@@ -71,7 +71,7 @@ export class DescribeCustomizeRuleTestHistogramResponseBody extends $dara.Model
   data?: DescribeCustomizeRuleTestHistogramResponseBodyData[];
   /**
    * @remarks
-   * The returned message.
+   * The message returned for the request.
    * 
    * @example
    * success
@@ -89,8 +89,9 @@ export class DescribeCustomizeRuleTestHistogramResponseBody 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