@alicloud/sddp20190103 1.6.5 → 2.0.0

package/src/models/DescribeRiskLevelsResponseBody.ts

@@ -5,31 +5,41 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeRiskLevelsResponseBodyRiskLevelList extends $dara.Model {
   /**
    * @remarks
-   * The description of the sensitivity level. You can enter a custom description.
-   * 
-   * The following list describes the sensitivity level names and the corresponding default description:
-   * 
-   * *   **NA**: which indicates that no sensitive data is detected.
-   * *   **S1**: which indicates the sensitive data at sensitivity level 1.
-   * *   **S2**: which indicates the sensitive data at sensitivity level 2.
-   * *   **S3**: which indicates the sensitive data at sensitivity level 3.
-   * *   **S4**: which indicates the sensitive data at sensitivity level 4.
-   * *   **S5**: which indicates the sensitive data at sensitivity level 5.
-   * *   **S6**: which indicates the sensitive data at sensitivity level 6.
-   * *   **S7**: which indicates the sensitive data at sensitivity level 7.
-   * *   **S8**: which indicates the sensitive data at sensitivity level 8.
-   * *   **S9**: which indicates the sensitive data at sensitivity level 9.
-   * *   **S10**: which indicates the sensitive data at sensitivity level 10.
+   * The description of the risk level. You can customize the description.
+   * 
+   * The following list describes the mappings between risk level names and their default descriptions:
+   * 
+   * - **NA**: No sensitive data is detected
+   * 
+   * - **S1**: Level-1 sensitive data
+   * 
+   * - **S2**: Level-2 sensitive data
+   * 
+   * - **S3**: Level-3 sensitive data
+   * 
+   * - **S4**: Level-4 sensitive data
+   * 
+   * - **S5**: Level-5 sensitive data
+   * 
+   * - **S6**: Level-6 sensitive data
+   * 
+   * - **S7**: Level-7 sensitive data
+   * 
+   * - **S8**: Level-8 sensitive data
+   * 
+   * - **S9**: Level-9 sensitive data
+   * 
+   * - **S10**: Level-10 sensitive data
    * 
    * @example
-   * Sensitive data at sensitivity level 1
+   * S3
    */
   description?: string;
   /**
    * @remarks
-   * The unique ID of the sensitivity level. Valid values: 1 to 11. Each sensitivity level ID maps a sensitivity level. For example, the sensitivity level ID of 2 corresponds to the sensitivity level S1.
+   * The unique ID of the risk level. Valid values: 1 to 11. Each risk level ID corresponds to a risk level name. For example, the risk level ID 2 corresponds to the risk level S1.
    * 
-   * For more information, see the description of the Name parameter.
+   * For more information about the mappings, see the description of the Name parameter.
    * 
    * @example
    * 2
@@ -37,19 +47,30 @@ export class DescribeRiskLevelsResponseBodyRiskLevelList extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The name of the sensitivity level. The highest sensitivity level varies based on rule templates. The highest sensitivity level is S10. The highest sensitivity level of the **Built-in data security classification templates for Alibaba and Ant Group** is S4, and that of the **built-in classification templates for financial data** and **built-in classification templates for assets** is S5. For more information about the built-in classification templates for financial data, see Guidelines for Security Classification of Financial Data and Security Data - JRT 0197-2020. For a copied rule template, the highest sensitivity level is S10. The following list describes the sensitivity level names and the corresponding IDs:
-   * 
-   * *   **NA**: 1
-   * *   **S1**: 2
-   * *   **S2**: 3
-   * *   **S3**: 4
-   * *   **S4**: 5
-   * *   **S5**: 6
-   * *   **S6**: 7
-   * *   **S7**: 8
-   * *   **S8**: 9
-   * *   **S9**: 10
-   * *   **S10**: 11
+   * The name of the risk level for the sensitive data. The maximum risk level is S10 and varies based on the data classification template. The maximum risk level is S4 for the **built-in data security classification template for Alibaba and Ant Group**, and S5 for the **built-in data classification template for the finance industry (with reference to JR/T 0197-2020 Financial Data Security - Guidelines for Data Security Classification)** and the **built-in data classification standard for the energy industry**. If you use a copied template, the maximum risk level is S10.
+   * The following list describes the mappings between risk level names and IDs:
+   * 
+   * - **NA**: 1
+   * 
+   * - **S1**: 2
+   * 
+   * - **S2**: 3
+   * 
+   * - **S3**: 4
+   * 
+   * - **S4**: 5
+   * 
+   * - **S5**: 6
+   * 
+   * - **S6**: 7
+   * 
+   * - **S7**: 8
+   * 
+   * - **S8**: 9
+   * 
+   * - **S9**: 10
+   * 
+   * - **S10**: 11
    * 
    * @example
    * S1
@@ -57,7 +78,7 @@ export class DescribeRiskLevelsResponseBodyRiskLevelList extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The number of times that each sensitivity level is referenced in the rule template. Default value: 0.
+   * The number of times the risk level is referenced in the template. The default value is 0.
    * 
    * @example
    * 20
@@ -101,7 +122,7 @@ export class DescribeRiskLevelsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * An array that consists of sensitivity levels.
+   * A list of risk levels.
    */
   riskLevelList?: DescribeRiskLevelsResponseBodyRiskLevelList[];
   static names(): { [key: string]: string } {

package/src/models/DescribeRulesRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeRulesRequest extends $dara.Model {
   /**
    * @remarks
-   * The content type of the sensitive data detection rule. Valid values:
+   * The type of content in the sensitive data detection rule. Valid values:
    * 
-   * *   **0**: keyword
-   * *   **2**: regular expression
+   * - **0**: keyword
+   * 
+   * - **2**: regular expression
    * 
    * @example
    * 2
@@ -16,7 +17,17 @@ export class DescribeRulesRequest extends $dara.Model {
   category?: number;
   /**
    * @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 exploits
+   * 
+   * - **2**: SQL injection bypass attempts
+   * 
+   * - **3**: stored procedure abuse
+   * 
+   * - **4**: buffer overflows
+   * 
+   * - **5**: error-based SQL injections
    * 
    * @example
    * 1
@@ -24,10 +35,11 @@ export class DescribeRulesRequest extends $dara.Model {
   contentCategory?: number;
   /**
    * @remarks
-   * The external cooperation channel. Valid values:
+   * The source of the external cooperation request. Valid values:
+   * 
+   * - DAS
    * 
-   * *   DAS
-   * *   YAOCHI
+   * - YAOCHI
    * 
    * @example
    * DAS
@@ -35,7 +47,7 @@ export class DescribeRulesRequest extends $dara.Model {
   cooperationChannel?: string;
   /**
    * @remarks
-   * The page number of the page to return.
+   * The page number of the paged query.
    * 
    * @example
    * 1
@@ -45,8 +57,9 @@ export class DescribeRulesRequest extends $dara.Model {
    * @remarks
    * The type of the sensitive data detection rule. Valid values:
    * 
-   * *   **0**: built-in rule
-   * *   **1**: custom rule
+   * - **0**: built-in
+   * 
+   * - **1**: custom
    * 
    * @example
    * 1
@@ -62,7 +75,7 @@ export class DescribeRulesRequest extends $dara.Model {
   featureType?: number;
   /**
    * @remarks
-   * The parent group type of the rule.
+   * The parent group of the rule.
    * 
    * @example
    * 4_1
@@ -70,12 +83,13 @@ export class DescribeRulesRequest extends $dara.Model {
   groupId?: string;
   /**
    * @remarks
-   * Specifies whether to allow earlier versions of request parameters to support keywords that are supported in later versions of request parameters. Valid values:
+   * Specifies whether the keyword is compatible with earlier versions. Valid values:
+   * 
+   * - **true**
    * 
-   * *   **true**: yes
-   * *   **false**: no
+   * - **false**
    * 
-   * > To specify keywords as the content type of the sensitive data detection rule, you can set the Category parameter to 0 for earlier versions of request parameters and set the Category parameter to 5 for later versions of request parameters. You can specify the KeywordCompatible parameter based on your business requirements.
+   * > In earlier versions, the Category parameter for keywords had a value of 0. In the current version, it has a value of 5. Enable this parameter based on your business needs.
    * 
    * @example
    * true
@@ -83,10 +97,11 @@ export class DescribeRulesRequest extends $dara.Model {
   keywordCompatible?: boolean;
   /**
    * @remarks
-   * The language of the content within the request and response. Valid values:
+   * The language of the request and response messages. Valid values:
    * 
-   * *   **zh**: Chinese
-   * *   **en**: English
+   * - **zh**: Chinese
+   * 
+   * - **en**: English
    * 
    * @example
    * zh
@@ -96,8 +111,9 @@ export class DescribeRulesRequest 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
@@ -108,7 +124,7 @@ export class DescribeRulesRequest extends $dara.Model {
    * The name of the sensitive data detection rule. Fuzzy match is supported.
    * 
    * @example
-   * \\*\\*\\* rule
+   * ***Rule
    */
   name?: string;
   /**
@@ -121,7 +137,19 @@ export class DescribeRulesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The name of the service to which the data asset 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**
+   * 
+   * - **RDS**
+   * 
+   * - **SELF_DB**
    * 
    * @example
    * MaxCompute
@@ -129,7 +157,19 @@ export class DescribeRulesRequest extends $dara.Model {
   productCode?: number;
   /**
    * @remarks
-   * The ID of the service to which the sensitive data detection rule is applied. 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
    * 1
@@ -137,13 +177,17 @@ export class DescribeRulesRequest 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.
+   * 
+   * - **4**: S3. Level 3 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.
+   * - **5**: S4. Level 4 sensitive data.
    * 
    * @example
    * 2
@@ -153,10 +197,13 @@ export class DescribeRulesRequest extends $dara.Model {
    * @remarks
    * The type of the sensitive data detection rule. Valid values:
    * 
-   * *   **1**: sensitive data detection rule
-   * *   **2**: audit rule
-   * *   **3**: anomalous event detection rule
-   * *   **99**: custom rule
+   * - **1**: data detection rule
+   * 
+   * - **2**: audit policy
+   * 
+   * - **3**: anomaly detection rule
+   * 
+   * - **99**: custom rule
    * 
    * @example
    * 1
@@ -164,10 +211,11 @@ export class DescribeRulesRequest extends $dara.Model {
   ruleType?: number;
   /**
    * @remarks
-   * Specifies whether to query a simplified rule. The simplified rule contains only the rule name. Valid values:
+   * Specifies whether to return a simplified version of the rule that contains only the rule name. Valid values:
    * 
-   * *   true
-   * *   false
+   * - true
+   * 
+   * - false
    * 
    * @example
    * false
@@ -175,10 +223,11 @@ export class DescribeRulesRequest extends $dara.Model {
   simplify?: boolean;
   /**
    * @remarks
-   * The status of the sensitive data detection rule. Valid values:
+   * The status. Valid values:
+   * 
+   * - **1**: Normal
    * 
-   * *   **1**: enabled
-   * *   **0**: disabled
+   * - **0**: Disabled
    * 
    * @example
    * 1
@@ -186,13 +235,15 @@ export class DescribeRulesRequest extends $dara.Model {
   status?: number;
   /**
    * @remarks
-   * The type of the data asset. Valid values:
+   * The type of data asset 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
+   * 
+   * > When you query for rules that support structured or unstructured assets, the response also includes rules that support all asset types.
    * 
    * @example
    * 1
@@ -200,11 +251,13 @@ export class DescribeRulesRequest extends $dara.Model {
   supportForm?: number;
   /**
    * @remarks
-   * The severity level of the alert. Valid values:
+   * The risk level.
+   * 
+   * - **1**: Low
+   * 
+   * - **2**: Medium
    * 
-   * *   **1**: low
-   * *   **2**: medium
-   * *   **3**: high
+   * - **3**: High
    * 
    * @example
    * 2