Queries tables in data assets such as MaxCompute projects and ApsaraDB RDS instances that Data Security Center (DSC) is authorized to access.

Operation description

When you call the DescribeTables operation to query tables, you can specify parameters such as Name and RiskLevelId to filter tables.

Limits

You can send up to 10 requests per second to call this operation by using your Alibaba Cloud account. If you send excessive requests, throttling is implemented, and your business may be affected.

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:DescribeTables	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: Chinese en_us: English	zh_cn
Name	string	No	The search keyword. Fuzzy match is supported. For example, if you specify test, all tables whose names contain test are retrieved.	test
ProductId	long	No	The ID of the service to which the table belongs. You can call the DescribeDataAssets operation to obtain the ID of the service.	1
ProductCode	string	No	The name of the service to which the table belongs, such as MaxCompute, OSS, and ApsaraDB RDS. For more information about the types of data assets from which Data Security Center (DSC) can scan for sensitive data, see Supported data assets.	MaxCompute
RiskLevelId	long	No	The sensitivity level of the table. Each sensitivity level ID corresponds to a sensitivity level name. Valid values: 1: N/A, which indicates that no sensitive data is detected. 2: S1, which indicates the low sensitivity level. 3: S2, which indicates the medium sensitivity level. 4: S3, which indicates the high sensitivity level. 5: S4, which indicates the highest sensitivity level.	2
RuleId	long	No	The ID of the sensitive data detection rule that the table hits. You can call the DescribeRules operation to obtain the ID of the sensitive data detection rule.	333322
InstanceId	long	No	The ID of the data asset to which the table belongs. You can call the DescribeInstances operation to obtain the ID of the data asset.	1
PackageId	long	No	The ID of the package to which the table belongs. You can call the DescribePackages operation to obtain the ID of the package.	555555
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
CurrentPage	integer	No	The page number of the page to return. Default value: 1.	1
ServiceRegionId	string	No	The region in which DSC is activated. For more information, see Supported regions.	cn-hangzhou
TemplateId	long	No	The ID of the industry-specific rule template.	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.	769FB3C1-F4C9-42DF-9B72-7077A8989C13
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of entries returned.	13
Items	array<object>	An array that consists of tables.
Table	object
CreationTime	long	The point in time when the table was created. Unit: milliseconds.	1536751124000
Owner	string	The Alibaba Cloud account to which the table belongs.	dtdep-239-******
SensitiveRatio	string	The percentage of sensitive fields in the table.	21%
TenantName	string	The name of the tenant.	Tenant 1
RiskLevelId	long	The sensitivity level of the table. Each sensitivity level ID corresponds to a sensitivity level name. Valid values: 1: N/A, which indicates that no sensitive data is detected. 2: S1, which indicates the low sensitivity level. 3: S2, which indicates the medium sensitivity level. 4: S3, which indicates the high sensitivity level. 5: S4, which indicates the highest sensitivity level.	2
InstanceName	string	The name of the data asset to which the table belongs.	Data Asset 1
ProductId	string	The ID of the service to which the table belongs.	1
Name	string	The name of the table.	gxdata
InstanceId	long	The ID of the data asset to which the table belongs.	1
TotalCount	integer	The total number of fields in the table.	1234
InstanceDescription	string	The description of the data asset.	Description 1
Sensitive	boolean	Indicates whether the table contains sensitive fields. Valid values: true: yes false: no	true
RiskLevelName	string	The name of the sensitivity level for the table. Valid values: N/A: indicates that no sensitive data is detected. S1: indicates the low sensitivity level. S2: indicates the medium sensitivity level. S3: indicates the high sensitivity level. S4: indicates the highest sensitivity level.	S2
SensitiveCount	integer	The total number of sensitive fields in the table.	32
Id	long	The ID of the table.	222
ProductCode	string	The name of the service to which the table belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS. For more information about the types of data assets from which DSC can scan for sensitive data, see Supported data assets.	MaxCompute
RuleList	array<object>	The information about the sensitive data detection rules that are hit.
Rule	object
Name	string	The name of the rule.	Rule name
RiskLevelId	long	The sensitivity level of the sensitive data that hits the sensitive data detection rule. Valid values: 1: N/A, which indicates that no sensitive data is detected. 2: S1, which indicates the low sensitivity level. 3: S2, which indicates the medium sensitivity level. 4: S3, which indicates the high sensitivity level. 5: S4, which indicates the highest sensitivity level.	1
Count	long	The total number of rules.	12

Examples

Sample success responses

JSONformat

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989C13",
  "PageSize": 10,
  "TotalCount": 13,
  "Items": [
    {
      "CreationTime": 1536751124000,
      "Owner": "dtdep-239-******",
      "SensitiveRatio": "21%",
      "TenantName": "Tenant 1\n",
      "RiskLevelId": 2,
      "InstanceName": "Data Asset 1\n",
      "ProductId": "1",
      "Name": "gxdata",
      "InstanceId": 1,
      "TotalCount": 1234,
      "InstanceDescription": "Description 1\n",
      "Sensitive": true,
      "RiskLevelName": "S2",
      "SensitiveCount": 32,
      "Id": 222,
      "ProductCode": "MaxCompute",
      "RuleList": [
        {
          "Name": "Rule name\n",
          "RiskLevelId": 1,
          "Count": 12
        }
      ]
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
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
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details