该接口用于配置RDS实例数据库代理连接地址的访问策略。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:ModifyDBProxyEndpoint | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 实例 ID。可调用 DescribeDBInstances 获取。 | rm-bp145737x5bi6**** |
DBProxyEndpointId | string | 否 | 代理连接地址 ID。可以通过接口 DescribeDBProxyEndpoint 查看。 说明
| gos787jog2wk0y**** |
ConfigDBProxyFeatures | string | 否 | 设置代理连接地址想要开通的代理功能,各功能之间以英文分号(;)隔开。格式: 功能取值:
开通情况取值:
说明
RDS PostgreSQL 仅支持设置 ReadWriteSpliting。
| ReadWriteSpliting:1;ConnectionPersist:0 |
RegionId | string | 否 | 地域 ID。可调用 DescribeRegions 获取。 | cn-hangzhou |
ReadOnlyInstanceMaxDelayTime | string | 否 | 读写分离中只读实例的最大延迟阈值,当只读实例延迟时间超过该值时,读取流量不发往该实例,单位:秒。不传该参数则保持原值。取值:0~3600。默认值:30。 说明
开通读写分离时才需要传入该参数。
| 30 |
ReadOnlyInstanceDistributionType | string | 否 | 读权重分配模式。取值:
说明
开通读写分离时才需要传入该参数。权限分配模式的详细信息,MySQL 请参见读权重分配,PostgreSQL 请参见开通并配置数据库代理服务。
| Standard |
ReadOnlyInstanceWeight | string | 否 | 自定义读权重分配,即传入主实例和只读实例的读请求权重。以 100 递增,最大值为 10000,格式:
| {"rm-uf6wjk5****":"500","rr-tfhfgk5xxx":"200"...} |
DbEndpointOperator | string | 否 | 操作类型,取值:
| Modify |
DbEndpointAliases | string | 否 | 代理终端的备注信息。 | test-proxy |
DbEndpointType | string | 否 | 代理终端的类型,保留参数,无需设置。 | RWSplit |
DbEndpointReadWriteMode | string | 否 | 读写类型,取值:
说明
| ReadWrite |
DBProxyEngineType | string | 否 | 废弃参数,无需配置。 | normal |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "6B50D92C-1960-4D4F-A290-AFADD6B1A5C8"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidVpcInstanceId | The specified VPC instance ID is invalid. | 操作失败,当前VPC instance ID无效。 |
400 | InvalidEndPoint.Format | The specified EndPoint is not valid. | 独享代理连接地址ID(DBProxyEndpointId)未传,查询不存在, 请检查Endpoint参数。 |
400 | InvalidEndpointType.Format | The specified EndpointType is invalid. | 指定的EndpointType无效,请检查参数正确性。 |
400 | IncorrectDBInstanceNetType | The current database instance network type does not support the operation. | 操作失败,数据库实例网络类型不支持此操作。 |
400 | EndpointNum.Error | The number of endpoint is invalid. | 当前终端数量不符合要求,请检查支持的终端数量。 |
400 | EndpointTypeOperation.NotSupport | The endpoint type does not support the operation. | 当前终端类型不支持此操作,请检查代理终端类型。 |
400 | InvalidDBInstanceName | Specified parameter DBInstanceName is not valid. | 指定的实例名称(DBInstanceName)无效,请检查参数值是否为null或空字符串。 |
400 | ClusterEndpoint.StatusNotValid | The cluster endpoint status is invalid. | 集群endpoint 状态无效。 |
400 | MaxscaleNotSupport | Current custins can not support Maxscale. | 带有maxscale的实例不支持此操作。 |
400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | 套餐实例不允许单独操作。 |
400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 定价计划价格结果没有找到。 |
400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | 您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。 |
400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | 您的账户可用额度小于0,请先充值后再尝试购买。 |
400 | CommodityServiceCalling.Exception | Failed to call commodity service. | 调用商品服务返回失败。 |
400 | RegionDissolvedEOM | Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. | 客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。 |
400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | 您购买的模块不合法,请重新购买。 |
400 | RegionEndTimeDissolvedIndia | Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024. | 客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。 |
400 | RegionEndTimeDissolvedAustralia | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. | 客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30 |
400 | Price.CommoditySys | Commodity system call exception. | 商品系统调用异常。 |
400 | Pay.InsufficientBalance | Insufficient available balance. | 可用金不足。 |
400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | 您选购的周期有问题,请重新选购。 |
400 | pay.noCreditCard | Account not bound to credit card. | 账户未绑定信用卡。 |
400 | Order.InstHasUnpaidOrder | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. | 您选购的服务存在未支付订单,请支付或作废后再下单。 |
400 | noAvailablePaymentMethod | No payment method is specified for your account. We recommend that you add a payment method. | 没有为您的帐户指定付款方式。我们建议您添加一种付款方式。 |
400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | 您的基本信息未完善,请在操作前先完善您的基本信息。 |
400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | 您的账户出现异常,详情请联系客服。 |
400 | BasicInfoUncompleted | Your information is incomplete, Complete your information before the operation. | 您的信息不完整,请在操作前填写您的信息。 |
400 | System.SaleValidateFailed | Sales expression validation system error. | 销售表达式校验系统错误。 |
400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | 存在禁止下单的标签,请联系您的分销商处理 |
403 | MaxScaleLevel.NotSupport | The current maxscale ins_num does not support this operation. | 操作失败,当前数据库代理规格不支持此操作。 |
403 | ReadDBInstance.NotFound | The current database instance does not contain any read only instance. | 当前数据库实例没有只读实例。 |
403 | IncorrectKindCode | The current KindCode of the custins does not support the operation. | 操作失败,当前实例所属环境类型不支持,请检查接口支持的实例类型。 |
403 | IncorrectDBInstanceState | The current database instance state does not support the operation. | 操作失败,数据库状态不支持此操作。请查看数据库信息,确保数据库状态为运行中。 |
403 | IncorrectDBInstanceEngine | Current DB Instance engine does not support this operation. | 操作失败,数据库引擎不支持。 |
403 | IncorrectKindCode | Current custins kindCode does not support this operation. | 操作失败,当前实例所属环境类型不支持,请检查接口支持的实例类型。 |
403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 操作失败,该实例状态下不支持此操作。 |
403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | 实例当前存在未支付订单,请支付后重试。 |
404 | EndpointConfig.Invalid | Please check the endpoint config parameter. | 代理终端配置不正确。请检查参数是否正确。 |
404 | Readins.NotFound | The current instance does not contain any read only instance. The operation is not supported. | 操作失败,当前实例不存在只读实例。 |
404 | Endpoint.NotFound | Specified endpoint is not found. | 未找到指定独享代理连接地址的端口。 |
404 | EndpointType.NotFound | The specified endpoint type is not found. | 操作失败,未知的代理终端类型,请检查终端类型。 |
404 | InvalidReadDBInstance.NotFound | The specified read only database instance does not exist. | 只读实例未创建或请求实例参数有误。 |
404 | InvalidParam | The specified Weight is invalid. | 权重无效。 |
404 | Maxscale.NotFound | The related maxscale instance is not found. | 操作失败,未找到关联的maxscale实例。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-12-19 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2022-06-23 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2022-06-08 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
|