@alicloud/sddp20190103 1.4.2 → 1.5.0

package/src/models/DescribeCategoryTemplateRuleListRequest.ts

@@ -0,0 +1,104 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeCategoryTemplateRuleListRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The number of the page to return. Default value: **1**.
+   * 
+   * @example
+   * 1
+   */
+  currentPage?: number;
+  /**
+   * @remarks
+   * This parameter is deprecated.
+   * 
+   * @example
+   * 1
+   */
+  featureType?: number;
+  /**
+   * @remarks
+   * The language of the content within the request and response. Default value: **zh_cn**. Valid values:
+   * 
+   * *   **zh_cn**: Simplified Chinese
+   * *   **en_us**: English
+   * 
+   * @example
+   * zh_cn
+   */
+  lang?: string;
+  /**
+   * @remarks
+   * The number of entries to return on each page. Default value: **10**.
+   * 
+   * @example
+   * 10
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The sensitivity level of the data that is not compliant with the rule. Valid values: **1** to **11**. Default value: **null**.
+   * 
+   * *   **1**: No sensitive data is detected.
+   * *   **2**: specifies the S1 sensitivity level.
+   * *   **3**: specifies the S2 sensitivity level.
+   * *   **4**: specifies the S3 sensitivity level.
+   * *   **5**: specifies the S4 sensitivity level.
+   * *   **6**: specifies the S5 sensitivity level.
+   * *   **7**: specifies the S6 sensitivity level.
+   * *   **8**: specifies the S7 sensitivity level.
+   * *   **9**: specifies the S8 sensitivity level.
+   * *   **10**: specifies the S9 sensitivity level.
+   * *   **11**: specifies the S10 sensitivity level.
+   * *   **null**: specifies all preceding sensitivity levels.
+   * 
+   * @example
+   * 2
+   */
+  riskLevelId?: number;
+  /**
+   * @remarks
+   * The status of the rule. Default value: **null**. Valid values:
+   * 
+   * *   **0**: disabled
+   * *   **1**: enabled
+   * *   **null**: all states
+   * 
+   * @example
+   * 1
+   */
+  status?: number;
+  static names(): { [key: string]: string } {
+    return {
+      currentPage: 'CurrentPage',
+      featureType: 'FeatureType',
+      lang: 'Lang',
+      pageSize: 'PageSize',
+      riskLevelId: 'RiskLevelId',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      currentPage: 'number',
+      featureType: 'number',
+      lang: 'string',
+      pageSize: 'number',
+      riskLevelId: 'number',
+      status: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeCategoryTemplateRuleListResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeCategoryTemplateRuleListResponseBody } from "./DescribeCategoryTemplateRuleListResponseBody";
+
+
+export class DescribeCategoryTemplateRuleListResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeCategoryTemplateRuleListResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DescribeCategoryTemplateRuleListResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeCategoryTemplateRuleListResponseBody.ts

@@ -0,0 +1,189 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeCategoryTemplateRuleListResponseBodyItems extends $dara.Model {
+  /**
+   * @remarks
+   * The description of the rule.
+   * 
+   * @example
+   * Rule for identifying ID card numbers
+   */
+  description?: string;
+  /**
+   * @remarks
+   * The unique ID of the rule.
+   * 
+   * @example
+   * 100
+   */
+  id?: number;
+  /**
+   * @remarks
+   * The IDs of sensitive data types. Multiple IDs are separated by commas (,).
+   * 
+   * @example
+   * 1001,1002
+   */
+  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:
+   * 
+   * *   **Asset**: the data asset type. Valid values: RDS, DRDS, PolarDB, OTS, ADB, and OceanBase. The value is of the STRING type.
+   * 
+   * *   **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:
+   * 
+   *     *   **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.
+   * 
+   * @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"}]}]
+   */
+  identificationScope?: string;
+  /**
+   * @remarks
+   * The name of the rule.
+   * 
+   * @example
+   * ID card number
+   */
+  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.
+   * 
+   * @example
+   * 2
+   */
+  riskLevelId?: number;
+  /**
+   * @remarks
+   * The status of the rule. Valid values:
+   * 
+   * *   **0**: disabled
+   * *   **1**: enabled
+   * *   **null**: all states
+   * 
+   * @example
+   * 1
+   */
+  status?: number;
+  static names(): { [key: string]: string } {
+    return {
+      description: 'Description',
+      id: 'Id',
+      identificationRuleIds: 'IdentificationRuleIds',
+      identificationScope: 'IdentificationScope',
+      name: 'Name',
+      riskLevelId: 'RiskLevelId',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      description: 'string',
+      id: 'number',
+      identificationRuleIds: 'string',
+      identificationScope: 'string',
+      name: 'string',
+      riskLevelId: 'number',
+      status: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeCategoryTemplateRuleListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The page number of the returned page.
+   * 
+   * @example
+   * 1
+   */
+  currentPage?: number;
+  /**
+   * @remarks
+   * The list of rules.
+   */
+  items?: DescribeCategoryTemplateRuleListResponseBodyItems[];
+  /**
+   * @remarks
+   * The number of entries returned per page.
+   * 
+   * @example
+   * 10
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The ID of the request.
+   * 
+   * @example
+   * 136082B3-B21F-5E9D-B68E-991FFD205D24
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The total number of rules in the template.
+   * 
+   * @example
+   * 10
+   */
+  totalCount?: number;
+  static names(): { [key: string]: string } {
+    return {
+      currentPage: 'CurrentPage',
+      items: 'Items',
+      pageSize: 'PageSize',
+      requestId: 'RequestId',
+      totalCount: 'TotalCount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      currentPage: 'number',
+      items: { 'type': 'array', 'itemType': DescribeCategoryTemplateRuleListResponseBodyItems },
+      pageSize: 'number',
+      requestId: 'string',
+      totalCount: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.items)) {
+      $dara.Model.validateArray(this.items);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeColumnsRequest.ts

@@ -0,0 +1,253 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeColumnsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The page number of the page to return.
+   * 
+   * @example
+   * 1
+   */
+  currentPage?: number;
+  /**
+   * @remarks
+   * The engine type. Valid values:
+   * 
+   * *   **MySQL**
+   * *   **MariaDB**
+   * *   **Oracle**
+   * *   **PostgreSQL**
+   * *   **SQLServer**
+   * 
+   * @example
+   * MySQL
+   */
+  engineType?: string;
+  /**
+   * @remarks
+   * The ID of the instance to which data in the column of the table belongs.
+   * 
+   * > You can call the [DescribeInstances](~~DescribeRules~~) operation to query the IDs of instances.
+   * 
+   * @example
+   * 1
+   */
+  instanceId?: number;
+  /**
+   * @remarks
+   * The name of the instance to which data in the column of the table belongs.
+   * 
+   * @example
+   * rm-bp17t1htja573l5i8****
+   */
+  instanceName?: string;
+  /**
+   * @remarks
+   * The language of the content within the request and response. Default value: **zh_cn**. Valid values:
+   * 
+   * *   **zh_cn**: Chinese
+   * *   **en_us**: English
+   * 
+   * @example
+   * zh_cn
+   */
+  lang?: string;
+  /**
+   * @remarks
+   * The data tag.
+   * 
+   * *   101: personal sensitive information
+   * *   102: personal information
+   * 
+   * @example
+   * 101
+   */
+  modelTagId?: string;
+  /**
+   * @remarks
+   * The search keyword. Fuzzy match is supported.
+   * 
+   * For example, if you enter **test**, all columns whose names contain **test** are retrieved.
+   * 
+   * @example
+   * test
+   */
+  name?: string;
+  /**
+   * @remarks
+   * The number of entries to return on each page.
+   * 
+   * @example
+   * 10
+   */
+  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**.
+   * 
+   * @example
+   * MaxCompute
+   */
+  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
+   * 
+   * @example
+   * 5
+   */
+  productId?: string;
+  /**
+   * @remarks
+   * The sensitivity level of the sensitive data that hits the sensitive data detection rule. Valid values:
+   * 
+   * *   **1**: N/A
+   * *   **2**: S1
+   * *   **3**: S2
+   * *   **4**: S3
+   * *   **5**: S4
+   * 
+   * @example
+   * 2
+   */
+  riskLevelId?: number;
+  /**
+   * @remarks
+   * The ID of the sensitive data detection rule that data in the column of the table hits.
+   * 
+   * > You can call the [DescribeRules](~~DescribeRules~~) operation to query the IDs of sensitive data detection rules.
+   * 
+   * @example
+   * 11111
+   */
+  ruleId?: number;
+  /**
+   * @remarks
+   * The name of the sensitive data detection rule that data in the column of the table hits.
+   * 
+   * @example
+   * ID card number (the Chinese mainland)
+   */
+  ruleName?: string;
+  /**
+   * @remarks
+   * The name of the sensitivity level of the data that hits the sensitive data detection rule. Valid values:
+   * 
+   * *   **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.
+   * 
+   * @example
+   * S2
+   */
+  sensLevelName?: string;
+  /**
+   * @remarks
+   * The ID of the table to which the column belongs.
+   * 
+   * > You can call the [DescribeTables](~~DescribeTables~~) operation to query the IDs of tables.
+   * 
+   * @example
+   * 11132334
+   */
+  tableId?: number;
+  /**
+   * @remarks
+   * The name of the table.
+   * 
+   * @example
+   * it_table
+   */
+  tableName?: string;
+  /**
+   * @remarks
+   * The ID of the industry-specific classification template.
+   * 
+   * >  You can call the [DescribeCategoryTemplateList](https://help.aliyun.com/document_detail/2399296.html) operation to obtain the IDs of industry-specific classification templates.
+   * 
+   * @example
+   * 5
+   */
+  templateId?: string;
+  /**
+   * @remarks
+   * The ID of the template rule that is hit.
+   * 
+   * >  You can call the [DescribeCategoryTemplateRuleList](https://help.aliyun.com/document_detail/410143.html) operation to obtain the IDs of hit template rules.
+   * 
+   * @example
+   * 1542
+   */
+  templateRuleId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      currentPage: 'CurrentPage',
+      engineType: 'EngineType',
+      instanceId: 'InstanceId',
+      instanceName: 'InstanceName',
+      lang: 'Lang',
+      modelTagId: 'ModelTagId',
+      name: 'Name',
+      pageSize: 'PageSize',
+      productCode: 'ProductCode',
+      productId: 'ProductId',
+      riskLevelId: 'RiskLevelId',
+      ruleId: 'RuleId',
+      ruleName: 'RuleName',
+      sensLevelName: 'SensLevelName',
+      tableId: 'TableId',
+      tableName: 'TableName',
+      templateId: 'TemplateId',
+      templateRuleId: 'TemplateRuleId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      currentPage: 'number',
+      engineType: 'string',
+      instanceId: 'number',
+      instanceName: 'string',
+      lang: 'string',
+      modelTagId: 'string',
+      name: 'string',
+      pageSize: 'number',
+      productCode: 'string',
+      productId: 'string',
+      riskLevelId: 'number',
+      ruleId: 'number',
+      ruleName: 'string',
+      sensLevelName: 'string',
+      tableId: 'number',
+      tableName: 'string',
+      templateId: 'string',
+      templateRuleId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeColumnsResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeColumnsResponseBody } from "./DescribeColumnsResponseBody";
+
+
+export class DescribeColumnsResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeColumnsResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DescribeColumnsResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+