调用ModifyDBClusterSSL接口开通、关闭PolarDB集群的SSL加密或更新PolarDB集群的CA证书。

调试

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

请求参数

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

系统规定参数。取值:ModifyDBClusterSSL

DBClusterId String pc-************

集群ID。

SSLEnabled String Enable

修改SSL状态,取值:

  • Disable:关闭SSL加密。
  • Enable:开启SSL加密。
  • Update:更新CA证书。
说明 开启SSL加密或更新CA证书后,需要下载和配置证书,详情请参见设置SSL加密
DBEndpointId String pe-******************

连接地址ID。

说明
  • 若目标集群为PolarDB MySQL版,该参数必填。
  • 若目标集群为PolarDB PostgreSQL版或PolarDB PostgreSQL版(兼容Oracle),无需传入该参数,默认所有地址开启SSL加密。
  • 可以通过DescribeDBClusterSSL接口查看连接地址详情。
NetType String Public

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

  • Public:公网
  • Private:私网
  • Inner:私网(经典网络)
说明
  • 若目标集群为PolarDB MySQL版,该参数必填。
  • 若目标集群为PolarDB PostgreSQL版或PolarDB PostgreSQL版(兼容Oracle),无需传入该参数,默认所有地址开启SSL加密。
SSLAutoRotate String Enable

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

  • Enable:开启
  • Disable:关闭

返回数据

名称 类型 示例值 描述
RequestId String A94B1755-6D8B-4E27-BF3C-8562BC******

请求ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=ModifyDBClusterSSL
&DBClusterId=pc-************
&SSLEnabled=Enable
&<公共请求参数>

正常返回示例

XML格式

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

<ModifyDBClusterSSLResponse>
<RequestId>A94B1755-6D8B-4E27-BF3C-8562BC******</RequestId>
</ModifyDBClusterSSLResponse>

JSON格式

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

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

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。

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