开启/关闭SSL
功能介绍
开启/关闭SSL。该接口目前仅针对Redis 6.0/7.0基础版的单机、主备和Cluster集群实例。
URI
PUT /v2/{project_id}/instances/{instance_id}/ssl
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID,获取方法请参见获取项目ID。 |
instance_id | 是 | String | 实例ID。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
enabled | 是 | Boolean | 开启或关闭SSL。true:开启/false:关闭 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
job_id | String | DCS任务ID。 |
instance_id | String | 实例ID。 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
error_code | String | 参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg | String | 参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
状态码:500
参数 | 参数类型 | 描述 |
|---|---|---|
error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
error_code | String | 参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg | String | 参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
请求示例
PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/ssl
{
"enabled" : true
} 响应示例
状态码:200
开启/关闭SSL成功。
{
"job_id" : "ff8080817fe01bb2017fe3cf68860481",
"instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79"
} 状态码:400
非法请求。
{
"error_code" : "DCS.4201",
"error_msg" : "Do not support SSL."
} 状态码:500
内部服务错误。
{
"error_code" : "DCS.5010",
"error_msg" : "Failed to operate SSL in database."
} 状态码
状态码 | 描述 |
|---|---|
200 | 开启/关闭SSL成功。 |
400 | 非法请求。 |
500 | 内部服务错误。 |
错误码
请参见错误码。

