All Products
Search
Document Center

DataWorks:GetDatabase

Last Updated:Jun 11, 2026

Mengkueri informasi tentang database tertentu di Peta Data.

Deskripsi operasi

  1. DataWorks Basic Edition or a higher edition is required.

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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter

Type

Required

Description

Example

Id

string

Yes

ID entitas basis data. Lihat tanggapan operasi ListDatabases dan Konsep terkait entitas metadata.

Format: ${EntityType}:${ID Instans atau URL yang di-escape}:${Pengenal katalog}:${Nama database}. Gunakan string kosong sebagai placeholder untuk level yang tidak ada.

Catatan

Untuk StarRocks, pengenal katalog adalah nama katalog. Untuk DLF, pengenal katalog adalah ID katalog. Untuk tipe lainnya, hierarki level katalog tidak didukung, dan string kosong dapat digunakan sebagai placeholder.

Contoh format ID umum

  • dlf-database::catalog_id:database_name

  • holo-database:instance_id::database_name

  • mysql-database:(instance_id|encoded_jdbc_url)::database_name

Catatan
  • catalog_id: ID katalog DLF.

  • instance_id: ID instans, yang diperlukan saat sumber data didaftarkan dalam mode instans.

  • encoded_jdbc_url: String koneksi JDBC yang di-encode, yang diperlukan saat sumber data didaftarkan dalam mode string koneksi.

  • database_name: Nama database.

dlf-database::catalog_id:database_name

Elemen respons

Element

Type

Description

Example

object

The response.

RequestId

string

The request ID.

1AFAE64E-D1BE-432B-A9****

Success

boolean

Indicates whether the request was successful.

true

Database Database

The database details.

Contoh

Respons sukses

JSONformat

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true,
  "Database": {
    "Id": "holo-database:h-xxxx::test_db",
    "Name": "test_db",
    "Comment": "test comment",
    "LocationUri": "oss://test-bucket/test_db",
    "ParentMetaEntityId": "holo:h-xxxx",
    "CreateTime": 1736852168000,
    "ModifyTime": 1736852168000
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.