全部产品
Search
文档中心

云数据库 RDS:ModifyDBInstanceSSL - 修改RDS实例的SSL配置

更新时间:Jan 23, 2024

该接口用于修改RDS实例的SSL链路配置。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

相关功能文档

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

调试

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

调试

授权信息

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

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

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
ConnectionStringstring

需要创建或更新服务器证书的内网或外网连接地址。

rm-uf6wjk5****.mysql.rds.aliyuncs.com
SSLEnabledinteger

开启或关闭 SSL,取值:

  • 1:开启
  • 0:关闭
1
CATypestring

该参数仅 RDS PostgreSQL 云盘版支持,表示证书类型,SSLEnabled 取值为 1 时,此参数默认取值为 aliyun。 取值:

  • aliyun:使用云证书
  • custom:使用自定义证书
aliyun
ServerCertstring

该参数仅 RDS PostgreSQL 云盘版支持,表示服务器证书内容,CAType 取值为 custom 时,此参数必须配置。

-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----
ServerKeystring

该参数仅 RDS PostgreSQL 云盘版支持,表示服务器证书私钥,CAType 取值为 custom 时,此参数必须配置。

-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----
ClientCAEnabledinteger

该参数仅 RDS PostgreSQL 云盘版支持,表示是否启用客户端授权机构公钥,取值:

  • 1:启用
  • 0:关闭
1
ClientCACertstring

该参数仅 RDS PostgreSQL 云盘版支持,表示客户端证书授权机构公钥,ClientCAEbabled 取值为 1 时,此参数必需配置。

-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----
ClientCrlEnabledinteger

该参数仅 RDS PostgreSQL 云盘版支持,表示是否启用客户端吊销证书,仅当客户端证书授权机构公钥启用时才允许配置,取值:

  • 1:启用
  • 0:关闭
1
ClientCertRevocationListstring

该参数仅 RDS PostgreSQL 云盘版支持,表示客户端吊销证书文件,ClientCrlEnabled 取值为 1 时,此参数必须配置。

-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----
ACLstring

该参数仅 RDS PostgreSQL 云盘版支持,表示认证方法,仅当客户端证书授权机构公钥启用时才允许设置,取值:

  • cert
  • prefer
  • verify-ca
  • verify-full(RDS PostgreSQL 12 以上支持)
cert
ReplicationACLstring

该参数仅 RDS PostgreSQL 云盘版支持,表示 replication 权限的认证方法,仅当客户端证书授权机构公钥启用时才允许设置,取值:

  • cert
  • prefer
  • verify-ca
  • verify-full(RDS PostgreSQL 12 以上支持)
cert
ForceEncryptionstring

该参数仅 RDS SQL Server 实例支持,表示实例是否开启强制 SSL 加密。更多详情,请参见设置 SSL 加密。取值:

  • 1:开启。
  • 0:未开启。
1
TlsVersionstring

该参数仅 RDS SQL Server 实例支持,表示为实例指定最低 LTS 版本号,当前支持 1.0、1.1、1.2。更多详情,请参见设置 SSL 加密

1.1

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

777C4593-8053-427B-99E2-105593277CAB

示例

正常返回示例

JSON格式

{
  "RequestId": "777C4593-8053-427B-99E2-105593277CAB"
}

错误码

HTTP status code错误码错误信息描述
400InvalidServerCertOrPrivateKeySpecify server certificate or private key is invalid.指定服务器证书或私钥无效。
400InvalidClientCACertSpecify client ca certificate is invalid.指定客户端权威机构证书无效。
400InvalidClientCrlSpecify client certificate revocation list is invalid.指定客户端证书吊销列表无效。
400InvalidCAType.NotFoundSpecify ca type is not found.指定服务器证书类型无效。
400InvalidACL.NotFoundSpecify acl is not found.指定访问控制类型无效。
400InvalidSSLStatusSpecify ssl status is invalid.操作失败,指定SSL状态无效。
400IncorrectDBSslStatusSpecified DB SSLStatus does not support this operation.指定的DB SSLStatus不支持此操作。
400InvalidModifyMode.FormatSpecified modify mode is not valid.-
403InvalidClientCrl.PermissionClient ca certificate is set first if need to set client certificate revocation list.操作失败,无相关权限。请先设置客户端CA证书授权。
403InvalidACL.PermissionClient ca certificate is set first if need to set acl.操作失败,请先设置客户端CA证书授权。
404Endpoint.NotFoundSpecified endpoint is not existed.目标的endpoint不存在。

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

变更历史

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