All Products
Search
Document Center

Data Security Center:DescribeColumns

Last Updated:Jan 08, 2024

Queries data in the columns of the tables that Data Security Center (DSC) is authorized to access. The tables include the tables of MaxCompute and ApsaraDB RDS.

Operation description

You can call this operation to query the data in columns of a table that may contain sensitive data. This helps you analyze sensitive data.

Precautions

The DescribeColumns operation is changed to DescribeColumnsV2. We recommend that you call the DescribeColumnsV2 operation when you develop your applications.

Limits

Each Alibaba Cloud account can call this operation up to 10 times per second. 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

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

Debug

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 enter test, all columns whose names contain test are retrieved.

test
TableIdlongNo

The ID of the table to which the column belongs.

Note You can call the DescribeTables operation to query the IDs of tables.
11132334
RuleIdlongNo

The ID of the sensitive data detection rule that data in the column of the table hits.

Note You can call the DescribeRules operation to query the IDs of sensitive data detection rules.
11111
ProductCodestringNo

The name of the service to which data in the column of the table belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS.

MaxCompute
InstanceIdlongNo

The ID of the instance to which data in the column of the table belongs.

Note You can call the DescribeInstances operation to query the IDs of instances.
1
InstanceNamestringNo

The name of the instance to which data in the column of the table belongs.

rm-bp17t1htja573l5i8****
TableNamestringNo

The name of the table.

it_table
RuleNamestringNo

The name of the sensitive data detection rule that data in the column of the table hits.

ID card number (the Chinese mainland)
SensLevelNamestringNo

The name of the sensitivity level of the data that hits the sensitive data detection rule. Valid values:

  • N/A: 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
PageSizeintegerNo

The number of entries to return on each page.

10
CurrentPageintegerNo

The page number of the page to return.

1
RiskLevelIdlongNo

The sensitivity level of the sensitive data that hits the sensitive data detection rule. Valid values:

  • 1: N/A
  • 2: S1
  • 3: S2
  • 4: S3
  • 5: S4
2

Response parameters

ParameterTypeDescriptionExample
object
CurrentPageinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

769FB3C1-F4C9-4******
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of entries returned.

12
Itemsobject []

A list of columns.

CreationTimelong

The time when the data in the column of the table is created. Unit: milliseconds.

1536751124000
TableNamestring

The name of the table to which the revised column belongs.

it_table
DataTypestring

The type of data in the column of the table.

String
OdpsRiskLevelValueinteger

The ID of the sensitivity level of the asset. Valid values:

  • 1: N/A
  • 2: S1
  • 3: S2
  • 4: S3
  • 5: S4
3
InstanceIdlong

The ID of the instance to which data in the column of the table belongs.

1
RiskLevelIdlong

The ID of the sensitivity level of data in the column of the table. Valid values:

  • 1: N/A
  • 2: S1
  • 3: S2
  • 4: S3
  • 5: S4
2
RuleNamestring

The name of the sensitive data detection rule that data in the column of the table hits.

\*\* rule
RuleIdlong

The ID of the sensitive data detection rule that data in the column of the table hits.

1
Sensitiveboolean

Indicates whether the column contains sensitive data. Valid values:

  • true
  • false
false
SensLevelNamestring

The name of the sensitivity level. 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
InstanceNamestring

The name of the instance to which data in the column of the table belongs.

rm-bp17t1htja573l5i8****
RiskLevelNamestring

The name of the sensitivity level for data in the column of 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
OdpsRiskLevelNamestring

The name of the sensitivity level for asset. 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.
S3
Namestring

The name of the column of the table.

gxdata
TableIdlong

The ID of the table.

123
Idstring

The ID of the column of the table.

268
ProductCodestring

The name of the service to which data in the column of the table belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS.

MaxCompute
RevisionStatuslong

Indicates whether the column is revised. Valid values:

  • 1: yes
  • 0: no
1
RevisionIdlong

The ID of the revision record.

12
ModelTagsobject []

A list of tags for data that hits the recognition model.

Idlong

The tag ID.

  • 101: sensitive personal information
  • 102: personal information
  • 103: important information
101
Namestring

The tag name.

  • Sensitive personal information
  • Personal information
  • Important information
personal sensitive data

Examples

Sample success responses

JSONformat

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-4******",
  "PageSize": 10,
  "TotalCount": 12,
  "Items": [
    {
      "CreationTime": 1536751124000,
      "TableName": "it_table",
      "DataType": "String",
      "OdpsRiskLevelValue": 3,
      "InstanceId": 1,
      "RiskLevelId": 2,
      "RuleName": "\\*\\* rule\n",
      "RuleId": 1,
      "Sensitive": false,
      "SensLevelName": "S2",
      "InstanceName": "rm-bp17t1htja573l5i8****",
      "RiskLevelName": "S2",
      "OdpsRiskLevelName": "S3",
      "Name": "gxdata",
      "TableId": 123,
      "Id": "268",
      "ProductCode": "MaxCompute",
      "RevisionStatus": 1,
      "RevisionId": 12,
      "ModelTags": [
        {
          "Id": 101,
          "Name": "personal sensitive data"
        }
      ]
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history