ModifyDBInstanceSSL--文档数据库 MongoDB 版-火山引擎

文档中心

立即注册

导航

ModifyDBInstanceSSL

最近更新时间：2024.10.17 14:42:41首次发布时间：2022.11.04 10:42:28

调用 ModifyDBInstanceSSL 接口修改目标 MongoDB 实例的 SSL 加密设置，包括开通、关闭加密功能，或更新 SSL 证书有效期。

请求类型

异步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mongo-shard-f9e5d782****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。
SSLAction	String	是	Close	对 SSL 加密功能进行对应操作。取值范围如下： `Open`：开通 SSL 加密功能。 `Close`：关闭 SSL 加密功能。 `Update`：更新 SSL 证书有效期。说明仅当 SSL 加密功能已开通后，才支持更新 SSL 证书有效期操作。您可以调用 DescribeDBInstanceSSL 接口查看实例的 SSL 功能是否已开通。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=ModifyDBInstanceSSL&Version=2022-01-01 HTTP/1.1
Host: mongodb.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "mongo-shard-f9e5d782****",
    "SSLAction": "Close"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202202211539050101742350380678****",
        "Action": "ModifyDBInstanceSSL",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

更多详情，请参见错误码。