All Products
Search

This Product

    Data Management:AddInstance

    Document Center

    Data Management:AddInstance

    Last Updated:Jun 11, 2026

    Mendaftarkan Instans database di Data Management Service (DMS) dan secara opsional mengaktifkan hosting keamanan untuk Instans tersebut.

    Deskripsi operasi

    Peran sistem Anda harus berupa DBA atau administrator. Untuk melihat peran sistem Anda, lihat Lihat peran sistem saya.

    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:AddInstance

    create

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    Tid

    integer

    No

    ID penyewa.

    Catatan

    Anda dapat menemukan ID penyewa dengan mengarahkan kursor ke ikon profil di sudut kanan atas Konsol DMS.

    23****
    InstanceType

    string

    Yes

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

    MySQL
    InstanceSource

    string

    Yes

    Sumber Instans. Nilai valid:

    • PUBLIC_OWN: Instans terkelola sendiri yang terhubung melalui Internet.

    • RDS: Instans ApsaraDB RDS.

    • ECS_OWN: Instans terkelola sendiri pada Instance ECS.

    • VPC_IDC: Instans terkelola sendiri di Pusat data lokal yang terhubung ke VPC.

    • GATEWAY: Instans Gerbang Basis Data.

    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 pra-rilis

    • test: lingkungan pengujian

    • sit: lingkungan SIT

    • uat: lingkungan UAT

    • pet: lingkungan uji stres

    • stag: lingkungan STAG.

    product
    EcsInstanceId

    string

    No

    ID Instans. Misalnya, jika Instans Anda adalah Instans Gerbang Basis Data, masukkan ID gerbang.

    Catatan

    Parameter ini wajib diisi jika InstanceSource diatur ke ECS_OWN atau GATEWAY.

    i-2zei9gs1t7h8l7ac****
    VpcId

    string

    No

    ID Instans VPC.

    Catatan

    Parameter ini wajib diisi jika InstanceSource diatur ke VPC_IDC.

    vpc-2zef4o1hu7ljd****
    EcsRegion

    string

    No

    Wilayah tempat Instans berada.

    Catatan

    Parameter ini wajib diisi jika InstanceSource diatur ke RDS, ECS_OWN, GATEWAY, atau VPC_IDC.

    cn-hangzhou
    Host

    string

    Yes

    Alamat koneksi database.

    rm-bp1g3tf90******.sqlserver.rds.aliyuncs.com
    Port

    integer

    Yes

    Port koneksi database.

    3306
    Sid

    string

    No

    SID Instans.

    Catatan

    Parameter ini wajib diisi jika InstanceType diatur ke ORACLE.

    testSid
    DatabaseUser

    string

    Yes

    Akun database.

    testsdb
    DatabasePassword

    string

    Yes

    Kata sandi database.

    test***
    InstanceAlias

    string

    Yes

    Alias Instans, yang membantu Anda mengidentifikasi Instans dengan cepat.

    测试实例
    DbaId

    integer

    Yes

    ID pengguna DBA untuk Instans. Anda dapat memanggil operasi ListUsers atau GetInstance untuk mendapatkan nilai ini.

    27****
    QueryTimeout

    integer

    Yes

    Periode pengatur waktu tunggu kueri. Unit: detik.

    7200
    ExportTimeout

    integer

    Yes

    Periode pengatur waktu ekspor. Unit: detik.

    86400
    EnableSellTrust

    string

    Yes

    Apakah akan mengaktifkan hosting keamanan untuk Instans. Nilai valid:

    • Y: Mengaktifkan mode hosting keamanan.

    • N: Tidak mengaktifkan mode hosting keamanan.

    Y
    EnableSellStable

    string

    No

    Apakah akan mengaktifkan fitur perubahan stabil untuk Instans. Nilai valid:

    • Y: Mengaktifkan.

    • N: Tidak mengaktifkan.

    N
    EnableSellCommon

    string

    No

    Apakah akan mengaktifkan fitur kolaborasi keamanan untuk Instans. Nilai valid:

    • Y: Mengaktifkan.

    • N: Tidak mengaktifkan.

    Y
    SafeRule

    string

    No

    Jika Anda ingin mengaktifkan fitur kolaborasi keamanan, tentukan set aturan keamanan (GroupName) untuk Instans. Anda dapat memanggil operasi ListStandardGroups atau GetInstance untuk mendapatkan nilai ini.

    金融线-生产
    EnableSellSitd

    string

    No

    Apakah akan mengaktifkan fitur perlindungan data sensitif untuk Instans. Nilai valid:

    • Y: Mengaktifkan.

    • N: Tidak mengaktifkan.

    Y
    DataLinkName

    string

    No

    Nama tautan data kueri lintas database.

    Catatan

    • Parameter ini wajib diisi jika UseDsql diatur ke 1.

    • 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 prioritas perubahan struktur DMS. Nilai valid:

    • 0: Tidak digunakan.

    • 1: Memprioritaskan DDL Online native.

    • 2: Memprioritaskan perubahan struktur tanpa kunci DMS.

    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 yang dikelola sendiri dari sumber lain.

    2
    UseDsql

    integer

    No

    Apakah akan mengaktifkan kueri lintas Instans. Nilai valid:

    • 0: Menonaktifkan.

    • 1: Mengaktifkan.

    Catatan

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

    1
    SkipTest

    boolean

    No

    Apakah akan melewatkan uji konektivitas untuk Instans. Nilai valid:

    • true: Melewatkan.

    • false: Tidak melewatkan.

    false
    TemplateId

    integer

    No

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

    31***
    TemplateType

    string

    No

    Tipe templat kategorisasi data. Anda dapat memanggil operasi ListClassificationTemplates untuk mendapatkan nilai ini.

    INNER
    UseSsl

    integer

    No

    Apakah akan mengaktifkan koneksi SSL. Setelah SSL diaktifkan, DMS terhubung ke database melalui SSL. Database harus memiliki SSL yang diaktifkan sebelum Anda menggunakan parameter ini. Nilai valid:

    • 0: Nilai default. DMS dan layanan database secara otomatis menegosiasikan apakah akan mengaktifkan SSL. Sistem secara otomatis mendeteksi apakah database target memiliki SSL yang diaktifkan. Jika SSL diaktifkan pada database, DMS terhubung melalui SSL. Jika tidak, DMS terhubung tanpa SSL.

    • 1: Mengaktifkan koneksi SSL. Jika database tidak memiliki SSL yang diaktifkan, parameter ini tidak berlaku.

    • -1: Menonaktifkan koneksi SSL.

    Catatan

    • Item konfigurasi ini hanya tersedia ketika jenis database adalah MySQL atau Redis.

    • SSL (Secure Sockets Layer) mengenkripsi koneksi jaringan di lapisan Transport, yang meningkatkan keamanan dan integritas data komunikasi tetapi meningkatkan pengatur waktu tanggapan koneksi jaringan.

    0
    RoleArn

    string

    No

    Nama Sumber Daya Alibaba Cloud peran yang diotorisasi di akun target, yang digunakan untuk pendaftaran Instans lintas penyewa.

    acs:ram::1760865*********:role/dms-role-arn

    Elemen respons

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    ID permintaan. Anda dapat menggunakan ID ini untuk menemukan log dan memecahkan masalah.

    0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
    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": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.