All Products
Search
Document Center

Data Security Center:DescribeTables

Last Updated:Feb 27, 2024

Queries tables in data assets, such as MaxCompute projects and ApsaraDB RDS instances, that you authorize Data Security Center (DSC) 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the content within the request and response. Default value: zh_cn. Valid values:

  • zh_cn: Chinese
  • en_us: English
zh_cn
NamestringNo

The search keyword. Fuzzy match is supported. For example, if you specify test, all tables whose names contain test are retrieved.

test
ProductIdlongNo

The ID of the service to which the table belongs. You can call the DescribeDataAssets operation to obtain the ID of the service.

1
ProductCodestringNo

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
RiskLevelIdlongNo

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
RuleIdlongNo

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
InstanceIdlongNo

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
PackageIdlongNo

The ID of the package to which the table belongs. You can call the DescribePackages operation to obtain the ID of the package.

555555
PageSizeintegerNo

The number of entries to return on each page. Default value: 10.

10
CurrentPageintegerNo

The page number of the page to return. Default value: 1.

1
ServiceRegionIdstringNo

The region in which DSC is activated. For more information, see Supported regions.

cn-hangzhou
TemplateIdlongNo

The ID of the industry-specific rule template.

1

Response parameters

ParameterTypeDescriptionExample
object
CurrentPageinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

769FB3C1-F4C9-42DF-9B72-7077A8989C13
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of entries returned.

13
Itemsobject []

An array that consists of tables.

CreationTimelong

The point in time when the table was created. Unit: milliseconds.

1536751124000
Ownerstring

The Alibaba Cloud account to which the table belongs.

dtdep-239-******
SensitiveRatiostring

The percentage of sensitive fields in the table.

21%
TenantNamestring

The name of the tenant.

Tenant 1
RiskLevelIdlong

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
InstanceNamestring

The name of the data asset to which the table belongs.

Data Asset 1
ProductIdstring

The ID of the service to which the table belongs.

1
Namestring

The name of the table.

gxdata
InstanceIdlong

The ID of the data asset to which the table belongs.

1
TotalCountinteger

The total number of fields in the table.

1234
InstanceDescriptionstring

The description of the data asset.

Description 1
Sensitiveboolean

Indicates whether the table contains sensitive fields. Valid values:

  • true: yes
  • false: no
true
RiskLevelNamestring

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
SensitiveCountinteger

The total number of sensitive fields in the table.

32
Idlong

The ID of the table.

222
ProductCodestring

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
RuleListobject []

The information about the sensitive data detection rules that are hit.

Namestring

The name of the rule.

Rule name
RiskLevelIdlong

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
Countlong

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 timeSummary of changesOperation
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-06The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.