更新时间:2026-04-03 GMT+08:00

修改实例SSL相关配置

功能介绍

修改实例SSL相关配置。

URI

POST /v2/{project_id}/{engine}/instances/{instance_id}/plain-ssl-switch

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

engine

String

参数解释

引擎。

约束限制

不涉及。

取值范围

  • rocketmq:RocketMQ消息引擎。

  • reliability:RocketMQ消息引擎别称。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

tls_mode

String

参数解释

协议模式。

约束限制

不涉及。

取值范围

  • SSL:服务端与客户端之间通过密文传输,安全性较高,性能较低。

  • PLAINTEXT:服务端与客户端之间通过明文传输,安全性较低,性能较高。

  • PERMISSIVE:服务端与客户端之间既能通过明文传输又能通过密文传输,传输方式由客户端决定。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

job_id

String

参数解释

任务ID。

取值范围

不涉及。

tls_mode

String

参数解释

协议模式。

取值范围

  • SSL:服务端与客户端之间通过密文传输,安全性较高,性能较低。

  • PLAINTEXT:服务端与客户端之间通过明文传输,安全性较低,性能较高。

  • PERMISSIVE:服务端与客户端之间既能通过明文传输又能通过密文传输,传输方式由客户端决定。

请求示例

'POST https://{endpoint}/v2/{project_id}/{engine}/instances/{instance_id}/plain-ssl-switch'

{
  "tls_mode" : "ssl"
}

响应示例

状态码:200

修改成功。

{
  "job_id" : "8abfa7b3971f12a20197207ea77161af",
  "tls_mode" : "ssl"
}

状态码

状态码

描述

200

修改成功。

错误码

请参见错误码