DescribeColumns - Data Security Center - Alibaba Cloud Documentation Center

You can call the DescribeColumns API to query column data in data asset tables, such as MaxCompute and RDS, that are authorized to connect to Data Security Center.

Operation description

This API is typically used to view column data in sensitive data asset information tables. This helps users accurately analyze sensitive data.

Notes

The DescribeColumns API has been revised and replaced by DescribeColumnsV2. Use the newer DescribeColumnsV2 version when developing applications.

QPS Limits

The single-user QPS limit for this API is 10 calls per second. If you exceed this limit, API calls will be rate-limited. This may affect your business. You should call the API reasonably.

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 type for requests and responses. The default value is zh_cn. Valid values: zh_cn: Chinese. en_us: English.	zh_cn
Name	string	No	The keyword for search. Supports fuzzy match. For example, entering test returns all data containing test.	test
TableId	integer	No	The unique ID of the asset table that contains the columns in data asset tables such as MaxCompute and RDS. Note Query column data in data asset tables authorized to connect to Data Security Center using the asset table ID. Obtain the asset table ID by calling the DescribeTables API.	11132334
RuleId	integer	No	The unique ID of the sensitive data detection rule hit by the column data in the asset table. Note Query column data in data asset tables authorized to connect to Data Security Center using the ID of the sensitive data detection rule hit by the column data in the asset table. Obtain the sensitive data detection rule ID by calling the DescribeRules API.	11111
ProductCode	string	No	The product name 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 Query column data in data asset tables authorized to connect to Data Security Center using the ID of the asset instance to which the column data in the data asset table belongs. Obtain the asset instance ID by calling the DescribeInstances API.	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 hit by the column data in the data asset table.	name
SensLevelName	string	No	Sensitivity level name. Valid values: N/A: No sensitive data 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 data entries displayed per page in the list.	10
CurrentPage	integer	No	The page number for 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 hit template rule. Note Obtain the hit template rule ID by calling DescribeCategoryTemplateRuleList.	1542
EngineType	string	No	Engine type. Valid values: MySQL. MariaDB. Oracle. PostgreSQL. SQLServer.	MySQL
ProductId	string	No	The ID corresponding 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	Data tag. 101: Personal sensitive information 102: Personal information	101
TemplateId	string	No	Industry template ID. Note Obtain the industry template ID by calling DescribeCategoryTemplateList.	5

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The page number of the current page displayed in the results.	1
RequestId	string	The request ID of the result.	769FB3C1-F4C9-4******
PageSize	integer	The number of data entries displayed per page in the results.	10
TotalCount	integer	The total number of data entries in the results.	12
Items	array<object>	Column data in the data asset table.
	array<object>
CreationTime	integer	The creation time of the column data in the data asset table, in milliseconds.	1536751124000
TableName	string	The name of the table to which the target column for correction 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 ID of the asset instance 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 hit by the column data in the data asset table.	name
RuleId	integer	The ID of the sensitive data detection rule hit by the column data in the data asset table.	1
Sensitive	boolean	Indicates whether the column data in the data asset table contains sensitive data. Valid values: true: The column data in the data asset table contains sensitive data. false: The column data in the data asset table does not contain sensitive data.	false
SensLevelName	string	Sensitivity level name. Valid values: N/A: No sensitive data 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 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 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 asset table to which the column data in the data asset table belongs.	123
Id	string	The unique ID of the column in the data asset table.	268
ProductCode	string	The product name to which the column data in the data asset table belongs. Valid values: MaxCompute, OSS, ADS, OTS, RDS, and others.	MaxCompute
RevisionStatus	integer	Correction status. Valid values: 1: Corrected. 0: Not corrected.	1
RevisionId	integer	Correction record ID.	12
ModelTags	array<object>	The list of data tags hit by the detection model.
	object	The data tag object hit by the 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 is located.	cn-***
EngineType	string	Database engine type.	MySQL
MaskingStatus	integer	Column encryption status. Valid values: -1: Not encrypted 1: Encryption successful 2: Encryption failed	-1
ProductId	integer	The ID corresponding 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.