@alicloud/sddp20190103 1.6.5 → 2.0.0

package/src/models/DescribeCategoryTemplateRuleListResponseBody.ts

@@ -8,12 +8,12 @@ export class DescribeCategoryTemplateRuleListResponseBodyItems extends $dara.Mod
    * The description of the rule.
    * 
    * @example
-   * Rule for identifying ID card numbers
+   * Template rule for identifying ID card numbers
    */
   description?: string;
   /**
    * @remarks
-   * The unique ID of the rule.
+   * The unique ID of the template rule.
    * 
    * @example
    * 100
@@ -21,7 +21,7 @@ export class DescribeCategoryTemplateRuleListResponseBodyItems extends $dara.Mod
   id?: number;
   /**
    * @remarks
-   * The IDs of sensitive data types. Multiple IDs are separated by commas (,).
+   * A comma-separated list of IDs of the associated atomic models.
    * 
    * @example
    * 1001,1002
@@ -29,15 +29,17 @@ export class DescribeCategoryTemplateRuleListResponseBodyItems extends $dara.Mod
   identificationRuleIds?: string;
   /**
    * @remarks
-   * The scan scope of the rule. The value is a JSON array of the STRING type. Each element in a JSON array indicates a scan scope that contains the following fields:
+   * The scope of data that the template rule scans. This parameter is a string converted from a JSON array. Each element in the JSON array represents a data scanning scope and contains the following fields:
    * 
-   * *   **Asset**: the data asset type. Valid values: RDS, DRDS, PolarDB, OTS, ADB, and OceanBase. The value is of the STRING type.
+   * - **Asset**: A string that indicates the asset type. Valid values include RDS, DRDS, PolarDB, OTS, ADB, OceanBase, and ODPS.
    * 
-   * *   **Content**: the scan scope. The value is of the STRING type. Each element in a JSON array indicates a scan scope that contains the following fields:
+   * - **Content**: The specific scope of the asset to scan. This is an array of objects, where each object contains the following fields:
    * 
-   *     *   **Range**: the matching condition. Valid values: Instance, database, table, column, project, bucket, and object. The value project is valid only for data assets in MaxCompute. The values bucket and object are valid only for data assets in Object Storage Service (OSS). The value of this parameter is of the STRING type.
-   *     *   **Operator**: the operator. Valid values: equals, regex, prefix, and suffix. The operator equals indicates a full match. The operator regex indicates a match by regular expression. The operator prefix indicates a match by prefix. The operator suffix indicates a match by suffix.
-   *     *   **Value**: the matching content. The value is of the STRING type.
+   *   - **Range**: A string that indicates the matching range. Valid values include instance, database, table, column, project (for MaxCompute assets only), bucket (for OSS assets only), and object (for OSS assets only).
+   * 
+   *   - **Operator**: A string that indicates the matching condition. Valid values include equals, regex (regular expression), prefix, and suffix.
+   * 
+   *   - **Value**: A string that indicates the content to match.
    * 
    * @example
    * [{"Asset":"RDS","Content":[{"Range":"database","Operator":"regex","Value":"register"}]},{"Asset":"RDS","Content":[{"Range":"table","Operator":"regex","Value":"register"}]},{"Asset":"RDS","Content":[{"Range":"column","Operator":"regex","Value":"register"}]},{"Asset":"ODPS","Content":[{"Range":"project","Operator":"regex","Value":"register"}]},{"Asset":"ODPS","Content":[{"Range":"table","Operator":"regex","Value":"register"}]},{"Asset":"ODPS","Content":[{"Range":"column","Operator":"regex","Value":"register"}]}]
@@ -45,28 +47,39 @@ export class DescribeCategoryTemplateRuleListResponseBodyItems extends $dara.Mod
   identificationScope?: string;
   /**
    * @remarks
-   * The name of the rule.
+   * The name of the template rule.
    * 
    * @example
-   * ID card number
+   * ID card
    */
   name?: string;
   /**
    * @remarks
-   * The sensitivity level of the data that is not compliant with the rule. Valid values: **1** to **11**.
-   * 
-   * *   **1**: No sensitive data is detected.
-   * *   **2**: indicates the S1 sensitivity level.
-   * *   **3**: indicates the S2 sensitivity level.
-   * *   **4**: indicates the S3 sensitivity level.
-   * *   **5**: indicates the S4 sensitivity level.
-   * *   **6**: indicates the S5 sensitivity level.
-   * *   **7**: indicates the S6 sensitivity level.
-   * *   **8**: indicates the S7 sensitivity level.
-   * *   **9**: indicates the S8 sensitivity level.
-   * *   **10**: indicates the S9 sensitivity level.
-   * *   **11**: indicates the S10 sensitivity level.
-   * *   **null**: indicates all preceding sensitivity levels.
+   * The risk level of the template rule. The value ranges from **1** to **11**. Valid values:
+   * 
+   * - **1**: No risk.
+   * 
+   * - **2**: S1.
+   * 
+   * - **3**: S2.
+   * 
+   * - **4**: S3.
+   * 
+   * - **5**: S4.
+   * 
+   * - **6**: S5.
+   * 
+   * - **7**: S6.
+   * 
+   * - **8**: S7.
+   * 
+   * - **9**: S8.
+   * 
+   * - **10**: S9.
+   * 
+   * - **11**: S10.
+   * 
+   * - **null**: Indicates all risk levels, including No risk, S1, S2, S3, S4, S5, S6, S7, S8, S9, and S10.
    * 
    * @example
    * 2
@@ -74,11 +87,13 @@ export class DescribeCategoryTemplateRuleListResponseBodyItems extends $dara.Mod
   riskLevelId?: number;
   /**
    * @remarks
-   * The status of the rule. Valid values:
+   * The status of the template rule. Valid values:
+   * 
+   * - **0**: disabled.
+   * 
+   * - **1**: enabled.
    * 
-   * *   **0**: disabled
-   * *   **1**: enabled
-   * *   **null**: all states
+   * - **null**: Represents all statuses, including enabled and disabled.
    * 
    * @example
    * 1
@@ -120,7 +135,7 @@ export class DescribeCategoryTemplateRuleListResponseBodyItems extends $dara.Mod
 export class DescribeCategoryTemplateRuleListResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The page number of the returned page.
+   * The page number.
    * 
    * @example
    * 1
@@ -128,12 +143,12 @@ export class DescribeCategoryTemplateRuleListResponseBody extends $dara.Model {
   currentPage?: number;
   /**
    * @remarks
-   * The list of rules.
+   * A list of template rules.
    */
   items?: DescribeCategoryTemplateRuleListResponseBodyItems[];
   /**
    * @remarks
-   * The number of entries returned per page.
+   * The number of template rules returned on each page.
    * 
    * @example
    * 10

package/src/models/DescribeColumnsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeColumnsRequest extends $dara.Model {
   /**
    * @remarks
-   * The page number of the page to return.
+   * The page number for paged query.
    * 
    * @example
    * 1
@@ -13,13 +13,17 @@ export class DescribeColumnsRequest extends $dara.Model {
   currentPage?: number;
   /**
    * @remarks
-   * The engine type. Valid values:
+   * Engine type. Valid values:
    * 
-   * *   **MySQL**
-   * *   **MariaDB**
-   * *   **Oracle**
-   * *   **PostgreSQL**
-   * *   **SQLServer**
+   * - **MySQL**.
+   * 
+   * - **MariaDB**.
+   * 
+   * - **Oracle**.
+   * 
+   * - **PostgreSQL**.
+   * 
+   * - **SQLServer**.
    * 
    * @example
    * MySQL
@@ -27,9 +31,9 @@ export class DescribeColumnsRequest extends $dara.Model {
   engineType?: string;
   /**
    * @remarks
-   * The ID of the instance to which data in the column of the table belongs.
+   * The ID of the asset instance to which the column data in the data asset table belongs.
    * 
-   * > You can call the [DescribeInstances](~~DescribeRules~~) operation to query the IDs of instances.
+   * > Query column data in data asset tables authorized to connect to Data Security Center using the ID of the asset instance to which the column data in the data asset table belongs. Obtain the asset instance ID by calling the [DescribeInstances](~~DescribeRules~~) API.
    * 
    * @example
    * 1
@@ -37,7 +41,7 @@ export class DescribeColumnsRequest extends $dara.Model {
   instanceId?: number;
   /**
    * @remarks
-   * The name of the instance to which data in the column of the table belongs.
+   * The name of the asset instance to which the column data in the data asset table belongs.
    * 
    * @example
    * rm-bp17t1htja573l5i8****
@@ -45,10 +49,11 @@ export class DescribeColumnsRequest extends $dara.Model {
   instanceName?: string;
   /**
    * @remarks
-   * The language of the content within the request and response. Default value: **zh_cn**. Valid values:
+   * The language type for requests and responses. The default value is **zh_cn**. Valid values:
    * 
-   * *   **zh_cn**: Chinese
-   * *   **en_us**: English
+   * - **zh_cn**: Chinese.
+   * 
+   * - **en_us**: English.
    * 
    * @example
    * zh_cn
@@ -56,10 +61,11 @@ export class DescribeColumnsRequest extends $dara.Model {
   lang?: string;
   /**
    * @remarks
-   * The data tag.
+   * Data tag.
+   * 
+   * - 101: Personal sensitive information
    * 
-   * *   101: personal sensitive information
-   * *   102: personal information
+   * - 102: Personal information
    * 
    * @example
    * 101
@@ -67,9 +73,9 @@ export class DescribeColumnsRequest extends $dara.Model {
   modelTagId?: string;
   /**
    * @remarks
-   * The search keyword. Fuzzy match is supported.
+   * The keyword for search. Supports fuzzy match.
    * 
-   * For example, if you enter **test**, all columns whose names contain **test** are retrieved.
+   * For example, entering **test** returns all data containing **test**.
    * 
    * @example
    * test
@@ -77,7 +83,7 @@ export class DescribeColumnsRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The number of entries to return on each page.
+   * The maximum number of data entries displayed per page in the list.
    * 
    * @example
    * 10
@@ -85,7 +91,7 @@ export class DescribeColumnsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @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 product name to which the column data in the data asset table belongs. Valid values: **MaxCompute, OSS, ADS, OTS, RDS**, and others.
    * 
    * @example
    * MaxCompute
@@ -93,20 +99,31 @@ export class DescribeColumnsRequest extends $dara.Model {
   productCode?: string;
   /**
    * @remarks
-   * The ID of the service to which the data object belongs. Valid values:
-   * 
-   * *   **1**: MaxCompute
-   * *   **2**: Object Storage Service (OSS)
-   * *   **3**: AnalyticDB for MySQL
-   * *   **4**: Tablestore (OTS)
-   * *   **5**: ApsaraDB RDS
-   * *   **6**: self-managed database
-   * *   **7**: PolarDB for Xscale (PolarDB-X)
-   * *   **8**: PolarDB
-   * *   **9**: AnalyticDB for PostgreSQL
-   * *   **10**: ApsaraDB for OceanBase
-   * *   **11**: ApsaraDB for MongoDB
-   * *   **25**: ApsaraDB for Redis
+   * The ID corresponding to the product name to which the data object belongs. Valid values:
+   * 
+   * - **1**: MaxCompute
+   * 
+   * - **2**: OSS
+   * 
+   * - **3**: ADB-MYSQL
+   * 
+   * - **4**: TableStore
+   * 
+   * - **5**: RDS
+   * 
+   * - **6**: SELF_DB
+   * 
+   * - **7**: PolarDB-X
+   * 
+   * - **8**: PolarDB
+   * 
+   * - **9**: ADB-PG
+   * 
+   * - **10**: OceanBase
+   * 
+   * - **11**: MongoDB
+   * 
+   * - **25**: Redis
    * 
    * @example
    * 5
@@ -114,13 +131,17 @@ export class DescribeColumnsRequest extends $dara.Model {
   productId?: string;
   /**
    * @remarks
-   * The sensitivity level of the sensitive data that hits the sensitive data detection rule. Valid values:
+   * The risk level ID of the sensitive data detection rule. Valid values:
+   * 
+   * - **1**: N/A.
+   * 
+   * - **2**: S1.
    * 
-   * *   **1**: N/A
-   * *   **2**: S1
-   * *   **3**: S2
-   * *   **4**: S3
-   * *   **5**: S4
+   * - **3**: S2.
+   * 
+   * - **4**: S3.
+   * 
+   * - **5**: S4.
    * 
    * @example
    * 2
@@ -128,9 +149,9 @@ export class DescribeColumnsRequest extends $dara.Model {
   riskLevelId?: number;
   /**
    * @remarks
-   * The ID of the sensitive data detection rule that data in the column of the table hits.
+   * The unique ID of the sensitive data detection rule hit by the column data in the asset table.
    * 
-   * > You can call the [DescribeRules](~~DescribeRules~~) operation to query the IDs of sensitive data detection rules.
+   * > Query column data in data asset tables authorized to connect to Data Security Center using the ID of the sensitive data detection rule hit by the column data in the asset table. Obtain the sensitive data detection rule ID by calling the [DescribeRules](~~DescribeRules~~) API.
    * 
    * @example
    * 11111
@@ -138,21 +159,25 @@ export class DescribeColumnsRequest extends $dara.Model {
   ruleId?: number;
   /**
    * @remarks
-   * The name of the sensitive data detection rule that data in the column of the table hits.
+   * The name of the sensitive data detection rule hit by the column data in the data asset table.
    * 
    * @example
-   * ID card number (the Chinese mainland)
+   * name
    */
   ruleName?: string;
   /**
    * @remarks
-   * The name of the sensitivity level of the data that hits the sensitive data detection rule. Valid values:
+   * Sensitivity level name. Valid values:
+   * 
+   * - **N/A**: No sensitive data detected.
+   * 
+   * - **S1**: Level 1 sensitive data.
+   * 
+   * - **S2**: Level 2 sensitive data.
+   * 
+   * - **S3**: Level 3 sensitive data.
    * 
-   * *   **N/A**: No sensitive data is detected.
-   * *   **S1**: indicates the low sensitivity level.
-   * *   **S2**: indicates the medium sensitivity level.
-   * *   **S3**: indicates the high sensitivity level.
-   * *   **S4**: indicates the highest sensitivity level.
+   * - **S4**: Level 4 sensitive data.
    * 
    * @example
    * S2
@@ -165,9 +190,9 @@ export class DescribeColumnsRequest extends $dara.Model {
   serviceRegionId?: string;
   /**
    * @remarks
-   * The ID of the table to which the column belongs.
+   * The unique ID of the asset table that contains the columns in data asset tables such as MaxCompute and RDS.
    * 
-   * > You can call the [DescribeTables](~~DescribeTables~~) operation to query the IDs of tables.
+   * > Query column data in data asset tables authorized to connect to Data Security Center using the asset table ID. Obtain the asset table ID by calling the [DescribeTables](~~DescribeTables~~) API.
    * 
    * @example
    * 11132334
@@ -175,7 +200,7 @@ export class DescribeColumnsRequest extends $dara.Model {
   tableId?: number;
   /**
    * @remarks
-   * The name of the table.
+   * The name of the data asset table.
    * 
    * @example
    * it_table
@@ -183,9 +208,9 @@ export class DescribeColumnsRequest extends $dara.Model {
   tableName?: string;
   /**
    * @remarks
-   * The ID of the industry-specific classification template.
+   * Industry template ID.
    * 
-   * >  You can call the [DescribeCategoryTemplateList](https://help.aliyun.com/document_detail/2399296.html) operation to obtain the IDs of industry-specific classification templates.
+   * > Obtain the industry template ID by calling [DescribeCategoryTemplateList](https://help.aliyun.com/document_detail/2399296.html).
    * 
    * @example
    * 5
@@ -193,9 +218,9 @@ export class DescribeColumnsRequest extends $dara.Model {
   templateId?: string;
   /**
    * @remarks
-   * The ID of the template rule that is hit.
+   * The ID of the hit template rule.
    * 
-   * >  You can call the [DescribeCategoryTemplateRuleList](https://help.aliyun.com/document_detail/410143.html) operation to obtain the IDs of hit template rules.
+   * > Obtain the hit template rule ID by calling [DescribeCategoryTemplateRuleList](https://help.aliyun.com/document_detail/410143.html).
    * 
    * @example
    * 1542