调用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接口失败

访问错误中心查看更多错误码。