Use DescribeColumns to query column data of data assets - Data Security Center - Alibaba Cloud - Data Security Center

Queries column data in data asset tables, such as MaxCompute and ApsaraDB RDS tables, that are authorized for connection by Data Security Center.

Operation description

This operation is used to view column data in sensitive data asset tables, which helps you accurately analyze sensitive data.

Notes

The DescribeColumns operation has been revised to DescribeColumnsV2. Use the newer version DescribeColumnsV2 when developing applications.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation at a reasonable frequency.

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

get

*All Resource

*

acs:ResourceGroupId

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 keyword to search for. Fuzzy match is supported. For example, if you enter test, all data entries that contain test in the search fields are returned.	test
TableId	integer	No	The unique ID of the data asset table to which the columns belong in MaxCompute, ApsaraDB RDS, or other assets. Note Queries column data in data asset tables authorized for connection by Data Security Center based on the table ID. You can call the DescribeTables operation to obtain the table ID.	11132334
RuleId	integer	No	The unique ID of the sensitive data detection rule that the column data matches. Note Queries column data in data asset tables authorized for connection by Data Security Center based on the ID of the sensitive data detection rule that the column data matches. You can call the DescribeRules operation to obtain the rule ID.	11111
ProductCode	string	No	The name of the product to which the column data in the data asset table belongs. Valid values: MaxCompute, OSS, ADS, OTS, RDS, and others.	MaxCompute
InstanceId	integer	No	The ID of the asset instance to which the column data in the data asset table belongs. Note Queries column data in data asset tables authorized for connection by Data Security Center based on the asset instance ID. You can call the DescribeInstances operation to obtain the instance ID.	1
InstanceName	string	No	The name of the asset instance to which the column data in the data asset table belongs.	rm-bp17t1htja573l5i8****
TableName	string	No	The name of the data asset table.	it_table
RuleName	string	No	The name of the sensitive data detection rule that the column data in the data asset table matches.	name
SensLevelName	string	No	The sensitivity level name. 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
PageSize	integer	No	The maximum number of entries per page.	10
CurrentPage	integer	No	The page number for a paged query.	1
RiskLevelId	integer	No	The risk level ID of the sensitive data detection rule. Valid values: 1: N/A. 2: S1. 3: S2. 4: S3. 5: S4.	2
TemplateRuleId	string	No	The ID of the matched template rule. Note You can call the DescribeCategoryTemplateRuleList operation to obtain the matched template rule ID.	1542
EngineType	string	No	The database engine type. Valid values: MySQL MariaDB Oracle PostgreSQL SQLServer	MySQL
ProductId	string	No	The ID that corresponds to the product name to which the data object belongs. Valid values: 1: MaxCompute 2: OSS 3: ADB-MYSQL 4: TableStore 5: RDS 6: SELF_DB 7: PolarDB-X 8: PolarDB 9: ADB-PG 10: OceanBase 11: MongoDB 25: Redis	5
ModelTagId	string	No	The data tag. 101: personal sensitive information 102: personal information	101
TemplateId	string	No	The industry template ID. Note You can call the DescribeCategoryTemplateList operation to obtain the industry template ID.	5
ServiceRegionId	string	No		cn-zhangjiakou

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The page number of the current page in the results.	1
RequestId	string	The request ID.	769FB3C1-F4C9-4******
PageSize	integer	The number of entries per page in the results.	10
TotalCount	integer	The total number of entries in the results.	12
Items	array<object>	The column data in the data asset tables.
	array<object>
CreationTime	integer	The creation time of the column data in the data asset table. The value is a timestamp in milliseconds.	1536751124000
TableName	string	The name of the table to which the revised target column belongs.	it_table
DataType	string	The data type of the column data in the data asset table.	String
OdpsRiskLevelValue	integer	The risk level code of the asset. Valid values: 1: N/A. 2: S1. 3: S2. 4: S3. 5: S4.	3
InstanceId	integer	The instance ID of the asset to which the column data in the data asset table belongs.	1
RiskLevelId	integer	The risk level ID of the column data in the data asset 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 the column data in the data asset table matches.	name
RuleId	integer	The ID of the sensitive data detection rule that the column data in the data asset table matches.	1
Sensitive	boolean	Indicates whether the column data in the data asset table contains sensitive data. Valid values: true: The column data contains sensitive data. false: The column data does not contain sensitive data.	false
SensLevelName	string	The sensitivity level name. 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
InstanceName	string	The name of the asset instance to which the column data in the data asset table belongs.	rm-bp17t1htja573l5i8****
RiskLevelName	string	The risk level name of the column data in 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
OdpsRiskLevelName	string	The risk level name of the asset. 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.	S3
Name	string	The name of the column in the data asset table.	gxdata
TableId	integer	The ID of the data asset table to which the column data belongs.	123
Id	string	The unique ID of the column in the data asset table.	268
ProductCode	string	The name of the product to which the column data in the data asset table belongs. Valid values: MaxCompute, OSS, ADS, OTS, RDS, and others.	MaxCompute
RevisionStatus	integer	The revision status. Valid values: 1: Revised. 0: Not revised.	1
RevisionId	integer	The revision record ID.	12
ModelTags	array<object>	The list of data tags for the matched detection model.
	object	The data tag object for the matched detection model.
Id	integer	The data tag ID of the detection model. 101: Personal sensitive information. 102: Personal information. 103: Important data.	101
Name	string	The data tag name of the detection model. Personal sensitive information. Personal information. Important data.	personal sensitive data
RegionId	string	The region where the asset resides.	cn-***
EngineType	string	The database engine type.	MySQL
MaskingStatus	integer	The encryption status of the column. Valid values: -1: Not encrypted. 1: Encryption succeeded. 2: Encryption failed.	-1
ProductId	integer	The ID that corresponds to the product name to which the data object belongs. Valid values: 1: MaxCompute 2: OSS 3: ADB-MYSQL 4: TableStore 5: RDS 6: SELF_DB 7: PolarDB-X 8: PolarDB 9: ADB-PG 10: OceanBase 11: MongoDB 25: Redis	5

Examples

Success response

JSON format

{
  "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": "name",
      "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"
        }
      ],
      "RegionId": "cn-***",
      "EngineType": "MySQL",
      "MaskingStatus": -1,
      "ProductId": 5
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.