All Products
Search

This Product

    ApsaraDB RDS:CreateReadOnlyDBInstance

    Document Center

    ApsaraDB RDS:CreateReadOnlyDBInstance

    Last Updated:Jun 12, 2026

    Membuat instans read-only untuk instans RDS.

    Deskripsi operasi

    Mesin database yang didukung

    • RDS MySQL

    • RDS PostgreSQL

    • RDS SQL Server

    Referensi

    Penting Sebelum memanggil operasi ini, baca dokumentasi berikut dengan saksama. Pastikan Anda sepenuhnya memahami prasyarat dan dampak operasi ini sebelum melaksanakannya.

    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

    rds:CreateReadOnlyDBInstance

    create

    *DBInstance

    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		 None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    ClientToken

    string

    No

    Token klien yang digunakan untuk memastikan idempotensi permintaan. Klien menghasilkan nilai parameter ini. Nilai harus unik di antara permintaan yang berbeda, tidak boleh melebihi 64 karakter, dan hanya dapat berisi karakter ASCII.

    ETnLKlblzczshOTUbOC****
    RegionId

    string

    Yes

    ID wilayah. Wilayah instans read-only harus sama dengan wilayah instans utama. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.

    cn-hangzhou
    ZoneId

    string

    Yes

    ID zona. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar zona terbaru.

    • Jika Anda menerapkan instans di zona tunggal, tentukan satu zona, misalnya, cn-hangzhou-b.

    • Jika Anda menerapkan instans di beberapa zona, tentukan beberapa zona yang dipisahkan oleh titik dua (:), misalnya, cn-hangzhou-b:cn-hangzhou-c.

    • Jumlah zona yang Anda tentukan harus kurang dari atau sama dengan jumlah node pada instans read-only yang sedang dibuat. Instans read-only Edisi Dasar hanya berisi 1 node, dan instans read-only Edisi Ketersediaan Tinggi berisi 2 node (1 node utama dan 1 node sekunder).

    cn-hangzhou-b
    DBInstanceId

    string

    Yes

    ID instans utama. Anda dapat memanggil operasi DescribeDBInstances untuk mengkueri ID instans utama.

    rm-uf6wjk5****
    DBInstanceClass

    string

    Yes

    Tipe instans. Untuk informasi selengkapnya, lihat Tipe instans read-only. Kami menyarankan agar tipe instans read-only tidak lebih rendah dari tipe instans utama. Jika tidak, instans read-only rentan terhadap latensi tinggi dan beban tinggi.

    mysqlro.n2.small.1c
    DBInstanceStorage

    integer

    Yes

    Kapasitas penyimpanan. Kapasitas penyimpanan instans read-only harus lebih besar dari atau sama dengan instans utama. Nilai valid: lihat kolom Kapasitas penyimpanan di Tipe instans read-only. Kapasitas bertambah dalam kelipatan 5 GB. Unit: GB.

    20
    EngineVersion

    string

    Yes

    Versi mesin database. Versi harus sama dengan instans utama.

    • Nilai valid untuk MySQL: 5.6, 5.7, dan 8.0.

    • Nilai valid untuk SQL Server: 2017_ent, 2019_ent, 2022_ent.

    • Nilai valid untuk PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0.

    5.6
    PayType

    string

    Yes

    Metode penagihan. Nilai valid:

    • Postpaid: bayar sesuai pemakaian

    • Prepaid: langganan.

    Postpaid
    DBInstanceDescription

    string

    No

    Deskripsi instans. Deskripsi harus memiliki panjang 2 hingga 256 karakter. Harus diawali dengan huruf (Cina atau Inggris) dan dapat berisi angka, karakter Cina, huruf Inggris, garis bawah (_), dan tanda hubung (-).

    Catatan

    Tidak dapat diawali dengan http:// atau https://.

    testReadOnly
    InstanceNetworkType

    string

    No

    Jenis jaringan instans read-only. Nilai valid:

    • VPC: virtual private cloud (VPC)

    • Classic: jaringan klasik

    Secara default, instans VPC dibuat. Anda harus menentukan VPCId dan VSwitchId.

    Catatan

    Jenis jaringan instans read-only dapat berbeda dari instans utama.

    Classic
    VPCId

    string

    No

    ID VPC instans read-only. Anda harus menentukan parameter ini ketika InstanceNetworkType kosong atau diatur ke VPC.

    Catatan

    • Jika tipe penyimpanan instans utama adalah SSD lokal, instans read-only dapat menggunakan VPC apa pun.

    • Jika tipe penyimpanan instans utama adalah cloud disk, VPC instans read-only harus sama dengan instans utama.

    vpc-uf6f7l4fg90****
    VSwitchId

    string

    No

    ID vSwitch instans read-only. Anda harus menentukan parameter ini ketika InstanceNetworkType kosong atau diatur ke VPC.

    vsw-uf6adz52c2p****
    PrivateIpAddress

    string

    No

    Alamat IP internal instans read-only. Alamat IP harus berada dalam rentang alamat IP vSwitch yang ditentukan. Secara default, sistem secara otomatis menetapkan alamat IP berdasarkan VPCId dan VSwitchId.

    172.16.XX.XX
    ResourceGroupId

    string

    No

    ID kelompok sumber daya.

    rg-acfmy****
    Category

    string

    No

    Edisi RDS instans. Nilai valid:

    • Basic: Edisi Dasar

    • HighAvailability: Edisi Ketersediaan Tinggi (default)

    • AlwaysOn: Edisi Kluster

    Catatan

    Instans read-only dari instans cloud disk PostgreSQL harus berupa Edisi Dasar. Oleh karena itu, Anda harus menentukan Basic.

    HighAvailability
    DBInstanceStorageType

    string

    No

    Tipe penyimpanan instans. Nilai valid:

    • local_ssd: SSD lokal

    • cloud_ssd: SSD standar

    • cloud_essd: ESSD PL1

    • cloud_essd2: ESSD PL2

    • cloud_essd3: ESSD PL3

    • general_essd: ESSD umum

    Catatan

    • Jika instans RDS MySQL utama menggunakan SSD lokal, hanya local_ssd yang didukung. Jika instans RDS MySQL utama menggunakan cloud disk, hanya tipe penyimpanan cloud disk yang didukung.

    • SQL Server hanya mendukung tipe penyimpanan cloud disk.

    local_ssd
    DedicatedHostGroupId

    string

    No

    ID klaster khusus. Tentukan parameter ini saat Anda membuat instans read-only di klaster khusus.

    dhg-4n****
    TargetDedicatedHostIdForMaster

    string

    No

    ID host instans utama. Tentukan parameter ini saat Anda membuat instans read-only di klaster khusus.

    i-bp****
    GdnInstanceName

    string

    No

    Parameter yang dicadangkan. Anda tidak perlu menentukan parameter ini.

    test
    TddlBizType

    string

    No

    Parameter yang dicadangkan. Anda tidak perlu menentukan parameter ini.

    test
    TddlRegionConfig

    string

    No

    Parameter yang dicadangkan. Anda tidak perlu menentukan parameter ini.

    test
    InstructionSetArch

    string

    No

    Parameter yang dicadangkan. Anda tidak perlu menentukan parameter ini.

    test
    UsedTime

    string

    No

    Durasi langganan. Nilai valid:

    • Jika Period diatur ke Year, UsedTime berkisar dari 1 hingga 5.

    • Jika Period diatur ke Month, UsedTime berkisar dari 1 hingga 9.

    Catatan

    Parameter ini wajib diisi jika PayType diatur ke Prepaid.

    1
    Period

    string

    No

    Tipe langganan untuk Instansi langganan. Nilai valid:

    • Year: langganan tahunan

    • Month: langganan bulanan

    Month
    AutoRenew

    string

    No

    Apakah akan mengaktifkan perpanjangan otomatis untuk instans. Parameter ini hanya didukung saat Anda membuat Instansi langganan. Nilai valid:

    • true: ya

    • false: tidak

    Catatan

    • Jika Anda membeli instans secara bulanan, periode perpanjangan otomatis adalah 1 bulan.

    • Jika Anda membeli instans secara tahunan, periode perpanjangan otomatis adalah 1 tahun.

    true
    DeletionProtection

    boolean

    No

    Apakah akan mengaktifkan fitur perlindungan rilis untuk instans RDS. Nilai valid:

    • true: mengaktifkan fitur

    • false: menonaktifkan fitur (default)

    Catatan

    Perlindungan rilis hanya dapat diaktifkan ketika metode penagihan adalah bayar sesuai pemakaian.

    true
    Port

    string

    No

    Menentukan port awal saat Anda membuat instans read-only untuk instans utama RDS MySQL.

    Nilai valid: 1000 hingga 65534.

    3306
    BurstingEnabled

    boolean

    No

    Parameter yang tidak digunakan lagi. Anda tidak perlu menentukan parameter ini.

    false
    IsAnalyticReadOnlyIns

    boolean

    No

    Apakah akan mengaktifkan fitur I/O burst untuk ESSD umum. Nilai valid:

    • true: mengaktifkan fitur

    • false: menonaktifkan fitur.

    AutoPay

    boolean

    No

    Apakah akan membuat instansi analitik DuckDB. Nilai valid:

    • true: ya

    • false: tidak

    Catatan

    Saat ini, hanya RDS MySQL dan RDS PostgreSQL yang mendukung instansi analitik DuckDB.

    AutoCreateProxy

    boolean

    No

    Apakah akan mengaktifkan pembayaran otomatis. Nilai valid:

    • true: mengaktifkan pembayaran otomatis. Pastikan saldo akun Anda mencukupi.

    • false: hanya menghasilkan pesanan tanpa pembayaran.

    Catatan

    Nilai default adalah true. Jika saldo metode pembayaran Anda tidak mencukupi, Anda dapat mengatur parameter AutoPay ke false. Dalam hal ini, pesanan yang belum dibayar akan dihasilkan. Anda dapat masuk ke konsol RDS untuk membayar pesanan secara manual. .

    false
    IoAccelerationEnabled

    string

    No

    Apakah akan membuat proxy secara otomatis. Nilai valid:

    • true: mengaktifkan pembuatan otomatis. Proxy tujuan umum dibuat secara default.

    • false: tidak mengaktifkan pembuatan otomatis.

    0
    AutoUseCoupon

    boolean

    No

    Apakah akan mengaktifkan fitur Buffer Pool Extension (BPE) untuk ESSD umum. Nilai valid:

    • 1: mengaktifkan fitur

    • 0: menonaktifkan fitur.

    true
    PromotionCode

    string

    No

    Apakah akan menggunakan voucher. Nilai valid:

    • true: menggunakan voucher.

    • false (default): tidak menggunakan voucher.

    71744626****
    CustomExtraInfo

    string

    No

    Kode voucher.

    None
    CustomExtraInfo

    string

    No

    Parameter yang dicadangkan. Anda tidak perlu menentukan parameter ini.

    None

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter tanggapan.

    ConnectionString

    string

    Titik akhir internal instans read-only yang dibuat.

    rr-****.mysql.rds.aliyuncs.com
    DBInstanceId

    string

    ID instans read-only yang dibuat.

    rr-uf6wjk5****
    OrderId

    string

    ID pesanan.

    10078937****
    Port

    string

    Port internal instans read-only yang dibuat.

    3306
    RequestId

    string

    ID permintaan.

    1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC

    Contoh

    Respons sukses

    JSONformat

    {
  "ConnectionString": "rr-****.mysql.rds.aliyuncs.com",
  "DBInstanceId": "rr-uf6wjk5****",
  "OrderId": "10078937****",
  "Port": "3306",
  "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC"
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidEngineVersion.Malformed The specified parameter EngineVersion is not valid.
    400 InvalidNetworkTypeClassicWhenCloudStorage The Specified InstanceNetworkType value Classic is not valid when choose cloud storage type.
    400 InvalidSecurityIPList.Malformed The specified parameter SecurityIPList is not valid.
    400 InvalidSecurityIPList.Duplicate The Security IP address is not in the available range or occupied.
    400 InvalidParameter The specified parameter dbInstanceId is not valid.
    400 OperationDenied VPC IP is in use, please check.
    400 InvalidZoneId.NotSupported The Specified vpc Zone not supported.
    400 InvalidAvZone.NotSupport Specified availableArea multiZone does not support in RDS.
    400 CDDC.AvailableHostsNotEnoughInZone Not enough available hosts are in the target zone.
    400 InvalidReadEngineVersionPattern The engine versions of the primary instance and the read-only instance do not match.
    400 InvalidDBInstanceClass.Offline The specified instance type is no longer provided. Please specify another instance type.
    400 SYSTEM.CONCURRENT_OPERATE Concurrent operation is detected.
    400 Price.PricingPlanResultNotFound Pricing plan price result not found.
    400 InvalidDBInstanceName.Duplicate Specified DB instance name already exists in the Aliyun RDS.
    400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type
    400 InvalidRequestId The request is copy, check your token.
    400 InvalidParam.InstanceNetworkType Creation of classic network instances is not supported.
    400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently.
    400 Order.NoRealNameAuthentication You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
    400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase.
    400 CommodityServiceCalling.Exception Failed to call commodity service.
    400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
    400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again.
    400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
    400 Price.CommoditySys Commodity system call exception.
    400 Pay.InsufficientBalance Insufficient available balance.
    400 Order.PeriodInvalid There is a problem with the period you selected, please choose again.
    400 pay.noCreditCard Account not bound to credit card.
    400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
    400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method.
    400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation.
    400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details.
    400 Api.NotSupport Specified api is not supported.
    400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance.
    400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records.
    400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
    400 KmsApiError User secret key invalid.
    400 System.SaleValidateFailed Sales expression validation system error.
    400 Abs.InvalidAccount.NotFound account is not found.
    400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s.
    400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled.
    400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled.
    400 IncorrectTargetClasscode The current instance type does not support this operation.
    400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS.
    400 RequiredParam.NotFound Required input param is not found.
    400 Parameters.Invalid Parameter error, please check the parameters.
    400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
    400 InvalideStatus.Format The instance status does not support this operation.
    400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid.
    400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation.
    400 Pay.NoCreditCard No credit cards.
    400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation.
    400 MirrorInsExists Specified DB instance mirror ins already existed.
    400 UnsupportedClassCode The specified DB instance class stops selling.
    400 InvalidBackupSet The specified database does not exist in the backup set.
    400 OrdTCommodityQueryError Failed to query for product.
    400 ProductInstanceReleased The instance has been released. Please check before placing the order.
    400 RegionEndTimeDissolvedIndia The region is no longer supported.
    400 InvalidVSwitchId.Format The specified vswitch Id format is incorrect.
    400 InvalidParameterValue.NotStandard Invalid parameter format.
    400 AtLeastThreeVSwitchAvailableIp The primary vswitch requires at least three available IP addresses.
    400 AtLeastTwoVSwitchAvailableIp The primary vswitch requires at least two available IP addresses.
    400 DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance Current instance is already attached to another duckdb instance, operation is conflict.
    500 CannotDecreaseEssdPerfLevel cannot decrease cloud essd performance level.
    500 InvalidEssdStorageSize invalid cloud essd storage size.
    500 ExternalFailure The request processing has failed due to external service failure.
    500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel.
    500 InvokeProxyFailure The request processing has failed due to service failure of rds api.
    403 OperationDenied.PrimaryDBInstanceStatus The operation is not permitted due to status of primary instance.
    403 InvalidReadStorageTypePattern The storage type of the primary instance and the read-only instance do not match.
    403 IncorrectCharacterType Current DB instance character type does not support this operation.
    403 InvalidMultiparamZoneInfoList Zoneinfo list is invaild.
    403 OrderStatus.UnPaid The specified db instance has unpaid order.
    403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount.
    403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd.
    403 InvalidUserOperatorPermission The user permission does not support this operation.
    403 InvalidVswitchId Specified conn vswitch id is not valid.
    403 IncorrectMinorVersion Current engine minor version does not support operations.
    403 OperationDenied.ZoneResource There is no available zone for inventory.
    403 NotInFlowController Sorry,no permission.
    403 InvalidKmsKey Kms key is disabled.
    403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation.
    403 BasicCategoryNotSupport The Basic category is not supported.
    404 IncorrectDBInstanceConnType Current DB instance conn type does not support this operation.
    404 InvalidDBInstance.NotFound The specified instance does not exist or is not supported.
    404 InvalidClusterKms The current instance does not authorized to access the Key Management Service.
    404 Request.NotFound The requested resource is not available.
    404 HostInfo.NotFound The specified host info is not found.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.