该接口用于修改RDS实例的SSL链路配置。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:ModifyDBInstanceSSL | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 实例 ID。可调用 DescribeDBInstances 获取。 | rm-uf6wjk5**** |
ConnectionString | string | 是 | 需要创建或更新服务器证书的内网或外网连接地址。 | rm-uf6wjk5****.mysql.rds.aliyuncs.com |
SSLEnabled | integer | 否 | 开启或关闭 SSL,取值:
| 1 |
CAType | string | 否 | 该参数仅 RDS PostgreSQL 云盘版支持,表示证书类型,SSLEnabled 取值为 1 时,此参数默认取值为 aliyun。 取值:
| aliyun |
ServerCert | string | 否 | 该参数仅 RDS PostgreSQL 云盘版支持,表示服务器证书内容,CAType 取值为 custom 时,此参数必须配置。 | -----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE----- |
ServerKey | string | 否 | 该参数仅 RDS PostgreSQL 云盘版支持,表示服务器证书私钥,CAType 取值为 custom 时,此参数必须配置。 | -----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY----- |
ClientCAEnabled | integer | 否 | 该参数仅 RDS PostgreSQL 云盘版支持,表示是否启用客户端授权机构公钥,取值:
| 1 |
ClientCACert | string | 否 | 该参数仅 RDS PostgreSQL 云盘版支持,表示客户端证书授权机构公钥,ClientCAEbabled 取值为 1 时,此参数必需配置。 | -----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE----- |
ClientCrlEnabled | integer | 否 | 该参数仅 RDS PostgreSQL 云盘版支持,表示是否启用客户端吊销证书,仅当客户端证书授权机构公钥启用时才允许配置,取值:
| 1 |
ClientCertRevocationList | string | 否 | 该参数仅 RDS PostgreSQL 云盘版支持,表示客户端吊销证书文件,ClientCrlEnabled 取值为 1 时,此参数必须配置。 | -----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL----- |
ACL | string | 否 | 该参数仅 RDS PostgreSQL 云盘版支持,表示认证方法,仅当客户端证书授权机构公钥启用时才允许设置,取值:
| cert |
ReplicationACL | string | 否 | 该参数仅 RDS PostgreSQL 云盘版支持,表示 replication 权限的认证方法,仅当客户端证书授权机构公钥启用时才允许设置,取值:
| cert |
ForceEncryption | string | 否 | 该参数仅 RDS SQL Server 实例支持,表示实例是否开启强制 SSL 加密。更多详情,请参见设置 SSL 加密。取值:
| 1 |
TlsVersion | string | 否 | 该参数仅 RDS SQL Server 实例支持,表示为实例指定最低 LTS 版本号,当前支持 1.0、1.1、1.2。更多详情,请参见设置 SSL 加密。 | 1.1 |
Certificate | string | 否 | 用户自定义证书,自定义证书为
| oss-cn-beijing-internal.aliyuncs.com:zhttest:test.pfx |
PassWord | string | 否 | 证书密码。 | zht123456 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "777C4593-8053-427B-99E2-105593277CAB"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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状态无效。 |
400 | IncorrectDBSslStatus | Specified DB SSLStatus does not support this operation. | 指定的DB SSLStatus不支持此操作。 |
400 | InvalidModifyMode.Format | Specified modify mode is not valid. | - |
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. | 调用商品服务返回失败。 |
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证书授权。 |
404 | Endpoint.NotFound | Specified endpoint is not existed. | 目标的endpoint不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2024-02-27 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2023-12-20 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2023-09-08 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2022-06-23 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
|