Queries the information about a sensitive field. The information includes the masking algorithm ID, masking algorithm name, and field security level.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dms:ListSensitiveColumnInfo | list | *All Resources * |
| 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 name of the database. 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 name of the table. 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 name of the sensitive field. You can call the ListSensitiveColumns operation to query the name of the sensitive field. 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 | long | 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 parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"SensitiveColumnList": {
"SensitiveColumn": [
{
"InstanceId": 0,
"SchemaName": "test_schema",
"TableName": "test_table",
"ColumnName": "test_column",
"CategoryName": "",
"IsPlain": true,
"SecurityLevel": "",
"UserSensitivityLevel": "S1",
"SampleData": "",
"DefaultDesensitizationRule": {
"RuleId": 0,
"RuleName": "test"
},
"SemiDesensitizationRuleList": {
"SemiDesensitizationRule": [
{
"RuleId": 0,
"RuleName": "test01"
}
]
}
}
]
},
"Success": true,
"TotalCount": 1
}Error codes
For a list of error codes, visit the Service error codes.