Use DescribeDataObjectColumnDetail API to query detection results for data table columns - Data Security Center - Alibaba Cloud - Data Security Center

Queries the column detection results of a data table.

Operation description

Before you begin

The DescribeDataObjectColumnDetail operation has been revised to DescribeDataObjectColumnDetailV2. Use the newer version DescribeDataObjectColumnDetailV2 when developing applications.

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

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
PageSize	integer	No	The maximum number of data asset instances to display on each page in a paged query. Settings this parameter for paging. Default value: 10.	10
CurrentPage	integer	No	The page number of the current page in a paged query. Settings this parameter for paging. Default value: 1.	1
ProductId	integer	No	The ID of the product 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
Id	integer	No	The unique ID of the data object to query. Note You can call DescribeDataObjects to obtain the ID.	318248
TemplateId	integer	No	The industry template ID. Note You can call DescribeDataObjects to obtain the industry template ID.	1
FeatureType	integer	No	This parameter is deprecated.	2

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The page number of the current page in a paged query. Settings this parameter for paging. Default value: 1.	1
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	8C8036CC-961D-514E-88E8-3088B5A50CA9
PageSize	integer	The maximum number of data asset instances to display on each page in a paged query. Settings this parameter for paging. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	61
Items	array<object>	The list of column detection results of the data table.
	array<object>	The column detection result object of the data table.
ColumnName	string	The column name.	hide14
DataType	string	The data type of the column.	varchar
ColumnComment	string	The comment of the column.	column comment
PrimaryKey	boolean	Indicates whether the column is a primary key. Valid values: true: The column is a primary key. false: The column is not a primary key.	true
Id	string	The unique ID of the column object.	1509415150052786176
RiskLevelId	integer	The risk level ID. Valid values: 1: N/A. No sensitive data is detected. 2: S1. Level 1 sensitive data. 3: S2. Level 2 sensitive data. 4: S3. Level 3 sensitive data. 5: S4. Level 4 sensitive data.	2
RiskLevelName	string	The risk 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.	S1
RuleId	integer	The ID of the sensitive data detection rule that is hit.	1004
RuleName	string	The name of the sensitive data detection rule that is hit.	name
Categories	array	The list of industry categories to which the sensitive data belongs.
	string	The industry category to which the sensitive data belongs. Multiple categories are separated by commas.	general sensitive information
ModelTags	array<object>	The list of data tags.
	object	The data tag object.
Id	integer	The ID of the data label. Valid values: 101: Personal sensitive information 102: Personal information 107: General information	101
Name	string	The name of the data label. Valid values: Personal sensitive information Personal information General information	personal sensitive information
EngineType	string	The engine type. Valid values: MySQL MariaDB Oracle PostgreSQL SQLServer	MySQL
MaskingStatus	integer	The encryption status of the column. Valid values: -1: Not encrypted. 1: Encrypted. 2: Encryption failed.	-1
InstanceName	string	The instance name of the data asset table.	rm-1234
TableName	string	The table name.	it_table
RegionId	string	The region where the asset resides.	cn-hangzhou
ProductId	integer	The ID of the product 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": "8C8036CC-961D-514E-88E8-3088B5A50CA9",
  "PageSize": 10,
  "TotalCount": 61,
  "Items": [
    {
      "ColumnName": "hide14",
      "DataType": "varchar",
      "ColumnComment": "column comment",
      "PrimaryKey": true,
      "Id": "1509415150052786176",
      "RiskLevelId": 2,
      "RiskLevelName": "S1",
      "RuleId": 1004,
      "RuleName": "name",
      "Categories": [
        "general sensitive information"
      ],
      "ModelTags": [
        {
          "Id": 101,
          "Name": "personal sensitive information"
        }
      ],
      "EngineType": "MySQL",
      "MaskingStatus": -1,
      "InstanceName": "rm-1234",
      "TableName": "it_table",
      "RegionId": "cn-hangzhou",
      "ProductId": 5
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.