DataWorks データマップの指定されたテーブルのカラムリストを照会します。
操作説明
この特徴を使用するには、DataWorks Basic Edition 以上のエディションを購入する必要があります。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dataworks:ListColumns |
list |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| TableId |
string |
必須 |
テーブルの ID。ID は ListTables 操作の応答から取得できます。詳細については、「メタデータエンティティの概念」を参照してください。 |
maxcompute-table:::project_name:[schema_name]:table_name |
| Name |
string |
任意 |
名前。あいまい一致がサポートされています。 |
test_table |
| Comment |
string |
任意 |
コメント。あいまい一致がサポートされています。 |
テストコメント |
| SortBy |
string |
任意 |
ソートフィールド。デフォルト値: Position。有効な値:
列挙値:
|
Position |
| Order |
string |
任意 |
ソート方向。デフォルト値: Asc。有効な値:
列挙値:
|
Asc |
| PageNumber |
integer |
任意 |
ページ番号。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
ページサイズ。デフォルト値: 10。最大値: 100。 |
10 |
| IncludeExtendedProperties |
boolean |
任意 |
拡張プロパティを返すかどうかを指定します。このパラメーターを |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答。 |
||
| RequestId |
string |
リクエスト ID。 |
D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx |
| Success |
boolean |
リクエストが成功したかどうかを示します。 |
true |
| PagingInfo |
object |
ページネーション結果。 |
|
| TotalCount |
integer |
レコードの総数。 |
1 |
| PageNumber |
integer |
ページ番号。 |
1 |
| PageSize |
integer |
ページサイズ。 |
10 |
| Columns |
array |
カラムリスト。 |
|
| Column |
カラム情報。 |
例
成功レスポンス
JSONJSON
{
"RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
"Success": true,
"PagingInfo": {
"TotalCount": 1,
"PageNumber": 1,
"PageSize": 10,
"Columns": [
{
"Id": "maxcompute-column:::project_name:[schema_name]:table_name:column_name",
"Name": "column_name",
"Comment": "字段1",
"TableId": "maxcompute-table:::project_name:[schema_name]:table_name",
"Position": 1,
"Type": "bigint",
"PrimaryKey": false,
"PartitionKey": false,
"ForeignKey": false,
"BusinessMetadata": {
"Description": "字段1的业务描述",
"CustomAttributes": {
"key": [
"张三"
]
}
},
"StatisticsInfos": {
"key": ""
}
}
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。