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

Queries the data detection results of data tables and files.

Operation description

Queries the detection results of data tables and files, allowing you to view asset data detection results from a global perspective.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If this limit is exceeded, the API call is throttled, which may affect your business. Call this operation as needed.

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 of the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English.	zh_cn
PageSize	integer	No	The maximum number of data asset instances to return per page in a paged query. Default value: 10.	10
CurrentPage	integer	No	The page number in a paged query. Default value: 1.	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: 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 OSS is included in the query, no other products can be specified. By default, non-OSS products are queried.	1,5
ParentCategoryIds	string	No	The list of parent category IDs of the templates to query, separated by commas.	234,236,238
QueryName	string	No	The keyword of the data object to query.	t_sddp_selfmysql_pers0
ServiceRegionId	string	No	The region where the asset resides. Valid values: cn-beijing: China (Beijing). cn-zhangjiakou: China (Zhangjiakou). cn-huhehaote: China (Hohhot). cn-hangzhou: China (Hangzhou). cn-shanghai: China (Shanghai). cn-shenzhen: China (Shenzhen). cn-hongkong: Hong Kong (China).	cn-hangzhou
TemplateId	integer	Yes	The industry template ID. Note You can call DescribeCategoryTemplateList to obtain the industry template ID.	1
DomainId	integer	No	The data domain ID to which the data asset belongs.	2
ModelTagIds	string	No	The data tags to query, separated by 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 values 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 of the asset instance ID.	8vb54hn2g9j191ddz
ModelIds	string	No	The model IDs of the industry template, separated by commas. Note You can call DescribeTemplateAllRules to obtain the industry template model IDs.	101
FileType	integer	No	The OSS file type supported for detection. Note You can call DescribeDocTypes to obtain the supported OSS file types. Use the Code field value from the response. This parameter is valid only for OSS asset queries.	100001
FileCategoryCode	integer	No	The file category code.	1
MemberAccount	integer	No	The member accounts ID.	**********8103
FeatureType	integer	No	[Deprecated] This parameter is deprecated.	2
APIVersion	integer	No	The identifier used for canary release evaluation.	1
RegionId	string	No	The region of the data catalog display page.	cn-zhangjiakou
ProductId	integer	No	The product of the data catalog.	5
RuleIds	string	No	The rule filter.	1,2,3
RiskLevelIdList	string	No	The risk level filter.	1,2,3
TableName	string	No	The task name filter.	TableName
DbName	string	No	The database name filter.	dataBaseName
TaskId	integer	No	The task ID filter.	1
Bucket	string	No	The OSS bucket filter.	bucketName
Project	string	No	The SLS project filter.	project
LogStore	string	No	The SLS Logstore filter.	logstore
LogStoreFlag	integer	No	The data catalog SLS page has two layers. This parameter indicates whether the query is at the Logstore dimension.	1
Path	string	No	The file path filter.	road
EngineType	string	No
Cursor	string	No	The facet dimension for associated filtering in the data catalog. Valid values: rule (category), task (task), instance (instance), and db (database). If this parameter is not specified or is empty, the original list and count query is performed (behavior unchanged). If a valid value is specified, the list query is skipped and only content.hitValues is returned. If an invalid value is specified, a parameter error is returned.	instance
CursorDirection	string	No	Specifies whether to filter revision items.	0
		No
		No

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The page number of the current page in a paged query. Settings for paging. Default value: 1.	1
RequestId	string	The ID of the request. The ID is a unique identifier that Alibaba Cloud generates for the request and can be used to troubleshoot issues.	E6F6460E-4330-549A-BD89-C183FB17571E
PageSize	integer	The maximum number of data asset instances to return per page in a paged query. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	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 that corresponds to the product name to which the data object belongs. Valid values: 1: MaxCompute 2: OSS 3: ADB-MYSQL 4: TableStore 5: RDS 6: SELF_DB 7: PolarDB-X 8: PolarDB 9: ADB-PG 10: OceanBase 11: MongoDB 25: Redis	5
InstanceDescription	string	The instance description of the data object.	instance description
ProductCode	string	The product name to which the data object belongs. 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 object 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 categories to which the sensitive data belongs.
	string	The list of industry categories to which the sensitive data belongs. Multiple categories are separated by commas.	general sensitive information
ModelTags	array<object>	The list of data labels.
	object	The list of data labels.
Id	integer	The data label ID. Valid values: 101: Personal sensitive information. 102: Personal information. 107: General information.	101
Name	string	The data label name. Valid values: Personal sensitive information. Personal information. General information.	Personal sensitive information
RuleList	array<object>	The list of matched detection models.
	object	The list of matched 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 is 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 is 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 matched detection models.	590
RuleCategoryNameList	string	The rule information described from the top to the bottom of the template.	Personal sensitive information-ID card
SampleList	string	The sample data.	["Lucy"，"Tom"]
ObjectFileCategory	string	The file category name.	text file
MemberAccount	integer	The member accounts ID.	**********8103
LastModifiedTime	integer	The last modification time of the file, in milliseconds.	1687676649830
InstanceId	string	The data asset instance ID.	rm-12*****
LastScanTime	integer	The timestamp of the last scan, in milliseconds.	1687676649830
RegionId	string	The region ID to which the data object belongs.	cn-hangzhou
Comment	string	The column comment.	comment
DataType	string	The database column type.	varchar
EngineType	string	The engine type.	TABLE
DbName	string	The database name.	DataBaseName
TableName	string	The table name.	tableName
RiskLevelId	integer	The sensitivity level.	1
TaskId	integer	The task ID.	1
TaskNumber	integer	The user task number.	1000
TaskName	string	The task name.	test-task
IsRevision	integer	The revision status.	-1
MaskStatus	integer	The column encryption status.	-1
FileCategoryCode	integer	The file type.	1
Size	integer	The file size.	1000
RuleCount	integer	The number of matched rules.	10
Sx	string	The array that consists of the number of rules matched at each sensitivity level, in the format "S1,S2,S3,S4,S5,S6,S7,S8,S9,S10", where S1 represents the number of rules matched at sensitivity level S1.	1,2,3,0,0,0,0,5,0,0
TemplateName	string	The template name.	test
Project	string	The Simple Log Service (SLS) project.	project
LogStore	string	The SLS Logstore.	logStore
ClusterType	string
HitValues	array	The associate filter values used to return filtered values.	["linxiu","sddptest"]
	string	The first value matched by the root node.	linxiu
SyncStatus	string
PreviousCursor	string
NextCursor	string
HasPrevious	boolean
HasNext	boolean
ErrorCode	string
ErrorMessage	string

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 sensitive information-ID card",
          "SampleList": "[\"Lucy\"，\"Tom\"]"
        }
      ],
      "ObjectFileCategory": "text file",
      "MemberAccount": 0,
      "LastModifiedTime": 1687676649830,
      "InstanceId": "rm-12*****",
      "LastScanTime": 1687676649830,
      "RegionId": "cn-hangzhou",
      "Comment": "comment",
      "DataType": "varchar",
      "EngineType": "TABLE",
      "DbName": "DataBaseName",
      "TableName": "tableName",
      "RiskLevelId": 1,
      "TaskId": 1,
      "TaskNumber": 1000,
      "TaskName": "test-task",
      "IsRevision": -1,
      "MaskStatus": -1,
      "FileCategoryCode": 1,
      "Size": 1000,
      "RuleCount": 10,
      "Sx": "1,2,3,0,0,0,0,5,0,0",
      "TemplateName": "test",
      "Project": "project",
      "LogStore": "logStore",
      "ClusterType": ""
    }
  ],
  "HitValues": [
    "linxiu"
  ],
  "SyncStatus": "",
  "PreviousCursor": "",
  "NextCursor": "",
  "HasPrevious": false,
  "HasNext": false,
  "ErrorCode": "",
  "ErrorMessage": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.