DescribeColumns - Data Security Center - Alibaba Cloud Documentation Center

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

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:DescribeColumns	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 enter test, all columns whose names contain test are retrieved.	test
TableId	long	No	The ID of the table to which the column belongs. Note You can call the DescribeTables operation to query the IDs of tables.	11132334
RuleId	long	No	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
ProductCode	string	No	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
InstanceId	long	No	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
InstanceName	string	No	The name of the instance to which data in the column of the table belongs.	rm-bp17t1htja573l5i8****
TableName	string	No	The name of the table.	it_table
RuleName	string	No	The name of the sensitive data detection rule that data in the column of the table hits.	ID card number (the Chinese mainland)
SensLevelName	string	No	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
PageSize	integer	No	The number of entries to return on each page.	10
CurrentPage	integer	No	The page number of the page to return.	1
RiskLevelId	long	No	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

Parameter	Type	Description	Example
	object
CurrentPage	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	769FB3C1-F4C9-4******
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of entries returned.	12
Items	array<object>	A list of columns.
Column	object
CreationTime	long	The time when the data in the column of the table is created. Unit: milliseconds.	1536751124000
TableName	string	The name of the table to which the revised column belongs.	it_table
DataType	string	The type of data in the column of the table.	String
OdpsRiskLevelValue	integer	The ID of the sensitivity level of the asset. Valid values: 1: N/A 2: S1 3: S2 4: S3 5: S4	3
InstanceId	long	The ID of the instance to which data in the column of the table belongs.	1
RiskLevelId	long	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
RuleName	string	The name of the sensitive data detection rule that data in the column of the table hits.	\\ rule
RuleId	long	The ID of the sensitive data detection rule that data in the column of the table hits.	1
Sensitive	boolean	Indicates whether the column contains sensitive data. Valid values: true false	false
SensLevelName	string	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
InstanceName	string	The name of the instance to which data in the column of the table belongs.	rm-bp17t1htja573l5i8****
RiskLevelName	string	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
OdpsRiskLevelName	string	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
Name	string	The name of the column of the table.	gxdata
TableId	long	The ID of the table.	123
Id	string	The ID of the column of the table.	268
ProductCode	string	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
RevisionStatus	long	Indicates whether the column is revised. Valid values: 1: yes 0: no	1
RevisionId	long	The ID of the revision record.	12
ModelTags	array<object>	A list of tags for data that hits the recognition model.
modelTags	object
Id	long	The tag ID. 101: sensitive personal information 102: personal information 103: important information	101
Name	string	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 time	Summary of changes	Operation
2024-08-16	The request parameters of the API has changed. The response structure of the API has changed	View Change Details