Queries data assets such as MaxCompute, ApsaraDB RDS, and Object Storage Service (OSS) that you authorize Data Security Center (DSC) to access.

Operation description

When you call the DescribeInstances operation, you can specify parameters such as Name and RiskLevelId to query data assets that meet filter conditions.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sddp:DescribeInstances	get	All Resources *	none	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: Simplified Chinese en_us: English	zh_cn
Name	string	No	The keyword that is used to search for data assets. DSC searches for data assets based on the keyword that you specify in fuzzy match mode. For example, if you specify data, all data assets whose names contain data are queried.	data
ProductId	long	No	The ID of the service to which the data asset belongs. You can call the DescribeDataAssets operation to query the ID of the service.	1
RiskLevelId	long	No	The sensitivity level ID of the data asset. A higher sensitivity level indicates that the identified data is more sensitive. Valid values: 1: No sensitive data is identified. 2: sensitive data at level 1. 3: sensitive data at level 2. 4: sensitive data at level 3 5: sensitive data at level 4. 6: sensitive data at level 5. 7: sensitive data at level 6. 8: sensitive data at level 7. 9: sensitive data at level 8. 10: sensitive data at level 9. 11: sensitive data at level 10.	2
RuleId	long	No	The ID of the sensitive data detection rule that the data asset hits. You can call the DescribeRules operation and obtain the ID of the sensitive data detection rule from the Id response parameter.	1111111
ServiceRegionId	string	No	The region where the data asset resides. For more information, see Supported regions.	cn-hangzhou
FeatureType	integer	No	This parameter is deprecated.	1
ProductCode	string	No	The name of the service to which the data asset belongs, such as MaxCompute, OSS, and ApsaraDB RDS. For more information about the types of data assets from which DSC can scan for sensitive data, see Supported data assets.	RDS
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1

Response parameters

Parameter	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 per page.	10
TotalCount	integer	The total number of data assets.	231
Items	array<object>	An array that consists of the data assets.
Instance	object
CreationTime	long	The time when the data asset was created. The value is a UNIX timestamp. Unit: milliseconds.	1637226782000
LastFinishTime	long	The time when the data asset was last scanned. The value is a UNIX timestamp. Unit: milliseconds.	1637622793000
Owner	string	The Alibaba Cloud account to which the data asset belongs.	dtdep-239-******
TenantName	string	The name of the tenant.	Tenant 1
Protection	boolean	The protection status of the data asset. Valid values: true: The data asset is being protected. false: The data asset is not protected.	false
DepartName	string	The name of the department to which the data asset belongs.	***DemoCenter
Labelsec	boolean	The security status of the data asset. Valid values: true: The data asset is secure. false: The data asset is insecure.	true
RiskLevelId	long	The ID of the sensitivity level for the data asset. A higher sensitivity level ID indicates that the identified data is more sensitive. 1: No sensitive data is detected. 2: sensitive data at level 1. 3: sensitive data at level 2. 4: sensitive data at level 3. 5: sensitive data at level 4. 6: sensitive data at level 5. 7: sensitive data at level 6. 8: sensitive data at level 7. 9: sensitive data at level 8. 10: sensitive data at level 9. 11: sensitive data at level 10.	2
ProductId	string	The ID of the service to which the data asset belongs.	5
Name	string	The name of the data asset.	gxdata
TotalCount	integer	The total number of data objects in the data asset. For example, if the data asset is an ApsaraDB RDS instance, the value indicates the total number of tables in all databases of the instance.	231
InstanceDescription	string	The description of the data asset.	Data asset Information 1
RuleName	string	The name of the sensitive data detection rule that the data asset hits.	\\\* rule
Sensitive	boolean	Indicates whether the data asset contains sensitive data. Valid values: true false	true
RiskLevelName	string	The name of the sensitivity level for the data asset.	Sensitive data at level 1
OdpsRiskLevelName	string	This parameter is deprecated.	1
SensitiveCount	integer	The number of sensitive data objects in the data asset. For example, if the data asset is an ApsaraDB RDS instance, the value indicates the number of sensitive tables in all databases of the instance.	123
Id	long	The unique ID of the data asset in DSC.	11111
ProductCode	string	The name of the service to which the data asset belongs, such as MaxCompute, OSS, and ApsaraDB RDS. For more information about the types of data assets that DSC can scan to detect sensitive data, see Supported data assets.	RDS
ModelTags	array<object>	A list of tags.
modelTags	object
Id	long	The ID of the tag. Valid values: 101: personal sensitive information 102: personal information 107: general information	101
Name	string	The name of the tag. Valid values: Personal sensitive information Personal information General information	personal sensitive data

Examples

Sample success responses

JSONformat

{
  "CurrentPage": 1,
  "RequestId": "71064826-726F-4ADA-B879-05D8055476FB",
  "PageSize": 10,
  "TotalCount": 231,
  "Items": [
    {
      "CreationTime": 1637226782000,
      "LastFinishTime": 1637622793000,
      "Owner": "dtdep-239-******",
      "TenantName": "Tenant 1\n",
      "Protection": false,
      "DepartName": "***DemoCenter",
      "Labelsec": true,
      "RiskLevelId": 2,
      "ProductId": "5",
      "Name": "gxdata",
      "TotalCount": 231,
      "InstanceDescription": "Data asset Information 1\n",
      "RuleName": "\\*\\*\\* rule\n",
      "Sensitive": true,
      "RiskLevelName": "Sensitive data at level 1\n",
      "OdpsRiskLevelName": "1",
      "SensitiveCount": 123,
      "Id": 11111,
      "ProductCode": "RDS",
      "ModelTags": [
        {
          "Id": 101,
          "Name": "personal sensitive data"
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-18	The response structure of the API has changed	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details