该接口用于在目标数据库下安装指定插件。
接口说明
适用引擎
RDS PostgreSQL
相关功能文档
注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。
管理插件
注意事项
只能安装实例大版本支持的插件,否则会安装失败。
- 插件支持情况请参见支持插件列表。
- 您可以调用DescribeDBInstanceAttribute查询实例大版本。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI
Explorer可以自动生成SDK代码示例。
调试调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:CreatePostgresExtensions | Write |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 |
用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 |
ETnLKlblzczshOTUbOCz**** |
DBInstanceId | string | 是 |
实例ID。可调用DescribeDBInstances获取。 |
pgm-gc7f1**** |
Extensions | string | 否 |
需要安装的插件,多个插件间使用英文逗号(,)分隔。 |
citext,pg_profile |
DBNames | string | 是 |
实例数据库名。可调用DescribeDatabases获取。 |
test_db |
AccountName | string | 是 |
插件所属的用户,仅支持高权限账号。 |
test_user |
SourceDatabase | string | 否 |
需要同步插件至目标数据库的源端数据库。如果不填写请求参数Extensions,该参数必须填写。 |
source_db |
ResourceGroupId | string | 否 |
资源组ID。 |
rg-acfmy**** |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object |
返回参数详情。 |
||
RequestId | string |
请求ID。 |
7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC |
示例
正常返回示例
JSON
格式
{
"RequestId": "7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidDBName.Format | Specified DB name is not valid. | 无效的数据库名称。请重新命名,数据库名称由小写字母,数字、下划线组成,字母开头,字母或数字结尾,最长16个字符。 |
400 | InvalidParameters.Format | Specified parameters is not valid. | 无效的参数。 |
400 | InvalidAccountName.NotFound | Specified account name does not exist. | 当前账户名不存在,请确认或选择正确的账户名。 |
403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 操作失败,该实例状态下不支持此操作。 |
403 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | 操作失败,实例处于锁定状态。 |
403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
403 | IncorrectAccountPrivilegeType | Current account privilege type does not support this operation. | – |
403 | IncorrectMinorVersion | Current engine minor version does not support operations. | 当前引擎小版本不支持此操作。 |
404 | InvalidDBInstance.NotFound | Specified instance does not exist or not support. | 指定的实例不存在指定的实例被删除或者实例不支持当前操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-12-07 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
|
||||||||||||||
2023-07-26 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
|
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/156593.html