DescribeTables - Data Security Center - Alibaba Cloud Documentation Center

Queries tables in data assets, such as MaxCompute and RDS, that Data Security Center is authorized to access.

Operation description

When you call the DescribeTables operation, you can specify parameters, such as search keywords and threat levels, to retrieve information about specific data asset tables.

QPS limits

Each Alibaba Cloud account can call this operation up to 10 times per second. If the number of calls per second exceeds the limit, throttling is triggered. This may affect your business. We recommend that you plan your calls to avoid exceeding this limit.

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

get

*All Resource

*

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
Name	string	No	The search keyword. Fuzzy search is supported. For example, if you enter `test`, all results that contain `test` are returned.	test
ProductId	integer	No	The ID of the product to which the data asset table belongs. Call the DescribeDataAssets operation to obtain this ID.	1
ProductCode	string	No	The name of the product to which the data asset table belongs. Valid values include MaxCompute, OSS, and RDS. For more information about the supported products, see Data asset types that support sensitive data detection.	MaxCompute
RiskLevelId	integer	No	The ID of the threat level for the data asset table. Each threat level ID corresponds to a threat level name. 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
RuleId	integer	No	The ID of the sensitive data detection rule that the data asset table hits. Call the DescribeRules operation to obtain this ID.	333322
InstanceId	integer	No	The ID of the instance to which the data asset table belongs. Call the DescribeInstances operation to obtain this ID.	1
PackageId	integer	No	The ID of the package to which the data asset table belongs. Call the DescribePackages operation to obtain this ID.	555555
PageSize	integer	No	The maximum 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
ServiceRegionId	string	No	The region where Data Security Center is available. For more information, see Supported regions.	cn-hangzhou
TemplateId	integer	No	The ID of the industry-specific template.	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.	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>	A list of data asset tables.
	array<object>
CreationTime	integer	The time when the data asset table was created. The value is a UNIX timestamp. Unit: milliseconds.	1536751124000
Owner	string	The Alibaba Cloud account that owns the data asset table.	dtdep-239-******
SensitiveRatio	string	The percentage of sensitive fields in the data asset table.	21%
TenantName	string	The name of the tenant.	租户1
RiskLevelId	integer	The ID of the threat level for the data asset table. Each threat level ID corresponds to a threat level name. 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
InstanceName	string	The name of the instance.	实例1
ProductId	string	The ID of the product to which the data asset table belongs.	1
Name	string	The name of the data asset table.	gxdata
InstanceId	integer	The ID of the instance to which the data asset table belongs.	1
TotalCount	integer	The total number of fields in the data asset table.	1234
InstanceDescription	string	The description of the instance.	备注1
Sensitive	boolean	Indicates whether the data asset table contains sensitive fields. true: yes. false: no.	true
RiskLevelName	string	The name of the threat level for 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.	S2
SensitiveCount	integer	The total number of sensitive fields in the data asset table.	32
Id	integer	The unique ID of the data asset table.	222
ProductCode	string	The name of the product to which the data asset table belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS. For more information about the supported products, see Data asset types that support sensitive data detection.	MaxCompute
RuleList	array<object>	The information about the sensitive data detection rules that the data asset table hits.
	object
Name	string	The name of the rule.	规则名称
RiskLevelId	integer	The ID of the threat level for 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.	1
Count	integer	The total number of rules.	12

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989C13",
  "PageSize": 10,
  "TotalCount": 13,
  "Items": [
    {
      "CreationTime": 1536751124000,
      "Owner": "dtdep-239-******",
      "SensitiveRatio": "21%",
      "TenantName": "租户1",
      "RiskLevelId": 2,
      "InstanceName": "实例1",
      "ProductId": "1",
      "Name": "gxdata",
      "InstanceId": 1,
      "TotalCount": 1234,
      "InstanceDescription": "备注1",
      "Sensitive": true,
      "RiskLevelName": "S2",
      "SensitiveCount": 32,
      "Id": 222,
      "ProductCode": "MaxCompute",
      "RuleList": [
        {
          "Name": "规则名称",
          "RiskLevelId": 1,
          "Count": 12
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.