DescribeColumnsV2 - Data Security Center - Alibaba Cloud Documentation Center

The DescribeColumnsV2 operation queries data in the columns of data asset tables, such as those in MaxCompute and RDS, that are authorized in Data Security Center.

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

get

*All Resource

*

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: Simplified Chinese en_us: English	zh_cn
Name	string	No	The keyword for the search. Fuzzy match is supported. For example, if you enter test, all data that contains test is returned.	test
TableId	string	No	The unique ID of the data asset table that contains the column. The table can be in a data asset such as MaxCompute or RDS. Note Query data in columns of a data asset table by the table ID. The data asset table must be authorized in Data Security Center. To obtain the ID of the data asset table, call the DescribeTables operation.	11132334
RuleId	integer	No	The unique ID of the sensitive data detection rule that is hit by the data in the column. Note Query data in columns of a data asset table based on the ID of the sensitive data detection rule that is hit. The data asset table must be authorized in Data Security Center. To obtain the ID of the sensitive data detection rule, call the DescribeRules operation.	11122200
ProductCode	string	No	The name of the product to which the data in the column of the data asset table belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS.	MaxCompute
InstanceId	integer	No	The ID of the data asset instance to which the data in the column belongs. Note Query data in columns of a data asset table based on the ID of the data asset instance. The data asset table must be authorized in Data Security Center. To obtain the ID of the data asset instance, call the DescribeInstances operation.	1
InstanceName	string	No	The name of the data asset instance to which the data in the column 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 is hit by the data in the column.	name
SensLevelName	string	No	The name of the sensitivity level. 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 to return on each page. Default value: 10.	10
CurrentPage	integer	No	The page number. Default value: 1.	1
RiskLevelId	integer	No	The ID of the risk level for the sensitive data detection rule. Valid values: 1: N/A 2: S1 3: S2 4: S3 5: S4	2
EngineType	string	No	The type of the database engine. Valid values: MySQL MariaDB Oracle PostgreSQL SQLServer	MySQL

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The page number. Default value: 1.	1
RequestId	string	The unique ID generated by Alibaba Cloud for the request.	B1F2BB1F-04EC-5D36-B136-B4DE17FD8DE0
PageSize	integer	The maximum number of entries returned on each page. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	12
Items	array<object>	A list of detection results for the columns in the data table.
	object	An object that contains the detection results for a column in the data table.
CreationTime	integer	The time when the data in the column of the data asset table was created. The value is a UNIX timestamp. Unit: milliseconds.	1536751124000
TableName	string	The name of the table that contains the revised target column.	it_table
DataType	string	The data type of the data in the column of the data asset table.	varchar
OdpsRiskLevelValue	integer	The code of the risk level for the data asset. Valid values: 1: N/A 2: S1 3: S2 4: S3 5: S4 Note A return value that is less than or equal to 1 indicates N/A.	3
InstanceId	integer	The ID of the data asset instance to which the data in the column belongs.	1232122
RiskLevelId	integer	The ID of the risk level for the data in the column of the data asset table. Valid values: 1: N/A 2: S1 3: S2 4: S3 5: S4 Note A return value that is less than or equal to 1 indicates N/A.	4
RuleName	string	The name of the sensitive data detection rule that is hit by the data in the column.	name
RuleId	integer	The ID of the sensitive data detection rule that is hit by the data in the column.	1004
Sensitive	boolean	Indicates whether the data in the column of the data asset table is sensitive. Valid values: true: The data in the column is sensitive. false: The data in the column is not sensitive.	true
SensLevelName	string	The name of the sensitivity level. 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 data asset instance to which the data in the column belongs.	rm-1234
RiskLevelName	string	The name of the risk level for the data in the column of 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.	S1
OdpsRiskLevelName	string	The name of the risk level for the data 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.	S4
Name	string	The name of the column in the data asset table.	obj_id
TableId	integer	The ID of the data asset table to which the data in the column belongs.	123
Id	string	The unique ID of the column in the data asset table.	111111
ProductCode	string	The name of the product to which the data in the column of the data asset table belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS.	RDS
RevisionStatus	integer	The revision status. Valid values: 1: revised 0: not revised	1
RevisionId	integer	The ID of the revision record.	12
ModelTags	array<object>	A list of data tags.
	object	A data tag object.
Id	integer	The ID of the data tag. Valid values: 101: Personal sensitive information 102: Personal information 107: General information	101
Name	string	The name of the data tag. Valid values: Personal sensitive information Personal information General information	personal sensitive information
EngineType	string	The type of the database engine. Valid values: MySQL MariaDB Oracle PostgreSQL SQLServer	MySQL
MaskingStatus	integer	The column encryption status. Valid values: -1: not encrypted 1: encryption successful 2: encryption failed	-1
ProductId	integer	The ID of the product to which the data asset belongs. Valid values: 1: MaxCompute 2: OSS 3: ADS 4: OTS 5: RDS 6: SELF_DB	5
RegionId	string	The region where the data asset resides.	cn-hangzhou

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "B1F2BB1F-04EC-5D36-B136-B4DE17FD8DE0",
  "PageSize": 10,
  "TotalCount": 12,
  "Items": [
    {
      "CreationTime": 1536751124000,
      "TableName": "it_table",
      "DataType": "varchar",
      "OdpsRiskLevelValue": 3,
      "InstanceId": 1232122,
      "RiskLevelId": 4,
      "RuleName": "name",
      "RuleId": 1004,
      "Sensitive": true,
      "SensLevelName": "S2",
      "InstanceName": "rm-1234",
      "RiskLevelName": "S1",
      "OdpsRiskLevelName": "S4",
      "Name": "obj_id",
      "TableId": 123,
      "Id": "111111",
      "ProductCode": "RDS",
      "RevisionStatus": 1,
      "RevisionId": 12,
      "ModelTags": [
        {
          "Id": 101,
          "Name": "personal sensitive information"
        }
      ],
      "EngineType": "MySQL",
      "MaskingStatus": -1,
      "ProductId": 5,
      "RegionId": "cn-hangzhou"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.