データマップ内のテーブル一覧をクエリします。スキーマをサポートしないデータソースタイプの場合、この操作は指定されたデータベース内のテーブルをクエリします。スキーマをサポートするデータソースタイプの場合、指定されたデータベース、MaxCompute プロジェクト、またはスキーマ内のテーブルをクエリできます。応答には、基本的なテーブル情報、テクニカルメタデータ、およびビジネスメタデータが含まれます。
操作説明
DataWorks Basic Edition またはそれ以上のエディションをご購入済みである必要があります。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dataworks:ListTables |
list |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ParentMetaEntityId |
string |
必須 |
親メタデータエンティティの ID です。この ID は、ListDatabases 操作または ListSchemas 操作の応答から取得できます。詳細については、「メタデータエンティティの概念」をご参照ください。
説明
以下は、一般的なデータソースタイプごとの
説明
これらの形式における各要素の意味は以下のとおりです。
|
maxcompute-project:::project_name |
| Name |
string |
任意 |
テーブル名です。あいまい一致がサポートされています。 |
abc |
| Comment |
string |
任意 |
テーブルのコメントです。あいまい一致がサポートされています。 |
this is a comment |
| TableTypes |
array |
任意 |
クエリ対象のテーブルタイプの一覧です。このパラメーターを省略すると、すべてのタイプのテーブルが返されます。 |
|
|
string |
任意 |
テーブルタイプです。有効な値はデータベースタイプによって異なります。 |
TABLE |
|
| SortBy |
string |
任意 |
ソートフィールドです。デフォルト値は
|
CreateTime |
| Order |
string |
任意 |
ソート順です。デフォルト値は
|
Asc |
| PageNumber |
integer |
任意 |
ページ番号です。デフォルト値は 1 です。 |
1 |
| PageSize |
integer |
任意 |
ページサイズです。デフォルト値は 10 です。最大値は 100 です。 |
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答オブジェクトです。 |
||
| RequestId |
string |
リクエスト ID です。 |
E25887B7-579C-54A5-9C4F-83A**** |
| Success |
boolean |
リクエストが成功したかどうかを示します。 |
true |
| PagingInfo |
object |
ページネーション情報です。 |
|
| TotalCount |
integer |
エントリの総数です。 |
100 |
| PageNumber |
integer |
ページ番号です。 |
1 |
| PageSize |
integer |
ページサイズです。 |
10 |
| Tables |
array |
テーブルの一覧です。 |
|
| Table |
テーブルの詳細情報です。 |
注記:
Tables 配列に含まれる Table オブジェクトには、以下の詳細プロパティが含まれます。
-
TechnicalMetadata -
BusinessMetadata
例
成功レスポンス
JSONJSON
{
"RequestId": "E25887B7-579C-54A5-9C4F-83A****",
"Success": true,
"PagingInfo": {
"TotalCount": 100,
"PageNumber": 1,
"PageSize": 10,
"Tables": [
{
"Id": "maxcompute-table:123456XXX::test_project::test_tbl\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\nhms-table:c-abc123xxx::test_db::test_tbl\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl",
"Name": "test_tbl",
"Comment": "测试表",
"TableType": "TABLE",
"PartitionKeys": [
"ds"
],
"ParentMetaEntityId": "maxcompute-schema:123456XXX::test_project_with_schema:default\nmaxcompute-project:123456XXX::test_project_without_schema\ndlf-database:123456XXX:test_catalog:test_db\nhms-database:c-abc123xxx::test_db\nholo-schema:h-abc123xxx::test_db:test_schema",
"CreateTime": 1736852168000,
"ModifyTime": 1736852168000,
"TechnicalMetadata": {
"Owner": "test_user",
"Location": "oss://test-bucket/test_tbl",
"Compressed": false,
"InputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
"OutputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
"SerializationLibrary": "org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe",
"Parameters": {
"key": "{\\\"k1\\\":\\\"v1\\\"}"
}
},
"BusinessMetadata": {
"Readme": "## 使用说明",
"Tags": [
{
"Key": "tag_key",
"Value": "tag_value"
}
],
"Categories": [
[
{
"Id": "CATEGORY.456",
"Name": "测试类目",
"ParentId": "CATEGORY.123"
}
]
],
"UpstreamTasks": [
{
"Id": 123456,
"Name": "test_task"
}
],
"Extension": {
"ProjectId": 234,
"EnvType": "Dev",
"ViewCount": 0,
"ReadCount": 0,
"FavorCount": 0
}
}
}
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。