@alicloud/cloud-siem20220616 6.0.2 → 6.2.0

package/src/models/ListEntitiesResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListEntitiesResponseBodyDataPageInfo extends $dara.Model {
   /**
+   * @remarks
+   * The page number of the current page.
+   * 
    * @example
    * 1
    */
   currentPage?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 100
    */
@@ -44,12 +53,28 @@ export class ListEntitiesResponseBodyDataPageInfo extends $dara.Model {
 }
 
 export class ListEntitiesResponseBodyDataResponseDataAgentDisposes extends $dara.Model {
+  /**
+   * @remarks
+   * The disposal suggestion recommended by the agent.
+   * 
+   * @example
+   * {}
+   */
   agentDisposalMethod?: string;
+  /**
+   * @remarks
+   * The UUID of the playbook recommended by the agent for disposal.
+   * 
+   * @example
+   * 12XAD-SFQ-WAF-2ca2
+   */
   agentDisposalPlaybookUuid?: string;
+  agentDisposalReason?: string;
   static names(): { [key: string]: string } {
     return {
       agentDisposalMethod: 'AgentDisposalMethod',
       agentDisposalPlaybookUuid: 'AgentDisposalPlaybookUuid',
+      agentDisposalReason: 'AgentDisposalReason',
     };
   }
 
@@ -57,6 +82,7 @@ export class ListEntitiesResponseBodyDataResponseDataAgentDisposes extends $dara
     return {
       agentDisposalMethod: 'string',
       agentDisposalPlaybookUuid: 'string',
+      agentDisposalReason: 'string',
     };
   }
 
@@ -70,99 +96,222 @@ export class ListEntitiesResponseBodyDataResponseDataAgentDisposes extends $dara
 }
 
 export class ListEntitiesResponseBodyDataResponseData extends $dara.Model {
+  agentAnalysisReason?: string;
+  /**
+   * @remarks
+   * The confidence level of the entity as determined by the agent.
+   * 
+   * @example
+   * 85
+   */
   agentConfidence?: string;
+  /**
+   * @remarks
+   * The disposal method recommended by the agent.
+   * 
+   * @example
+   * delete_file
+   */
   agentDisposalMethod?: string;
+  /**
+   * @remarks
+   * The UUID of the playbook recommended by the agent for disposal.
+   * 
+   * @example
+   * 12XAD-SFQ-WAF-2ca2
+   */
   agentDisposalPlaybookUuid?: string;
+  agentDisposalReason?: string;
+  /**
+   * @remarks
+   * The disposal suggestion recommended by the agent.
+   * 
+   * @example
+   * {}
+   */
   agentDisposalSuggestion?: string;
+  /**
+   * @remarks
+   * The list of disposal suggestions recommended by the agent.
+   */
   agentDisposes?: ListEntitiesResponseBodyDataResponseDataAgentDisposes[];
   /**
+   * @remarks
+   * The number of alerts associated with the entity.
+   * 
    * @example
    * 1
    */
   alertNum?: number;
   /**
+   * @remarks
+   * The alert UUID.
+   * 
    * @example
    * sas_71e24437d2797ce8fc59692905a4****
    */
   alertUuid?: string;
   /**
+   * @remarks
+   * The Alibaba Cloud account ID.
+   * 
    * @example
    * 123456789****
    */
   aliuid?: number;
   /**
+   * @remarks
+   * The code of the cloud service provider from which the entity originates. Valid values:
+   * - aliyun: Alibaba Cloud
+   * - qcloud: Tencent Cloud
+   * - hcloud: Huawei Cloud.
+   * 
    * @example
    * aliyun
    */
   cloudCode?: string;
   /**
+   * @remarks
+   * The logical ID of the entity.
+   * 
    * @example
    * 12345****
    */
   entityId?: string;
   /**
+   * @remarks
+   * The display information of the entity in JSON format.
+   * 
    * @example
    * {"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?: string;
   /**
+   * @remarks
+   * The entity name.
+   * 
    * @example
    * 123.123.123.123
    */
   entityName?: string;
   /**
+   * @remarks
+   * The entity type. Valid values:
+   * - ip: IP address
+   * - domain: domain name
+   * - url: URL
+   * - process: process
+   * - file: file
+   * - host: host
+   * - cloud_account: cloud account
+   * - container: container
+   * - bucket: Object Storage Service (OSS) bucket.
+   * 
    * @example
    * ip
    */
   entityType?: string;
   /**
+   * @remarks
+   * The entity UUID.
+   * 
    * @example
    * 8087b3e4aa6862852c100c8738cf****
    */
   entityUuid?: string;
   /**
+   * @remarks
+   * The number of events associated with the entity.
+   * 
    * @example
    * 1
    */
   eventNum?: number;
   /**
+   * @remarks
+   * The time when the entity was collected.
+   * 
    * @example
    * 2021-01-06 16:37:29
    */
   gmtCreate?: string;
   /**
+   * @remarks
+   * The time when the entity was last updated.
+   * 
    * @example
    * 2021-01-06 16:37:29
    */
   gmtModified?: string;
   /**
+   * @remarks
+   * The entity ID.
+   * 
    * @example
    * 123456789***
    */
   id?: number;
   /**
+   * @remarks
+   * The incident UUID. You can obtain this value from the incident list operation.
+   * 
    * @example
    * 85ea4241-798f-4684-a876-65d4f0c3****
    */
   incidentUuid?: string;
+  /**
+   * @remarks
+   * Indicates whether the entity is an asset. Valid values:
+   * + 0: No.
+   * + 1: Yes.
+   * 
+   * @example
+   * 1
+   */
   isAsset?: string;
+  /**
+   * @remarks
+   * Indicates whether the entity is malicious. Valid values:
+   * + 0: No.
+   * + 1: Yes.
+   * 
+   * @example
+   * 0
+   */
   isMalware?: string;
   /**
+   * @remarks
+   * The malware type of the entity.
+   * 
    * @example
    * aliyun.siem.sas.alert_tag.webshell
    */
   malwareType?: string;
   /**
+   * @remarks
+   * The linked account ID associated with the entity.
+   * 
    * @example
    * 113091674488****
    */
   subUserId?: number;
+  /**
+   * @remarks
+   * The entity tags. The value is a JSON array string:
+   * 
+   * `"[{"tagKey1":"tagValue1"},{"tagKey2":"tagValue2"}]"`.
+   * 
+   * @example
+   * [{"tagKey1":"tagValue1"},{"tagKey2":"tagValue2"}]
+   */
   tags?: string;
   static names(): { [key: string]: string } {
     return {
+      agentAnalysisReason: 'AgentAnalysisReason',
       agentConfidence: 'AgentConfidence',
       agentDisposalMethod: 'AgentDisposalMethod',
       agentDisposalPlaybookUuid: 'AgentDisposalPlaybookUuid',
+      agentDisposalReason: 'AgentDisposalReason',
       agentDisposalSuggestion: 'AgentDisposalSuggestion',
       agentDisposes: 'AgentDisposes',
       alertNum: 'AlertNum',
@@ -189,9 +338,11 @@ export class ListEntitiesResponseBodyDataResponseData extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      agentAnalysisReason: 'string',
       agentConfidence: 'string',
       agentDisposalMethod: 'string',
       agentDisposalPlaybookUuid: 'string',
+      agentDisposalReason: 'string',
       agentDisposalSuggestion: 'string',
       agentDisposes: { 'type': 'array', 'itemType': ListEntitiesResponseBodyDataResponseDataAgentDisposes },
       alertNum: 'number',
@@ -229,7 +380,15 @@ export class ListEntitiesResponseBodyDataResponseData extends $dara.Model {
 }
 
 export class ListEntitiesResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The pagination information.
+   */
   pageInfo?: ListEntitiesResponseBodyDataPageInfo;
+  /**
+   * @remarks
+   * The detailed data.
+   */
   responseData?: ListEntitiesResponseBodyDataResponseData[];
   static names(): { [key: string]: string } {
     return {
@@ -262,26 +421,43 @@ export class ListEntitiesResponseBodyData extends $dara.Model {
 
 export class ListEntitiesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The HTTP status code of the request.
+   * 
    * @example
    * 200
    */
   code?: number;
   /**
+   * @remarks
+   * The response data.
+   * 
    * @example
    * 123456
    */
   data?: ListEntitiesResponseBodyData;
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 9AAA9ED9-78F4-5021-86DC-D51C7511****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * - true: successful.
+   * - false: failed.
+   * 
    * @example
    * true
    */

package/src/models/ListImportedLogsByProdRequest.ts

@@ -5,11 +5,13 @@ import * as $dara from '@darabonba/typescript';
 export class ListImportedLogsByProdRequest extends $dara.Model {
   /**
    * @remarks
-   * The code of the cloud service provider. Valid values:
+   * The multicloud code. Valid values:
    * 
-   * *   qcloud: Tencent Cloud.
-   * *   aliyun: Alibaba Cloud.
-   * *   hcloud: Huawei Cloud.
+   * - qcloud: Tencent Cloud.
+   * 
+   * - aliyun: Alibaba Cloud.
+   * 
+   * - hcloud: Huawei Cloud.
    * 
    * This parameter is required.
    * 
@@ -19,7 +21,7 @@ export class ListImportedLogsByProdRequest extends $dara.Model {
   cloudCode?: string;
   /**
    * @remarks
-   * The code of the cloud service.
+   * The code of the product.
    * 
    * This parameter is required.
    * 
@@ -29,10 +31,11 @@ export class ListImportedLogsByProdRequest extends $dara.Model {
   prodCode?: 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 hub of threat analysis is deployed. 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
@@ -40,7 +43,7 @@ export class ListImportedLogsByProdRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the account that you switch from the management account.
+   * The user ID that the administrator uses to switch to the perspective of a member.
    * 
    * @example
    * 113091674488****
@@ -48,9 +51,11 @@ export class ListImportedLogsByProdRequest 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/ListImportedLogsByProdResponseBody.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ListImportedLogsByProdResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the log is automatically added to the threat analysis feature within newly added accounts. Valid values:
+   * Indicates whether logs are automatically ingested for new accounts. Valid values:
    * 
-   * *   1: yes.
-   * *   0: no.
+   * - 1: Logs are automatically ingested.
+   * 
+   * - 0: Logs are not automatically ingested.
    * 
    * @example
    * 2023-11-23 12:30:00
@@ -16,11 +17,13 @@ export class ListImportedLogsByProdResponseBodyData extends $dara.Model {
   autoImported?: number;
   /**
    * @remarks
-   * The code of the cloud service provider. Valid values:
+   * The multicloud code. Valid values:
+   * 
+   * - qcloud: Tencent Cloud.
    * 
-   * *   qcloud: Tencent Cloud.
-   * *   aliyun: Alibaba Cloud.
-   * *   hcloud: Huawei Cloud.
+   * - aliyun: Alibaba Cloud.
+   * 
+   * - hcloud: Huawei Cloud.
    * 
    * @example
    * hcloud
@@ -28,10 +31,11 @@ export class ListImportedLogsByProdResponseBodyData extends $dara.Model {
   cloudCode?: string;
   /**
    * @remarks
-   * Indicates whether the log is added to the threat analysis feature. Valid values:
+   * Indicates whether the log is ingested. Valid values:
+   * 
+   * - 1: The log is ingested.
    * 
-   * *   1: yes.
-   * *   0: no.
+   * - 0: The log is not ingested.
    * 
    * @example
    * 2023-11-23 12:30:00
@@ -39,7 +43,7 @@ export class ListImportedLogsByProdResponseBodyData extends $dara.Model {
   imported?: number;
   /**
    * @remarks
-   * The number of users who have added the log.
+   * The number of users who have ingested the log.
    * 
    * @example
    * 2
@@ -63,18 +67,19 @@ export class ListImportedLogsByProdResponseBodyData extends $dara.Model {
   logMdsCode?: string;
   /**
    * @remarks
-   * The type of log. Valid values:
-   *  - 1: the log produced by other product
-   *  - 2: the predefined log
-   *  - 3: the custom log
+   * The log type. Valid values:
+   * 
+   * - 1: Ingested on the threat analysis side.
+   * 
+   * - 2: Predefined Simple Log Service log. -3: Custom Simple Log Service log.
    * 
    * @example
-   * 1
+   * 2023-11-23 12:30:00
    */
   logType?: number;
   /**
    * @remarks
-   * The time when the log was last added.
+   * The time when the log was last ingested.
    * 
    * @example
    * 2023-11-23 12:30:00
@@ -82,7 +87,7 @@ export class ListImportedLogsByProdResponseBodyData extends $dara.Model {
   modifyTime?: string;
   /**
    * @remarks
-   * The code of the cloud service to which the log belongs.
+   * The code of the product to which the log belongs.
    * 
    * @example
    * qcloud_waf
@@ -90,7 +95,7 @@ export class ListImportedLogsByProdResponseBodyData extends $dara.Model {
   prodCode?: string;
   /**
    * @remarks
-   * The total number of users who have the log.
+   * The total number of users for the log.
    * 
    * @example
    * 5
@@ -98,7 +103,7 @@ export class ListImportedLogsByProdResponseBodyData extends $dara.Model {
   totalUserCount?: number;
   /**
    * @remarks
-   * The number of users who have not added the log.
+   * The number of users who have not ingested the log.
    * 
    * @example
    * 3

package/src/models/ListProjectLogStoresRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ListProjectLogStoresRequest 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. Specify the 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: 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 ListProjectLogStoresRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The log code.
+   * The code of the log to query.
    * 
    * This parameter is required.
    * 
@@ -26,7 +27,7 @@ export class ListProjectLogStoresRequest extends $dara.Model {
   sourceLogCode?: string;
   /**
    * @remarks
-   * The code of the cloud service.
+   * The code of the product to query.
    * 
    * This parameter is required.
    * 
@@ -36,7 +37,7 @@ export class ListProjectLogStoresRequest extends $dara.Model {
   sourceProdCode?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account.
+   * The ID of the Alibaba Cloud account to query.
    * 
    * This parameter is required.
    * 

package/src/models/ListProjectLogStoresResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListProjectLogStoresResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The endpoint of the Simple Log Service project.
+   * The endpoint of the SLS project.
    * 
    * @example
    * cn-hangzhou.log.aliyuncs.com
@@ -13,7 +13,7 @@ export class ListProjectLogStoresResponseBodyData extends $dara.Model {
   endPoint?: string;
   /**
    * @remarks
-   * The name of the region in which the Simple Log Service project resides.
+   * The name of the region where the SLS project resides.
    * 
    * @example
    * hangzhou
@@ -21,7 +21,7 @@ export class ListProjectLogStoresResponseBodyData extends $dara.Model {
   localName?: string;
   /**
    * @remarks
-   * The name of the Simple Log Service Logstore.
+   * The name of the SLS Logstore.
    * 
    * @example
    * cloud-siem-logstore
@@ -29,7 +29,7 @@ export class ListProjectLogStoresResponseBodyData extends $dara.Model {
   logStore?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account that is used to purchase the threat analysis feature.
+   * The ID of the Alibaba Cloud account that is used to purchase Threat Analysis.
    * 
    * @example
    * 123XXXXXXXXX
@@ -37,7 +37,7 @@ export class ListProjectLogStoresResponseBodyData extends $dara.Model {
   mainUserId?: number;
   /**
    * @remarks
-   * The name of the Simple Log Service project.
+   * The name of the SLS project.
    * 
    * @example
    * cloud-siem-project
@@ -45,7 +45,7 @@ export class ListProjectLogStoresResponseBodyData extends $dara.Model {
   project?: string;
   /**
    * @remarks
-   * The ID of the region in which the Simple Log Service project resides.
+   * The region where the SLS project resides.
    * 
    * @example
    * cn-hangzhou
@@ -53,7 +53,7 @@ export class ListProjectLogStoresResponseBodyData extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account that can be used to perform operations supported by the threat analysis feature.
+   * The ID of the member account for which threat analysis is performed.
    * 
    * @example
    * 123XXXXXXXX
@@ -61,7 +61,7 @@ export class ListProjectLogStoresResponseBodyData extends $dara.Model {
   subUserId?: number;
   /**
    * @remarks
-   * The username of the Alibaba Cloud account that can be used to perform operations supported by the threat analysis feature.
+   * The name of the member account.
    * 
    * @example
    * sas_account_xxxx

package/src/models/ListRdUsersRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ListRdUsersRequest 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 of Threat Analysis is located. Select the region of the Management Center 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