DescribeDataAssets - Data Security Center - Alibaba Cloud Documentation Center

Searches for data assets on the Overview page of Data Security Center (DSC).

Operation description

This operation is typically used to query data assets of different types on the overview page of DSC.

Usage notes

This operation is deprecated and no longer maintained.

QPS limit

The queries per second (QPS) limit for a single user is 10 calls per second. If you exceed this limit, API calls are throttled. This may affect your business. Plan your calls accordingly.

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:DescribeDataAssets

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
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)	zh_cn
Name	string	No	The keyword for a fuzzy search of data assets.	test
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
RuleId	integer	No	The ID of the sensitive data detection rule that the data asset matches. Note To find data assets based on the sensitive data detection rules they match, call the DescribeRules operation to get the rule IDs.	11122200
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 database 12: AnalyticDB for MySQL table 21: OSS bucket 22: OSS object 31: Tablestore instance 32: Tablestore table 51: RDS database 52: RDS table 61: Self-managed database on an ECS instance 62: Self-managed table on an ECS instance 71: DRDS database 72: DRDS table 81: PolarDB database 82: PolarDB table 91: GPDB database 92: GPDB table	1
PageSize	integer	No	The number of entries to return on each page. The default value is 20.	20
CurrentPage	integer	No	The page number to return.	1

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	71064826-726F-4ADA-B879-05D8055476FB
PageSize	integer	The number of entries returned on each page.	20
TotalCount	integer	The total number of data assets that contain sensitive data.	1
Items	array<object>	An array of data assets.
	object
Acl	string	The access control list (ACL) of the OSS bucket. Note This parameter is returned only when RangeId is 21 (OSS buckets).	private
CreationTime	integer	The time when the data asset was created. The value is a UNIX timestamp in milliseconds.	1536751124000
DataType	string	The type of the data asset.	OSS_BUCKET
Owner	string	The owner of the data asset.	dtdep-239-******
SensitiveRatio	string	The percentage of sensitive data in the data asset.	45%
Protection	boolean	Indicates whether data protection is enabled. This is a static field and is returned only when RangeId is 1 (MaxCompute projects). false: Data protection is disabled. true: Data protection is enabled. Data can only flow into the project, not out of it.	false
Labelsec	boolean	The sensitivity level of the data. This is a static field and is returned only when RangeId is 1 (MaxCompute projects). 0: Unclassified 1: Confidential 2: Sensitive 3: Highly sensitive	0
TotalCount	integer	The total number of items in the data asset. For example, the total number of projects, packages, or tables in MaxCompute, the total number of databases or tables in RDS, or the total number of buckets or objects in OSS.	432
RiskLevelId	integer	The ID of the risk level. A larger value indicates a higher risk level. Valid values: 1: No sensitive data detected 2: Level 1 3: Level 2 4: Level 3 5: Level 4 6: Level 5 7: Level 6 8: Level 7 9: Level 8 10: Level 9 11: Level 10	2
RuleName	string	The name of the sensitive data detection rule that the data asset matches.	***规则
Sensitive	boolean	Indicates whether the data asset contains sensitive data. Valid values: true: Yes false: No	true
ObjectKey	string	The key of the OSS object. Note This parameter is returned only when RangeId is 22 (OSS objects).	内部
RiskLevelName	string	The name of the risk level.	中等风险等级
OdpsRiskLevelName	string	The name of the risk level for the MaxCompute data asset. Valid values: S1: Low S2: Medium S3: High S4: Highest Note This parameter is returned only when `RangeId` is `1` (MaxCompute projects).	S4
ProductId	string	The ID of the service to which the data asset belongs. Valid values: 1: MaxCompute 2: OSS 3: AnalyticDB for MySQL 4: Tablestore 5: RDS	5
Name	string	The name of the data asset.	gxdata
SensitiveCount	integer	The total number of sensitive items in the data asset. For example, the total number of sensitive projects, packages, or tables in MaxCompute, the total number of sensitive databases or tables in RDS, or the total number of sensitive buckets or objects in OSS.	24
Id	string	The ID of the data asset.	268
ProductCode	string	The code of the service to which the data asset belongs.	RDS

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "71064826-726F-4ADA-B879-05D8055476FB",
  "PageSize": 20,
  "TotalCount": 1,
  "Items": [
    {
      "Acl": "private",
      "CreationTime": 1536751124000,
      "DataType": "OSS_BUCKET",
      "Owner": "dtdep-239-******",
      "SensitiveRatio": "45%",
      "Protection": false,
      "Labelsec": true,
      "TotalCount": 432,
      "RiskLevelId": 2,
      "RuleName": "***规则",
      "Sensitive": true,
      "ObjectKey": "内部",
      "RiskLevelName": "中等风险等级",
      "OdpsRiskLevelName": "S4",
      "ProductId": "5",
      "Name": "gxdata",
      "SensitiveCount": 24,
      "Id": "268",
      "ProductCode": "RDS"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.