全部产品
Search
文档中心

云数据库 RDS:ModifyDbProxyInstanceSsl - 设置数据库代理连接地址SSL加密

更新时间:Jan 16, 2024

该接口用于设置RDS MySQL数据库代理连接地址的SSL加密。

接口说明

适用引擎

RDS MySQL

相关功能文档

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

RDS MySQL 设置数据库代理 SSL 加密

调试

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

调试

授权信息

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

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

请求参数

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

地域 ID。可调用 DescribeRegions 获取。

cn-hangzhou
DbInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

rm-t4n3a****
DbProxyEndpointIdstring

代理连接地址 ID。可以通过接口 DescribeDBProxyEndpoint 查看。

ta9um4****
DbProxyConnectStringstring

需要开启 SSL 加密的地址。

test123456.rwlb.rds.aliyuncs.com
DbProxySslEnabledstring

对 SSL 加密执行的操作,取值:

  • 0:关闭 SSL 加密
  • 1:开启 SSL 加密或修改 SSL 加密地址
  • 2:更新证书有效期
说明 执行以上操作会重启实例,请谨慎操作。
1
DBProxyEngineTypestring

预留参数,无需配置。

normal

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

BF46A62B-3717-4397-9338-36BB95C898B3

示例

正常返回示例

JSON格式

{
  "RequestId": "BF46A62B-3717-4397-9338-36BB95C898B3"
}

错误码

HTTP status code错误码错误信息描述
400MinorVersionNotSupportThe current database minor version does not support the operation.操作失败,当前小版本不支持该操作。
400InvalidDbProxyStatusThe proxy status of the database is abnormal.操作失败,数据库实例的代理状态不正常。
400InvalidDBInstanceNameSpecified parameter DBInstanceName is not valid.指定的实例名称(DBInstanceName)无效,请检查参数值是否为null或空字符串。
400MaxscaleNotSupportCurrent custins can not support Maxscale.带有maxscale的实例不支持此操作。
403RDSCategoryNotSupportThe specified instance category does not support this operation.操作失败,当前实例类别不支持该操作。
403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.操作失败,数据库引擎不支持。
403IncorrectKindCodeCurrent custins kindCode does not support this operation.操作失败,当前实例所属环境类型不支持,请检查接口支持的实例类型。
403IncorrectDBInstanceTypeCurrent DB instance engine and type does not support operations.操作失败,当前数据库实例引擎和类型不支持。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
403ConnectionStringLengthExceededConnection String is too long.连接字符串太长,请修改后重试。
404Endpoint.NotFoundThe specified endpoint is not found.操作失败,指定的端点信息未找到。
404EnabledSSLNotSupportThe backend service does not support SSL.后端服务未支持SSL。
404InvalidDbProxyConnectionString.NotFoundThe specified database proxy connection string is not found.操作失败,未找到指定的数据库代理地址。
404InvalidDBInstanceName.NotFoundThe database instance does not exist.数据库实例名称不存在。请确认数据名称是否正确。
404EndpointType.NotFoundThe specified endpoint type is not found.操作失败,未知的代理终端类型,请检查终端类型。
404EndpointConfig.InvalidPlease check the endpoint config parameter.代理终端配置不正确。请检查参数是否正确。
404InvalidMaxscaleConnectionString.NotFoundThe specified database proxy connection string is not found.操作失败,该数据库代理地址未找到。

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

变更历史

变更时间变更内容概要操作
2023-12-19OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 403 变更
    错误码 404 变更
2022-06-23OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
2022-06-08OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:DBProxyEngineType