ManagePrivateRds - 管理私有RDS-云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

调用ManagePrivateRds接口管理存储层私有定制RDS实例。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
drds:ManagePrivateRds	WRITE	instance acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	PolarDB-X 实例所在的地域 ID。说明您可以调用 DescribeDrdsInstances 查看目标账号下所有实例详情，包括地域 ID。	cn-hanzhou
DrdsInstanceId	string	是	PolarDB-X 实例 ID。说明您可以调用 DescribeDrdsInstances 查看目标账号下所有实例详情，包括实例 ID。	drds*************
DBInstanceId	string	是	存储层私有定制 RDS 实例 ID。说明您可以调用 DescribeDrdsRdsInstances 查看所有存储层私有定制 RDS 实例详情，包括实例 ID。	rm-***************
RdsAction	string	是	当前支持对私有定制 RDS 实例执行如下管理操作： DescribeDBInstanceAttribute：查询私有定制 RDS 实例的详细信息。 DescribeAvailableClasses：查询私有定制 RDS 实例可购买规格，包括规格代码和存储空间。 DescribeSQLCollectorPolicy：查询私有定制 RDS 实例的 SQL 洞察（SQL 审计）状态。 ModifySQLCollectorPolicy：开启或关闭私有定制 RDS 实例的 SQL 洞察（SQL 审计）功能。 DescribeParameters：查询私有定制 RDS 实例当前的参数配置。 ModifyParameter：修改私有定制 RDS 实例参数。 DescribeDBInstanceHAConfig：查询私有定制 RDS 实例的高可用模式和数据复制方式。 SwitchDBInstanceHA：切换私有定制 RDS 实例的主备实例。	SwitchDBInstanceHA
Params	string	否	需要转发的私有定制 RDS 接口的请求参数及其值的 JOSN 串，参数的值都是字符串类型，例如`{NodeId:"1797****"}`。各私有定制 RDS 接口的请求参数及取值范围，请参见如下文档中请求参数的部分： DescribeDBInstanceAttribute DescribeAvailableClasses DescribeSQLCollectorPolicy ModifySQLCollectorPolicy DescribeParameters ModifyParameter DescribeDBInstanceHAConfig SwitchDBInstanceHA 说明针对上述各接口的必选请求参数，`Action`和`DBInstanceId`参数值无需传入，其他必选请求参数必须传入。	{NodeId:"1797****"}

返回参数

名称	类型	描述	示例值
	object
Data	string	转发私有定制 RDS 接口返回的参数结果集。	{"requestId":"E63C810A-4A13-47B6-BA67-C0E23A******"}
RequestId	string	请求 ID。	0237BCD2-2C7A-4F86-A766-657AF6******
Success	boolean	请求是否成功。	true

示例

正常返回示例

JSON格式

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

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
500	RDSAPI.ERROR	Failed to call the RDS API operation.	调用RDS接口失败

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史