Use ListSensitiveColumnInfo to query sensitive column information and masking algorithm - Data Management - Alibaba Cloud - Data Management

Queries masking algorithm and security level information for sensitive fields.

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

dms:ListSensitiveColumnInfo

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	integer	Yes	The ID of the instance. You can call the ListInstances or GetInstance operation to query the instance ID.	183****
SchemaName	string	No	The database name. You can also call the SearchDatabase operation to query the database name. Note You can also call the ListDatabases operation to query the value of the SchemaName parameter of a physical database, or the ListLogicDatabases operation to query the value of the SchemaName parameter of a logical database.	test_schema
TableName	string	No	The table name. You can call the ListSensitiveColumns operation to query the table name. Note You can also call the ListTables operation to query the table name.	test_table
ColumnName	string	No	The sensitive field name. You can call the ListSensitiveColumns operation to query the sensitive field name. Note You can also call the ListColumns operation to query the name of the sensitive field.	test_column
PageNumber	integer	No	The page number of the returned page.	1
PageSize	integer	No	The number of entries to return on each page.	100
Tid	integer	No	The ID of the tenant. Note To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.	3***

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID, which can be used to locate logs and troubleshoot issues.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
SensitiveColumnList	object
SensitiveColumn	array<object>	The details of the sensitive field.
	array<object>	The details of the field.
InstanceId	integer	The ID of the instance.	183****
SchemaName	string	The name of the database.	test_schema
TableName	string	The name of the table.	test_table
ColumnName	string	The name of the sensitive field.	test_column
CategoryName	string	The name of the category.	Default category
IsPlain	boolean	Indicates whether the sensitive field is displayed in plaintext.	False
SecurityLevel	string	The sensitivity level of the field. Valid values: Low Medium High	Low
UserSensitivityLevel	string	The user-defined sensitivity level.	S1
SampleData	string	The sample data.	Xi'an
DefaultDesensitizationRule	object	The default masking algorithm details.
RuleId	integer	The masking algorithm ID.	101**
RuleName	string	The masking algorithm name.	test
SemiDesensitizationRuleList	object
SemiDesensitizationRule	array<object>	The list of partial masking algorithms.
	object	The details of the partial masking algorithm.
RuleId	integer	The ID of the partial masking algorithm.	10***
RuleName	string	The partial masking algorithm name.	test01
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
TotalCount	integer	The total number of returned entries.	1

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "SensitiveColumnList": {
    "SensitiveColumn": [
      {
        "InstanceId": 0,
        "SchemaName": "test_schema",
        "TableName": "test_table",
        "ColumnName": "test_column",
        "CategoryName": "Default category",
        "IsPlain": true,
        "SecurityLevel": "Low",
        "UserSensitivityLevel": "S1",
        "SampleData": "Xi'an",
        "DefaultDesensitizationRule": {
          "RuleId": 0,
          "RuleName": "test"
        },
        "SemiDesensitizationRuleList": {
          "SemiDesensitizationRule": [
            {
              "RuleId": 0,
              "RuleName": "test01"
            }
          ]
        }
      }
    ]
  },
  "Success": true,
  "TotalCount": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.