All Products
Search

This Product

    Data Management:ListSensitiveColumns

    Document Center

    Data Management:ListSensitiveColumns

    Last Updated:Aug 28, 2026

    Queries sensitive columns in a database table.

    Operation description

    This API operation is deprecated. Use ListSensitiveColumnInfo to query masking algorithm information for sensitive columns.

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

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Tid

    integer

    No

    The tenant ID.

    Note

    To view the tenant ID, hover over the profile picture in the upper-right corner of the DMS console. Manage DMS tenants.

    3
    SchemaName

    string

    No

    The database name. Call SearchDatabase to query this value.

    Note

    You can also call ListDatabases for physical database names or ListLogicDatabases for logical database names.

    test_schema
    TableName

    string

    No

    The table name. Call ListTables to query the table ID.

    test_table
    ColumnName

    string

    No

    The column name. Call ListColumns to query column names.

    test_column
    SecurityLevel

    string

    No

    The sensitivity level. Valid values:

    • SENSITIVE: medium sensitivity

    • CONFIDENTIAL: high sensitivity

    SENSITIVE
    PageNumber

    integer

    No

    The page number to return.

    1
    PageSize

    integer

    No

    The number of entries per page.

    100
    DbId

    integer

    No

    The database ID. Call SearchDatabase to query this value.

    Note

    You can also call ListDatabases for physical database IDs or ListLogicDatabases for logical database IDs.

    1860
    Logic

    boolean

    No

    Whether the database is a logical database. Valid values:

    • true: The database is a logical database.

    • false: The database is a physical database.

    false

    Response elements

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

    The total number of returned entries.

    1
    RequestId

    string

    The request ID.

    09D82FD7-F87F-59EF-AA82-AEF71B09E306
    ErrorCode

    string

    The error code.

    UnknownError
    ErrorMessage

    string

    The error message.

    UnknownError
    SensitiveColumnList

    object

    SensitiveColumn

    array<object>

    The sensitive fields.

    object

    ColumnName

    string

    The column name.

    test_column
    TableName

    string

    The table name.

    test_table
    SecurityLevel

    string

    The sensitivity level. Valid values:

    • SENSITIVE

    • CONFIDENTIAL

    SENSITIVE
    ColumnCount

    integer

    The number of sensitive columns.

    1
    SchemaName

    string

    The database name.

    test_schema
    FunctionType

    string

    The de-identification algorithm type. Valid values:

    • DEFAULT: All characters are masked (default).

    • FIX_POS: Characters at specified positions are masked.

    • FIX_CHAR: Specific characters are masked.

    DEFAULT
    Success

    boolean

    Whether the request was successful. Valid values:

    • true: The request succeeded.

    • false: The request failed.

    true

    Examples

    Success response

    JSON format

    {
  "TotalCount": 1,
  "RequestId": "09D82FD7-F87F-59EF-AA82-AEF71B09E306",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "SensitiveColumnList": {
    "SensitiveColumn": [
      {
        "ColumnName": "test_column",
        "TableName": "test_table",
        "SecurityLevel": "SENSITIVE",
        "ColumnCount": 1,
        "SchemaName": "test_schema",
        "FunctionType": "DEFAULT"
      }
    ]
  },
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.