All Products
Search

This Product

    Data Management:ListSensitiveColumnsDetail

    Document Center

    Data Management:ListSensitiveColumnsDetail

    Last Updated:Aug 28, 2026

    Queries the details of 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:ListSensitiveColumnsDetail

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Tid

    integer

    No

    The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.

    3***
    SchemaName

    string

    Yes

    The name of the database. You can call the ListSensitiveColumns operation to obtain the name of the database.

    Note

    SchemaName_test
    TableName

    string

    Yes

    The name of the table. You can call the ListSensitiveColumns operation to obtain the name of the table.

    Note

    You can also call the ListTables operation to obtain the name of the table.

    test
    ColumnName

    string

    Yes

    The name of the field. You can call the ListSensitiveColumns operation to obtain the name of the field.

    Note

    You can also call the ListColumns operation to obtain the name of the field.

    ColumnName_test
    DbId

    integer

    No

    The ID of the database. The database can be a physical database or a logical database.

    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

    RequestId

    string

    The ID of the request.

    7629888F-C9FB-4D16-A7D3-B443FE06FBD4
    SensitiveColumnsDetailList

    object

    SensitiveColumnsDetail

    array<object>

    The details of the sensitive field.

    object

    DbId

    integer

    The ID of the database.

    1860****
    ColumnName

    string

    The name of the field.

    ColumnName_test
    ColumnDescription

    string

    The description of the field.

    test
    TableName

    string

    The name of the table.

    test
    DbType

    string

    The type of the database.

    mysql
    ColumnType

    string

    The data type of the field.

    varchar(32)
    Logic

    boolean

    Whether the database is a logical database. Valid values:

    • true: The database is a logical database.

    • false: The database is not a logical database.

    false
    SchemaName

    string

    The name of the database.

    SchemaName_test
    SearchName

    string

    The search name of the database.

    test@xxx:3306
    EnvType

    string

    The environment type of the database.

    product
    ErrorCode

    string

    The error code returned.

    UnknownError
    ErrorMessage

    string

    The error message returned.

    UnknownError
    Success

    boolean

    Whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "7629888F-C9FB-4D16-A7D3-B443FE06FBD4",
  "SensitiveColumnsDetailList": {
    "SensitiveColumnsDetail": [
      {
        "DbId": 0,
        "ColumnName": "ColumnName_test",
        "ColumnDescription": "test",
        "TableName": "test",
        "DbType": "mysql",
        "ColumnType": "varchar(32)",
        "Logic": false,
        "SchemaName": "SchemaName_test",
        "SearchName": "test@xxx:3306",
        "EnvType": "product"
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.