ModifyDBClusterSSL - 设置集群SSL

更新时间:
复制 MD 格式

开通或关闭PolarDB集群的SSL加密功能,或更新PolarDB集群的CA证书。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

DBClusterId

string

集群 ID。

pc-************

SSLEnabled

string

修改 SSL 状态,取值:

  • Disable:关闭 SSL 加密。

  • Enable:开启 SSL 加密。

  • Update:更新 CA 证书。

说明

开启 SSL 加密或更新 CA 证书后,需要下载和配置证书,详情请参见设置 SSL 加密

Enable

DBEndpointId

string

连接地址 ID。

说明
  • 若目标集群为 PolarDB MySQL 版,该参数必填。

  • 若目标集群为 PolarDB PostgreSQL 版或 PolarDB PostgreSQL 版(兼容 Oracle),无需传入该参数,默认所有地址开启 SSL 加密。

  • 可以通过 DescribeDBClusterSSL 接口查看连接地址详情。

pe-******************

NetType

string

连接地址的网络类型,需要与 DBEndpointId 参数传入的连接地址的网络类型保持一致,取值:

  • Public:公网

  • Private:私网

  • Inner:私网(经典网络)

说明
  • 若目标集群为 PolarDB MySQL 版,该参数必填。

  • 若目标集群为 PolarDB PostgreSQL 版或 PolarDB PostgreSQL 版(兼容 Oracle),无需传入该参数,默认所有地址开启 SSL 加密。

Public

SSLAutoRotate

string

是否开启 SSL 证书自动轮转,取值:

  • Enable:开启

  • Disable:关闭

Enable

CertValidDays

string

1095

PfsInstanceId

string

pfs-xxx

ConnectionString

string

xxx

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

A94B1755-6D8B-4E27-BF3C-8562BC******

示例

正常返回示例

JSON格式

{
  "RequestId": "A94B1755-6D8B-4E27-BF3C-8562BC******"
}

错误码

HTTP status code

错误码

错误信息

描述

400 EngineMigration.ActionDisabled Specified action is disabled while custins is in engine migration. custins处于引擎迁移中时,指定的操作被禁用
400 InvalidDBEndpointId.Malformed The specified parameter DBEndpointId is not valid. 指定的参数DBEndpointId无效
400 InvalidSSLAutoRotate.Malformed The specified SSLAutoRotate is not valid. 指定的参数SSLAutoRotate无效。
400 InvalidNetType.Malformed The specified parameter NetType is not valid. 指定的参数NetType无效。
400 InvalidConnectionString.Malformed The specified parameter ConnectionString is not valid. 指定的参数ConnectionString无效。
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。
404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的参数DBClusterId无效

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

变更历史

更多信息,参考变更详情