ModifyInstanceSSL - 修改TLS(SSL)配置

更新时间:
复制为 MD 格式

为云数据库 Tair(兼容 Redis)实例开启TLS(Transport Layer Security)加密协议配置。

接口说明

该 API 对应的控制台操作请参见设置 SSL 加密

说明

如需指定 SSL 最低版本,您可以调用 ModifyInstanceConfig 接口通过修改参数来实现。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

kvstore:ModifyInstanceSSL

update

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

  • kvstore:SSLEnabled

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

r-bp1zxszhcgatnx****

SSLEnabled

string

修改 TLS(SSL)设置,取值:

  • Disable:关闭。

  • Enable:开启。

  • Update:更新证书。

Enable

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

AD7E16AA-6B23-43BF-979C-07D957FB****

InstanceId

string

实例 ID。

r-bp1zxszhcgatnx****

TaskId

string

任务 ID。

32184****

示例

正常返回示例

JSON格式

{
  "RequestId": "AD7E16AA-6B23-43BF-979C-07D957FB****",
  "InstanceId": "r-bp1zxszhcgatnx****",
  "TaskId": "32184****"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameters.Format Specified parameters is not valid. 参数无效。
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.

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

变更历史

更多信息,参考变更详情