すべてのプロダクト
Search
ドキュメントセンター

Data Management:ListSensitiveColumnsDetail

最終更新日:Mar 21, 2026

機密フィールドの詳細情報を照会します。

今すぐお試しください

この 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:ListSensitiveColumnsDetail

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Tid

integer

任意

テナントの ID です。テナント ID を取得するには、GetUserActiveTenant または ListUserTenants 操作を呼び出します。

3***

SchemaName

string

必須

データベースの名前です。データベース名を取得するには、ListSensitiveColumns 操作を呼び出します。

説明

SchemaName_test

TableName

string

必須

テーブルの名前です。テーブル名を取得するには、ListSensitiveColumns 操作を呼び出します。

説明

テーブル名を取得するには、ListTables 操作を呼び出します。

test

ColumnName

string

必須

フィールドの名前です。フィールド名を取得するには、ListSensitiveColumns 操作を呼び出します。

説明

フィールド名を取得するには、ListColumns 操作を呼び出します。

ColumnName_test

DbId

integer

任意

データベースの ID です。データベースは物理データベースまたは論理データベースのいずれかです。

1860****

Logic

boolean

任意

データベースが論理データベースであるかどうかを指定します。有効な値は以下のとおりです。

  • true: 論理データベースです。

  • false: 物理データベースです。

false

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエストの ID です。

7629888F-C9FB-4D16-A7D3-B443FE06FBD4

SensitiveColumnsDetailList

object

SensitiveColumnsDetail

array<object>

機密フィールドの詳細情報です。

object

DbId

integer

データベースの ID です。

1860****

ColumnName

string

フィールドの名前です。

ColumnName_test

ColumnDescription

string

フィールドの説明です。

test

TableName

string

テーブルの名前です。

test

DbType

string

データベースの種類です。

mysql

ColumnType

string

フィールドのデータの型です。

varchar(32)

Logic

boolean

データベースが論理データベースであるかどうかを示します。有効な値は以下のとおりです。

  • true: 論理データベースです。

  • false: 論理データベースではありません。

false

SchemaName

string

データベースの名前です。

SchemaName_test

SearchName

string

データベースを検索するために使用される名前です。

test@xxx:3306

EnvType

string

データベースが属する環境の種類です。

product

ErrorCode

string

返されたエラーコードです。

UnknownError

ErrorMessage

string

返されたエラーメッセージです。

UnknownError

Success

boolean

リクエストが成功したかどうかを示します。有効な値は以下のとおりです。

  • true: リクエストは成功しました。

  • false: リクエストは失敗しました。

true

成功レスポンス

JSONJSON

{
  "RequestId": "7629888F-C9FB-4D16-A7D3-B443FE06FBD4",
  "SensitiveColumnsDetailList": {
    "SensitiveColumnsDetail": [
      {
        "DbId": 0,
        "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
}

エラーコード

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

変更履歴

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