@alicloud/sddp20190103 1.6.4 → 2.0.0

package/src/models/CreateConfigRequest.ts

@@ -7,9 +7,11 @@ export class CreateConfigRequest extends $dara.Model {
    * @remarks
    * The code of the common configuration item. Valid values:
    * 
-   * *   **access_failed_cnt**: the maximum number of access attempts allowed when Data Security Center (DSC) fails to access an unauthorized resource.
-   * *   **access_permission_exprie_max_days**: the maximum idle period allowed for access permissions before an alert is triggered.
-   * *   **log_datasize_avg_days**: the minimum percentage of the volume of logs of a specific type generated on the current day to the average volume of logs generated in the previous 10 days before an alert is triggered.
+   * - **access_failed_cnt**: the maximum number of access attempts allowed when Data Security Center (DSC) fails to access an unauthorized resource.
+   * 
+   * - **access_permission_exprie_max_days**: the maximum idle period allowed for access permissions before an alert is triggered.
+   * 
+   * - **log_datasize_avg_days**: the minimum percentage of the volume of logs of a specific type generated on the current day to the average volume of logs generated in the previous 10 days before an alert is triggered.
    * 
    * @example
    * access_failed_cnt
@@ -20,7 +22,7 @@ export class CreateConfigRequest extends $dara.Model {
    * The description of the common configuration item.
    * 
    * @example
-   * Maximum number of access attempts allowed when DSC fails to access an unauthorized resource: 10
+   * Unauthorized resource multiple access attempts: current threshold is defined as 10 attempts
    */
   description?: string;
   /**
@@ -35,8 +37,9 @@ export class CreateConfigRequest extends $dara.Model {
    * @remarks
    * The language of the content within the request and response. Default value: **zh_cn**. Valid values:
    * 
-   * *   **zh_cn**: Chinese
-   * *   **en_us**: English
+   * - **zh_cn**: Chinese
+   * 
+   * - **en_us**: English
    * 
    * @example
    * zh_cn
@@ -47,16 +50,18 @@ export class CreateConfigRequest extends $dara.Model {
    * This parameter is deprecated.
    * 
    * @example
-   * 39.170.XX.XX
+   * 106.11.XX.XX
    */
   sourceIp?: string;
   /**
    * @remarks
    * The value of the common configuration item. The meaning of this parameter varies with the value of the Code parameter.
    * 
-   * *   If you set the Code parameter to **access_failed_cnt**, the Value parameter specifies the maximum number of access attempts allowed when DSC fails to access an unauthorized resource.
-   * *   If you set the Code parameter to **access_permission_exprie_max_days**, the Value parameter specifies the maximum idle period allowed for access permissions before an alert is triggered.
-   * *   If you set the Code parameter to **log_datasize_avg_days**, the Value parameter specifies the minimum percentage of the volume of logs of a specific type generated on the current day to the average amount of logs generated in the previous 10 days before an alert is triggered.
+   * - If you set the Code parameter to **access_failed_cnt**, the Value parameter specifies the maximum number of access attempts allowed when DSC fails to access an unauthorized resource.
+   * 
+   * - If you set the Code parameter to **access_permission_exprie_max_days**, the Value parameter specifies the maximum idle period allowed for access permissions before an alert is triggered.
+   * 
+   * - If you set the Code parameter to **log_datasize_avg_days**, the Value parameter specifies the minimum percentage of the volume of logs of a specific type generated on the current day to the average amount of logs generated in the previous 10 days before an alert is triggered.
    * 
    * @example
    * 30

package/src/models/CreateDataLimitRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDataLimitRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to enable the security audit feature. Valid values:
+   * Specifies whether to enable auditing. Valid values:
    * 
-   * *   **0**: no
-   * *   **1**: yes
+   * - **0**: Do not enable auditing.
+   * 
+   * - **1**: Enable auditing.
    * 
    * @example
    * 1
@@ -16,12 +17,13 @@ export class CreateDataLimitRequest extends $dara.Model {
   auditStatus?: number;
   /**
    * @remarks
-   * Specifies whether to automatically trigger a re-scan after a rule is modified. Valid values:
+   * Specifies whether to automatically trigger a rescan when a rule changes. Valid values:
+   * 
+   * - **0**: Do not trigger an automatic scan.
    * 
-   * *   **0**: no
-   * *   **1**: yes
+   * - **1**: Trigger an automatic scan.
    * 
-   * > When a re-scan is triggered, DSC scans all data in your data asset.
+   * > If you enable this feature, a rule change triggers a full scan of all data in the data source.
    * 
    * @example
    * 1
@@ -29,10 +31,11 @@ export class CreateDataLimitRequest extends $dara.Model {
   autoScan?: number;
   /**
    * @remarks
-   * The permissions. Valid values:
+   * The permission level of the credential. Valid values:
    * 
-   * *   **ReadOnly**: read-only permissions
-   * *   **ReadWrite**: read and write permissions
+   * - **ReadOnly**: Read-only permissions.
+   * 
+   * - **ReadWrite**: Read and write permissions.
    * 
    * @example
    * ReadOnly
@@ -42,10 +45,11 @@ export class CreateDataLimitRequest extends $dara.Model {
    * @remarks
    * Specifies whether to enable sensitive data detection. Valid values:
    * 
-   * *   **1**: yes
-   * *   **0**: no
+   * - **1**: Enabled.
+   * 
+   * - **0**: Disabled.
    * 
-   * > If this is your first time to authorize DSC to access the data asset, the default value is 1. If this is not your first time to authorize DSC to access the data asset, the default value is the same as that used in the last authorization operation. Both 1 and 0 are possible.
+   * > The default value is 1 for the first authorization. For later authorizations, the value from the previous authorization is used. Set this parameter to 1 to detect sensitive data.
    * 
    * @example
    * 1
@@ -53,10 +57,11 @@ export class CreateDataLimitRequest extends $dara.Model {
   enable?: number;
   /**
    * @remarks
-   * The database engine that is run by the instance. Valid values:
+   * The database engine type. Valid values:
    * 
-   * *   **MySQL**
-   * *   **SQLServer**
+   * - **MySQL**
+   * 
+   * - **SQLServer**
    * 
    * @example
    * MySQL
@@ -64,10 +69,11 @@ export class CreateDataLimitRequest extends $dara.Model {
   engineType?: string;
   /**
    * @remarks
-   * Specifies whether to enable anomalous event detection. Valid values:
+   * Specifies whether to enable anomalous activity detection. Valid values:
+   * 
+   * - **0**: Disabled.
    * 
-   * *   **0**: no
-   * *   **1**: yes (default)
+   * - **1**: Enabled. This is the default value.
    * 
    * @example
    * 1
@@ -83,10 +89,11 @@ export class CreateDataLimitRequest extends $dara.Model {
   featureType?: number;
   /**
    * @remarks
-   * Specifies whether to immediately scan the authorized asset. Valid values:
+   * Specifies whether to immediately scan the authorized data asset. Valid values:
+   * 
+   * - **false**: Do not scan immediately.
    * 
-   * *   **false**
-   * *   **true**
+   * - **true**: Scan immediately.
    * 
    * @example
    * false
@@ -94,10 +101,11 @@ export class CreateDataLimitRequest extends $dara.Model {
   instantlyScan?: boolean;
   /**
    * @remarks
-   * The language of the content within the request and response. Default value: **zh_cn**. Valid values:
+   * The language of the content that is returned in the response. Default value: **zh_cn**. Valid values:
    * 
-   * *   **zh_cn**: Chinese
-   * *   **en_us**: English
+   * - **zh_cn**: Chinese
+   * 
+   * - **en_us**: English
    * 
    * @example
    * zh_cn
@@ -105,12 +113,15 @@ export class CreateDataLimitRequest extends $dara.Model {
   lang?: string;
   /**
    * @remarks
-   * The retention period of raw logs after you enable the security audit feature. Unit: days. Valid values:
+   * The retention period of raw logs after you enable auditing. Unit: days. Valid values:
+   * 
+   * - **30**
+   * 
+   * - **90**
    * 
-   * *   **30**
-   * *   **90**
-   * *   **180**
-   * *   **365**
+   * - **180**
+   * 
+   * - **365**
    * 
    * @example
    * 30
@@ -118,10 +129,11 @@ export class CreateDataLimitRequest extends $dara.Model {
   logStoreDay?: number;
   /**
    * @remarks
-   * Specifies whether to enable optical character recognition (OCR). Valid values:
+   * Specifies whether to enable Optical Character Recognition (OCR). Valid values:
+   * 
+   * - **1**: Enabled.
    * 
-   * *   **1**: yes
-   * *   **0**: no
+   * - **0**: Disabled.
    * 
    * @example
    * 0
@@ -129,23 +141,23 @@ export class CreateDataLimitRequest extends $dara.Model {
   ocrStatus?: number;
   /**
    * @remarks
-   * The name of the asset. The value is a connection string. It consists of an instance ID and a database name, which are separated by a comma (,). This parameter is required.
+   * The name of the data asset. The name consists of the instance ID and the database name, separated by a period (.).
    * 
    * @example
-   * test-11**
+   * rm-****34.******name
    */
   parentId?: string;
   /**
    * @remarks
-   * The password that is used to access the database.
+   * The password to access the database.
    * 
    * @example
-   * passwd
+   * p****d
    */
   password?: string;
   /**
    * @remarks
-   * The port that is used to connect to the database.
+   * The database connection port.
    * 
    * @example
    * 3306
@@ -153,13 +165,17 @@ export class CreateDataLimitRequest extends $dara.Model {
   port?: number;
   /**
    * @remarks
-   * The type of service to which the data asset belongs. Valid values:
+   * The service to which the data asset belongs. Valid values:
+   * 
+   * - **1**: MaxCompute
    * 
-   * *   **1** :MaxCompute
-   * *   **2**: Object Storage Service (OSS)
-   * *   **3**: AnalyticDB for MySQL
-   * *   **4** :Tablestore
-   * *   **5**: ApsaraDB RDS
+   * - **2**: OSS
+   * 
+   * - **3**: ADS
+   * 
+   * - **4**: OTS
+   * 
+   * - **5**: RDS
    * 
    * This parameter is required.
    * 
@@ -169,11 +185,15 @@ export class CreateDataLimitRequest extends $dara.Model {
   resourceType?: number;
   /**
    * @remarks
-   * The number of sensitive data samples that are collected after sensitive data detection is enabled. Valid values:
+   * The number of sensitive data samples to return after a scan. Valid values:
+   * 
+   * - **0**
+   * 
+   * - **5**
+   * 
+   * - **10**
    * 
-   * *   **0**
-   * *   **5**
-   * *   **10**
+   * > The default value is 10.
    * 
    * @example
    * 0
@@ -181,15 +201,21 @@ export class CreateDataLimitRequest extends $dara.Model {
   samplingSize?: number;
   /**
    * @remarks
-   * The region in which the data asset resides. Valid values:
+   * The region where the data asset is located. Valid values:
+   * 
+   * - **cn-beijing**: China (Beijing)
+   * 
+   * - **cn-zhangjiakou**: China (Zhangjiakou)
+   * 
+   * - **cn-huhehaote**: China (Hohhot)
+   * 
+   * - **cn-hangzhou**: China (Hangzhou)
+   * 
+   * - **cn-shanghai**: China (Shanghai)
+   * 
+   * - **cn-shenzhen**: China (Shenzhen)
    * 
-   * *   **cn-beijing**: China (Beijing).
-   * *   **cn-zhangjiakou**: China (Zhangjiakou)
-   * *   **cn-huhehaote**: China (Hohhot)
-   * *   **cn-hangzhou**: China (Hangzhou)
-   * *   **cn-shanghai**: China (Shanghai)
-   * *   **cn-shenzhen**: China (Shenzhen)
-   * *   **cn-hongkong**: China (Hong Kong)
+   * - **cn-hongkong**: China (Hong Kong)
    * 
    * @example
    * cn-hangzhou
@@ -200,15 +226,15 @@ export class CreateDataLimitRequest extends $dara.Model {
    * This parameter is deprecated.
    * 
    * @example
-   * 39.170.XX.XX
+   * 106.11.XX.XX
    */
   sourceIp?: string;
   /**
    * @remarks
-   * The username that is used to access the database.
+   * The username for the database.
    * 
    * @example
-   * yhm
+   * y*****m
    */
   userName?: string;
   static names(): { [key: string]: string } {

package/src/models/CreateDataLimitResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDataLimitResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the data asset.
+   * The ID of the authorized data asset.
    * 
    * @example
    * 1

package/src/models/CreateRuleRequest.ts

@@ -7,8 +7,9 @@ export class CreateRuleRequest extends $dara.Model {
    * @remarks
    * The content type of the sensitive data detection rule. Valid values:
    * 
-   * *   **0**: keyword
-   * *   **2**: regular expression
+   * - **0**: keyword.
+   * 
+   * - **2**: regular expression.
    * 
    * @example
    * 0
@@ -16,7 +17,7 @@ export class CreateRuleRequest extends $dara.Model {
   category?: number;
   /**
    * @remarks
-   * The content of the sensitive data detection rule. You can specify a regular expression or keywords that are used to match sensitive fields or text.
+   * The content of the sensitive data detection rule. The content can be a regular expression or a keyword that is used to match sensitive data fields or text.
    * 
    * This parameter is required.
    * 
@@ -26,7 +27,17 @@ export class CreateRuleRequest extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The type of the content in the sensitive data detection rule. Valid values include **1**, **2**, **3**, **4**, and **5**. The value 1 indicates attempts to exploit SQL injections. The value 2 indicates bypass by using SQL injections. The value 3 indicates abuse of stored procedures. The value 4 indicates buffer overflow. The value 5 indicates SQL injections based on errors.
+   * The content type. Valid values:
+   * 
+   * - **1**: SQL injection exploit.
+   * 
+   * - **2**: SQL injection bypass.
+   * 
+   * - **3**: stored procedure abuse.
+   * 
+   * - **4**: buffer overflow.
+   * 
+   * - **5**: error-based SQL injection.
    * 
    * @example
    * 1
@@ -42,10 +53,11 @@ export class CreateRuleRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The language of the content within the request and response. Valid values:
+   * The language of the content in the request and response. Valid values:
+   * 
+   * - **zh**: Chinese.
    * 
-   * *   **zh**: Chinese
-   * *   **en**: English
+   * - **en**: English.
    * 
    * @example
    * zh
@@ -55,8 +67,9 @@ export class CreateRuleRequest extends $dara.Model {
    * @remarks
    * The match type. Valid values:
    * 
-   * *   **1**: rule-based match
-   * *   **2**: dictionary-based match
+   * - **1**: rule-based match.
+   * 
+   * - **2**: dictionary-based match.
    * 
    * @example
    * 1
@@ -64,7 +77,7 @@ export class CreateRuleRequest extends $dara.Model {
   matchType?: number;
   /**
    * @remarks
-   * The IDs of the models for sensitive data audit.
+   * The IDs of the model rules for sensitive data auditing.
    * 
    * @example
    * 1452
@@ -82,7 +95,7 @@ export class CreateRuleRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The name of the service to which data in the column of the table belongs. Valid values include **MaxCompute**, **OSS**, **ADS**, **OTS**, and **RDS**.
+   * The name of the service to which the data asset belongs. Valid values: **MaxCompute**, **OSS**, **ADS**, **OTS**, and **RDS**.
    * 
    * @example
    * RDS
@@ -90,7 +103,19 @@ export class CreateRuleRequest extends $dara.Model {
   productCode?: string;
   /**
    * @remarks
-   * The ID of the service to which the data asset belongs. Valid values include **1**, **2**, **3**, **4**, and **5**. The value 1 indicates MaxCompute. The value 2 indicates Object Storage Service (OSS). The value 3 indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS.
+   * The ID of the service to which the data asset belongs. Valid values:
+   * 
+   * - **1**: MaxCompute
+   * 
+   * - **2**: OSS
+   * 
+   * - **3**: ADS
+   * 
+   * - **4**: OTS
+   * 
+   * - **5**: RDS
+   * 
+   * - **6**: SELF_DB
    * 
    * @example
    * 2
@@ -98,13 +123,17 @@ export class CreateRuleRequest extends $dara.Model {
   productId?: number;
   /**
    * @remarks
-   * The sensitivity level of the sensitive data that hits the sensitive data detection rule. Valid values:
+   * The sensitivity level ID of the sensitive data detection rule. Valid values:
+   * 
+   * - **1**: N/A. No sensitive data is detected.
+   * 
+   * - **2**: S1. Level 1 sensitive data.
+   * 
+   * - **3**: S2. Level 2 sensitive data.
    * 
-   * *   **1**: N/A, which indicates that no sensitive data is detected.
-   * *   **2**: S1, which indicates the low sensitivity level.
-   * *   **3**: S2, which indicates the medium sensitivity level.
-   * *   **4**: S3, which indicates the high sensitivity level.
-   * *   **5**: S4, which indicates the highest sensitivity level.
+   * - **4**: S3. Level 3 sensitive data.
+   * 
+   * - **5**: S4. Level 4 sensitive data.
    * 
    * @example
    * 2
@@ -112,12 +141,15 @@ export class CreateRuleRequest extends $dara.Model {
   riskLevelId?: number;
   /**
    * @remarks
-   * The type of the sensitive data detection rule. Valid values:
+   * The type of the rule. Valid values:
+   * 
+   * - **1**: data detection rule.
+   * 
+   * - **2**: audit policy.
    * 
-   * *   **1**: sensitive data detection rule
-   * *   **2**: audit rule
-   * *   **3**: anomalous event detection rule
-   * *   **99**: custom rule
+   * - **3**: anomaly detection rule.
+   * 
+   * - **99**: custom rule.
    * 
    * @example
    * 1
@@ -128,7 +160,7 @@ export class CreateRuleRequest extends $dara.Model {
    * This parameter is deprecated.
    * 
    * @example
-   * 39.170.XX.XX
+   * 106.11.XX.XX
    */
   sourceIp?: string;
   /**
@@ -136,15 +168,16 @@ export class CreateRuleRequest extends $dara.Model {
    * The statistical expression.
    * 
    * @example
-   * 1
+   * {"time":"24","groupby":"1003","having":[{"key":"2001","value":"50"}]}
    */
   statExpress?: string;
   /**
    * @remarks
-   * Specifies whether to enable the sensitive data detection rule. Valid values:
+   * The status of the rule. Valid values:
+   * 
+   * - **1**: Enabled.
    * 
-   * *   **1**: yes
-   * *   **0**: no
+   * - **0**: Disabled.
    * 
    * @example
    * 1
@@ -152,13 +185,13 @@ export class CreateRuleRequest extends $dara.Model {
   status?: number;
   /**
    * @remarks
-   * The type of the data asset. Valid values:
+   * The type of data assets that the rule supports. Valid values:
    * 
-   * *   **0**: all data assets
-   * *   **1**: structured data asset
-   * *   **2**: unstructured data asset
+   * - **0**: all assets.
    * 
-   * > If you set the parameter to 1 or 2, rules that support all data assets and rules that support the queried data asset type are returned.
+   * - **1**: structured assets.
+   * 
+   * - **2**: unstructured assets.
    * 
    * @example
    * 1
@@ -166,7 +199,7 @@ export class CreateRuleRequest extends $dara.Model {
   supportForm?: number;
   /**
    * @remarks
-   * The code of the service to which the sensitive data detection rule is applied. Valid values include **MaxCompute**, **OSS**, **ADS**, **OTS**, and **RDS**.
+   * The code of the service to which the rule applies. Valid values: **MaxCompute**, **OSS**, **ADS**, **OTS**, and **RDS**.
    * 
    * @example
    * MaxCompute
@@ -174,7 +207,7 @@ export class CreateRuleRequest extends $dara.Model {
   target?: string;
   /**
    * @remarks
-   * The IDs of the templates that are used to audit sensitive data.
+   * The IDs of the template rules for sensitive data auditing.
    * 
    * @example
    * 1
@@ -182,11 +215,13 @@ export class CreateRuleRequest extends $dara.Model {
   templateRuleIds?: string;
   /**
    * @remarks
-   * The risk level of the alert that is triggered. Valid values:
+   * The risk level. Valid values:
+   * 
+   * - **1**: Low.
+   * 
+   * - **2**: Medium.
    * 
-   * *   **1**: low
-   * *   **2**: medium
-   * *   **3**: high
+   * - **3**: High.
    * 
    * @example
    * 2