All Products
Search

This Product

    DataWorks:ListSchemas

    Document Center

    DataWorks:ListSchemas

    Last Updated:Jun 11, 2026

    Melakukan kueri daftar skema di bawah database atau proyek MaxCompute yang ditentukan di Data Map. Saat ini mendukung tipe MaxCompute dan Holo.

    Deskripsi operasi

    1. Anda harus membeli DataWorks Basic Edition atau 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:ListSchemas

    list

    *All Resource

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    ParentMetaEntityId

    string

    Yes

    ID entitas induk. Untuk informasi lebih lanjut, lihat Konsep terkait entitas metadata. Untuk tipe crawler metadata Hologres, Anda dapat memanggil operasi ListDatabases untuk mengkueri pengaturan parameter ParentMetaEntityId.

    Konfigurasi parameter ParentMetaEntityId dalam format ${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}. Jika sebuah level tidak ada, biarkan level tersebut kosong.

    Catatan

    Jika Anda ingin mengkueri informasi tentang skema MaxCompute, tentukan string kosong pada level Instance ID sebagai placeholder dan nama proyek MaxCompute pada level Database name. Pastikan fitur skema diaktifkan untuk proyek MaxCompute.

    maxcompute-project:::project_name
    Name

    string

    No

    Nama. Pencocokan fuzzy didukung.

    abc
    Comment

    string

    No

    Komentar. Pencocokan fuzzy didukung.

    test comment
    Types

    array

    No

    Tipe. Pencocokan tepat didukung. Jika parameter ini dibiarkan kosong, semua tipe akan dikueri.

    string

    No

    Tipe skema.

    MANAGED
    SortBy

    string

    No

    Field yang digunakan untuk pengurutan. Nilai default: CreateTime. Nilai yang valid:

    • CreateTime

    • ModifyTime

    • Name

    • Type

    CreateTime
    Order

    string

    No

    Urutan pengurutan skema. 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

    Jumlah entri per halaman. Nilai default: 10. Nilai maksimum: 100.

    10

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter respons.

    RequestId

    string

    ID permintaan.

    235BBA5E-3428-XXXXXX
    Success

    boolean

    Menunjukkan apakah permintaan berhasil.

    true
    PagingInfo

    object

    Informasi paginasi.

    TotalCount

    integer

    Jumlah total entri.

    1
    PageNumber

    integer

    Nomor halaman.

    1
    PageSize

    integer

    Jumlah entri per halaman.

    10
    Schemas

    array

    Skema.

    Schema

    Skema.

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "235BBA5E-3428-XXXXXX",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Schemas": [
      {
        "Id": "maxcompute-schema:123456XXX::test_project:default\nholo-schema:h-abc123xxx::test_db:test_schema",
        "Name": "test_db",
        "Comment": "test comment",
        "Type": "MANAGED",
        "ParentMetaEntityId": "maxcompute-project:123456XXX::test_project\nholo-database:h-abc123xxx::test_db",
        "CreateTime": 1736852168000,
        "ModifyTime": 1736852168000
      }
    ]
  }
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.