All Products
Search

This Product

    Data Management:RegisterInstance

    Document Center

    Data Management:RegisterInstance

    Last Updated:Jun 11, 2026

    Mendaftarkan instans database baru di Data Management (DMS).

    Deskripsi operasi

    Sebelum memulai: Peran pengguna Anda harus berupa administrator atau DBA. Anda dapat memanggil operasi ListUsers atau GetUser untuk mendapatkan RoleIdList peran pengguna.

    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

    dms:RegisterInstance

    create

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    Tid

    integer

    No

    ID penyewa. Anda dapat memanggil operasi GetUserActiveTenant untuk mendapatkan parameter ini.

    3***
    InstanceType

    string

    Yes

    Jenis database. Untuk informasi lebih lanjut mengenai nilai valid, lihat Deskripsi parameter DbType.

    MySQL
    InstanceSource

    string

    Yes

    Sumber instans database. Nilai valid:

    • PUBLIC_OWN: Instans terkelola yang terhubung melalui Internet

    • RDS: Instans ApsaraDB RDS

    • ECS_OWN: Instans terkelola pada Instance ECS

    • VPC_IDC: Instans terkelola di IDC yang terhubung VPC.

    RDS
    NetworkType

    string

    Yes

    Jenis jaringan. Nilai valid:

    • CLASSIC: jaringan klasik

    • VPC: VPC.

    VPC
    EnvType

    string

    Yes

    Jenis lingkungan. Nilai valid:

    • product: lingkungan produksi

    • dev: lingkungan pengembangan

    • pre: lingkungan staging

    • test: lingkungan pengujian

    • sit: lingkungan SIT

    • uat: lingkungan UAT

    • pet: lingkungan uji stres

    • stag: lingkungan STAG.

    product
    EcsInstanceId

    string

    No

    ID instans dari Instance ECS.

    Catatan

    Jika InstanceSource diatur ke ECS_OWN, parameter ini wajib diisi.

    i-2zei9gs1t7h8l7ac****
    VpcId

    string

    No

    ID VPC.

    Catatan

    Jika InstanceSource diatur ke VPC_IDC, parameter ini wajib diisi.

    vpc-xxxxxxxxxxxxxxxxxxxxx
    EcsRegion

    string

    No

    Wilayah tempat instans berada.

    Catatan

    Jika InstanceSource diatur ke RDS, ECS_OWN, atau VPC_IDC, parameter ini wajib diisi.

    cn-hangzhou
    Host

    string

    Yes

    Alamat host database tujuan.

    172.XX.XXX.254
    Port

    integer

    Yes

    Port akses database tujuan.

    3306
    Sid

    string

    No

    SID database.

    Catatan

    Jika InstanceType diatur ke ORACLE, parameter ini wajib diisi.

    XXX
    DatabaseUser

    string

    Yes

    Akun yang digunakan untuk mengakses database.

    dmstest
    DatabasePassword

    string

    Yes

    Kata sandi yang digunakan untuk mengakses database.

    ******
    InstanceAlias

    string

    Yes

    Alias instans. Alias membantu Anda mengidentifikasi dan menemukan instans dengan cepat.

    测试实例
    DbaUid

    integer

    Yes

    UID pengguna yang mengemban peran DBA untuk instans. Anda dapat memanggil operasi ListUsers atau GetInstance untuk mendapatkan parameter ini.

    22275482072787****
    SafeRule

    string

    Yes

    Set aturan keamanan (GroupName) instans. Anda dapat memanggil operasi ListStandardGroups atau GetInstance untuk mendapatkan parameter ini.

    测试使用
    QueryTimeout

    integer

    Yes

    Periode waktu tunggu kueri. Unit: detik.

    60
    ExportTimeout

    integer

    Yes

    Periode waktu tunggu ekspor. Unit: detik.

    600
    DataLinkName

    string

    No

    Nama datalink untuk kueri lintas database.

    Catatan

    • Jika UseDsql diatur ke 1, parameter ini wajib diisi.

    • Nama TautanDB hanya dapat berisi huruf kecil dan garis bawah (_).

    • Nama TautanDB harus unik secara global dalam penyewa.

    dblink_test
    DdlOnline

    integer

    No

    Apakah akan mengaktifkan fitur prioritas evolusi skema. Nilai valid:

    • 0: dinonaktifkan

    • 1: perubahan tanpa kunci native diutamakan. Jika gagal, DMS akan menjalankan perubahan struktur.

    • 2: evolusi skema tanpa kunci DMS digunakan untuk menjalankan perubahan.

    Catatan

    Jenis database yang didukung: ApsaraDB RDS for MySQL, Mesin DPI PolarDB Basis Data Relasional Cloud-Native for MySQL, ApsaraDB MyBase for MySQL, dan MySQL dari sumber lain.

    2
    UseDsql

    integer

    No

    Apakah akan mengaktifkan kueri lintas instans. Nilai valid:

    • 0: dinonaktifkan

    • 1: diaktifkan

    Catatan

    Jenis database yang didukung: MySQL, SQL Server, PostgreSQL, PolarDB Basis Data Relasional Cloud-Native for PostgreSQL (Kompatibel dengan Oracle), dan Redis.

    1
    SkipTest

    boolean

    No

    Apakah akan melewatkan uji konektivitas untuk instans. Nilai valid:

    • true: Melewatkan uji konektivitas.

    • false: Tidak melewatkan uji konektivitas.

    true
    EnableSellSitd

    string

    No

    • Y: Mengaktifkan perlindungan data sensitif.

    • NULL atau nilai lainnya: Tidak mengaktifkan perlindungan data sensitif.

    Y
    TemplateId

    integer

    No

    ID templat klasifikasi data. Anda dapat memanggil operasi ListClassificationTemplates untuk mendapatkan parameter ini.

    31***
    TemplateType

    string

    No

    Jenis templat kategorisasi data. Anda dapat memanggil operasi ListClassificationTemplates untuk mendapatkan parameter ini.

    INNER
    DbaUidByString

    string

    No

    Pengganti untuk bidang DbaUid. Anda dapat menentukan nilai DbaUid non-numerik seperti akun peran.

    22275482072787****
    ResourceGroup

    string

    No

    Elemen respons

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    ID permintaan.

    F4E2A94B-604F-43FF-93E7-F4EE3DCF412E
    ErrorCode

    string

    Kode kesalahan.

    UnknownError
    ErrorMessage

    string

    Paket kesalahan.

    UnknownError
    Success

    boolean

    Menunjukkan apakah permintaan berhasil. Nilai valid:

    • true: Permintaan berhasil.

    • false: Permintaan gagal.

    true

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "F4E2A94B-604F-43FF-93E7-F4EE3DCF412E",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.