All Products
Search
Document Center

Data Management:ListSensitiveColumns

Last Updated:Nov 28, 2024

Queries sensitive fields in a table of a database.

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.

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:ListSensitiveColumnslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant.

Note To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the Manage DMS tenants topic.
3
SchemaNamestringNo

The name of the database. You can call the SearchDatabase operation to query the name of the database.

Note You can also call the ListDatabases operation to query the name of a physical database and the ListLogicDatabases operation to query the name of a logical database.
test_schema
TableNamestringNo

The name of the table. You can call the ListTables operation to query the ID of the table.

test_table
ColumnNamestringNo

The name of the field. You can call the ListColumns operation to query the name of the field.

test_column
SecurityLevelstringNo

The sensitivity level of the field. Valid values:

  • SENSITIVE: medium sensitivity level
  • CONFIDENTIAL: high sensitivity level
SENSITIVE
PageNumberintegerNo

The number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page.

100
DbIdlongNo

The ID of the database. You can call the SearchDatabase operation to query the ID of the database.

Note You can also call the ListDatabases operation to query the ID of the physical database and the ListLogicDatabases operation to query the ID of 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
TotalCountlong

The total number of returned entries.

1
RequestIdstring

The ID of the request.

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

The error code.

UnknownError
ErrorMessagestring

The error message.

UnknownError
SensitiveColumnListarray<object>

The sensitive fields.

SensitiveColumnobject
ColumnNamestring

The name of the field.

test_column
TableNamestring

The name of the table.

test_table
SecurityLevelstring

The sensitivity level of the field. Valid values:

  • SENSITIVE
  • CONFIDENTIAL
SENSITIVE
ColumnCountlong

The number of sensitive fields.

1
SchemaNamestring

The name of the database.

test_schema
FunctionTypestring

The type of the de-identification algorithm. Valid values:

  • DEFAULT: All characters are masked. This is the default value.
  • FIX_POS: The characters at specific positions are masked.
  • FIX_CHAR: Specific characters are masked.
DEFAULT
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true

Examples

Sample success responses

JSONformat

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

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

Change history

Change timeSummary of changesOperation
No change history