ListSensitiveColumns API 呼び出しによる敏感列のクエリ - DMS

データベースのテーブル内のセンシティブフィールドをクエリします。

操作説明

この API は廃止されたため、ドキュメントは更新されません。センシティブフィールドのマスキングアルゴリズム関連の情報を取得するには、ListSensitiveColumnInfo インターフェースのご利用を推奨します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dms:ListSensitiveColumns

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Tid	integer	任意	テナントの ID。説明テナントの ID を表示するには、Data Management (DMS) コンソールの右上に表示されているプロフィール画像にポインターを合わせます。詳細については、「DMS テナントの管理」トピックの「現在のテナントに関する情報の表示」セクションをご参照ください。	3
SchemaName	string	任意	データベースの名前。SearchDatabase 操作を呼び出して、データベースの名前をクエリできます。説明また、ListDatabases 操作を呼び出して物理データベースの名前を、ListLogicDatabases 操作を呼び出して論理データベースの名前をクエリすることもできます。	test_schema
TableName	string	任意	テーブルの名前。ListTables 操作を呼び出して、テーブルの ID をクエリできます。	test_table
ColumnName	string	任意	フィールドの名前。ListColumns 操作を呼び出して、フィールドの名前をクエリできます。	test_column
SecurityLevel	string	任意	フィールドの機密度レベル。有効な値： SENSITIVE：中程度の機密度レベル CONFIDENTIAL：高い機密度レベル	SENSITIVE
PageNumber	integer	任意	返すページ番号。	1
PageSize	integer	任意	各ページで返すエントリ数。	100
DbId	integer	任意	データベースの ID。SearchDatabase 操作を呼び出して、データベースの ID をクエリできます。説明また、ListDatabases 操作を呼び出して物理データベースの ID を、ListLogicDatabases 操作を呼び出して論理データベースの ID をクエリすることもできます。	1860
Logic	boolean	任意	データベースが論理データベースであるかどうかを指定します。有効な値： true：データベースは論理データベースです。 false：データベースは物理データベースです。	false

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	返されたエントリの総数。	1
RequestId	string	リクエスト ID。	09D82FD7-F87F-59EF-AA82-AEF71B09E306
ErrorCode	string	エラーコード。	UnknownError
ErrorMessage	string	エラーメッセージ。	UnknownError
SensitiveColumnList	object
SensitiveColumn	array<object>	センシティブフィールド。
	object
ColumnName	string	フィールドの名前。	test_column
TableName	string	テーブルの名前。	test_table
SecurityLevel	string	フィールドの機密度レベル。有効な値： SENSITIVE CONFIDENTIAL	SENSITIVE
ColumnCount	integer	センシティブフィールドの数。	1
SchemaName	string	データベースの名前。	test_schema
FunctionType	string	マスキングアルゴリズムのタイプ。有効な値： DEFAULT：すべての文字がマスクされます。これがデフォルト値です。 FIX_POS：特定の位置の文字がマスクされます。 FIX_CHAR：特定の文字がマスクされます。	DEFAULT
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功です。 false：リクエストは失敗です。	true

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。