調用CreateReadOnlyDBInstance介面為某個執行個體建立一個唯讀執行個體。
- 主執行個體的版本必須為以下其中一種:
- MySQL 5.6
- MySQL 5.7/8.0高可用版(本地SSD盤)
- SQL Server 2017叢集版
- 對於MySQL類型執行個體:
- 如果主執行個體記憶體≥64GB,最多允許建立10個唯讀執行個體。
- 如果主執行個體記憶體<64GB,最多允許建立5個唯讀執行個體。
- 對於SQL Server類型執行個體,最多允許建立7個唯讀執行個體。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateReadOnlyDBInstance |
系統規定參數,取值:CreateReadOnlyDBInstance。 |
RegionId | String | 是 | cn-hangzhou |
地區ID。唯讀執行個體的地區必須和主執行個體相同。可以通過介面DescribeRegions查看地區列表。 |
ZoneId | String | 是 | cn-hangzhou-b |
可用性區域ID。可以通過介面DescribeRegions查看可用性區域列表。 |
DBInstanceId | String | 是 | rm-uf6wjk5xxxxxxx |
主執行個體ID。 |
DBInstanceClass | String | 是 | rds.mys2.small |
執行個體規格,詳見執行個體規格表。建議唯讀執行個體規格不小於主執行個體規格,否則易導致唯讀執行個體延遲高、負載高等現象。 |
DBInstanceStorage | Integer | 是 | 20 |
儲存空間,取值:5-3000,每5GB進行遞增,單位:GB。 说明 不同版本執行個體,支援的取值範圍不同,請以控制台建立唯讀執行個體頁面為準。
|
EngineVersion | String | 是 | 5.6 |
資料庫版本號碼。必須與主執行個體相同。取值:
|
PayType | String | 是 | Postpaid |
付費類型,僅支援隨用隨付,取值:Postpaid。 |
DBInstanceDescription | String | 否 | 測試唯讀執行個體 |
執行個體描述,長度為2~256個字元。以中文、英文字母開頭,可以包含數字、中文、英文、底線(_)、虛線(-)。 说明 不能以 http:// 和 https:// 開頭。
|
ClientToken | String | 否 | ETnLKlblzczshOTUbOCzxxxxxxxxxx |
用於保證請求的等冪性,防止重複提交請求。由用戶端產生該參數值,要保證在不同請求間唯一,最大值不超過64個ASCII字元,且該參數值中不能包含非ASCII字元。 |
InstanceNetworkType | String | 否 | Classic |
執行個體的網路類型,取值:
預設建立傳統網路執行個體。 |
VPCId | String | 否 | vpc-uf6f7l4fg90xxxxxxxxxx |
VPC ID。 |
VSwitchId | String | 否 | vsw-uf6adz52c2pxxxxxxxxxx |
交換器ID。 |
AccessKeyId | String | 否 | LTAIfCxxxxxxxxxx |
阿里雲頒發給使用者的訪問服務所用的密鑰ID。 |
PrivateIpAddress | String | 否 | 172.16.201.69 |
設定唯讀執行個體的內網IP,需要在指定交換器的IP位址範圍內。系統預設通過VPCId和VSwitchId自動分配。 |
ResourceGroupId | String | 否 | rg-acfmyxxxxxxxxxx |
資源群組ID。 |
DBInstanceStorageType | String | 否 | local_ssd |
執行個體儲存類型,取值:
说明 MySQL僅支援本地碟儲存類型,SQL Server僅支援雲端硬碟儲存類型。
|
Category | String | 否 | HighAvailability |
執行個體系列,取值:
|
返回資料
名稱 | 類型 | 樣本值 | 描述 |
---|---|---|---|
DBInstanceId | String | rr-uf6wjk5xxxxxxx |
建立的唯讀執行個體ID。 |
OrderId | String | 10078937xxxxx |
訂單ID。 |
ConnectionString | String | rr-xxxxx.mysql.rds.aliyuncs.com |
建立的唯讀執行個體內網資料庫連接地址。 |
Port | String | 3306 |
建立的唯讀執行個體內網資料庫連接連接埠。 |
RequestId | String | 1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC |
請求ID。 |
樣本
請求樣本
http(s)://rds.aliyuncs.com/?Action=CreateReadOnlyDBInstance
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-b
&DBInstanceId=rm-uf6wjk5xxxxxxx
&DBInstanceClass=rds.mys2.small
&DBInstanceStorage=20
&EngineVersion=5.6
&PayType=Postpaid
&<公用請求參數>
正常返回樣本
XML
格式
<CreateReadOnlyDBInstanceResponse>
<OrderId>10078937xxxxx</OrderId>
<ConnectionString>rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com </ConnectionString>
<DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId>
<port>3306</port>
<RequestId>1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC</RequestId>
</CreateReadOnlyDBInstanceResponse>
JSON
格式
{
"Port":"3306",
"ConnectionString":"rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com",
"RequestId":"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
"DBInstanceId":"rm-uf6wjk5xxxxxxx",
"OrderId":"10078937xxxxx"
}
錯誤碼
HttpCode | 錯誤碼 | 錯誤資訊 | 描述 |
---|---|---|---|
400 | InvalidEngineVersion.Malformed | The specified parameter "EngineVersion" is not valid. | 指定EngineVersion參數無效。 |
400 | InvalidSecurityIPList.Malformed | The specified parameter "SecurityIPList" is not valid. | 指定的SecurityIPList參數無效。 |
400 | InvalidSecurityIPList.Duplicate | The Security IP address is not in the available range or occupied. | 指定的安全IP地址已被佔用或不在有效區間內。 |
400 | InvalidParameter | The specified parameter "dbInstanceId" is not valid. | 指定dbInstanceId參數無效。 |
403 | OperationDenied.PrimaryDBInstanceStatus | The operation is not permitted due to status of primary instance. | 主執行個體狀態不支援,執行個體處於運行態,才能做此操作。 |
400 | OperationDenied | VPC IP is in use, please check. | 該Ip已經被使用,請您更換IP再重試。 |
404 | IncorrectDBInstanceConnType | Current DB instance conn type does not support this operation. | 當前DB執行個體連線類型不支援此操作。 |
400 | InvalidZoneId.NotSupported | The Specified vpc Zone not supported. | 當前可用性區域不支援生產 VPC 執行個體,請您更換可用性區域再試。 |
訪問錯誤中心查看更多錯誤碼。