Tüm Ürünler
Search

Bu Ürün

    :CreateReadOnlyDBInstance

    Belge Merkezi

    :CreateReadOnlyDBInstance

    Son Güncelleme:Oct 02, 2026

    Bir ApsaraDB RDS örneği için salt okunur örnek oluşturur.

    Operation description

    Desteklenen motorlar

    • RDS MySQL

    • RDS PostgreSQL

    • RDS SQL Server

    İlgili belgeler

    Önemli Bu işlemi çağırmadan önce lütfen aşağıdaki belgeleri dikkatlice okuyun, işlemin ön koşullarını ve etkilerini tam olarak anladığınızdan emin olun ve ardından devam edin.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    rds:CreateReadOnlyDBInstance

    create

    *DBInstance.

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

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ClientToken

    string

    No

    İsteğin idempotent olmasını sağlamak için kullanılan istemci belirteci. Belirteci oluşturmak için istemciyi kullanabilirsiniz, ancak belirtecin farklı istekler arasında benzersiz olduğundan emin olmalısınız. Belirteç yalnızca ASCII karakterleri içerebilir ve uzunluğu 64 karakteri aşamaz.

    ETnLKlblzczshOTUbOC****
    RegionId

    string

    Yes

    Bölge kimliği. Salt okunur örnek, birincil örnekle aynı bölgede bulunmalıdır. Bölge kimliğini sorgulamak için DescribeRegions çağrısı yapabilirsiniz.

    cn-hangzhou
    ZoneId

    string

    Yes

    Bölge kimliği. Bölge kimliğini sorgulamak için DescribeRegions çağrısı yapabilirsiniz.

    • Salt okunur örneği tek bir bölgeye dağıtmak için cn-hangzhou-b gibi tek bir bölge belirtin.

    • Salt okunur örneği birden fazla bölgeye dağıtmak için cn-hangzhou-b:cn-hangzhou-c gibi iki nokta üst üste (:) ile ayrılmış birden fazla bölge belirtin.

    • Belirtilen bölge sayısı, salt okunur örnekteki düğüm sayısından küçük veya ona eşit olmalıdır. Temel Sürüm salt okunur örnek yalnızca bir düğüm içerir. Yüksek kullanılabilirlik serisi salt okunur örnek iki düğüm (bir birincil düğüm ve bir ikincil düğüm) içerir.

    cn-hangzhou-b
    DBInstanceId

    string

    Yes

    Birincil örnek kimliği. Örnek kimliğini sorgulamak için DescribeDBInstances çağrısı yapabilirsiniz.

    rm-uf6wjk5****
    DBInstanceClass

    string

    Yes

    Örnek türü. Daha fazla bilgi için Salt okunur örnek türleri konusuna bakın. Salt okunur örneğin örnek türü, birincil örneğinkine eşit veya ondan daha yüksek olmalıdır. Aksi takdirde, salt okunur örnekte yüksek gecikme ve ağır yükler yaşanabilir.

    mysqlro.n2.small.1c
    DBInstanceStorage

    integer

    Yes

    Örnek depolama kapasitesi. Salt okunur örneğin depolama kapasitesi, birincil örneğinkinden büyük veya ona eşit olmalıdır. Daha fazla bilgi için Salt okunur örnek türleri içindeki Depolama kapasitesi sütununa bakın. Değer 5 GB'lık artışlarla belirlenir. Birim: GB.

    20
    EngineVersion

    string

    Yes

    Veritabanı motoru sürümü. Sürüm, birincil örneğin sürümüyle aynı olmalıdır.

    • MySQL: 5.6, 5.7 ve 8.0.

    • SQL Server: 2017_ent, 2019_ent ve 2022_ent.

    • PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0 ve 15.0.

    5.6
    PayType

    string

    Yes

    Faturalandırma yöntemi. Geçerli değerler:

    • Postpaid: Kullandıkça öde.

    • Prepaid: Abonelik.

    Postpaid
    DBInstanceDescription

    string

    No

    Örnek açıklaması. Açıklama 2 ila 256 karakter uzunluğunda olmalı ve harf, rakam, alt çizgi (_) ve tire (-) içerebilir. Bir harf veya Çince karakterle başlamalıdır.

    Not

    Açıklama http:// veya https:// ile başlayamaz.

    testReadOnly
    InstanceNetworkType

    string

    No

    Salt okunur örneğin ağ türü. Geçerli değerler:

    • VPC: Sanal özel bulut (VPC).

    • Classic: Klasik ağ.

    Varsayılan olarak, VPC'ye bağlı bir örnek oluşturulur. Ayrıca VPCId ve VSwitchId parametrelerini de belirtmelisiniz.

    Not

    Salt okunur örneğin ağ türü, birincil örneğin ağ türünden farklı olabilir.

    Classic
    VPCId

    string

    No

    Salt okunur örneğin VPC kimliği. Bu parametre, InstanceNetworkType boş bırakıldığında veya VPC olarak ayarlandığında gereklidir.

    Not

    • Birincil örneğin depolama türü Premium Yerel SSD'ler ise, salt okunur örnek herhangi bir VPC kullanabilir.

    • Birincil örneğin depolama türü bulut diskleri ise, salt okunur örneğin VPC'si birincil örneğinkiyle aynı olmalıdır.

    vpc-uf6f7l4fg90****
    VSwitchId

    string

    No

    Salt okunur örneğin vSwitch kimliği. Bu parametre, InstanceNetworkType boş bırakıldığında veya VPC olarak ayarlandığında gereklidir.

    vsw-uf6adz52c2p****
    PrivateIpAddress

    string

    No

    Salt okunur örneğin dahili ağ IP adresi ayarları. IP adresı, belirtilen vSwitch'in adres aralığı içinde olmalıdır. Sistem, varsayılan olarak VPCId ve VSwitchId değerlerine göre otomatik şekilde bir dahili ağ IP adresı atar.

    172.16.XX.XX
    ResourceGroupId

    string

    No

    Kaynak grubu kimliği.

    rg-acfmy****
    Category

    string

    No

    Örnek sürümü. Geçerli değerler:

    • Basic: Temel Sürüm.

    • HighAvailability: Yüksek kullanılabilirlik (HA) serisi (varsayılan).

    • AlwaysOn: Küme Sürümü.

    Not

    PostgreSQL bulut diski örneklerinin salt okunur örnekleri Temel Sürümü kullanır. Bu parametreyi Basic olarak ayarlamalısınız.

    HighAvailability
    DBInstanceStorageType

    string

    No

    Örneğin depolama türü. Geçerli değerler:

    • local_ssd: Premium Yerel SSD'ler.

    • cloud_ssd: Standart SSD'ler.

    • cloud_essd: PL1 ESSD'ler.

    • cloud_essd2: PL2 ESSD'ler.

    • cloud_essd3: PL3 ESSD'ler.

    • general_essd: Premium ESSD'ler.

    Not

    • Birincil RDS MySQL örneği Premium Yerel SSD'ler kullanıyorsa, yalnızca local_ssd desteklenir. Birincil RDS MySQL örneği bulut diskleri kullanıyorsa, premium performanslı disk depolama türleri desteklenir.

    • SQL Server, premium performanslı disk depolama türlerini destekler.

    local_ssd
    DedicatedHostGroupId

    string

    No

    Özel küme kimliği. Bu parametre, özel bir kümede salt okunur örnek oluşturduğunuzda gereklidir.

    dhg-4n****
    TargetDedicatedHostIdForMaster

    string

    No

    Birincil örneğin ana makine kimliği. Bu parametre, özel bir kümede salt okunur örnek oluşturduğunuzda gereklidir.

    i-bp****
    GdnInstanceName

    string

    No

    Ayrılmış bir parametre. Bu parametreyi belirtmenize gerek yoktur.

    test
    TddlBizType

    string

    No

    Ayrılmış bir parametre. Bu parametreyi belirtmenize gerek yoktur.

    test
    TddlRegionConfig

    string

    No

    Ayrılmış bir parametre. Bu parametreyi belirtmenize gerek yoktur.

    test
    InstructionSetArch

    string

    No

    Ayrılmış bir parametre. Bu parametreyi belirtmenize gerek yoktur.

    test
    UsedTime

    string

    No

    Abonelik süresi. Geçerli değerler:

    • Period parametresi Year olarak ayarlanırsa, UsedTime için geçerli değerler 1 ile 5 arasındadır.

    • Period parametresi Month olarak ayarlanırsa, UsedTime için geçerli değerler 1 ile 9 arasındadır.

    Not

    Bu parametre, PayType parametresi Prepaid olarak ayarlandığında gereklidir.

    1
    Period

    string

    No

    Abonelik süresinin birimi. Geçerli değerler:

    • Year: Yıl.

    • Month: Ay.

    Month
    AutoRenew

    string

    No

    Otomatik yenilemenin etkinleştirilip etkinleştirilmeyeceğini belirtir. Bu parametre yalnızca abonelik örnekleri için gereklidir. Geçerli değerler:

    • true: Otomatik yenilemeyi etkinleştirir.

    • false: Otomatik yenilemeyi devre dışı bırakır.

    Not

    • Örneği aylık bazda satın alırsanız, otomatik yenileme dönemi bir aydır.

    • Örneği yıllık bazda satın alırsanız, otomatik yenileme dönemi bir yıldır.

    true
    DeletionProtection

    boolean

    No

    Serbest bırakma koruması özelliğinin etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler:

    • true: Özelliği etkinleştirir.

    • false: Özelliği devre dışı bırakır (varsayılan).

    Not

    Bu özellik yalnızca kullandıkça öde faturalandırma yöntemini kullanan örnekler için desteklenir.

    true
    Port

    string

    No

    Bir RDS MySQL birincil örneği için salt okunur örnek oluşturduğunuzda başlatılan bağlantı noktası.

    Geçerli değerler: 1000 ile 65534 arası.

    3306
    BurstingEnabled

    boolean

    No

    Kullanımdan kaldırılmış bir parametre. Bu parametreyi belirtmenize gerek yoktur.

    0
    IsAnalyticReadOnlyIns

    boolean

    No

    Premium ESSD bulut diski için I/O ani artış özelliğinin etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler:

    • true: Özelliği etkinleştirir.

    • false: Özelliği devre dışı bırakır.

    false
    AutoPay

    boolean

    No

    DuckDB analiz örneği oluşturulup oluşturulmayacağını belirtir. Geçerli değerler:

    • true: DuckDB analiz örneği oluşturur.

    • false: DuckDB analiz örneği oluşturmaz.

    Not

    DuckDB analiz örneklerini yalnızca RDS MySQL ve RDS PostgreSQL destekler.

    false
    AutoCreateProxy

    boolean

    No

    Otomatik ödemenin etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler:

    • true: Otomatik ödemeyi etkinleştirir. Hesap bakiyenizin yeterli olduğundan emin olun.

    • false: Hesabınızdan ücret almadan bir sipariş oluşturur.

    Not

    Varsayılan değer: true. Ödeme yönteminizde yetersiz bakiye varsa, AutoPay parametresini false olarak ayarlayın. Bu durumda, ödenmemiş bir sipariş oluşturulur. Ödemeyi tamamlamak için ApsaraDB RDS konsolunda oturum açabilirsiniz.

    false
    IoAccelerationEnabled

    string

    No

    Veritabanı aracısının otomatik olarak oluşturulmasının etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler:

    • true: Otomatik oluşturmayı etkinleştirir. Varsayılan olarak, genel amaçlı bir veritabanı aracısı oluşturulur.

    • false: Otomatik oluşturmayı etkinleştirmez.

    false
    AutoUseCoupon

    boolean

    No

    Premium ESSD bulut diski için Arabellek Havuzu Uzantısı (BPE) özelliğinin etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler:

    • 1: Özelliği etkinleştirir.

    • 0: Özelliği etkinleştirmez.

    0
    PromotionCode

    string

    No

    Kupon kullanılıp kullanılmayacağını belirtir. Geçerli değerler:

    • true: Kupon kullanır.

    • false (varsayılan): Kupon kullanmaz.

    true
    CustomExtraInfo

    string

    No

    Kupon kodu.

    71744626****

    Response elements

    Element

    Type

    Description

    Example

    object

    Yanıt parametreleri.

    ConnectionString

    string

    Salt okunur örneğin dahili veritabanı bağlantı adresi.

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

    string

    Salt okunur örnek kimliği.

    rr-uf6wjk5****
    OrderId

    string

    Sipariş kimliği.

    10078937****
    Port

    string

    Salt okunur örneğin dahili veritabanı bağlantı noktası.

    3306
    RequestId

    string

    İstek kimliği.

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

    Examples

    Success response

    JSON format

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

    Error codes

    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.
    403 GuardDBInstanceNotSupport Guard instance does not support this operation.
    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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.