ModifyDBInstanceSSL - 修改MongoDB实例的SSL链路配置

修改MongoDB实例的SSL配置。

接口说明

调用 ModifyDBInstanceSSL 接口时,实例必须满足以下条件:

  • 实例状态为运行中。

  • 实例类型为副本集或分片集群实例。
    • 副本集实例的版本需为 3.4 及以上版本。

    • 分片集群实例的存储模式需要为 ESSD 云盘版。

说明

在开通、更新和关闭 SSL 过程中,实例会重启一次,建议您在业务低峰期操作。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:ModifyDBInstanceSSL

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称

类型

必填

描述

示例值

DBInstanceId

string

实例 ID。

dds-bp2235****

SSLAction

string

对 SSL 功能执行的操作,取值说明:

  • Open:开启 SSL 加密。

  • Close:关闭 SSL 加密。

  • Update:更新 SSL 证书。

Open

SwitchMode

string

返回参数

名称

类型

描述

示例值

object

返回数据。

RequestId

string

请求 ID。

6D806B11-078F-4154-BF9F-844F56D08964

示例

正常返回示例

JSON格式

{
  "RequestId": "6D806B11-078F-4154-BF9F-844F56D08964"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParam Specified parameters is not valid.
400 SSLAlreadyEnabled SSL have already been enabled.
400 SSLAlreadyDisabled SSL have already been disabled.
403 SSLNotEnabled SSL not enabled.
403 IncorrectCharacterType Current DB instance CharacterType does not support this operation.
403 IncorrectEngineVersion Current engine version does not support operations.
403 IncorrectDBInstanceState Current DB instance state does not support this operation. 当前数据库实例状态不支持此操作。
403 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation. 当前的数据库实例锁定模式不支持此操作。
404 EnabledSSLNotSupport Specified region does not support enable ssl.

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

变更历史

更多信息,参考变更详情