文档

CreatePostgresExtensions - 在目标数据库下安装指定插件

更新时间:

该接口用于在目标数据库下安装指定插件。

接口说明

适用引擎

RDS PostgreSQL

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

管理插件

注意事项

只能安装实例大版本支持的插件,否则会安装失败。

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。

ETnLKlblzczshOTUbOCz****
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

pgm-gc7f1****
Extensionsstring

需要安装的插件,多个插件间使用英文逗号(,)分隔。 如果不填写请求参数 SourceDatabase,该参数必须填写。

citext,pg_profile
DBNamesstring

实例数据库名。可调用 DescribeDatabases 获取。

test_db
AccountNamestring

插件所属的用户,仅支持高权限账号。

test_user
SourceDatabasestring

需要同步插件至目标数据库的源端数据库。如果不填写请求参数 Extensions,该参数必须填写。

source_db
ResourceGroupIdstring

资源组 ID。

rg-acfmy****
RiskConfirmedboolean

过低小版本实例安装某些特定插件存在安全风险,确认风险即可安装。 取值范围:

  • true
  • false
说明 相关风险说明,请参见RDS PostgreSQL 限制创建插件说明
true

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC

示例

正常返回示例

JSON格式

{
  "RequestId": "7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC"
}

错误码

HTTP status code错误码错误信息描述
400InvalidDBName.FormatSpecified DB name is not valid.无效的数据库名称。请重新命名,数据库名称由小写字母,数字、下划线组成,字母开头,字母或数字结尾,最长16个字符。
400InvalidParameters.FormatSpecified parameters is not valid.无效的参数。
400InvalidAccountName.NotFoundSpecified account name does not exist.当前账户名不存在,请确认或选择正确的账户名。
403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.操作失败,该实例状态下不支持此操作。
403IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.操作失败,实例处于锁定状态。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
403IncorrectAccountPrivilegeTypeCurrent account privilege type does not support this operation.-
403IncorrectMinorVersionCurrent engine minor version does not support operations.当前引擎小版本不支持此操作。
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。

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

变更历史

变更时间变更内容概要操作
2023-12-07OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:RiskConfirmed
2023-07-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    删除错误码:400
    删除错误码:404
  • 本页导读 (1)
文档反馈