DataWorks Data Map 用 ListColumns API 概要 - DataWorks - Alibaba Cloud - DataWorks

操作説明

DataWorks Basic Edition またはそれ以上のエディションが必要です。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:ListColumns

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TableId	string	必須	テーブル ID です。ListTables 操作の戻り値および「メタデータエンティティに関する概念」をご参照ください。	maxcompute-table:::project_name:[schema_name]:table_name
Name	string	任意	名前です。あいまい一致がサポートされています。	test_table
Comment	string	任意	コメントです。あいまい一致がサポートされています。	test comment
SortBy	string	任意	ソートフィールドです。デフォルト値：Position。有効な値： Name Position	Position
Order	string	任意	ソート順です。デフォルト値：Asc。有効な値： Asc Desc	Asc
PageNumber	integer	任意	ページ番号です。デフォルト値：1。	1
PageSize	integer	任意	1 ページあたりのレコード数です。デフォルト値：10。最大値：100。	10

レスポンスフィールド

フィールド	型	説明	例
	object	応答です。
RequestId	string	リクエスト ID です。	D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx
Success	boolean	リクエストが成功したかどうかを示します。	true
PagingInfo	object	ページネーション結果です。
TotalCount	integer	返されたレコードの総数です。	1
PageNumber	integer	ページ番号です。	1
PageSize	integer	1 ページあたりのレコード数です。	10
Columns	array	テーブル内のカラムです。
	Column	テーブル内のカラムです。

例

成功レスポンス

JSONJSON

{
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Columns": [
      {
        "Id": "maxcompute-column:123456::test_project:default:test_tbl:col1",
        "Name": "col1",
        "Comment": "字段1",
        "TableId": "maxcompute-table:123456::test_project:default:test_tbl",
        "Position": 1,
        "Type": "bigint",
        "PrimaryKey": false,
        "PartitionKey": false,
        "ForeignKey": false,
        "BusinessMetadata": {
          "Description": "字段1的业务描述"
        }
      }
    ]
  }
}

エラーコード

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

変更履歴

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