DescribeDataObjectColumnDetailV2 - Data Security Center - Alibaba Cloud Documentation Center

Queries the detection results for the columns of a data table.

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

get

*All Resource

*

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
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
CurrentPage	integer	No	The page number. 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	string	Yes	The unique ID of the data object to query. Note You can call the DescribeDataObjects operation to obtain the ID.	13456723343
TemplateId	integer	Yes	The ID of the industry-specific template. Note You can call the DescribeDataObjects operation to obtain the ID of the industry-specific template.	1
FeatureType	integer	No	This parameter is deprecated.	2

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The page number of the returned page. Default value: 1.	1
RequestId	string	The ID of the request.	769FB3C1-F4C9-42DF-9B72-7077A8989C13
PageSize	integer	The number of entries returned per page. Default value: 10.	10
TotalCount	integer	The total number of entries.	231
Items	array<object>	The list of detection results for the columns in the data table.
	array<object>	A detection result for a column in the data table.
ColumnName	string	The name of the column.	hide14
DataType	string	The data type of the column.	varchar
ColumnComment	string	The comments on 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 data object.	1392973973691383808
RiskLevelId	integer	The ID of the sensitivity level. 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 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.	S1
RuleId	integer	The ID of the hit detection model.	51
RuleName	string	The name of the hit detection model.	name
Categories	array	The list of industry-specific categories for the sensitive data.
	string	The industry-specific category for the sensitive data. Multiple categories are separated by commas.	general sensitive information
ModelTags	array<object>	The list of data tags.
	object	A data tag.
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 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 name of the instance for the data asset table.	rm-bp17t1htja573l5i8****
TableName	string	The name of the table.	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": "769FB3C1-F4C9-42DF-9B72-7077A8989C13",
  "PageSize": 10,
  "TotalCount": 231,
  "Items": [
    {
      "ColumnName": "hide14",
      "DataType": "varchar",
      "ColumnComment": "column comment",
      "PrimaryKey": true,
      "Id": "1392973973691383808",
      "RiskLevelId": 2,
      "RiskLevelName": "S1",
      "RuleId": 51,
      "RuleName": "name",
      "Categories": [
        "general sensitive information"
      ],
      "ModelTags": [
        {
          "Id": 101,
          "Name": "personal sensitive information"
        }
      ],
      "EngineType": "MySQL",
      "MaskingStatus": -1,
      "InstanceName": "rm-bp17t1htja573l5i8****",
      "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.