Queries the columns of tables in instances, such as MaxCompute projects and ApsaraDB RDS instances, that you authorize Data Security Center (DSC) to access.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeColumns

The operation that you want to perform. Set the value to DescribeColumns.

Lang String No zh

The natural language of the request and response. Valid values:

  • zh: Chinese
  • en: English

Default value: en.

Name String No test

The keyword that is used to filter tables. DSC retrieves tables based on the keyword that you enter in fuzzy match mode.

For example, if you enter test, all tables whose names contain test are retrieved.

TableId Long No 11132334

The unique ID of the MaxCompute or ApsaraDB RDS table to which the columns belong.

Note You can query the columns of a specific table in instances that you authorize DSC to access based on the table ID. To query the ID of a table, call the DescribeTables operation.
RuleId Long No 11111

The unique ID of the sensitive data detection rule that the columns hit.

Note You can query the columns of tables in instances that you authorize DSC to access based on the ID of a sensitive data detection rule. To query the ID of a sensitive data detection rule, call the DescribeRules operation.
ProductCode String No MaxCompute

The name of the service to which the columns belong. Valid values: MaxCompute, Object Storage Service (OSS), and ApsaraDB RDS.

InstanceId Long No 1

The ID of the instance to which the columns belong.

Note You can query the columns of tables in a specific instance that you authorize DSC to access based on the instance ID. To query the ID of an instance, call the DescribeInstances operation.
InstanceName String No rm-bp17t1htja573l5i8****

The name of the instance to which the columns belong.

TableName String No it_table

The name of the table.

RuleName String No ID card number (mainland China)

The name of the sensitive data detection rule that the columns hit.

SensLevelName String No S2

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

  • S1: low risk level
  • S2: medium risk level
  • S3: high risk level
  • S4: highest risk level
PageSize Integer No 10

The number of entries to return on each page.

CurrentPage Integer No 1

The number of the page to return.

RiskLevelId Long No 2

The risk level ID of the column that hits the sensitive data detection rule. Valid values:

  • 1: S1, indicating the low risk level
  • 2: S2, indicating the medium risk level
  • 3: S3, indicating the high risk level
  • 4: S4, indicating the highest risk level

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
CurrentPage Integer 1

The page number of the returned page.

Items Array of Column

The list of columns that were queried.

CreationTime Long 1536751124000

The time when the column was created. This value is a UNIX timestamp that represents the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

DataType String String

The data type of the column.

Id String 268

The unique ID of the column.

InstanceId Long 1

The ID of the instance to which the column belongs.

InstanceName String rm-bp17t1htja573l5i8****

The name of the instance to which the column belongs.

Name String gxdata

The name of the column.

OdpsRiskLevelName String S3

The risk level of the table. Valid values:

  • S1: low risk level
  • S2: medium risk level
  • S3: high risk level
  • S4: highest risk level
OdpsRiskLevelValue Integer 3

The risk level ID of the column. Valid values:

  • 1: S1, indicating the low risk level
  • 2: S2, indicating the medium risk level
  • 3: S3, indicating the high risk level
  • 4: S4, indicating the highest risk level
ProductCode String MaxCompute

The name of the service to which the column belongs. Valid values: MaxCompute, OSS, and ApsaraDB RDS.

RevisionId Long 12

The ID of the revision record.

RevisionStatus Long 1

The revision status. Valid values:

  • 1: revised
  • 0: unrevised
RiskLevelId Long 2

The risk level ID of the column. Valid values:

  • 1: S1, indicating the low risk level
  • 2: S2, indicating the medium risk level
  • 3: S3, indicating the high risk level
  • 4: S4, indicating the highest risk level
RiskLevelName String S2

The risk level of the column. Valid values:

  • S1: low risk level
  • S2: medium risk level
  • S3: high risk level
  • S4: highest risk level
RuleId Long 1

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

RuleName String ** rule

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

SensLevelName String S2

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

  • S1: low risk level
  • S2: medium risk level
  • S3: high risk level
  • S4: highest risk level
Sensitive Boolean false

Indicates whether the column contains sensitive data. Valid values:

  • true: the column contains sensitive data.
  • false: the column does not contain sensitive data.
TableId Long 123

The ID of the table to which the column belongs.

TableName String it_table

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

PageSize Integer 10

The number of entries returned per page.

RequestId String 769FB3C1-F4C9-4******

The ID of the request.

TotalCount Integer 12

The total number of returned entries.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeColumns
&<Common request parameters>

Sample success responses

XML format

<DescribeColumnsResponse>
      <RequestId>769FB3C1-F4C9-4******</RequestId>
      <TotalCount>4</TotalCount>
      <PageSize>10</PageSize>
      <CurrentPage>1</CurrentPage>
      <Items>
            <Owner>dtdep-239-***</Owner>
            <ProductCode>RDS</ProductCode>
            <RiskLevelId>2</RiskLevelId>
            <RiskLevelName>S2</RiskLevelName>
            <DepartName>***DemoCenter</DepartName>
            <Name>gxdata</Name>
            <CreationTime>1536751124000</CreationTime>
            <Sensitive>true</Sensitive>
            <Id>268</Id>
            <RuleId>1</RuleId>
            <RuleName>** rule</RuleName>
            <InstanceId>1</InstanceId>
            <TableId>123</TableId>
      </Items>
</DescribeColumnsResponse>

JSON format

{
    "RequestId":"769FB3C1-F4C9-4******",
    "TotalCount":4,
    "PageSize":10,
    "CurrentPage":1,
    "Items":[
        {
            "Owner":"dtdep-239-***", 
            "ProductCode":"RDS",
            "RiskLevelId":2,
            "RiskLevelName":"S2", 
            "DepartName":"***DemoCenter", 
            "Name":"gxdata", 
            "CreationTime":1536751124000, 
            "Sensitive":true, 
            "Id":268,
            "RuleId":1,
            "RuleName":"** rule",
            "InstanceId":1,
            "TableId":123
        }
    ]
}

Error codes

For a list of error codes, visit the API Error Center.