调用ListSensitiveColumnsDetail获取敏感字段详情信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListSensitiveColumnsDetail

系统规定参数。取值:ListSensitiveColumnsDetail

Tid Long 3***

租户ID,可通过调用接口GetUserActiveTenantListUserTenants获取该参数的值。

SchemaName String SchemaName_test

数据库名,可通过调用接口ListSensitiveColumns获取该参数的值。

说明
TableName String test

表名,可通过调用接口ListSensitiveColumns获取该参数的值。

说明 您也可以通过调用接口ListTables获取该参数的值。
ColumnName String ColumnName_test

字段名,可通过调用接口ListSensitiveColumns获取该参数的值。

说明 您也可以通过调用接口ListColumns获取该参数的值。
RegionId String cn-hangzhou

DMS服务地域,取值请参见RegionID参数说明

DbId Long 1860****

数据库ID(DatabaseId),数据库分为物理库和逻辑库两种:

Logic Boolean false

是否为逻辑库,取值如下:

  • true:逻辑库
  • false:物理库

返回数据

名称 类型 示例值 描述
RequestId String 7629888F-C9FB-4D16-A7D3-B443FE06FBD4

请求ID。

SensitiveColumnsDetailList Array of SensitiveColumnsDetail

敏感字段详情列表。

SensitiveColumnsDetail
DbId Long 1860****

数据库ID。

ColumnName String ColumnName_test

字段名。

ColumnDescription String test

字段描述。

TableName String test

表名。

DbType String mysql

数据库类型。

ColumnType String varchar(32)

字段类型。

Logic Boolean false

是否为逻辑库,返回值如下:

  • true:是
  • false:否
SchemaName String SchemaName_test

数据库名。

SearchName String test@xxx:3306

数据库搜索名。

EnvType String product

环境类型。

ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

错误信息。

Success Boolean true

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=ListSensitiveColumnsDetail
&Tid=3***
&SchemaName=SchemaName_test
&TableName=test
&ColumnName=ColumnName_test
&DbId=1860****
&Logic=false
&公共请求参数

正常返回示例

XML格式

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格式

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
}

错误码

访问错误中心查看更多错误码。