ringkasan API ListTables untuk pengambilan tabel Data Map - DataWorks - Alibaba Cloud - DataWorks

Mengambil daftar tabel data di Peta Data DataWorks. Untuk tipe yang tidak mendukung level skema, Anda dapat mengambil daftar tabel data dalam database tertentu. Untuk tipe yang mendukung level skema, Anda dapat mengambil daftar tabel data dalam database, proyek MaxCompute, atau skema tertentu. Respons hanya mencakup informasi dasar tabel dan tidak menyertakan metadata teknis maupun metadata bisnis.

Deskripsi operasi

Anda harus berlangganan DataWorks Edisi Dasar atau edisi yang lebih tinggi untuk menggunakan fitur ini.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:ListTables

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ParentMetaEntityId	string	Yes	ID entitas metadata tingkat induk. Anda dapat memperoleh nilai ini dari tanggapan operasi ListDatabases atau ListSchemas. Untuk informasi selengkapnya, lihat Metadata entity concepts. Nilai tersebut dapat berupa database tempat tabel tersebut berada. Format `ParentMetaEntityId` adalah `${EntityType}:${InstanceID or encoded URL}:${DataCatalogIdentifier}:${DatabaseName}`. Gunakan string kosong sebagai pengganti untuk level yang tidak ada. Nilai tersebut juga dapat berupa skema database tempat tabel tersebut berada. Format `ParentMetaEntityId` adalah `${EntityType}:${InstanceID or encoded URL}:${DataCatalogIdentifier}:${DatabaseName}:${SchemaName}`. Gunakan string kosong sebagai pengganti untuk level yang tidak ada. Catatan Anda hanya dapat mengatur `ParentMetaEntityId` ke skema database jika tipe database mendukung skema (`maxcompute/holo/postgresql/sqlserver/hybriddb_for_postgresql/oracle`, dengan model tiga lapisan harus diaktifkan untuk tipe maxcompute). Jika tidak, Anda hanya dapat mengaturnya ke database. Untuk tipe maxcompute dan dlf, gunakan string kosong sebagai pengganti ID instans. Untuk tipe maxcompute, nama database adalah nama proyek MaxCompute. Untuk tipe starrocks, pengenal katalog data adalah nama katalog. Untuk tipe dlf, pengenal katalog data adalah ID katalog. Tipe lain tidak mendukung level katalog, sehingga Anda dapat menggunakan string kosong sebagai pengganti. Contoh berikut menunjukkan format ParentMetaEntityId untuk tipe umum: `maxcompute-project:::project_name` `maxcompute-schema:::project_name:schema_name` (hanya ketika model tiga lapisan diaktifkan untuk proyek tersebut) `dlf-database::catalog_id:database_name` `hms-database:instance_id::database_name` `holo-schema:instance_id::database_name:schema_name` `mysql-database:(instance_id\|encoded_jdbc_url)::database_name` Catatan Keterangan: `instance_id`: ID instans. Nilai ini wajib jika sumber data terdaftar dalam mode instans. `encoded_jdbc_url`: String koneksi JDBC yang telah di-encode URL. Nilai ini wajib jika sumber data terdaftar menggunakan string koneksi. `catalog_id`: ID katalog DLF. `project_name`: Nama proyek MaxCompute. `database_name`: Nama database. `schema_name`: Nama skema.	maxcompute-project:::project_name
Name	string	No	Nama. Mendukung pencocokan fuzzy.	abc
Comment	string	No	Komentar. Mendukung pencocokan fuzzy.	this is a comment
TableTypes	array	No	Daftar tipe tabel yang akan ditanyakan. Jika parameter ini dikosongkan, semua tipe akan ditanyakan.
	string	No	Tipe tabel. Nilai yang valid bervariasi tergantung pada tipe database.	TABLE
SortBy	string	No	Bidang yang digunakan untuk mengurutkan hasil. Nilai default: CreateTime. Nilai yang valid: CreateTime: waktu pembuatan ModifyTime: waktu modifikasi Name: nama TableType: tipe tabel	CreateTime
Order	string	No	Urutan pengurutan. Nilai default: Asc. Nilai yang valid: Asc: urutan menaik Desc: urutan menurun	Asc
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Ukuran halaman. Nilai default: 10. Nilai maksimum: 100.	10
IncludeExtendedProperties	boolean	No	Menentukan apakah properti tambahan akan dikembalikan. Atur parameter ini ke `true` untuk mengembalikan properti tambahan atau `false` untuk tidak mengembalikannya.	true

Elemen respons

Element	Type	Description	Example
	object	Tanggapan.
RequestId	string	ID permintaan.	E25887B7-579C-54A5-9C4F-83A****
Success	boolean	Menunjukkan apakah permintaan berhasil.	true
PagingInfo	object	Hasil paginasi.
TotalCount	integer	Jumlah total entri.	100
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Ukuran halaman.	10
Tables	array	Daftar tabel data.
	Table	Detail tabel data.

Note:

Objek Table yang dikembalikan dalam Tables memiliki struktur yang disederhanakan dan tidak mencakup properti berikut:

TechnicalMetadata
BusinessMetadata

Jika Anda perlu memperoleh metadata teknis atau metadata bisnis suatu tabel, panggil operasi GetTable untuk mengambil objek Table lengkap.

Contoh

Respons sukses

JSONformat

{
  "RequestId": "E25887B7-579C-54A5-9C4F-83A****",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "Tables": [
      {
        "Id": "dlf-table::catalog_id:database_name::table_name",
        "Name": "table_name",
        "Comment": "测试表",
        "TableType": "TABLE",
        "PartitionKeys": [
          "ds"
        ],
        "ParentMetaEntityId": "dlf-database::catalog_id:database_name",
        "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": "value"
          }
        },
        "BusinessMetadata": {
          "Readme": "## 使用说明",
          "CustomAttributes": {
            "key": [
              "张三"
            ]
          },
          "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
          }
        },
        "StatisticsInfos": {
          "key": ""
        }
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.