全部产品
Search

搜索本产品

    云原生数据库 PolarDB：ModifyDBClusterSSL - 设置集群SSL

    文档中心

    云原生数据库 PolarDB：ModifyDBClusterSSL - 设置集群SSL

    更新时间：Jun 17, 2024

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    DBClusterIdstring是

    集群 ID。

    		pc-************
    SSLEnabledstring否

    修改 SSL 状态，取值：

    • Disable：关闭 SSL 加密。
    • Enable：开启 SSL 加密。
    • Update：更新 CA 证书。
    说明 开启 SSL 加密或更新 CA 证书后，需要下载和配置证书，详情请参见设置 SSL 加密。
    		Enable
    DBEndpointIdstring否

    连接地址 ID。

    说明
  • 若目标集群为 PolarDB MySQL 版，该参数必填。
  • 若目标集群为 PolarDB PostgreSQL 版或 PolarDB PostgreSQL 版（兼容 Oracle），无需传入该参数，默认所有地址开启 SSL 加密。
  • 可以通过 DescribeDBClusterSSL 接口查看连接地址详情。
    •
    		pe-******************
    NetTypestring否

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

    • Public：公网
    • Private：私网
    • Inner：私网（经典网络）
    说明
  • 若目标集群为 PolarDB MySQL 版，该参数必填。
  • 若目标集群为 PolarDB PostgreSQL 版或 PolarDB PostgreSQL 版（兼容 Oracle），无需传入该参数，默认所有地址开启 SSL 加密。
    •
    		Public
    SSLAutoRotatestring否

    是否开启 SSL 证书自动轮转，取值：

    • Enable：开启

    • Disable：关闭

    		Enable

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

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

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400EngineMigration.ActionDisabledSpecified action is disabled while custins is in engine migration.当custins处于引擎迁移中时，指定的操作被禁用
    400InvalidDBEndpointId.MalformedThe specified parameter DBEndpointId is not valid.指定的参数DBEndpointId无效
    400InvalidSSLAutoRotate.MalformedThe specified SSLAutoRotate is not valid.指定的参数SSLAutoRotate无效。
    400InvalidNetType.MalformedThe specified parameter NetType is not valid.指定的参数NetType无效。
    400InvalidConnectionString.MalformedThe specified parameter ConnectionString is not valid.指定的参数ConnectionString无效。
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。
    404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效

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

    变更历史

    变更时间变更内容概要操作
    2023-09-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      错误码 400 变更
      错误码 404 变更
    2023-04-24OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：404
      新增错误码：400