DescribeDataObjects-阿里云帮助中心

Query data detection results for tables and files.

Operation description

This operation queries data detection results for tables and files, to provide a comprehensive view across all your assets.

QPS limit

The per-user QPS limit for this operation is 10 requests per second. If you exceed this limit, the system throttles your API calls. To prevent business disruptions, call this operation only when necessary.

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 content within the request and response. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English.	zh_cn
PageSize	integer	No	The number of data assets to return on each page. Default value: 10.	10
CurrentPage	integer	No	The page number of the returned page. Default value: 1.	1
ProductIds	string	No	The IDs of the products to which the data assets to be queried belong. You can specify multiple product IDs. Separate them with commas (,). We recommend that you specify this parameter. 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 If you want to query data assets that belong to OSS, you cannot query data assets of other products. By default, data assets of products other than OSS are queried.	1,5
ParentCategoryIds	string	No	The IDs of the parent asset categories to be queried. You can specify multiple IDs. Separate them with commas (,).	234,236,238
QueryName	string	No	The keyword of the data asset to be queried.	t_sddp_selfmysql_pers0
ServiceRegionId	string	No	The region where the data 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: China (Hong Kong)	cn-hangzhou
TemplateId	integer	Yes	The ID of the industry-specific rule template. Note You can call the DescribeCategoryTemplateList operation to obtain the ID of the industry-specific rule template.	1
DomainId	integer	No	The ID of the data domain to which the data asset belongs.	2
ModelTagIds	string	No	The data labels to be queried. You can specify multiple data labels. Separate them with commas (,). Valid values: 101: personal sensitive information 102: personal information 107: general information	101,102
RiskLevels	string	No	The sensitivity level of the data asset. You can specify multiple sensitivity levels. Separate them with commas (,). 2: S1, low sensitivity level 3: S2, medium sensitivity level 4: S3, high sensitivity level 5: S4, highest sensitivity level	2
InstanceId	string	No	The keyword of the instance ID.	8vb54hn2g9j191ddz
ModelIds	string	No	The model ID of the industry-specific rule template. You can specify multiple IDs. Separate them with commas (,). Note You can call the DescribeTemplateAllRules operation to obtain the model ID of the industry-specific rule template.	101
FileType	integer	No	The type of the OSS file. Note This parameter is valid only for querying data assets of the OSS type. You can call the DescribeDocTypes operation to obtain the supported OSS file types. Use the value of the `Code` parameter in the response.	100001
FileCategoryCode	integer	No	The code of the file category.	1
MemberAccount	integer	No	The ID of the member.	**********8103
FeatureType	integer	No	This parameter is deprecated.	2
APIVersion	integer	No	The version of the API.	1
RegionId	string	No	The region in which the data asset catalog resides.	cn-zhangjiakou
ProductId	integer	No	The ID of the product.	5
RuleIds	string	No	The IDs of the rules. You can specify multiple rule IDs. Separate them with commas (,).	1,2,3
RiskLevelIdList	string	No	The IDs of the sensitivity levels. You can specify multiple sensitivity level IDs. Separate them with commas (,).	1,2,3
TableName	string	No	The name of the table.	TableName
DbName	string	No	The name of the database.	dataBaseName
TaskId	integer	No	The ID of the task.	1
Bucket	string	No	The name of the OSS bucket.	bucketName
Project	string	No	The name of the Simple Log Service project.	project
LogStore	string	No	The name of the Logstore.	logstore
LogStoreFlag	integer	No	Specifies whether to query data at the Logstore level. The Simple Log Service data catalog has two layers. Set this parameter to 1 to query data at the Logstore level.	1
Path	string	No	The path of the file.	road

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The number of the page to return. Default value: 1.	1
RequestId	string	The unique ID of the request. Alibaba Cloud generates this ID to help you troubleshoot issues.	E6F6460E-4330-549A-BD89-C183FB17571E
PageSize	integer	The number of data asset instances to return on each page. Default value: 10.	10
TotalCount	integer	The total number of entries that match the query.	21
Items	array<object>	A list of data objects.
	array<object>	A data object.
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 ID of the industry template.	1
ProductId	integer	The ID of the product to which the data object belongs. Valid values: 1: MaxCompute 2: OSS 3: ADB-MYSQL 4: Table Store 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 asset instance.	instance description
ProductCode	string	The name of the product to which the data object belongs. Valid values: MaxCompute OSS ADB-MYSQL Table Store RDS SELF_DB PolarDB-X PolarDB ADB-PG OceanBase MongoDB Redis	RDS
SensitiveCount	integer	The number of sensitive data fields.	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 name of the region.	cn-hangzhou
Categories	array	An array of industry categories to which the sensitive data belongs.
	string	The industry classification of the sensitive data.	general sensitive information
ModelTags	array<object>	A list of data tags.
	object	A data tag.
Id	integer	The ID of the data tag. Valid values: 101: Personal sensitive information 102: Personal information 107: General information	101
Name	string	The name of the data tag. Valid values: Personal sensitive information Personal information General information	Personal sensitive information
RuleList	array<object>	A list of matched detection models.
	object	A matched detection model.
RuleId	integer	The ID of the detection model.	1080
RuleName	string	The name of the detection model.	name
RiskLevelId	integer	The ID of the risk level. 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 name of the risk level. 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 hierarchical category of the rule, from the top-level to the leaf-level category in the template.	Personal sensitive information-ID card
SampleList	string	The sample data.	["Lucy"，"Tom"]
ObjectFileCategory	string	The name of the file category.	text file
MemberAccount	integer	The ID of the member account.	**********8103
LastModifiedTime	integer	The last modification time of the file, in milliseconds.	1687676649830
InstanceId	string	The ID of the data asset instance.	rm-12*****
LastScanTime	integer	The timestamp of the last scan, in milliseconds.	1687676649830
RegionId	string	The ID of the region where the data object is located.	cn-hangzhou
Comment	string	The comment on the column.	comment
DataType	string	The data type of the database column.	varchar
DbName	string	The name of the database.	DataBaseName
TableName	string	The name of the table.	tableName
RiskLevelId	integer	The risk level.	1
TaskId	integer	The ID of the task.	1
TaskNumber	integer	The task number.	1000
TaskName	string	The name of the task.	test-task
IsRevision	integer	The revision status.	-1
MaskStatus	integer	The column encryption status.	-1
FileCategoryCode	integer	The code for the file category.	1
Size	integer	The size of the file in bytes.	1000
RuleCount	integer	The number of matched rules.	10
Sx	string	A comma-separated string that specifies the count of matched rules for each risk level. The string follows the format `S1,S2...S10`, where the value at each position represents the count for the corresponding risk level.	1,2,3,0,0,0,0,5,0,0
TemplateName	string	The name of the template.	test
Project	string	The name of the Simple Log Service (SLS) project.	project
LogStore	string	The name of the Logstore in SLS.	logStore
ClusterType	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",
      "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": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.