全部產品
Search
文件中心

Data Management:ListSensitiveColumnInfo - 擷取敏感欄位的脫敏演算法相關資訊

更新時間:Mar 21, 2026

調用此介面可以擷取到敏感欄位所使用的脫敏演算法ID、名稱,以及欄位的安全層級等資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:ListSensitiveColumnInfo

list

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

InstanceId

integer

執行個體 ID。您可調用 ListInstancesGetInstance 介面擷取該參數的值。

183****

SchemaName

string

資料庫名。您可調用介面 SearchDatabase 擷取該參數的值。

說明

您也可以調用介面 ListDatabases 擷取物理庫的 SchemaName 值,調用介面 ListLogicDatabases 擷取邏輯庫的 SchemaName 值。

test_schema

TableName

string

表名。您可通過調用介面 ListSensitiveColumns 擷取該參數的值。

說明

您也可以通過調用介面 ListTables 擷取該參數的值。

test_table

ColumnName

string

欄位名。您可調用介面 ListSensitiveColumns 擷取該參數的值。

說明

您也可以通過調用介面 ListColumns 擷取該參數的值。

test_column

PageNumber

integer

分頁查詢時,設定當前頁面的頁碼。

1

PageSize

integer

每頁資料量。

100

Tid

integer

租戶的 ID。

說明

取自系統右上方頭像處懸停展示的租戶 ID 資訊,詳情請參見查看租戶資訊

3***

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID,用於定位日誌,排查問題。

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931

ErrorCode

string

錯誤碼,請求異常時返回。

UnknownError

ErrorMessage

string

調用失敗時,返回的錯誤資訊。

UnknownError

SensitiveColumnList

object

SensitiveColumn

array<object>

敏感欄位詳情列表。

array<object>

欄位詳情。

InstanceId

integer

執行個體 ID。

183****

SchemaName

string

資料庫名。

test_schema

TableName

string

表名。

test_table

ColumnName

string

欄位名。

test_column

CategoryName

string

分類名稱。

預設分類

IsPlain

boolean

標註該敏感序列的欄位是否以明文展示。

False

SecurityLevel

string

欄位敏感等級,傳回值如下:

UserSensitivityLevel

string

使用者定義的敏感等級。

S1

SampleData

string

抽樣資料。

西安市

DefaultDesensitizationRule

object

預設的脫敏演算法資訊。

RuleId

integer

脫敏演算法 ID。

101**

RuleName

string

脫敏演算法名稱。

test

SemiDesensitizationRuleList

object

SemiDesensitizationRule

array<object>

半脫敏演算法列表。

object

半脫敏演算法詳情。

RuleId

integer

半脫敏演算法 ID。

10***

RuleName

string

半脫敏演算法名稱。

test01

Success

boolean

請求是否成功。傳回值如下:

  • true:請求成功

  • false:請求失敗

true

TotalCount

integer

資料總數。

1

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情