All Products
Search
Document Center

Data Management:ListSensitiveColumnsDetail

Last Updated:Apr 18, 2024

Queries the details of a sensitive field.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dms:ListSensitiveColumnsDetailRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

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

3***
SchemaNamestringYes

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

Note
  • You can also call the ListDatabases or SearchDatabase operation to obtain the name of a physical database.
  • You can also call the ListLogicDatabases or SearchDatabase operation to obtain the name of a logical database.
  • SchemaName_test
    TableNamestringYes

    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
    ColumnNamestringYes

    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
    DbIdlongNo

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

    1860****
    LogicbooleanNo

    Specifies 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 parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    7629888F-C9FB-4D16-A7D3-B443FE06FBD4
    SensitiveColumnsDetailListobject []

    The details of the sensitive field.

    DbIdlong

    The ID of the database.

    1860****
    ColumnNamestring

    The name of the field.

    ColumnName_test
    ColumnDescriptionstring

    The description of the field.

    test
    TableNamestring

    The name of the table.

    test
    DbTypestring

    The type of the database.

    mysql
    ColumnTypestring

    The data type of the field.

    varchar(32)
    Logicboolean

    Indicates 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
    SchemaNamestring

    The name of the database.

    SchemaName_test
    SearchNamestring

    The name that is used to search for the database.

    test@xxx:3306
    EnvTypestring

    The type of the environment to which the database belongs.

    product
    ErrorCodestring

    The error code returned.

    UnknownError
    ErrorMessagestring

    The error message returned.

    UnknownError
    Successboolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.
    • false: The request failed.
    true

    Examples

    Sample success responses

    JSONformat

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

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

    Change history

    Change timeSummary of changesOperation
    No change history