All Products
Search

This Product

    ApsaraDB RDS:CreateReadOnlyDBInstance

    Document Center

    ApsaraDB RDS:CreateReadOnlyDBInstance

    Last Updated:Jun 12, 2026

    Operasi ini digunakan untuk membuat instance read-only untuk instance RDS.

    Deskripsi operasi

    Mesin database yang didukung

    • RDS MySQL

    • RDS PostgreSQL

    • RDS SQL Server

    Dokumentasi fitur terkait

    Penting Sebelum menggunakan operasi ini, baca dengan saksama dokumentasi fitur untuk memastikan Anda memahami sepenuhnya prasyarat penggunaan operasi serta dampak setelah penggunaannya, kemudian baru lakukan operasi.

    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 menjamin idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan nilai tersebut, tetapi Anda harus memastikan bahwa nilai tersebut unik di antara permintaan yang berbeda. Token hanya boleh berisi karakter ASCII dan panjangnya tidak boleh melebihi 64 karakter.

    ETnLKlblzczshOTUbOC****
    RegionId

    string

    Yes

    ID wilayah. Instance read-only harus berada di wilayah yang sama dengan instance 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 ingin men-deploy instance read-only di satu zona, masukkan satu ID zona, misalnya cn-hangzhou-b.

    • Jika Anda ingin men-deploy instance read-only di beberapa zona, masukkan beberapa ID zona yang dipisahkan dengan titik dua (:), misalnya cn-hangzhou-b:cn-hangzhou-c.

    • Jumlah zona harus kurang dari atau sama dengan jumlah node pada instance read-only yang sedang dibuat. Instance read-only Basic Edition hanya berisi 1 node, sedangkan instance read-only High-availability Edition berisi 2 node (1 node utama dan 1 node sekunder).

    cn-hangzhou-b
    DBInstanceId

    string

    Yes

    ID instance utama. Anda dapat memanggil operasi DescribeDBInstances untuk mengkueri ID tersebut.

    rm-uf6wjk5****
    DBInstanceClass

    string

    Yes

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

    mysqlro.n2.small.1c
    DBInstanceStorage

    integer

    Yes

    Kapasitas penyimpanan. Kapasitas penyimpanan instance read-only harus lebih besar atau sama dengan instance utama. Nilai yang valid: lihat kolom Storage capacity di Tipe instance read-only. Nilai harus berupa kelipatan 5. Satuan: GB.

    20
    EngineVersion

    string

    Yes

    Versi mesin database. Harus sama dengan instance utama.

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

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

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

    5.6
    PayType

    string

    Yes

    Metode penagihan. Nilai yang valid:

    • Postpaid: bayar sesuai pemakaian

    • Prepaid: berlangganan

    Postpaid
    DBInstanceDescription

    string

    No

    Deskripsi instance. Panjang deskripsi harus 2 hingga 256 karakter. Harus dimulai dengan huruf atau karakter Tionghoa dan dapat berisi digit, huruf, karakter Tionghoa, garis bawah (_), dan tanda hubung (-).

    Catatan

    Deskripsi tidak boleh dimulai dengan http:// atau https://.

    testReadOnly
    InstanceNetworkType

    string

    No

    Tipe jaringan instance read-only. Nilai yang valid:

    • VPC: virtual private cloud (VPC)

    • Classic: jaringan klasik

    Secara default, sistem membuat instance VPC. Anda harus menentukan VPCId dan VSwitchId.

    Catatan

    Tipe jaringan instance read-only dapat berbeda dari instance utama.

    Classic
    VPCId

    string

    No

    ID VPC instance read-only. Parameter ini wajib ketika InstanceNetworkType dibiarkan kosong atau diatur ke VPC.

    Catatan

    • Jika tipe penyimpanan instance utama adalah SSD lokal, instance read-only dapat di-deploy di VPC mana pun.

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

    vpc-uf6f7l4fg90****
    VSwitchId

    string

    No

    ID vSwitch instance read-only. Parameter ini wajib ketika InstanceNetworkType dibiarkan kosong atau diatur ke VPC.

    vsw-uf6adz52c2p****
    PrivateIpAddress

    string

    No

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

    172.16.XX.XX
    ResourceGroupId

    string

    No

    ID grup sumber daya.

    rg-acfmy****
    Category

    string

    No

    Edisi RDS instance. Nilai yang valid:

    • Basic: Basic Edition

    • HighAvailability: High-availability Edition (default)

    • AlwaysOn: Cluster Edition

    Catatan

    Untuk instance PostgreSQL dengan cloud disk, instance read-only adalah Basic Edition. Oleh karena itu, Anda harus menentukan Basic.

    HighAvailability
    DBInstanceStorageType

    string

    No

    Tipe penyimpanan instance. Nilai yang 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 instance RDS MySQL utama menggunakan SSD lokal, Anda hanya dapat menentukan local_ssd. Jika instance RDS MySQL utama menggunakan cloud disk, Anda hanya dapat menentukan tipe penyimpanan cloud disk.

    • Untuk SQL Server, hanya tipe penyimpanan cloud disk yang didukung.

    local_ssd
    DedicatedHostGroupId

    string

    No

    ID dedicated cluster. Tentukan parameter ini ketika Anda membuat instance read-only dalam dedicated cluster.

    dhg-4n****
    TargetDedicatedHostIdForMaster

    string

    No

    ID host instance utama. Tentukan parameter ini ketika Anda membuat instance read-only dalam dedicated cluster.

    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 berlangganan. Nilai yang valid:

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

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

    Catatan

    Parameter ini wajib ketika PayType diatur ke Prepaid.

    1
    Period

    string

    No

    Satuan durasi berlangganan untuk instance berlangganan. Nilai yang valid:

    • Year

    • Month

    Month
    AutoRenew

    string

    No

    Menentukan apakah akan mengaktifkan perpanjangan otomatis. Parameter ini hanya berlaku ketika Anda membuat instance berlangganan. Nilai yang valid:

    • true

    • false

    Catatan

    • Jika Anda mengatur durasi berlangganan dalam bulan, siklus perpanjangan adalah 1 bulan.

    • Jika Anda mengatur durasi berlangganan dalam tahun, siklus perpanjangan adalah 1 tahun.

    true
    DeletionProtection

    boolean

    No

    Menentukan apakah akan mengaktifkan fitur perlindungan pelepasan untuk RDS. Nilai yang valid:

    • true: aktif

    • false: nonaktif (default)

    Catatan

    Fitur ini hanya dapat diaktifkan ketika metode penagihan adalah bayar sesuai pemakaian.

    true
    Port

    string

    No

    Port dapat diinisialisasi ketika Anda membuat instance read-only untuk instance RDS MySQL utama.

    Nilai yang valid: 1000 hingga 65534.

    3306
    BurstingEnabled

    boolean

    No

    Parameter yang sudah usang. Anda tidak perlu menentukan parameter ini.

    false
    IsAnalyticReadOnlyIns

    boolean

    No

    Menentukan apakah akan mengaktifkan fitur I/O burst untuk ESSD umum. Nilai yang valid:

    • true: aktif

    • false: nonaktif

    AutoPay

    boolean

    No

    Menentukan apakah akan membuat instance analitik DuckDB. Nilai yang valid:

    • true: aktif

    • false: nonaktif

    Catatan

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

    AutoCreateProxy

    boolean

    No

    Menentukan apakah akan mengaktifkan pembayaran otomatis. Nilai yang valid:

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

    • false: hanya menghasilkan pesanan yang belum dibayar tanpa pemotongan.

    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, dan Anda dapat masuk ke konsol RDS untuk membayar pesanan tersebut.

    false
    IoAccelerationEnabled

    string

    No

    Menentukan apakah akan membuat proxy secara otomatis. Nilai yang valid:

    • true: membuat proxy secara otomatis. Secara default, proxy serbaguna akan dibuat.

    • false: tidak membuat proxy secara otomatis.

    0
    AutoUseCoupon

    boolean

    No

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

    • 1: aktif

    • 0: nonaktif

    true
    PromotionCode

    string

    No

    Menentukan apakah akan menggunakan voucher. Nilai yang valid:

    • true: gunakan voucher.

    • false (default): jangan gunakan voucher.

    71744626****
    CustomExtraInfo

    string

    No

    Kode kupon.

    None
    CustomExtraInfo

    string

    No

    Parameter yang dicadangkan. Anda tidak perlu menentukan parameter ini.

    None

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter respons.

    ConnectionString

    string

    Endpoint internal instance read-only yang dibuat.

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

    string

    ID instance read-only yang dibuat.

    rr-uf6wjk5****
    OrderId

    string

    ID pesanan.

    10078937****
    Port

    string

    Port internal instance 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.