调用ModifyDBInstanceSSL接口修改MongoDB实例的SSL配置。

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

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

调试

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

请求参数

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

要执行的操作,取值: ModifyDBInstanceSSL

DBInstanceId String dds-bpxxxxxxxx

实例ID。

SSLAction String Open

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

  • Open:开启SSL加密。
  • Close:关闭SSL加密。
  • Update:更新SSL证书。
RegionId String cn-hangzhou

实例所属的地域ID,您可以通过调用DescribeDBInstanceAttribute进行查询。

返回数据

名称 类型 示例值 描述
RequestId String 6D806B11-078F-4154-BF9F-844F56D08964

请求ID。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=ModifyDBInstanceSSL
&DBInstanceId=dds-bpxxxxxxxx
&SSLAction=Open
&<公共请求参数>

正常返回示例

XML 格式

<ModifyDBInstanceSSLResponse>
	  <RequestId>6D806B11-078F-4154-BF9F-844F56D08964</RequestId>
</ModifyDBInstanceSSLResponse>

JSON 格式

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

错误码

HttpCode 错误码 错误信息 描述
403 IncorrectDBInstanceState Current DB instance state does not support this operation. 实例状态不支持此操作,请您检查输入的参数是否正确。
403 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation. 实例已经被锁定。

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