調用ManagePrivateRds接口管理存儲層私有定制RDS實例。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 ManagePrivateRds

系統規定參數，取值為ManagePrivateRds。

DBInstanceId String 是 rm-***************

存儲層私有定制RDS實例ID。

說明 您可以調用DescribeDrdsRdsInstances查看所有存儲層私有定制RDS實例詳情，包括實例ID。
DrdsInstanceId String 是 drds*************

PolarDB-X實例ID。

說明 您可以調用DescribeDrdsInstances查看目標賬號下所有實例詳情，包括實例ID。
RdsAction String 是 SwitchDBInstanceHA

當前支持對私有定制RDS實例執行如下管理操作：

  • DescribeDBInstanceAttribute：查詢私有定制RDS實例的詳細信息。
  • DescribeAvailableClasses：查詢私有定制RDS實例可購買規格，包括規格代碼和存儲空間。
  • DescribeSQLCollectorPolicy：查詢私有定制RDS實例的SQL洞察（SQL審計）狀態。
  • ModifySQLCollectorPolicy：開啟或關閉私有定制RDS實例的SQL洞察（SQL審計）功能。
  • DescribeParameters：查詢私有定制RDS實例當前的參數配置。
  • ModifyParameter：修改私有定制RDS實例參數。
  • DescribeDBInstanceHAConfig：查詢私有定制RDS實例的高可用模式和數據復制方式。
  • SwitchDBInstanceHA：切換私有定制RDS實例的主備實例。
RegionId String 是 cn-hanzhou

PolarDB-X實例所在的地域ID。

說明 您可以調用DescribeDrdsInstances查看目標賬號下所有實例詳情，包括地域ID。
Params String 否 {NodeId:"1797****"}

需要轉發的私有定制RDS接口的請求參數及其值的JOSN串，參數的值都是字符串類型，例如{NodeId:"1797****"}。

各私有定制RDS接口的請求參數及取值范圍，請參見如下文檔中請求參數的部分：

說明 針對上述各接口的必選請求參數，Action和DBInstanceId參數值無需傳入，其他必選請求參數必須傳入。

返回數據

名稱 類型 示例值 描述
Data String {"requestId":"E63C810A-4A13-47B6-BA67-C0E23A******"}

轉發私有定制RDS接口返回的參數結果集。
RequestId String 0237BCD2-2C7A-4F86-A766-657AF6******

請求ID。
Success Boolean true

請求是否成功。

示例

請求示例

http(s)://drds.aliyuncs.com/?Action=ManagePrivateRds
&DBInstanceId=rm-***************
&DrdsInstanceId=drds*************
&RdsAction=SwitchDBInstanceHA
&RegionId=cn-hanzhou
&<公共請求參數>

正常返回示例

XML格式 

<RequestId>0237BCD2-2C7A-4F86-A766-657AF6******</RequestId>
<Data>{"requestId":"E63C810A-4A13-47B6-BA67-C0E23A******"}</Data>
<Success>true</Success>

JSON格式 

{
    "RequestId": "0237BCD2-2C7A-4F86-A766-657AF6******",
    "Data": "{\"requestId\":\"E63C810A-4A13-47B6-BA67-C0E23A******\"}",
    "Success": true
}

錯誤碼

HttpCode 錯誤碼 錯誤信息 描述
500 RDSAPI.ERROR Failed to call the RDS API operation. 調用RDS接口失敗

訪問錯誤中心查看更多錯誤碼。