# Alibaba Cloud Sensitive Data Discovery and Protection API

> Alibaba Cloud Sensitive Data Discovery and Protection API on Apizie: 54 endpoints (Modifies the general alert configuration parameters, Creates a scan authorization for a database, project, or Object Storage Service (OSS) bucket, Creates a custom sensitive data detection rule by calling CreateRule, Calls the CreateScanTask operation to create a custom scan task for detecting sensitive data in assets that…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:aliyun-sddp/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-sddp`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/sddp
- Page: https://www.apizie.tech/api/cloud/aliyun-sddp
- OpenAPI: https://www.apizie.tech/api/cloud/aliyun-sddp/openapi.json

Alibaba Cloud OpenAPI for Sensitive Data Discovery and Protection (sddp, version 2019-01-03). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Modifies the general alert configuration parameters
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/create-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Code | string | no | The code of the common configuration item. Valid values: access_failed_cnt: the maximum number of access attempts allowed when Data… |
| Description | string | no | The description of the common configuration item |
| Value | string | no | 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… |
| FeatureType | integer | no | This parameter is deprecated |
| SourceIp | string | no | This parameter is deprecated |
| Lang | string | no | The language of the content within the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese en_us: English |

### Creates a scan authorization for a database, project, or Object Storage Service (OSS) bucket
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/create-data-limit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| ResourceType | integer | yes | The type of the service to which the asset to be scanned belongs. Valid values: 1: MaxCompute. 2: OSS. 3: ADS. 4: OTS. 5: RDS |
| ServiceRegionId | string | no | Required. The region in which the asset resides. Valid values: cn-beijing: China (Beijing). cn-zhangjiakou: China (Zhangjiakou).… |
| ParentId | string | no | Required. The name of the asset, which consists of the instance ID and the database connection string separated by a period (.) |
| UserName | string | no | The username of the database asset |
| Password | string | no | The password used to access the database asset |
| AuditStatus | integer | no | Specifies whether to enable auditing. Valid values: 0: Auditing is disabled. 1: Auditing is enabled |
| AutoScan | integer | no | Specifies whether to automatically trigger a rescan when rules are changed. Valid values: 0: Automatic rescan is not triggered. 1:… |
| LogStoreDay | integer | no | The retention period of raw logs after auditing is enabled. Unit: days. Valid values: 30 90 180 365 |
| EngineType | string | no | The type of the database. Valid values: MySQL SQLServer |
| Port | integer | no | The database connection port |
| OcrStatus | integer | no | The OCR status. Valid values: 1: Enabled. 0: Disabled |
| EventStatus | integer | no | The anomalous activity detection status. Valid values: 0: Disabled. 1: Enabled (default) |
| Enable | integer | no | Specifies whether to enable sensitive data detection. Valid values: 1: Enabled. 0: Disabled. If the asset is authorized for the first… |
| SamplingSize | integer | no | The number of sample entries for sensitive data detection after data detection is enabled. Valid values: 0 5 10 Default value: 10 |
| CertificatePermission | string | no | The credential permission. Valid values: ReadOnly: read-only permission. ReadWrite: read and write permission |
| FeatureType | integer | no | This parameter is deprecated |
| SourceIp | string | no | This parameter is deprecated |
| InstantlyScan | string | no | Specifies whether to immediately scan the authorized asset. Valid values: false: The asset is not immediately scanned. true: The asset is… |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |

### Creates a custom sensitive data detection rule by calling CreateRule
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/create-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the sensitive data detection rule |
| Category | integer | no | The type of content in the sensitive data detection rule. Valid values: 0: keyword. 2: regular expression |
| Content | string | yes | The content of the sensitive data detection rule. The content can be a regular expression or keyword used to match sensitive data fields… |
| StatExpress | string | no | The statistical expression |
| RiskLevelId | integer | no | The sensitivity level ID of the sensitive data detection rule. Valid values: 1: N/A. No sensitive data is detected. 2: S1. Level-1… |
| RuleType | integer | no | The feature type of the rule. Valid values: 1: data detection rule. 2: audit policy. 3: outlier detection rule. 99: custom rule |
| ProductCode | string | no | The name of the product to which the column data in the data asset table belongs. Valid values: MaxCompute, OSS, ADS, OTS, RDS, and others |
| ProductId | integer | no | The ID that corresponds to the product name of the data asset. Valid values: 1: MaxCompute 2: OSS 3: ADS 4: OTS 5: RDS 6: SELF_DB |
| WarnLevel | integer | no | The risk level. Valid values: 1: low. 2: medium. 3: high |
| Description | string | no | The description of the rule |
| ContentCategory | integer | no | The content type. Valid values: 1: SQL injection exploitation attempt. 2: SQL injection bypass attempt. 3: stored procedure abuse. 4:… |
| Status | integer | no | The status of the rule. Valid values: 1: enabled. 0: disabled |
| Target | string | no | The target product code. Valid values: MaxCompute, OSS, ADS, OTS, RDS, and others |
| MatchType | integer | no | The match type. Valid values: 1: rule-based match. 2: dictionary-based match |
| SupportForm | integer | no | The asset form supported by the rule. Valid values: 0: all assets. 1: structured assets. 2: unstructured assets |
| SourceIp | string | no | This parameter is deprecated |
| TemplateRuleIds | string | no | The collection of template IDs for sensitive data auditing |
| ModelRuleIds | string | no | The collection of model IDs for sensitive data auditing |
| Lang | string | no | The language type for the request and response messages. Valid values: zh: Chinese. en: English |

### Calls the CreateScanTask operation to create a custom scan task for detecting sensitive data in assets that…
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/create-scan-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| DataLimitId | integer | yes | The unique ID of the data asset such as an instance, database, or bucket. You can call [DescribeDataLimits](~~DescribeDataLimits~~) to… |
| IntervalDay | integer | yes | The interval in days between two consecutive custom scan tasks. Valid values: 1 to 2147483648 |
| RunHour | integer | yes | The runtime of the next scan task. Unit: hours |
| RunMinute | integer | yes | The runtime of the next scan task. Unit: minutes |
| TaskName | string | yes | The name of the scan task |
| TaskUserName | string | no | The account that creates the scan task |
| OssScanPath | string | no | The scan scope for OSS assets. Prefix match, suffix match, and regular expression match are supported |
| ScanRange | integer | yes | The scan scope matching rule for the custom scan task. This parameter takes effect only when used together with ScanRangeContent. Valid… |
| ScanRangeContent | string | yes | The content to match within the scan scope of structured data assets by using prefix match, suffix match, or regular expression match.… |
| ResourceType | integer | yes | The resource type of the product to query. Valid values: 1: MaxCompute. 2: OSS. 3: ADS. 4: OTS. 5: RDS. 6: SELF_DB |
| SourceIp | string | no | This parameter is deprecated |
| FeatureType | integer | no | This parameter is deprecated |
| Lang | string | no | The language of the request and response. Valid values: zh: Chinese. en: English |

### Creates a service-linked role for Data Security Center (DSC) and authorizes DSC to access cloud resources
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/create-slr-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| SourceIp | string | no | [Deprecated] This parameter is deprecated |
| FeatureType | integer | no | [Deprecated] This parameter is deprecated |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Simplified Chinese en_us: English (US) |
| ServiceName | string | no | The service name of the Alibaba Cloud service for which you want to create a service-linked role to associate with DSC |

### Deletes authorized data assets such as databases, instances, or buckets from connection authorization
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/delete-data-limit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Id | integer | yes | The unique ID of the data asset, such as an instance, database, or bucket. Call the DescribeDataLimits operation to obtain the ID from the… |
| FeatureType | integer | no | This parameter is deprecated |
| SourceIp | string | no | This parameter is deprecated |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |

### Deletes a custom sensitive data detection rule
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/delete-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Id | integer | yes | The ID of the sensitive data detection rule |
| FeatureType | integer | no | This parameter is deprecated |
| SourceIp | string | no | This parameter is deprecated |
| Lang | string | no | The language of the data asset. Valid values: zh: Chinese. en: English |

### Queries the audit alert log list
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-audit-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| UserName | string | no | The username |
| ClientIp | string | no | The IP address of the client |
| ClientUa | string | no | The client type |
| InstanceName | string | no | The name of the asset instance |
| DatabaseName | string | no | The name of the database |
| StartTime | integer | no | The start time of the alert logs. Unit: milliseconds |
| EndTime | integer | no | The end time of the alert logs. The value is a UNIX timestamp in milliseconds |
| ProductCode | string | no | The name of the service to which the data asset belongs. Valid values: MaxCompute, OSS, ADS, OTS, and RDS |
| ProductId | integer | no | The ID of the service to which the data object belongs. Valid values: 1: MaxCompute 2: OSS 3: ADB-MYSQL 4: TableStore 5: RDS 6: SELF_DB 7:… |
| SqlText | string | no | The content of the SQL statement |
| ExecuteTimeRange | string | no | The execution time range |
| EffectRowRange | string | no | The range of affected rows |
| RuleName | string | no | The name of the audit rule |
| OperateType | string | no | The operation type |
| OssObjectKey | string | no | The key of the OSS object |
| AsyncRequestId | string | no | The request ID |
| PageSize | integer | no | The number of entries to return on each page for paging in a paged query. Maximum value: 50. Default value: 10 |
| CurrentPage | integer | no | The page number for paging in a paged query. Default value: 1 |
| RuleCategory | string | no | The rule type |
| LoadWhiteList | string | no | Specifies whether to load the whitelist status |
| MemberAccount | string | no | The UID of the member account |
| IpType | string | no | The network type. Valid values: default: Non-Alibaba Cloud services. This is the default value. aliyun: Alibaba Cloud services |
| LogQueryOpJson | string | no | The JSON string of query conditions |
| Message | string | no | The message content |
| LogSource | string | no | The data source |
| RuleAggQuery | string | no | Specifies whether to perform an aggregate query |
| RuleId | string | no | The ID of the audit rule |

### Queries the list of industry templates
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-category-template-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Simplified Chinese. en_us: English |
| PageSize | integer | no | The number of entries per page in a paged query. Default value: 10 |
| CurrentPage | integer | no | The page number in a paged query. Default value: 1 |
| UsageScenario | integer | no | The scenario in which the API is called. Default value: null. Valid values: null: legacy version. 0: legacy version. 1: new version |
| FeatureType | integer | no | This parameter is deprecated |

### Queries a paginated list of rules in a data classification template
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-category-template-rule-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. The default value is zh_cn. Valid values: zh_cn: Simplified Chinese. en_us: US English |
| PageSize | integer | no | The number of template rules to return on each page. The default value is 10 |
| CurrentPage | integer | no | The page number. The default value is 1 |
| Status | integer | no | The status of the template rule. The default value is null. Valid values: 0: The rule is disabled. 1: The rule is enabled. null: All rules… |
| RiskLevelId | integer | no | The risk level of the template rule. The value ranges from 1 to 11. The default value is null. Valid values: 1: No risk. 2: S1. 3: S2. 4:… |
| FeatureType | integer | no | This parameter is deprecated |

### Queries the column data in data asset tables, such as MaxCompute and ApsaraDB RDS, that are authorized in…
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-columns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| Name | string | no | The keyword for search. Fuzzy match is supported. For example, if you enter test, all data that contains test is returned |
| TableId | integer | no | The unique ID of the asset table to which the columns in asset tables such as MaxCompute and ApsaraDB RDS belong. To query the column data… |
| RuleId | integer | no | The unique ID of the sensitive data detection rule that is hit by the column data in the asset table. To query the column data in data… |
| ProductCode | string | no | The name of the service to which the column data in the data asset table belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS |
| InstanceId | integer | no | The ID of the asset instance to which the column data in the data asset table belongs. To query the column data in data asset tables that… |
| InstanceName | string | no | The name of the asset instance to which the column data in the data asset table belongs |
| TableName | string | no | The name of the data asset table |
| RuleName | string | no | The name of the sensitive data detection rule that is hit by the column data in the data asset table |
| SensLevelName | string | no | The sensitivity level. Valid values: N/A: No sensitive data is detected. S1: Level 1 sensitive data. S2: Level 2 sensitive data. S3: Level… |
| PageSize | integer | no | The maximum number of entries to return on each page |
| CurrentPage | integer | no | The page number to return in a paged query |
| RiskLevelId | integer | no | The risk level ID of the sensitive data detection rule. Valid values: 1: N/A. 2: S1. 3: S2. 4: S3. 5: S4 |
| TemplateRuleId | string | no | The ID of the template rule that is hit. You can call the https://help.aliyun.com/document_detail/410143.html operation to obtain the ID… |
| EngineType | string | no | The engine type. Valid values: MySQL. MariaDB. Oracle. PostgreSQL. SQLServer |
| ProductId | string | no | The ID that corresponds to the name of the service to which the data object belongs. Valid values: 1: MaxCompute. 2: OSS. 3: ADB-MYSQL. 4:… |
| ModelTagId | string | no | The data tag. Valid values: 101: Personal sensitive information. 102: Personal information |
| TemplateId | string | no | The industry template ID. You can call the https://help.aliyun.com/document_detail/2399296.html operation to obtain the industry template ID |
| ServiceRegionId | string | no | The region of the instance to which the column belongs |

### Queries column data in data asset tables, such as MaxCompute and ApsaraDB RDS tables, that are connected to…
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-columns-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese (Simplified). en_us: English (US) |
| Name | string | no | The keyword to search for. Fuzzy match is supported. For example, if you enter test, all data entries that contain test in the search… |
| TableId | string | no | The unique ID of the data asset table to which the columns belong in MaxCompute, ApsaraDB RDS, or other data assets. Queries column data… |
| RuleId | integer | no | The unique ID of the sensitive data detection rule that the column data matches. Queries column data in data asset tables that are… |
| ProductCode | string | no | The name of the product to which the column data in the data asset table belongs. Valid values: MaxCompute, OSS, ADS, OTS, RDS, and others |
| InstanceId | integer | no | The ID of the asset instance to which the column data in the data asset table belongs. Queries column data in data asset tables that are… |
| InstanceName | string | no | The name of the asset instance to which the column data in the data asset table belongs |
| TableName | string | no | The name of the data asset table |
| RuleName | string | no | The name of the sensitive data detection rule that the column data in the data asset table matches |
| SensLevelName | string | no | The sensitivity level name. Valid values: N/A: no sensitive data detected. S1: Level 1 sensitive data. S2: Level 2 sensitive data. S3:… |
| PageSize | integer | no | The maximum number of entries per page in a paged query. Default value: 10 |
| CurrentPage | integer | no | The page number in a paged query. Default value: 1 |
| RiskLevelId | integer | no | The risk level ID of the sensitive data detection rule. Valid values: 1: N/A. 2: S1. 3: S2. 4: S3. 5: S4 |
| EngineType | string | no | The engine type. Valid values: MySQL MariaDB Oracle PostgreSQL SQLServer |

### Queries common configuration items for anomaly alerts
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Valid values: zh_cn: Chinese (Simplified). Default value. en_us: English (United States) |

### Searches for data assets on the Overview page of Data Security Center (DSC)
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-data-assets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. The default value is zh_cn. Valid values: zh_cn: Chinese (Simplified) en_us: English (US) |
| Name | string | no | The keyword for a fuzzy search of data assets |
| RiskLevels | string | no | The risk levels of the data assets to query. Separate multiple risk levels with commas (,). 2: S1, low risk level 3: S2, medium risk level… |
| RuleId | integer | no | The ID of the sensitive data detection rule that the data asset matches. To find data assets based on the sensitive data detection rules… |
| RangeId | integer | no | The type of data asset to query. Valid values: 1: MaxCompute project 2: MaxCompute table 3: MaxCompute package 11: AnalyticDB for MySQL… |
| PageSize | integer | no | The number of entries to return on each page. The default value is 20 |
| CurrentPage | integer | no | The page number to return |

### Retrieves the details of an authorized data asset, such as a MaxCompute project, ApsaraDB RDS database, or…
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-data-limit-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the content within the request and response. Valid values: zh: Simplified Chinese. en: English |
| Id | integer | yes | The unique ID of the data asset that you want to query. You can call the [DescribeDataLimits](~~DescribeDataLimits~~) operation to query… |
| NetworkType | integer | no | The network type of the data asset that you want to query. Valid values: 1: virtual private cloud (VPC) 2: classic network |
| FeatureType | integer | no | This parameter is deprecated |

### Call the DescribeDataLimitSet operation to query the authorization list for unstructured assets or the list…
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-data-limit-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Valid values: zh_cn: Chinese (Simplified). This is the default value. en_us: English (US) |
| ResourceType | integer | no | The type of data asset. Valid values: 1: MaxCompute. 2: OSS. 3: ADS. 4: OTS. 5: RDS. 6: SELF_DB. If you set this parameter to a value… |
| ParentId | string | no | The ID of the parent asset. The [DescribeDataLimitDetail](~~DescribeDataLimitDetail~~) or [DescribeDataLimits](~~DescribeDataLimits~~)… |
| FeatureType | integer | no | This parameter is deprecated |
| RegionType | string | no | The region type. native_audit: A region that supports traffic collection |

### Queries the list of data assets, including authorized instances, databases, and buckets
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-data-limits` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Valid values: zh: Chinese. en: English |
| PageSize | integer | no | The maximum number of entries to return on each page in a paging query |
| CurrentPage | integer | no | The page number of the current page in a paged query |
| ResourceType | integer | no | Required. The type of the product to which the data asset belongs. Valid values: 1: MaxCompute 2: OSS 3: ADS 4: OTS 5: RDS 6: SELF_DB |
| ParentId | string | no | The ID of the parent asset to which the data asset belongs. Valid values: The project name or ID for MaxCompute. The bucket name or ID for… |
| ServiceRegionId | string | no | The region where the asset resides |
| CheckStatus | integer | no | The data detection status. Valid values: 0: Ready. 1: Running. 2: Connectivity test in progress. 3: Connectivity test passed. 4:… |
| AuditStatus | integer | no | The audit status. Valid values: 1: Audit enabled. 0: Audit disabled |
| EngineType | string | no | The database type. Valid values: MySQL, SQLServer, Oracle, PostgreSQL, MongoDB, and others |
| DatamaskStatus | integer | no | The data masking permission status. Valid values: 1: Enabled. 0: Disabled |
| Enable | integer | no | The detection permission status. Valid values: 1: Enabled. 0: Disabled |
| StartTime | integer | no | The start time of the creation time range. Format: timestamp. Unit: milliseconds |
| EndTime | integer | no | The end time of the creation time range. Format: timestamp. Unit: milliseconds |
| MemberAccount | integer | no | The ID of the member accounts |
| FeatureType | integer | no | [Deprecated] This parameter is deprecated |

### Queries the execution status of data masking tasks
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-data-masking-run-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| TaskId | string | no | The ID of the data masking task |
| StartTime | integer | no | The start time of the task execution. The value is a UNIX timestamp in milliseconds |
| EndTime | integer | no | The end time of the task execution. The value is a UNIX timestamp in milliseconds |
| Status | integer | no | The execution status of the task. Valid values: -1: Pending. 0: Running. 1: Successful. 2: Failed. 3: Terminated by user. 4: Partially… |
| SrcType | integer | no | The type of the source service to which the masked data belongs. Valid values: 1: MaxCompute, 2: OSS, 3: ADS, 4: OTS, and 5: RDS |
| DstType | integer | no | The type of the destination service where the masked data is stored. Valid values: 1: MaxCompute, 2: OSS, 3: ADS, 4: OTS, and 5: RDS |
| PageSize | integer | no | The maximum number of entries to return on each page |
| CurrentPage | integer | no | The page number for paging in a paged query |
| MainProcessId | integer | no | The ID of the main task. If the task contains subtasks, the value of this parameter is the ID of the current task. Otherwise, the value is… |
| SrcTableName | string | no | The name of the source table |

### Queries the list of static data masking tasks
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-data-masking-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| SearchKey | string | no | The keyword used to search for tasks. You can search by task name or task ID |
| StartTime | integer | no | The start time of the task creation period. Format: timestamp. Unit: milliseconds |
| EndTime | integer | no | The end time of the task creation period. Format: timestamp. Unit: milliseconds |
| DstType | integer | no | The service to which the destination data source belongs. Valid values: 1: MaxCompute. 2: OSS. 3: ADS. 4: OTS. 5: RDS. 6: SELF_DB |
| PageSize | integer | no | The maximum number of entries per page |
| CurrentPage | integer | no | The page number for a paged query |

### Queries the column detection results of a data table
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-data-object-column-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| PageSize | integer | no | The maximum number of data asset instances to return on each page during a paged query. Default value: 10 |
| CurrentPage | integer | no | The page number of the current page during a paged query. Default value: 1 |
| ProductId | integer | no | The ID of the product to which the data object belongs. Valid values: 1: MaxCompute 2: OSS 3: ADB-MYSQL 4: TableStore 5: RDS 6: SELF_DB 7:… |
| Id | integer | no | The unique ID of the data object to query. You can call the https://help.aliyun.com/document_detail/2399253.html operation to obtain the ID |
| TemplateId | integer | no | The ID of the industry template. You can call the https://help.aliyun.com/document_detail/2399253.html operation to obtain the ID of the… |
| FeatureType | integer | no | [Deprecated] This parameter is deprecated |

### Queries the column detection results of a data table
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-data-object-column-detail-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language type of the request and response messages. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| PageSize | integer | no | The maximum number of data asset instances to return on each page during a paged query. Default value: 10 |
| CurrentPage | integer | no | The page number of the current page during a paged query. Default value: 1 |
| ProductId | integer | no | The ID of the product to which the data object belongs. Valid values: 1: MaxCompute 2: OSS 3: ADB-MYSQL 4: TableStore 5: RDS 6: SELF_DB 7:… |
| Id | string | yes | The unique ID of the data object to query. You can call the https://help.aliyun.com/document_detail/2399253.html operation to obtain the ID |
| TemplateId | integer | yes | The ID of the industry template. You can call the https://help.aliyun.com/document_detail/2399253.html operation to obtain the ID of the… |
| FeatureType | integer | no | [Deprecated] This parameter is deprecated |

### Queries the data detection results of data tables and files
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-data-objects` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| PageSize | integer | no | The maximum number of data asset instances to return per page in a paged query. Default value: 10 |
| CurrentPage | integer | no | The page number in a paged query. Default value: 1 |
| ProductIds | string | no | We recommend that you specify this parameter. The list of product IDs to query, separated by commas. Valid values: 1: MaxCompute 2: OSS 3:… |
| ParentCategoryIds | string | no | The list of parent category IDs of the templates to query, separated by commas |
| QueryName | string | no | The keyword of the data object to query |
| ServiceRegionId | string | no | The region where the asset resides. Valid values: cn-beijing: China (Beijing). cn-zhangjiakou: China (Zhangjiakou). cn-huhehaote: China… |
| TemplateId | integer | yes | The industry template ID. You can call https://help.aliyun.com/document_detail/2399296.html to obtain the industry template ID |
| DomainId | integer | no | The data domain ID to which the data asset belongs |
| ModelTagIds | string | no | The data tags to query, separated by commas. Valid values: 101: personal sensitive information. 102: personal information. 107: general… |
| RiskLevels | string | no | The risk levels of the data assets to query. Separate multiple values with commas (,). 2: S1, low risk level. 3: S2, medium risk level. 4:… |
| InstanceId | string | no | The keyword of the asset instance ID |
| ModelIds | string | no | The model IDs of the industry template, separated by commas. You can call https://help.aliyun.com/document_detail/2536491.html to obtain… |
| FileType | integer | no | The OSS file type supported for detection. You can call https://help.aliyun.com/document_detail/2536492.html to obtain the supported OSS… |
| FileCategoryCode | integer | no | The file category code |
| MemberAccount | integer | no | The member accounts ID |
| FeatureType | integer | no | [Deprecated] This parameter is deprecated |
| APIVersion | integer | no | The identifier used for canary release evaluation |
| RegionId | string | no | The region of the data catalog display page |
| ProductId | integer | no | The product of the data catalog |
| RuleIds | string | no | The rule filter |
| RiskLevelIdList | string | no | The risk level filter |
| TableName | string | no | The task name filter |
| DbName | string | no | The database name filter |
| TaskId | integer | no | The task ID filter |
| Bucket | string | no | The OSS bucket filter |
| Project | string | no | The SLS project filter |
| LogStore | string | no | The SLS Logstore filter |
| LogStoreFlag | integer | no | The data catalog SLS page has two layers. This parameter indicates whether the query is at the Logstore dimension |
| Path | string | no | The file path filter |
| EngineType | string | no | The EngineType |
| FacetType | string | no | The facet dimension for associated filtering in the data catalog. Valid values: rule (category), task (task), instance (instance), and db… |
| IsRevision | integer | no | Specifies whether to filter revision items |
| Cursor | string | no | The Cursor |
| CursorDirection | string | no | The CursorDirection |

### Queries the list of OSS file types that can be detected
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-doc-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |

### Queries the details of a single anomalous activity, including the time when the anomalous activity occurred,…
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-event-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Valid values: zh: Chinese. en: English |
| Id | integer | yes | The unique ID of the anomalous activity. To query the details of a single anomalous activity, provide the unique ID of the anomalous… |

### Queries anomalous activity types
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-event-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Valid values: zh: Chinese. en: English |
| ParentTypeId | integer | no | The ID of the parent anomalous activity type to which the child anomalous activity type belongs. Valid values: 01: anomalous permission… |
| ResourceId | integer | no | The resource type of the product. Valid values: 1: MaxCompute. 2: Object Storage Service (OSS). 3: AnalyticDB for MySQL. 4: Tablestore. 5.… |
| Status | integer | no | The status. Valid values: 1: active. 2: inactive |
| FeatureType | integer | no | This parameter is deprecated |

### Lists anomalous events
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. The default value is zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| Id | integer | no | The unique ID of the anomalous activity |
| UserId | integer | no | The ID of the account that performed the operation that triggered the anomalous activity |
| DealUserId | string | no | The ID of the account that handled the anomalous activity |
| Status | string | no | The processing status of the anomalous activity. 0: Unhandled. 1: Confirmed. 2: Dismissed |
| TypeCode | string | no | The code of the parent type of the anomalous activity. 01: Anomalous permission access. 02: Anomalous data flow. 03: Anomalous data… |
| SubTypeCode | string | no | The name of the child type of the anomalous activity. To query anomalous activities by the child type name, call the DescribeEventTypes… |
| StartTime | integer | no | The time when the anomalous activity occurred. This is the start time of the detection. The value is a UNIX timestamp. Unit: milliseconds |
| EndTime | integer | no | The time when the detection of the anomalous activity ended. The value is a UNIX timestamp. Unit: milliseconds |
| PageSize | integer | no | The number of entries to return on each page |
| CurrentPage | integer | no | The page number of the page to return |
| InstanceName | string | no | The name of the data asset instance |
| ProductCode | string | no | The service to which the data asset belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS |
| TargetProductCode | string | no | The destination service for an anomalous data flow event. Valid values include MaxCompute, OSS, ADS, OTS, and RDS |
| UserName | string | no | The username of the RAM user |
| WarnLevel | integer | no | The risk level of the anomalous activity. 1: Low. 2: Medium. 3: High |

### Retrieves the completion status of a detection task based on the task ID. You can obtain the task ID from…
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-identify-task-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Id | integer | yes | The task ID. You can obtain the task ID from the ID field in the response of the CreateScanTask or ScanOssObjectV1 operation |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Simplified Chinese en_us: English (US) |

### Queries a list of data assets
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-instance-sources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Valid values: zh_cn: Simplified Chinese. This is the default value. en_us: English |
| PageSize | integer | no | The number of entries per page in a paginated query. Default value: 10 |
| CurrentPage | integer | no | The page number. Default value: 1 |
| ServiceRegionId | string | no | The region where the asset is located. For more information, see https://help.aliyun.com/document_detail/214257.html |
| EngineType | string | no | The database engine type. Valid values: MySQL MariaDB Oracle PostgreSQL SQLServer |
| InstanceId | string | no | The instance ID |
| ProductId | integer | no | The product type ID to query. Valid values: 1: MaxCompute 2: OSS 3: ADS 4: OTS 5: RDS 6: SELF_DB |
| ProductCode | string | no | The name of the product to query. Valid values: MaxCompute, OSS, ADS, OTS, and RDS |
| AuditStatus | integer | no | The audit status. Valid values: 1: Auditing is enabled. 0: Auditing is disabled |
| SearchType | string | no | The type of the fuzzy search for data assets. Valid values: InstanceId: The instance ID. InstanceName: The instance name. DatabaseName:… |
| SearchKey | string | no | The keyword for the fuzzy search of data assets |
| AuthStatus | integer | no | The authorization status of the data asset instance. 0: Unauthorized. 1: Authorized |
| FeatureType | integer | no | This parameter is deprecated |

### Retrieves the list of data asset instances for authorized MaxCompute, ApsaraDB RDS, and OSS connections
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese (Simplified). en_us: English (US) |
| Name | string | no | The search keyword. Fuzzy match is supported. For example, if you enter data, all data entries that contain data in the search item are… |
| ProductId | integer | no | The ID of the product to which the data asset instance belongs. You can call the [DescribeDataAssets](~~DescribeDataAssets~~) operation to… |
| RiskLevelId | integer | no | The risk level ID of the data asset instance. A higher risk level ID indicates more sensitive data is detected. Valid values: 1: No… |
| RuleId | integer | no | The ID of the sensitive data detection rule that the data asset instance hits. You can call the [DescribeRules](~~DescribeRules~~)… |
| ServiceRegionId | string | no | The region of the data asset instance. For more information, see https://help.aliyun.com/document_detail/214257.html |
| FeatureType | integer | no | This parameter is deprecated |
| ProductCode | string | no | The name of the product to which the data asset instance belongs, such as MaxCompute, OSS, or RDS. For supported product names, see… |
| PageSize | integer | no | The maximum number of data asset instances to return on each page in a paged query. Default value: 10 |
| CurrentPage | integer | no | The page number of the current page in a paged query. Default value: 1 |

### Queries the details of a single OSS storage object that is authorized for connection in Data Security Center
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-oss-object-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| Id | integer | yes | The unique ID of the OSS storage object. Call the https://help.aliyun.com/document_detail/410152.html operation to obtain the ID |

### Queries the details of a single storage object in OSS that is authorized for connection to Data Security…
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-oss-object-detail-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Simplified Chinese. en_us: English (US) |
| Id | string | no | The unique ID of the OSS storage object. Call the https://help.aliyun.com/document_detail/410152.html operation to obtain the ID |
| ServiceRegionId | string | no | The service region ID, which is the region ID of the bucket |
| BucketName | string | no | The bucket name |
| ObjectKey | string | no | The full name of the file stored in OSS |
| TemplateId | integer | no | The industry template ID. Call the https://help.aliyun.com/document_detail/2399296.html operation to obtain the industry template ID |

### Queries the list of storage objects in authorized OSS buckets
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-oss-objects` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Valid values: zh: Chinese. en: English |
| Name | string | no | The search keyword. Fuzzy matching is supported |
| RiskLevelId | integer | no | The risk level ID of the OSS storage object. Valid values: 1: N/A: No sensitive data is detected. 2: S1: Level 1 sensitive data. 3: S2:… |
| RuleId | integer | no | The ID of the sensitive data detection rule hit by the OSS storage object. To query the storage objects in OSS buckets authorized for Data… |
| InstanceId | string | no | The ID of the asset instance to which the OSS object belongs. To query the storage objects in OSS buckets authorized for DSC based on the… |
| PageSize | integer | no | The maximum number of entries to return on each page |
| CurrentPage | integer | no | The page number to return in a paged query |
| ServiceRegionId | string | no | The region where the asset resides |
| LastScanTimeStart | integer | no | The start time of the last scan. Format: timestamp. Unit: milliseconds |
| LastScanTimeEnd | integer | no | The end time of the last scan. Format: timestamp. Unit: milliseconds |
| TemplateId | integer | no | The ID of the industry template |
| FileCategoryCode | integer | no | The code of the file category |
| Marker | integer | no | The marker used to retrieve subsequent data starting from the specified marker in a paged query |

### Retrieves information about MaxCompute packages authorized for scanning, including package names, owner…
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-packages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. The default value is zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| Name | string | no | The keyword for the search. Fuzzy matching is supported |
| ProductId | integer | no | The ID of the product to which the data asset package belongs. To query the list of MaxCompute data asset packages that are authorized for… |
| RiskLevelId | integer | no | The ID of the risk level for the data asset package. 1: N/A: No sensitive data is detected. 2: S1: Level 1 sensitive data. 3: S2: Level 2… |
| RuleId | integer | no | The ID of the sensitive data detection rule that the data asset package matches. To query the list of MaxCompute data asset packages that… |
| InstanceId | integer | no | The ID of the asset instance to which the data asset package belongs. To query the list of MaxCompute data asset packages that are… |
| PageSize | integer | no | The maximum number of entries to return on each page |
| CurrentPage | integer | no | The page number to return |

### Queries a list of unauthorized or authorized assets
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-parent-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| CurrentPage | integer | no | The paging Settings for the current page number in a paged query. Default value: 1 |
| PageSize | integer | no | The paging Settings for the number of entries per page in a paged query. Default value: 10 |
| ServiceRegionId | string | no | The region where the asset resides. Valid values: cn-beijing: China (Beijing). cn-zhangjiakou: China (Zhangjiakou). cn-huhehaote: China… |
| EngineType | string | no | The engine type. Valid values: MySQL MariaDB Oracle PostgreSQL SQLServer |
| InstanceId | string | no | The instance ID of the asset to which the column data in the data asset table belongs |
| DbName | string | no | The name of the database |
| ResourceType | integer | no | Required. The product type. Valid values: 1: MaxCompute 2: OSS 3: ADB-MYSQL 4: TableStore 5: RDS 6: SelfDB 7: PolarDB-X 8: PolarDB 9:… |
| CheckStatus | integer | no | The status of the instance or the database connection under the instance. Valid values: -3: database not created -2: released -1: not… |
| ClusterStatus | string | no | The instance status. Valid values: Running: running Released: released DatabaseNotCreated: database not created |
| AuthStatus | integer | no | The authorization status of the data asset instance. Valid values: 0: unauthorized 1: authorized |
| MemberAccount | integer | no | The ID of the member accounts |
| Lang | string | no | The language of the request and response. Valid values: zh_cn: Chinese (Simplified). Default value. en_us: English (US) |

### Call the DescribeRiskLevels operation to retrieve a list of risk levels for sensitive data
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-risk-levels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Valid values: zh_cn: Chinese. This is the default value. en_us: English |
| TemplateId | integer | no | The ID of the industry-specific template. Call https://help.aliyun.com/document_detail/2399296.html to get the ID of the industry-specific… |
| FeatureType | integer | no | This parameter is deprecated |

### Queries the list of sensitive data detection rules
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language type of the request and response messages. Valid values: zh: Chinese. en: English |
| PageSize | integer | no | The maximum number of entries to return on each page |
| CurrentPage | integer | no | The page number for paging in a paged query |
| CustomType | integer | no | The type of the sensitive data detection rule. Valid values: 0: system built-in. 1: user-defined |
| Category | integer | no | The content type of the sensitive data detection rule. Valid values: 0: keyword. 2: regular expression |
| Name | string | no | The name of the sensitive data detection rule. Fuzzy match is supported |
| RiskLevelId | integer | no | The ID of the sensitivity level for the sensitive data detection rule. Valid values: 1: N/A: No sensitive data is detected. 2: S1: Level 1… |
| RuleType | integer | no | The type of the sensitive data detection rule. Valid values: 1: data detection rule. 2: audit policy. 3: outlier detection rule. 99:… |
| MatchType | integer | no | The match type. Valid values: 1: rule match. 2: dictionary match |
| ProductCode | integer | no | The name of the service to which the data asset belongs. Valid values: MaxCompute. OSS. ADS. OTS. RDS. SELF_DB |
| ProductId | integer | no | 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 |
| WarnLevel | integer | no | The risk level. Valid values: 1: low risk. 2: medium risk. 3: high risk |
| ContentCategory | integer | no | The content type. Valid values: 1: SQL injection exploitation attempt. 2: SQL injection bypass attempt. 3: stored procedure abuse. 4:… |
| Status | integer | no | The status. Valid values: 1: normal. 0: disabled |
| KeywordCompatible | string | no | Specifies whether the keywords of the legacy and new versions are compatible. Valid values: true: yes. false: no. In the legacy version,… |
| GroupId | string | no | The parent group of the rule |
| SupportForm | integer | no | The type of data assets supported by the rule. Valid values: 0: all assets. 1: structured assets. 2: unstructured assets. When you query… |
| FeatureType | integer | no | [Deprecated] This parameter is deprecated |
| CooperationChannel | string | no | The external cooperation source of the request. Valid values: DAS. YAOCHI |
| Simplify | string | no | Specifies whether to obtain the simplified version of the rules, which includes only the rule names. Valid values: true: yes. false: no |

### Queries tables in data assets, such as MaxCompute and RDS, that Data Security Center is authorized to access
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| Name | string | no | The search keyword. Fuzzy search is supported. For example, if you enter test, all results that contain test are returned |
| ProductId | integer | no | The ID of the product to which the data asset table belongs. Call the [DescribeDataAssets](~~DescribeDataAssets~~) operation to obtain… |
| ProductCode | string | no | The name of the product to which the data asset table belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS. For more… |
| RiskLevelId | integer | no | The ID of the risk level for the data asset table. Each risk level ID corresponds to a risk level name. Valid values: 1: N/A. No sensitive… |
| RuleId | integer | no | The ID of the sensitive data detection rule that the data asset table hits. Call the [DescribeRules](~~DescribeRules~~) operation to… |
| InstanceId | integer | no | The ID of the instance to which the data asset table belongs. Call the [DescribeInstances](~~DescribeInstances~~) operation to obtain this… |
| PackageId | integer | no | The ID of the package to which the data asset table belongs. Call the [DescribePackages](~~DescribePackages~~) operation to obtain this ID |
| PageSize | integer | no | The maximum number of entries to return on each page. Default value: 10 |
| CurrentPage | integer | no | The number of the page to return. Default value: 1 |
| ServiceRegionId | string | no | The region where Data Security Center is available. For more information, see https://help.aliyun.com/document_detail/214257.html |
| TemplateId | integer | no | The ID of the industry-specific template |

### Lists all rules in an industry-specific template
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-template-all-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| TemplateId | integer | no | The ID of the industry template. You can call the https://help.aliyun.com/document_detail/2399296.html operation to obtain the ID of the… |
| FeatureType | integer | no | This parameter is deprecated |

### Queries the status of a user account by calling DescribeUserStatus
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/describe-user-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Valid values: zh_cn: Chinese (Simplified). This is the default value. en_us: English (US) |
| FeatureType | integer | no | This parameter is deprecated |

### Calls the DisableUserConfig operation to disable a user configuration. After the user configuration is…
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/disable-user-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Valid values: zh_cn: Chinese. This is the default value. en_us: English |
| Code | string | no | The code of the configuration item in the anomaly alert general configuration module. You can call [DescribeConfigs](~~DescribeConfigs~~)… |
| FeatureType | integer | no | This parameter is deprecated |

### Calls the ExecDatamask operation to perform dynamic data masking
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/exec-datamask` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| TemplateId | integer | yes | Specifies the ID of the masking template. After you create a template in the Data Security Center console… |
| Data | string | yes | Specifies the data to be masked. The value is a JSON string that contains the following fields: dataHeaderList: the column names of the… |
| FeatureType | integer | no | [Deprecated] This parameter is deprecated |
| Lang | string | no | Specifies the language of the request and response. Default value: zh_cn. Valid values: zh_cn: Simplified Chinese en_us: English (US) |

### Triggers a data masking task
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/manual-trigger-masking-process` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| Id | integer | yes | The ID of the data masking task, represented as a number. The data masking task ID is represented by a string of characters. You can call… |

### Masks images in storage objects
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/mask-oss-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| BucketName | string | yes | The name of the OSS bucket |
| ObjectKey | string | yes | The full name of the file stored in OSS |
| ServiceRegionId | string | yes | The region where the bucket is located |
| MaskRuleIdList | string | yes | The list of masking rule IDs, separated by commas (,). The rule ID mappings are as follows: 3000: Images that contain ID card information… |
| IsSupportRestore | string | no | Specifies whether the image can be restored |
| IsAlwaysUpload | string | no | Specifies whether to always upload the processed image. If this parameter is set to false, the image is uploaded only when a masking rule… |
| IsCoverObject | string | no | Specifies whether to overwrite the original file. true: Overwrites the original file after masking succeeds. false: Does not overwrite the… |
| Lang | string | no | The language of the response |

### Modifies the configuration items of a Data Security Center (DSC) connection authorization
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/modify-data-limit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response messages. Valid values: zh: Chinese (default) en: English |
| Id | integer | yes | The unique ID of the data asset that belongs to the product associated with the DSC connection authorization configuration item. To modify… |
| ResourceType | integer | yes | The name of the product to which the data of the DSC connection authorization configuration item belongs. Valid values: 1: MaxCompute 2:… |
| ServiceRegionId | string | no | The region where the asset resides. Valid values: cn-beijing: China (Beijing) cn-zhangjiakou: China (Zhangjiakou) cn-huhehaote: China… |
| UserName | string | no | The username used for the DSC connection authorization to the RDS database |
| Password | string | no | The password used for the DSC connection authorization to the RDS database |
| ModifyPassword | string | no | Specifies whether to modify the username and password for connecting to the database. Valid values: true: Modify. false: Do not modify |
| AuditStatus | integer | no | Specifies whether to enable auditing. Valid values: 0: Disable auditing. 1: Enable auditing |
| LogStoreDay | integer | no | The retention period of raw logs after auditing is enabled. Unit: days. Valid values: 30 90 180 365 |
| EngineType | string | no | The database type. Valid values: MySQL SQLServer |
| Port | integer | no | The port used to connect to the database |
| AutoScan | integer | no | Specifies whether to automatically trigger a rescan when rules change. Valid values: 0: Do not trigger an automatic scan. 1: Trigger an… |
| SamplingSize | integer | no | The number of sample entries for sensitive data detection after data detection is enabled. Valid values: 0 5 10 |
| VpcId | string | no | The VPC ID to which the data asset belongs |
| SecurityGroupIdList | string | no | The security groups used by PrivateLink in agent-based auditing (JSON-encoded) |
| VSwitchIdList | string | no | The vSwitches used by PrivateLink in agent-based auditing (JSON-encoded) |
| FeatureType | integer | no | This parameter is deprecated |

### Modifies the risk level definition rules for sensitive data, including the default risk level for…
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/modify-default-level` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| DefaultId | integer | no | The default risk level ID for unrecognized data. Valid values: 1: N/A. 2: S1. 3: S2. 4: S3. 5: S4 |
| SensitiveIds | string | no | The risk level IDs for data classified as "sensitive". Separate multiple IDs with commas (,). Valid values: 1: N/A. 2: S1. 3: S2. 4: S3.… |

### Handles anomalous activities
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/modify-event-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. The default value is zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| Id | integer | yes | The unique ID of the anomalous activity. To handle an anomalous activity, you must provide its unique ID. You can obtain this ID by… |
| Backed | string | no | Specifies whether to enhance the detection of the anomalous activity. Enhancing detection improves accuracy and increases the alert rate… |
| DealReason | string | no | The reason for handling the anomalous activity |
| Status | integer | yes | The operation to perform on the anomalous activity. 1: Mark as false positive. 2: Confirm and handle the anomalous activity |

### Invokes this operation to enable the feature for detecting anomalous activity events of specified child…
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/modify-event-type-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Valid values:- zh: Chinese- en: English |
| SubTypeIds | string | no | The unique IDs of the anomalous activity child classes, separated by commas (,). To enable the detection of anomalous activities of… |
| FeatureType | integer | no | This parameter is deprecated |

### You can call the ModifyReportTaskStatus operation to enable or disable report tasks
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/modify-report-task-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| ReportTaskStatus | integer | no | The status to set for the report task. Valid values: 0: Disable 1: Enable This parameter is required. |
| FeatureType | integer | no | This parameter is deprecated |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese en_us: English |

### Modifies a custom sensitive data detection rule in Data Security Center (DSC)
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/modify-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Simplified Chinese. en_us: English (US) |
| Id | integer | yes | The unique ID of the sensitive data detection rule. You can call the [DescribeRules](~~DescribeRules~~) operation to obtain the rule ID |
| Name | string | yes | The name of the sensitive data detection rule. You can call the [DescribeRules](~~DescribeRules~~) operation to obtain the rule name |
| Category | integer | no | The type of the sensitive data detection rule content. Valid values: 2: regular expression. 3: algorithm. 5: keyword |
| Content | string | yes | The content of the sensitive data detection rule. The content can be a regular expression, algorithm, or keyword that is used to match… |
| RiskLevelId | integer | no | The risk level ID of the sensitive data detection rule. Valid values: 1: N/A. No sensitive data is detected. 2: S1. Level-1 sensitive… |
| RuleType | integer | no | The type of the sensitive data detection rule. Valid values: 1: data detection rule. 2: audit policy. 3: anomalous activity rule |
| ProductCode | string | no | The resource type of the product that contains the sensitive data detection rule. Valid values: MaxCompute OSS ADS OTS RDS SELF_DB |
| ProductId | integer | no | The product ID of the product that contains the sensitive data detection rule. Valid values: 1: MaxCompute. 2: OSS. 3: ADS. 4: OTS. 5:… |
| WarnLevel | integer | no | The risk level of the sensitive data detection rule. Valid values: 1: low. 2: medium. 3: high |
| MatchType | integer | no | The match type. Valid values: 1: rule match. 2: dictionary match |
| SupportForm | integer | no | The data asset type supported by the rule. Valid values: 0: all assets. 1: structured assets. 2: unstructured assets |
| TemplateRuleIds | string | no | The collection of template IDs associated with the sensitive data audit |
| ModelRuleIds | string | no | The collection of model IDs associated with the sensitive data audit |

### Enables or disables the detection feature of a sensitive data detection rule
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/modify-rule-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Valid values: zh: Chinese. en: English |
| Id | integer | no | The unique ID of the sensitive data detection rule. To enable or disable the detection feature of a sensitive data detection rule, you… |
| Ids | string | no | The unique IDs of the sensitive data detection rules. Separate multiple IDs with commas (,). To enable or disable the detection feature of… |
| Status | integer | yes | Specifies whether to enable or disable the detection feature of the sensitive data detection rule. Valid values: 0: disabled. 1: enabled |

### Restores a masked image
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/restore-oss-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Bucket | string | yes | The OSS bucket |
| ObjectKey | string | yes | The full name of the file stored in OSS |
| ServiceRegionId | string | yes | The region ID of the bucket |
| TargetObjectKey | string | no | The storage path of the restored image |
| Lang | string | no | The language of the request and response. Valid values: zh: Chinese. en: English |

### Creates a scan task to detect sensitive data in the specified storage objects
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/scan-oss-object-v1` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| ServiceRegionId | string | yes | The ID of the region where the OSS bucket resides |
| BucketName | string | yes | The name of the OSS bucket |
| ObjectKeyList | string | yes | The list of storage objects to be scanned in the OSS bucket. You can specify up to 50 object keys at a time (JSON-encoded) |
| TemplateId | integer | no | The ID of the industry template. You can call the DescribeCategoryTemplateList operation to obtain the template list. If you do not… |
| Lang | string | no | The language of the request and response. Valid values: zh: Chinese. en: English |

### You can call the StopMaskingProcess operation to stop a data masking task. You can call the…
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/stop-masking-process` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |
| Lang | string | no | The language of the request and response. Valid values: zh_cn: Chinese (Simplified). This is the default value. en_us: English (US) |
| Id | integer | yes | The unique ID of the data masking task. You can obtain the ID of a data masking task from the return value of the… |

### version
`POST https://www.apizie.tech/v1/cloud:aliyun-sddp/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sddp.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://www.apizie.tech/v1/cloud:aliyun-sddp/create-config" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Sensitive Data Discovery and Protection API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-sddp/create-config with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Sensitive Data Discovery and Protection API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Sensitive Data Discovery and Protection itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Sensitive Data Discovery and Protection API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-sddp.

### What is the status of the Alibaba Cloud Sensitive Data Discovery and Protection API?
Needs your own provider key (bring your own key)