All Products
Search
Document Center

Data Management:GetDatabase

Last Updated:Mar 21, 2026

Mengambil detail database yang ditentukan.

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

Tid

integer

No

ID penyewa. Anda dapat memanggil API GetUserActiveTenant untuk mendapatkan ID ini.

-1

Host

string

Yes

Titik akhir database.

192.168.XX.XX

Port

integer

Yes

Port koneksi database.

3306

Sid

string

No

SID database.

Catatan

SID database adalah pengidentifikasi unik untuk database Oracle.

test_sid

SchemaName

string

Yes

Nama database.

mysql

RealLoginUserUid

string

No

None.

Elemen respons

Element

Type

Description

Example

object

RequestId

string

ID permintaan.

3CDB8601-AD74-4A47-8114-08E08CD6****

Database

object

Detail database.

DatabaseId

string

ID database.

984****

Host

string

Titik akhir database.

192.168.XX.XX

CatalogName

string

Nama katalog database.

def

DbaName

string

Nama panggilan DBA.

dba_name

State

string

Status database. Nilai yang valid:

  • NORMAL: Database sedang berjalan.

  • DISABLED: Database dinonaktifkan.

  • OFFLINE: Database offline.

  • NOT_EXIST: Database tidak ada.

NORMAL

DbaId

string

ID pengguna DBA.

27****

SchemaName

string

Nama skema.

mysql

InstanceId

string

ID instans.

149****

Port

integer

Port yang digunakan untuk menghubungkan ke database.

3306

EnvType

string

Jenis lingkungan database. Nilai yang valid:

  • product: produksi

  • dev: pengembangan

  • pre: pra-rilis

  • test: pengujian

  • sit: pengujian integrasi sistem (SIT)

  • uat: pengujian penerimaan pengguna (UAT)

  • pet: pengujian kinerja

  • stag: staging

product

Sid

string

SID database.

Catatan

Parameter ini hanya dikembalikan untuk database Oracle.

test_sid

OwnerIdList

object

ID pemilik database.

OwnerIds

array

Daftar ID pengguna pemilik database.

string

ID pengguna dari salah satu pemilik database.

27****

Encoding

string

Set karakter.

utf8mb4

DbType

string

Jenis mesin database. Untuk informasi selengkapnya, lihat deskripsi parameter DbType.

mysql

OwnerNameList

object

Nama panggilan pemilik database.

OwnerNames

array

Daftar nama panggilan Pemilik Database.

string

Nama panggilan dari salah satu pemilik database.

test

SearchName

string

Nama yang digunakan untuk mencari database.

mysql@192.168.XX.XX:3306

InstanceAlias

string

Alias instans.

test

ErrorCode

string

Kode kesalahan.

UnknownError

ErrorMessage

string

Pesan kesalahan.

An unknown error occurred.

Success

boolean

Menunjukkan apakah permintaan berhasil. Nilai yang valid:

  • true: Permintaan berhasil.

  • false: Permintaan gagal.

true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "3CDB8601-AD74-4A47-8114-08E08CD6****",
  "Database": {
    "DatabaseId": "984****",
    "Host": "192.168.XX.XX",
    "CatalogName": "def",
    "DbaName": "dba_name",
    "State": "NORMAL",
    "DbaId": "27****",
    "SchemaName": "mysql",
    "InstanceId": "149****",
    "Port": 3306,
    "EnvType": "product",
    "Sid": "test_sid",
    "OwnerIdList": {
      "OwnerIds": [
        "27****"
      ]
    },
    "Encoding": "utf8mb4",
    "DbType": "mysql",
    "OwnerNameList": {
      "OwnerNames": [
        "test"
      ]
    },
    "SearchName": "mysql@192.168.XX.XX:3306",
    "InstanceAlias": "test"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "An unknown error occurred.",
  "Success": true
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.