@alicloud/cloud-siem20220616 6.0.2 → 6.2.0

package/src/models/DescribeEventDisposeRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeEventDisposeRequest extends $dara.Model {
   /**
    * @remarks
-   * The page number. Pages start from page 1.
+   * The number of the page to return. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class DescribeEventDisposeRequest extends $dara.Model {
   currentPage?: number;
   /**
    * @remarks
-   * The UUID of the event.
+   * The globally unique UUID of the event.
    * 
    * @example
    * 85ea4241-798f-4684-a876-65d4f0c3****
@@ -21,7 +21,7 @@ export class DescribeEventDisposeRequest extends $dara.Model {
   incidentUuid?: string;
   /**
    * @remarks
-   * The number of entries per page. Maximum value: 500.
+   * The number of entries to return on each page. The maximum value is 500.
    * 
    * @example
    * 10
@@ -29,10 +29,11 @@ export class DescribeEventDisposeRequest extends $dara.Model {
   pageSize?: 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 where the Data Management center of Threat Analysis is located. Select the region based on the region where your assets are deployed. Valid values:
    * 
-   * *   cn-hangzhou: Your assets reside in regions inside China.
-   * *   ap-southeast-1: Your assets reside in regions outside China.
+   * - cn-hangzhou: Your assets are deployed in the Chinese mainland or China (Hong Kong).
+   * 
+   * - ap-southeast-1: Your assets are deployed in regions outside China.
    * 
    * @example
    * cn-hangzhou
@@ -40,7 +41,7 @@ export class DescribeEventDisposeRequest 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 a member.
    * 
    * @example
    * 113091674488****
@@ -48,9 +49,11 @@ export class DescribeEventDisposeRequest 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

package/src/models/DescribeEventDisposeResponseBody.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeEventDisposeResponseBodyDataReceiverInfo extends $dara.Model {
   /**
    * @remarks
-   * The channel of the contact information. Valid values:
+   * The channel to send the notification. Valid values:
    * 
-   * *   message
-   * *   mail
+   * - message: text message
+   * 
+   * - mail: email
    * 
    * @example
    * message
@@ -16,7 +17,7 @@ export class DescribeEventDisposeResponseBodyDataReceiverInfo extends $dara.Mode
   channel?: string;
   /**
    * @remarks
-   * The creation time.
+   * The time when the record was created.
    * 
    * @example
    * 2021-01-06 16:37:29
@@ -24,7 +25,7 @@ export class DescribeEventDisposeResponseBodyDataReceiverInfo extends $dara.Mode
   gmtCreate?: string;
   /**
    * @remarks
-   * The modification time.
+   * The time when the record was last modified.
    * 
    * @example
    * 2021-01-06 16:37:29
@@ -32,7 +33,7 @@ export class DescribeEventDisposeResponseBodyDataReceiverInfo extends $dara.Mode
   gmtModified?: string;
   /**
    * @remarks
-   * The ID of the recipient who receives the event handling result.
+   * The record ID of the recipient for the event handling result.
    * 
    * @example
    * 123
@@ -40,7 +41,7 @@ export class DescribeEventDisposeResponseBodyDataReceiverInfo extends $dara.Mode
   id?: number;
   /**
    * @remarks
-   * The UUID of the event.
+   * The globally unique UUID of the event.
    * 
    * @example
    * 85ea4241-798f-4684-a876-65d4f0c3****
@@ -48,7 +49,7 @@ export class DescribeEventDisposeResponseBodyDataReceiverInfo extends $dara.Mode
   incidentUuid?: string;
   /**
    * @remarks
-   * The message title.
+   * The title of the message.
    * 
    * @example
    * siem event dealed message
@@ -64,10 +65,11 @@ export class DescribeEventDisposeResponseBodyDataReceiverInfo extends $dara.Mode
   receiver?: string;
   /**
    * @remarks
-   * Indicates whether the message is sent. Valid values:
+   * The sending status of the notification. Valid values:
+   * 
+   * - 0: not sent
    * 
-   * *   0: not sent
-   * *   1: sent
+   * - 1: sent
    * 
    * @example
    * 1
@@ -111,7 +113,7 @@ export class DescribeEventDisposeResponseBodyDataReceiverInfo extends $dara.Mode
 export class DescribeEventDisposeResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * An array consisting of JSON objects that are configured for event handling.
+   * The JSON object of the event handling configuration.
    * 
    * @example
    * { playbookName: "使用安全组封禁入方向IP", sophonTaskId: "400442a5-4f98-45ed-97db-5ab117eb0b8f", … }
@@ -119,12 +121,12 @@ export class DescribeEventDisposeResponseBodyData extends $dara.Model {
   eventDispose?: any[];
   /**
    * @remarks
-   * The JSON object that is configured for an alert recipient.
+   * The JSON object of the alert recipient configuration.
    */
   receiverInfo?: DescribeEventDisposeResponseBodyDataReceiverInfo;
   /**
    * @remarks
-   * The description of the event.
+   * The remarks on the event.
    * 
    * @example
    * dealed
@@ -134,10 +136,13 @@ export class DescribeEventDisposeResponseBodyData extends $dara.Model {
    * @remarks
    * The status of the event. Valid values:
    * 
-   * *   0: not handled
-   * *   1: handing
-   * *   5: handling failed
-   * *   10: handled
+   * - 0: unhandled
+   * 
+   * - 1: handling
+   * 
+   * - 5: failed
+   * 
+   * - 10: handled
    * 
    * @example
    * 0
@@ -179,7 +184,7 @@ export class DescribeEventDisposeResponseBodyData extends $dara.Model {
 export class DescribeEventDisposeResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code that is returned.
+   * The status code of the request.
    * 
    * @example
    * 200
@@ -195,7 +200,7 @@ export class DescribeEventDisposeResponseBody extends $dara.Model {
   data?: DescribeEventDisposeResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The message returned for the request.
    * 
    * @example
    * success
@@ -213,8 +218,9 @@ export class DescribeEventDisposeResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the request was successful. Valid values:
    * 
-   * *   true
-   * *   false
+   * - true
+   * 
+   * - false
    * 
    * @example
    * true

package/src/models/DescribeImportedLogCountRequest.ts

@@ -5,16 +5,35 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeImportedLogCountRequest 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 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 a region outside China.
    * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The user ID of the member. An administrator can specify this parameter to switch to the perspective of the member.
+   * 
+   * @example
+   * 113091674488****
+   */
   roleFor?: string;
+  /**
+   * @remarks
+   * 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?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeImportedLogCountResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeImportedLogCountResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The number of logs that are added.
+   * The number of ingested logs.
    * 
    * @example
    * 10
@@ -21,7 +21,7 @@ export class DescribeImportedLogCountResponseBodyData extends $dara.Model {
   totalLogCount?: number;
   /**
    * @remarks
-   * The number of logs that are not added.
+   * The number of logs that are not ingested.
    * 
    * @example
    * 49
@@ -55,12 +55,12 @@ export class DescribeImportedLogCountResponseBodyData extends $dara.Model {
 export class DescribeImportedLogCountResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The data returned.
+   * The returned data.
    */
   data?: DescribeImportedLogCountResponseBodyData;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 6276D891-*****-55B2-87B9-74D413F7****

package/src/models/DescribeLogFieldsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeLogFieldsRequest extends $dara.Model {
   /**
    * @remarks
-   * The log source of the rule.
+   * The log source for the rule.
    * 
    * @example
    * cloud_siem_aegis_sas_alert
@@ -13,7 +13,7 @@ export class DescribeLogFieldsRequest extends $dara.Model {
   logSource?: string;
   /**
    * @remarks
-   * The log type of the rule.
+   * The log source for the rule.
    * 
    * @example
    * cloud_siem_aegis_sas_alert
@@ -21,10 +21,11 @@ export class DescribeLogFieldsRequest extends $dara.Model {
   logType?: 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 threat analysis Management Hub 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 a region outside China.
    * 
    * @example
    * cn-hangzhou
@@ -32,7 +33,7 @@ export class DescribeLogFieldsRequest 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 switches to.
    * 
    * @example
    * 113091674488****
@@ -40,9 +41,11 @@ export class DescribeLogFieldsRequest 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/DescribeLogFieldsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeLogFieldsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The type of the log to which the field belongs.
+   * The log type to which the field belongs.
    * 
    * @example
    * HTTP_ACTIVITY
@@ -13,7 +13,7 @@ export class DescribeLogFieldsResponseBodyData extends $dara.Model {
   activityName?: string;
   /**
    * @remarks
-   * The internal code of the field description.
+   * The Medusa code for the field description.
    * 
    * @example
    * sas.cloudsiem.prod.activity_name
@@ -21,7 +21,7 @@ export class DescribeLogFieldsResponseBodyData extends $dara.Model {
   fieldDesc?: string;
   /**
    * @remarks
-   * The name of the field.
+   * The name of the rule field.
    * 
    * @example
    * activity_name
@@ -31,8 +31,9 @@ export class DescribeLogFieldsResponseBodyData extends $dara.Model {
    * @remarks
    * The data type of the field. Valid values:
    * 
-   * *   varchar
-   * *   bigint
+   * - varchar: string
+   * 
+   * - bigint: number
    * 
    * @example
    * varchar
@@ -78,7 +79,7 @@ export class DescribeLogFieldsResponseBodyData extends $dara.Model {
 export class DescribeLogFieldsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The request status code.
    * 
    * @example
    * 200
@@ -94,7 +95,7 @@ export class DescribeLogFieldsResponseBody extends $dara.Model {
   data?: DescribeLogFieldsResponseBodyData[];
   /**
    * @remarks
-   * The returned message.
+   * The message returned.
    * 
    * @example
    * success
@@ -112,8 +113,9 @@ export class DescribeLogFieldsResponseBody 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/DescribeLogSourceRequest.ts

@@ -13,10 +13,11 @@ export class DescribeLogSourceRequest extends $dara.Model {
   logType?: 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. You must select 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 DescribeLogSourceRequest 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 a member.
    * 
    * @example
    * 113091674488****
@@ -32,9 +33,11 @@ export class DescribeLogSourceRequest 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 within the enterprise.
    * 
    * @example
    * 1

package/src/models/DescribeLogSourceResponseBody.ts

@@ -13,7 +13,7 @@ export class DescribeLogSourceResponseBodyData extends $dara.Model {
   logSource?: string;
   /**
    * @remarks
-   * The internal code of the log source.
+   * The Medusa code of the log source for the rule.
    * 
    * @example
    * sas.cloudsiem.prod.cloud_siem_aegis_sas_alert
@@ -45,7 +45,7 @@ export class DescribeLogSourceResponseBodyData extends $dara.Model {
 export class DescribeLogSourceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The request status code.
    * 
    * @example
    * 200
@@ -61,7 +61,7 @@ export class DescribeLogSourceResponseBody extends $dara.Model {
   data?: DescribeLogSourceResponseBodyData[];
   /**
    * @remarks
-   * The returned message.
+   * The message returned.
    * 
    * @example
    * success
@@ -79,8 +79,9 @@ export class DescribeLogSourceResponseBody 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/DescribeLogTypeRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeLogTypeRequest 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 Data Management 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: for assets in the Chinese mainland and China (Hong Kong)
+   * 
+   * - ap-southeast-1: for assets in regions outside China
    * 
    * @example
    * cn-hangzhou
@@ -16,7 +17,7 @@ export class DescribeLogTypeRequest 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 a specific member.
    * 
    * @example
    * 113091674488****
@@ -25,8 +26,10 @@ export class DescribeLogTypeRequest extends $dara.Model {
   /**
    * @remarks
    * The type of the view. Valid values:
-   * - 0: the current Alibaba Cloud account
-   * - 1: the global account
+   * 
+   * - 0: The view of the current Alibaba Cloud account.
+   * 
+   * - 1: The view of all accounts in an enterprise.
    * 
    * @example
    * 1

package/src/models/DescribeLogTypeResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeLogTypeResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The log type of the rule.
+   * The log type for the rule.
    * 
    * @example
    * HTTP_ACTIVITY
@@ -13,7 +13,7 @@ export class DescribeLogTypeResponseBodyData extends $dara.Model {
   logType?: string;
   /**
    * @remarks
-   * The internal code of the log type.
+   * The code for the log type name.
    * 
    * @example
    * sas.cloudsiem.prod.http_activity
@@ -45,7 +45,7 @@ export class DescribeLogTypeResponseBodyData extends $dara.Model {
 export class DescribeLogTypeResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The status code of the request.
    * 
    * @example
    * 200
@@ -61,7 +61,7 @@ export class DescribeLogTypeResponseBody extends $dara.Model {
   data?: DescribeLogTypeResponseBodyData[];
   /**
    * @remarks
-   * The returned message.
+   * The message returned.
    * 
    * @example
    * success
@@ -79,8 +79,9 @@ export class DescribeLogTypeResponseBody 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/DescribeOperatorsRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeOperatorsRequest 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 Data Management center for threat analysis. Select a region based on your asset location. 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
@@ -16,7 +17,7 @@ export class DescribeOperatorsRequest 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 this member.
    * 
    * @example
    * 113091674488****
@@ -24,9 +25,11 @@ export class DescribeOperatorsRequest 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 your enterprise.
    * 
    * @example
    * 1
@@ -34,10 +37,11 @@ export class DescribeOperatorsRequest extends $dara.Model {
   roleType?: number;
   /**
    * @remarks
-   * The type of the scenario in which the operator is used. Valid values:
+   * The scenario for the operator. Valid values:
+   * 
+   * - If you leave this parameter empty, the default scenario is used.
    * 
-   * *   If you do not specify this parameter, the default scenario is used.
-   * *   AGGREGATE: AGGREGATE scenario.
+   * - AGGREGATE: The aggregate function scenario.
    * 
    * @example
    * AGGREGATE