Use DescribeDataObjects to query data detection results for data assets - Data Security Center

Retrieves data detection results for tables and files.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sddp:DescribeDataObjects

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language for requests and responses. Default: zh_cn. Valid values: zh_cn: Chinese. en_us: English.	zh_cn
PageSize	integer	No	The maximum number of data asset instances to display per page in a paged query. Default: 10.	10
CurrentPage	integer	No	The page number for a paged query. Default: 1.	1
ProductIds	string	No	Specify this parameter. The IDs of the products to query. Separate multiple IDs with commas. 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 Note OSS is mutually exclusive with other products. If you include OSS, do not include other products. By default, non-OSS products are queried.	1,5
ParentCategoryIds	string	No	The IDs of the parent categories of the templates to query. Separate multiple IDs with commas.	234,236,238
QueryName	string	No	The keyword for the data object to query.	t_sddp_selfmysql_pers0
ServiceRegionId	string	No	The region where the asset resides. Valid values: cn-beijing: North China 2 (Beijing). cn-zhangjiakou: North China 3 (Zhangjiakou). cn-huhehaote: North China 5 (Hohhot). cn-hangzhou: East China 1 (Hangzhou). cn-shanghai: East China 2 (Shanghai). cn-shenzhen: South China 1 (Shenzhen). cn-hongkong: Hong Kong (China).	cn-hangzhou
TemplateId	integer	Yes	The industry template ID. Note Call DescribeCategoryTemplateList to get the industry template ID.	1
DomainId	integer	No	The ID of the data domain that contains the data asset.	2
ModelTagIds	string	No	The data tags to query. Separate multiple tags with commas. Valid values: 101: Personal sensitive information. 102: Personal information. 107: General information.	101,102
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. 4: S3, high risk level. 5: S4, highest risk level.	2
InstanceId	string	No	The keyword for the asset instance ID.	8vb54hn2g9j191ddz
ModelIds	string	No	The model IDs of the industry templates. Separate multiple IDs with commas. Note Call DescribeTemplateAllRules to get the industry template model ID.	101
FileType	integer	No	The OSS file types that can be detected. Note Call DescribeDocTypes to get the detectable OSS file types. Use the value of the Code field in the response. This parameter applies only to queries of OSS assets.	100001
FileCategoryCode	integer	No	The file categorization code.	1
MemberAccount	integer	No	The ID of the member account.	**********8103
FeatureType	integer	No	This parameter is deprecated.	2

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The current page number in a paged query. Default: 1.	1
RequestId	string	The unique ID that Alibaba Cloud generates for this request. Use it to troubleshoot issues.	E6F6460E-4330-549A-BD89-C183FB17571E
PageSize	integer	The maximum number of data asset instances to display per page in a paged query. Default: 10.	10
TotalCount	integer	The total number of results returned by the query.	21
Items	array<object>	The list of data objects.
	array<object>	The list of data objects.
Name	string	The name of the data object.	t_sddp_selfmysql_pers0
Id	string	The unique ID of the data object.	20000
TemplateId	integer	The industry template ID.	1
ProductId	integer	The ID of the product that contains the data object. 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	5
InstanceDescription	string	The description of the data object instance.	instance description
ProductCode	string	The name of the product that contains the data object. Valid values: MaxCompute OSS ADB-MYSQL TableStore RDS SELF_DB PolarDB-X PolarDB ADB-PG OceanBase MongoDB Redis	RDS
SensitiveCount	integer	The number of sensitive data entries.	1
ObjectType	string	The type of the data object.	text type
Path	string	The path of the data object.	rm-12.db_*
RegionName	string	The region name.	cn-hangzhou
Categories	array	The list of industry categorizations for sensitive data.
	string	The list of industry categorizations for sensitive data. Separate multiple categorizations with commas.	general sensitive information
ModelTags	array<object>	The list of data tags.
	object	The list of data tags.
Id	integer	The data tag ID. Valid values: 101: Personal sensitive information. 102: Personal information. 107: General information.	101
Name	string	The data tag name. Valid values: Personal sensitive information. Personal information. General information.	Personal sensitive information
RuleList	array<object>	The list of hit detection models.
	object	The list of hit detection models.
RuleId	integer	The detection model ID.	1080
RuleName	string	The detection model name.	name
RiskLevelId	integer	The risk level ID of the sensitive data detection rule. Valid values: 1: N/A: No sensitive data detected. 2: S1: Level 1 sensitive data. 3: S2: Level 2 sensitive data. 4: S3: Level 3 sensitive data. 5: S4: Level 4 sensitive data.	2
RiskLevelName	string	The risk level name of the data asset table. Valid values: N/A: No sensitive data detected. S1: Level 1 sensitive data. S2: Level 2 sensitive data. S3: Level 3 sensitive data. S4: Level 4 sensitive data.	S1
RuleCount	integer	The number of hit detection models.	590
RuleCategoryNameList	string		”Personal information”-”ID card”
SampleList	string		["John","Jane"]
ObjectFileCategory	string	The file categorization name.	text file
MemberAccount	integer	The ID of the member account.	**********8103
LastModifiedTime	integer	The last update time of the file, in milliseconds.	1687676649830
InstanceId	string	The data asset instance ID.	rm-12*****
LastScanTime	integer	The UNIX timestamp of the last scan, in milliseconds.	1687676649830
RegionId	string	The region ID of the OSS storage object.	cn-hangzhou
Comment	string		Remarks
DataType	string		varchar
DbName	string		DataBaseName
TableName	string		tableName
RiskLevelId	integer		1
TaskId	integer		1
TaskNumber	integer		1000
TaskName	string		Task name
IsRevision	integer		-1
MaskStatus	integer		-1
FileCategoryCode	integer		1
Size	integer		1000
RuleCount	integer		10
Sx	string		1,2,3
TemplateName	string		Template name
Project	string		project
LogStore	string		logStore

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "E6F6460E-4330-549A-BD89-C183FB17571E",
  "PageSize": 10,
  "TotalCount": 21,
  "Items": [
    {
      "Name": "t_sddp_selfmysql_pers0",
      "Id": "20000",
      "TemplateId": 1,
      "ProductId": 5,
      "InstanceDescription": "instance description",
      "ProductCode": "RDS",
      "SensitiveCount": 1,
      "ObjectType": "text type",
      "Path": "rm-12**.db_***",
      "RegionName": "cn-hangzhou",
      "Categories": [
        "general sensitive information"
      ],
      "ModelTags": [
        {
          "Id": 101,
          "Name": "Personal sensitive information"
        }
      ],
      "RuleList": [
        {
          "RuleId": 1080,
          "RuleName": "name",
          "RiskLevelId": 2,
          "RiskLevelName": "S1",
          "RuleCount": 590,
          “RuleCategoryNameList”: “”Personal information”-”ID card””,
          "SampleList": "[\"John\",\"Jane\"]"
        }
      ],
      "ObjectFileCategory": "text file",
      "MemberAccount": 0,
      "LastModifiedTime": 1687676649830,
      "InstanceId": "rm-12*****",
      "LastScanTime": 1687676649830,
      "RegionId": "cn-hangzhou",
      "Comment": "Remarks",
      "DataType": "varchar",
      "DbName": "DataBaseName",
      "TableName": "tableName",
      "RiskLevelId": 1,
      "TaskId": 1,
      "TaskNumber": 1000,
      "TaskName": "Task name",
      "IsRevision": -1,
      "MaskStatus": -1,
      "FileCategoryCode": 1,
      "Size": 1000,
      "RuleCount": 10,
      "Sx": "1,2,3",
      "TemplateName": "Template name",
      "Project": "project",
      "LogStore": "logStore"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.