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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListSensitiveColumnsDetail

The operation that you want to perform. Set the value to ListSensitiveColumnsDetail.

Tid Long Yes 3***

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

SchemaName String Yes SchemaName_test

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

Note
TableName String Yes test

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.
ColumnName String Yes ColumnName_test

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.
RegionId String No cn-hangzhou

The ID of the region in which Data Management (DMS) is activated. For more information, see RegionID parameter.

DbId Long No 1860****

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

Logic Boolean No false

Specifies whether the database is a logical database. Valid values:

  • true: The database is a logical database.
  • false: The database is a physical database.

Response parameters

Parameter Type Example Description
RequestId String 7629888F-C9FB-4D16-A7D3-B443FE06FBD4

The ID of the request.

SensitiveColumnsDetailList Array of SensitiveColumnsDetail

The details of the sensitive field.

SensitiveColumnsDetail
DbId Long 1860****

The ID of the database.

ColumnName String ColumnName_test

The name of the field.

ColumnDescription String test

The description of the field.

TableName String test

The name of the table.

DbType String mysql

The type of the database.

ColumnType String varchar(32)

The data type of the field.

Logic Boolean false

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.
SchemaName String SchemaName_test

The name of the database.

SearchName String test@xxx:3306

The name that is used to search for the database.

EnvType String product

The type of the environment to which the database belongs.

ErrorCode String UnknownError

The error code returned.

ErrorMessage String UnknownError

The error message returned.

Success Boolean true

Indicates whether the request was successful. Valid values:

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

Examples

Sample request

http(s)://dms-enterprise.aliyuncs.com/?Action=ListSensitiveColumnsDetail
&Tid=3***
&SchemaName=SchemaName_test
&TableName=test
&ColumnName=ColumnName_test
&DbId=1860****
&Logic=false
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListSensitiveColumnsDetailResponse>
    <RequestId>7629888F-C9FB-4D16-A7D3-B443FE06FBD4</RequestId>
    <SensitiveColumnsDetailList>
        <ColumnName>ColumnName_test</ColumnName>
        <ColumnDescription>test</ColumnDescription>
        <TableName>test</TableName>
        <DbType>mysql</DbType>
        <ColumnType>varchar(32)</ColumnType>
        <Logic>false</Logic>
        <SchemaName>SchemaName_test</SchemaName>
        <SearchName>test@xxx:3306</SearchName>
        <EnvType>product</EnvType>
    </SensitiveColumnsDetailList>
    <ErrorCode>UnknownError</ErrorCode>
    <ErrorMessage>UnknownError</ErrorMessage>
    <Success>true</Success>
</ListSensitiveColumnsDetailResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "7629888F-C9FB-4D16-A7D3-B443FE06FBD4",
  "SensitiveColumnsDetailList" : [ {
    "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 API Error Center.