DescribeDataObjectColumnDetail - Data Security Center - Alibaba Cloud Documentation Center

Queries the detection results for columns in a data table.

Operation description

Notes

The DescribeDataObjectColumnDetail operation has been updated to DescribeDataObjectColumnDetailV2. We recommend that you use the latest version, DescribeDataObjectColumnDetailV2, for application development.

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

*

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 to return. Default value: 1.	1
ProductId	integer	No	The ID of the service 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 that you want to query. Note Call the DescribeDataObjects operation to obtain the ID.	318248
TemplateId	integer	No	The ID of the industry-specific template. Note 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.	1
RequestId	string	The ID of the request.	8C8036CC-961D-514E-88E8-3088B5A50CA9
PageSize	integer	The number of entries returned on each page.	10
TotalCount	integer	The total number of entries.	61
Items	array<object>	The details of the columns.
	array<object>	The details of a column.
ColumnName	string	The name of the column.	hide14
DataType	string	The data type of the column.	varchar
ColumnComment	string	The comment 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 ID of the column.	1509415150052786176
RiskLevelId	integer	The ID of the sensitivity level. Valid values: 1: N/A 2: S1 3: S2 4: S3 5: S4	2
RiskLevelName	string	The name of the sensitivity level. Valid values: N/A S1 S2 S3 S4	S1
RuleId	integer	The ID of the sensitive data detection rule that was matched.	1004
RuleName	string	The name of the sensitive data detection rule that was matched.	name
Categories	array	The industry-specific data classifications.
	string	The industry-specific data classification.	general sensitive information
ModelTags	array<object>	The data labels.
	object	The data label.
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 type of the database engine. Valid values: MySQL MariaDB Oracle PostgreSQL SQLServer	MySQL
MaskingStatus	integer	The data masking status of the column. Valid values: -1: Not masked 1: Masked 2: Masking failed	-1
InstanceName	string	The name of the instance where the table is located.	rm-1234
TableName	string	The name of the table.	it_table
RegionId	string	The ID of the region where the data asset is located.	cn-hangzhou
ProductId	integer	The ID of the service 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.