All Products
Search

This Product

    ApsaraDB RDS:ModifyDBInstanceConfig

    Document Center

    ApsaraDB RDS:ModifyDBInstanceConfig

    Last Updated:Jun 12, 2026

    Operasi ini digunakan untuk memodifikasi item konfigurasi dari sebuah instance RDS.

    Deskripsi operasi

    Engine yang didukung

    • RDS PostgreSQL

    • RDS SQL Server

    Catatan

    Item konfigurasi yang saat ini didukung adalah fitur PgBouncer RDS PostgreSQL, fitur enkripsi cloud disk RDS PostgreSQL, fitur enkripsi cloud disk RDS SQL Server, dan fitur pembersihan log kesalahan RDS SQL Server.

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

    none

    *DBInstance

    acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    DBInstanceId

    string

    Yes

    ID instance. Anda dapat memanggil DescribeDBInstances untuk mendapatkannya.

    pgm-2ze****
    ConfigName

    string

    Yes

    Nama item konfigurasi yang akan dimodifikasi. Digunakan bersama dengan ConfigValue.

    Item konfigurasi RDS PostgreSQL

    • pgbouncer: Memodifikasi fitur PgBouncer.

    • encryptionKey: Memodifikasi fitur enkripsi cloud disk.

    • duckdb_create_databases: Mengonfigurasi secara batch database instance utama sebagai database penyimpanan kolumnar DuckDB.

    • duckdb_prepare_dependency: Mengonfigurasi instance utama dengan sekali klik agar parameter dan versi kernel minor-nya memenuhi prasyarat untuk membuat instance analitik DuckDB. Jika instance utama memiliki instance read-only yang sudah dibuat, instance read-only tersebut akan dimodifikasi secara sinkron.

    • enable_db_visible_by_connect_rls: Mengaktifkan CONNECT RLS pada instance untuk mengontrol visibilitas database.

    • set_db_visible_by_connect_rls: Mengaktifkan CONNECT RLS pada database untuk mengontrol visibilitas database. Ini hanya dapat dipanggil setelah CONNECT RLS diaktifkan pada instance.

    Item konfigurasi RDS SQL Server

    • clear_errorlog: Membersihkan log kesalahan.

    • encryptionKey: Memodifikasi fitur enkripsi cloud disk. Instance Serverless dan instance dengan spesifikasi shared tidak mendukung pengaktifan fitur ini.

    pgbouncer
    ConfigValue

    string

    Yes

    Nilai dari item konfigurasi yang akan dimodifikasi. Digunakan bersama dengan ConfigName.

    Nilai item konfigurasi RDS PostgreSQL

    • Fitur PgBouncer: true (aktifkan), false (nonaktifkan).

    • Fitur enkripsi cloud disk:

      • ServiceKey: Menggunakan kunci yang dihasilkan secara otomatis oleh Alibaba Cloud, yaitu menggunakan kunci layanan yang dikelola oleh RDS (Default Service CMK) untuk mengaktifkan enkripsi cloud disk.

      • : Menggunakan kunci kustom untuk mengaktifkan enkripsi cloud disk, atau mengganti kunci saat ini. Contoh, 494c98ce-f2b5-48ab-96ab-36c986b6****.

      • disabled: Menonaktifkan enkripsi cloud disk.

    • Perbaikan sekali klik untuk prasyarat yang diperlukan dalam membuat instance analitik DuckDB: duckdb_prepare_dependency

    • Atur database instance utama secara batch sebagai database penyimpanan kolumnar DuckDB. String JSON, contoh {"dbNames": "db1,db2,db3", "accountName": "yourSuperAccountName"}, dengan:

      • dbNames: Nama database yang akan dikonversi menjadi database penyimpanan kolumnar DuckDB. Beberapa database dipisahkan dengan koma (,).

      • accountName: Akun dengan hak akses tinggi (privileged account). Hanya satu akun privileged yang perlu dikonfigurasi.

    • Aktifkan CONNECT RLS pada instance untuk mengontrol visibilitas database: true untuk mengaktifkan.

    • Aktifkan CONNECT RLS pada database untuk mengontrol visibilitas database: Nama database yang dikontrol oleh CONNECT RLS. Beberapa database dipisahkan dengan koma (,), misalnya testdb1,testdb2. Klien yang terhubung ke database dengan CONNECT RLS yang diaktifkan akan menampilkan daftar database dengan benar berdasarkan apakah mereka memiliki izin CONNECT pada database lain.

    Nilai item konfigurasi RDS SQL Server

    • Fitur pembersihan log kesalahan: 1 (konfirmasi pembersihan).

    • Fitur enkripsi cloud disk (fitur ini tidak dapat dinonaktifkan setelah diaktifkan):

      • serviceKey: Menggunakan kunci yang dihasilkan secara otomatis oleh Alibaba Cloud, yaitu menggunakan kunci layanan yang dikelola oleh RDS (Default Service CMK) untuk mengaktifkan enkripsi cloud disk.

      • : Menggunakan kunci kustom untuk mengaktifkan enkripsi cloud disk, atau mengganti kunci saat ini. Contoh, 494c98ce-f2b5-48ab-96ab-36c986b6****.

    true
    ResourceGroupId

    string

    No

    ID grup sumber daya. Anda dapat memanggil DescribeDBInstanceAttribute untuk mendapatkannya.

    rg-bp67acfmxazb4p****
    ClientToken

    string

    No

    Token klien yang digunakan untuk memastikan idempotensi permintaan dan mencegah pengiriman duplikat. Nilai ini dihasilkan oleh klien dan harus unik di antara permintaan yang berbeda. Panjang maksimum adalah 64 karakter ASCII, dan nilai tidak boleh mengandung karakter non-ASCII.

    6000170000591aed949d0f****
    SwitchTime

    string

    No

    Waktu ketika modifikasi dilakukan. Kami merekomendasikan agar Anda melakukan perubahan pada jam non-puncak bisnis. Format: yyyy-MM-ddTHH:mm:ssZ (waktu UTC).

    2025-05-06T09:24:00Z
    SwitchTimeMode

    string

    No

    Waktu peralihan. Nilai yang valid:

    • Immediate: Berlaku segera.

    • MaintainTime: Berlaku selama jendela pemeliharaan (maintenance window). Anda dapat memanggil operasi ModifyDBInstanceMaintainTime untuk memodifikasi jendela pemeliharaan.

    Immediate

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Detail parameter respons.

    RequestId

    string

    ID permintaan.

    76364A52-E0AB-5CC8-9818-CF1DC482C092

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "76364A52-E0AB-5CC8-9818-CF1DC482C092"
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 %s DB Operation Failed:%s.
    400 InvalidDBInstanceName.NotFound The specified DB instance name does not exist.
    400 MinorVersionNotSupport The current database minor version does not support the operation.
    400 InvalidConfigName The ConfigName is not valid.
    400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently.
    400 Price.PricingPlanResultNotFound Pricing plan price result not found.
    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 InvalidInstanceLevel.DiskType Specified instance level not support request disk type
    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 InvalidSourceCategory specified source category is invalid.
    400 InvalidParameter Invalid parameter.
    400 InvalidConfigValue The ConfigValue is not valid.
    400 InvalidParameters.Format Specified parameters is not valid.
    400 DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance Current instance is already attached to another duckdb instance, operation is conflict.
    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 IncorrectDBInstanceType Current DB instance type does not support this operation.
    403 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation.
    403 IncorrectDBInstanceState Current DB instance state does not support this operation.
    403 CloudDiskEncryptionNotSupport The encryption key is not allowed for general-purpose instance.
    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 UnsupportedByBlueGreenDeployment Operation prohibited due to blue green deployment.
    403 EncryptionKeyNotSupport The encryption key is not support to generate encryption disk.
    403 IncorrectDBState The current DB state does not support this operation.
    403 UnsupportedReadOrBakReadState Current DB instance has read or bak read running in unsupport states
    403 IncorrectAccountPrivilegeType the current account privilege type does not support this operation.
    403 DBInstanceStatusNotActive The status of the current instance is not active.
    403 ReadOnlyInstanceNotSupport Read-only instance does not support this operation.
    403 Invalid.Parameter Specified parameters is not valid.
    403 TargetMajorVesionNotSupported The specified major version is not supported.
    403 ReadInstanceNotSupport Instances with read-only do not support this operation.
    403 IncorrectDBInstance The current DB instance does not support this operation.
    404 InvalidDBInstance.NotFound Specified instance does not exist or not support.
    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.
    404 InvalidAccountName.NotFound The specified account is not found.
    404 InvalidReadDBInstance.NotFound The specified read only database instance does not exist.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.