调用ModifyDBInstanceSSL接口修改实例SSL链路。

该接口用于为实例设置SSL(Secure Sockets Layer)加密。

说明
  • 支持如下版本实例:
    • RDS MySQL非基础版实例
    • RDS SQL Server所有版本实例
    • RDS PostgreSQL云盘版本实例
  • 读写分离地址不支持SSL加密。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyDBInstanceSSL

系统规定参数。取值:ModifyDBInstanceSSL

DBInstanceId String rm-uf6wjk5xxxxxxx

实例ID。

ConnectionString String rm-uf6wjk5xxxxx.mysql.rds.aliyuncs.com

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

SSLEnabled Integer 1

开启或关闭SSL,取值:

  • 1:开启
  • 0:关闭
CAType String aliyun

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

取值:

  • aliyun:使用云证书
  • custom:使用自定义证书
ServerCert String -----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----

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

ServerKey String -----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----

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

ClientCAEnabled Integer 1

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

  • 1:启用
  • 0:关闭
ClientCACert String -----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----

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

ClientCrlEnabled Integer 1

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

  • 1:启用
  • 0:关闭
ClientCertRevocationList String -----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----

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

ACL String cert

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

  • cert
  • perfer
  • verify-ca
  • verify-full(RDS PostgreSQL 12以上支持)
ReplicationACL String cert

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

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

返回数据

名称 类型 示例值 描述
RequestId String 777C4593-8053-427B-99E2-105593277CAB

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=ModifyDBInstanceSSL
&ConnectionString=rm-uf6wjk5xxxxx.mysql.rds.aliyuncs.com
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RequestId>777C4593-8053-427B-99E2-105593277CAB</RequestId>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidServerCertOrPrivateKey Specify server certificate or private key is invalid. 指定服务器证书或私钥无效。
400 InvalidClientCACert Specify client ca certificate is invalid. 指定客户端权威机构证书无效。
400 InvalidClientCrl Specify client certificate revocation list is invalid. 指定客户端证书吊销列表无效。
400 InvalidCAType.NotFound Specify ca type is not found. 指定服务器证书类型无效。
400 InvalidACL.NotFound Specify acl is not found. 指定访问控制类型无效。
400 InvalidSSLStatus Specify ssl status is invalid. 操作失败,指定SSL状态无效。
403 InvalidClientCrl.Permission Client ca certificate is set first if need to set client certificate revocation list. 操作失败,无相关权限。请先设置客户端CA证书授权。
403 InvalidACL.Permission Client ca certificate is set first if need to set acl. 操作失败,请先设置客户端CA证书授权。

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