首页 云数据库 MongoDB API参考指南 API目录 SSL加密 ModifyDBInstanceSSL - 修改MongoDB实例的SSL链路配置

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

修改MongoDB实例的SSL配置。

接口说明

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

  • 实例状态为运行中。
  • 实例类型为副本集实例。
  • 实例的数据库版本为3.4、4.0或4.2版本,其中4.2版本仅中国站支持。
说明 在开通、更新和关闭SSL过程中,实例会重启一次,建议您在业务低峰期操作。

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
DBInstanceId string

实例ID。

dds-bp2235****
SSLAction string

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

  • Open:开启SSL加密。
  • Close:关闭SSL加密。
  • Update:更新SSL证书。
Open

返回参数

名称 类型 描述 示例值
object

返回数据。

RequestId string

请求ID。

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

示例

正常返回示例

JSON格式

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

错误码

Http 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. -

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

阿里云首页 云数据库 MongoDB 版 相关技术圈