ListTableColumns API フィールドリファレンス - 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:ListTableColumns

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Tid	integer	任意	テナント ID。 GetUserActiveTenant または ListUserTenants 操作を呼び出して、テナント ID を取得できます。	3***
DbId	integer	必須	物理データベースの ID。 ListDatabases または SearchDatabase 操作を呼び出して、物理データベース ID を取得できます。	123
TableName	string	必須	テーブル名。説明 ListTables 操作を呼び出してテーブル名を照会することもできます。	100g_customer
TableSchemaName	string	任意	テーブルのスキーマ名。SQL Server インスタンスの場合にのみ必要です。	dbo

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	リクエストが失敗した場合に返されるエラーコード。	UnknownError
ColumnList	object
Column	array<object>	テーブル内の列の詳細。
	object
ColumnId	string	列の ID。	12345
ColumnType	string	列のデータ型。	varchar
Description	string	列の説明。	column desc
AutoIncrement	boolean	列が自動インクリメント列であるかどうかを示します。有効な値は次のとおりです： true：列は自動インクリメント列です。 false：列は自動インクリメント列ではありません。	false
FunctionType	string	列に使用されるマスキングアルゴリズムのタイプ。有効な値は次のとおりです： null：マスキングアルゴリズムは使用されません。 DEFAULT：フルマスキングアルゴリズムが使用されます。 FIX_POS：固定位置がマスクされます。 FIX_CHAR：固定文字が置き換えられます。	NULL
DataPrecision	integer	列の有効桁数。	0
DefaultValue	string	列のデフォルト値。	aaa
ColumnName	string	列名。	c1
SecurityLevel	string	列のセキュリティレベル。有効な値は次のとおりです： INNER：列は内部列ですが、機密ではありません。 SENSITIVE：列は機密です。 CONFIDENTIAL：列は極秘列です。	INNER
DataScale	integer	列データの小数点以下の桁数。	0
DataLength	integer	フィールドの長さです。	32
Sensitive	boolean	列が機密列であるかどうかを示します。有効な値は次のとおりです： true：列は機密列です。 false：列は機密列ではありません。	false
Nullable	boolean	列が空にできるかどうかを示します。有効な値は次のとおりです： true：列は空にできます。 false：列は空にできません。	true
ErrorMessage	string	リクエストが失敗した場合に返されるエラーメッセージ。	UnknownError
Success	boolean	リクエストが成功したかどうかを示します。有効な値は次のとおりです： true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ColumnList": {
    "Column": [
      {
        "ColumnId": "12345",
        "ColumnType": "varchar",
        "Description": "column desc",
        "AutoIncrement": false,
        "FunctionType": "NULL",
        "DataPrecision": 0,
        "DefaultValue": "aaa",
        "ColumnName": "c1",
        "SecurityLevel": "INNER",
        "DataScale": 0,
        "DataLength": 32,
        "Sensitive": false,
        "Nullable": true
      }
    ]
  },
  "ErrorMessage": "UnknownError",
  "Success": true
}

エラーコード

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

変更履歴

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