DescribeColumnsV2 - Data Security Center - Alibaba Cloud Documentation Center

Queries the columns of tables in instances, such as MaxCompute projects and ApsaraDB RDS instances, that you authorize Data Security Center (DSC) to access.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sddp:DescribeColumnsV2	get	All Resources *	none	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: simplified Chinese en_us: English	zh_cn
Name	string	No	The search keyword. Fuzzy match is supported. For example, if you enter test, all columns whose names contain test are retrieved.	test
TableId	string	No	The ID of the table to which the column belongs. Note You can call the DescribeTables operation to obtain the ID of the table.	11132334
RuleId	long	No	The ID of the sensitive data detection rule that data in the column of the table hits. Note You can call the DescribeRules operation to obtain the ID of the sensitive data detection rule.	11122200
ProductCode	string	No	The name of the service to which data in the column of the table belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS.	MaxCompute
InstanceId	long	No	The ID of the instance to which data in the column of the table belongs. Note You can call the DescribeInstances operation to obtain the ID of the instance to which the data in the column of the table belongs.	1
InstanceName	string	No	The name of the instance to which data in the column of the table belongs.	rm-bp17t1htja573l5i8****
TableName	string	No	The name of the table.	it_table
RuleName	string	No	The name of the sensitive data detection rule that data in the column of the table hits.	name
SensLevelName	string	No	The name of the sensitivity level. Valid values: N/A: indicates that no sensitive data is detected. S1: indicates the low sensitivity level. S2: indicates the medium sensitivity level. S3: indicates the high sensitivity level. S4: indicates the highest sensitivity level.	S2
PageSize	integer	No	The number of entries per page. Default value: 10.	10
CurrentPage	integer	No	The page number. Default value: 1.	1
RiskLevelId	long	No	The ID of the sensitivity level of the data that hits the sensitive data detection rule. Valid values: 1: N/A 2: S1 3: S2 4: S3 5: S4	2

Response parameters

Parameter	Type	Description	Example
	object
CurrentPage	integer	The page number. Default value: 1.	1
RequestId	string	The request ID.	B1F2BB1F-04EC-5D36-B136-B4DE17FD8DE0
PageSize	integer	The number of entries per page. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	12
Items	array<object>	A list of column recognition results of the data table.
Column	object	recognition result.
CreationTime	long	The time when the data in the column of the table is created. Unit: milliseconds.	1536751124000
TableName	string	The name of the table to which the revised column belongs.	it_table
DataType	string	The type of data in the column of the table.	varchar
OdpsRiskLevelValue	integer	The ID of the sensitivity level of the asset. Valid values: 1: N/A 2: S1 3: S2 4: S3 5: S4 Note The return value <=1 means N/A.	3
InstanceId	long	The ID of the instance to which data in the column of the table belongs.	1232122
RiskLevelId	long	The ID of the sensitivity level of data in the column of the table. Valid values: 1: N/A 2: S1 3: S2 4: S3 5: S4 Note The return value <=1 means N/A.	4
RuleName	string	The name of the sensitive data detection rule that data in the column of the table hits.	name
RuleId	long	The ID of the sensitive data detection rule that data in the column of the table hits.	1004
Sensitive	boolean	Indicates whether the column contains sensitive data. Valid values: true false	true
SensLevelName	string	The name of the sensitivity level. Valid values: N/A: indicates that no sensitive data is detected. S1: indicates the low sensitivity level. S2: indicates the medium sensitivity level. S3: indicates the high sensitivity level. S4: indicates the highest sensitivity level.	S2
InstanceName	string	The name of the instance to which data in the column of the table belongs.	rm-1234
RiskLevelName	string	The name of the sensitivity level for data in the column of the table. Valid values: N/A: indicates that no sensitive data is detected. S1: indicates the low sensitivity level. S2: indicates the medium sensitivity level. S3: indicates the high sensitivity level. S4: indicates the highest sensitivity level.	S1
OdpsRiskLevelName	string	The name of the sensitivity level for asset. Valid values: N/A: indicates that no sensitive data is detected. S1: indicates the low sensitivity level. S2: indicates the medium sensitivity level. S3: indicates the high sensitivity level. S4: indicates the highest sensitivity level.	S4
Name	string	The name of the column of the table.	obj_id
TableId	long	The ID of the table.	123
Id	string	The ID of the column of the table.	111111
ProductCode	string	The name of the service to which data in the column of the table belongs. Valid values: MaxCompute, OSS, ADS, OTS, and RDS.	RDS
RevisionStatus	long	Indicates whether the column is revised. Valid values: 1: yes 0: no	1
RevisionId	long	The ID of the revision record.	12
ModelTags	array<object>	A list of data tags.
modelTags	object	A list of tags.
Id	long	The tag ID. Valid values: 101: personal sensitive information 102: personal information 107: general information	101
Name	string	The tag name. Valid values: Personal sensitive information Personal information General information	personal sensitive information

Examples

Sample success responses

JSONformat

{
  "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"
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history