テーブルの列情報をリスト表示 - Data Management (DMS)

テーブルのカラム情報を返します。

操作説明

この操作は、コントロールモードがセキュリティコラボレーションであるデータベースインスタンスに対してのみ呼び出すことができます。

今すぐお試しください

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

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Tid	integer	任意	テナントの ID。`GetUserActiveTenant` 操作を呼び出してテナント ID を取得できます。	3***
TableId	string	必須	テーブルの ID。`ListTables` 操作を呼び出してテーブル ID を取得できます。	39281****
Logic	boolean	任意	データベースが論理データベースであるかどうかを指定します。有効な値： true：データベースは論理データベースです。 false：データベースは物理データベースです。	false

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	0AD9AC55-5873-474A-9F33-4285806A3619
ErrorCode	string	返されたエラーコード。	UnknownError
ColumnList	object
Column	array<object>	カラムに関する詳細。
	object	テーブル内のフィールドに関する詳細。
ColumnType	string	カラムのデータの型。	varchar
AutoIncrement	boolean	カラムが自動インクリメント列であるかどうかを示します。有効な値： true：カラムは自動インクリメント列です。 false：カラムは自動インクリメント列ではありません。	false
ColumnId	string	カラムの ID。	62589****
DefaultValue	string	カラムのデフォルト値。	def_value
Sensitive	boolean	カラムが機密性の高い列であるかどうかを示します。有効な値： true：カラムは機密性の高い列です。 false：カラムは機密性の高い列ではありません。	false
ColumnName	string	カラム名。	name
SecurityLevel	string	カラムのセキュリティレベル。有効な値： INNER：カラムは機密情報ではない内部カラムです。 SENSITIVE：カラムは機密性の高いカラムです。 CONFIDENTIAL：カラムは機密扱いのカラムです。説明詳細については、「フィールドの機密度レベル」をご参照ください。	INNER
Description	string	カラムの説明。	test
DataPrecision	integer	フィールドの有効桁数。	0
DataScale	integer	フィールドの小数点以下の桁数。	0
FunctionType	string	フィールドに使用されるマスキングアルゴリズムのタイプ。有効な値： null：マスキングアルゴリズムは使用されません。 DEFAULT：完全マスキングアルゴリズムが使用されます。 FIX_POS：固定位置がマスクされます。 FIX_CHAR：固定文字が置き換えられます。	DEFAULT
Nullable	boolean	カラムが空にできるかどうかを示します。有効な値： true：カラムは空にできます。 false：カラムは空にできません。	false
DataLength	integer	フィールドの長さ。	4
ErrorMessage	string	返されたエラーメッセージ。	UnknownError
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "0AD9AC55-5873-474A-9F33-4285806A3619",
  "ErrorCode": "UnknownError",
  "ColumnList": {
    "Column": [
      {
        "ColumnType": "varchar",
        "AutoIncrement": false,
        "ColumnId": "62589****",
        "DefaultValue": "def_value",
        "Sensitive": false,
        "ColumnName": "name",
        "SecurityLevel": "INNER",
        "Description": "test",
        "DataPrecision": 0,
        "DataScale": 0,
        "FunctionType": "DEFAULT",
        "Nullable": false,
        "DataLength": 4
      }
    ]
  },
  "ErrorMessage": "UnknownError",
  "Success": true
}

エラーコード

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

変更履歴

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