ModifyInstanceSSL - 修改TLS(SSL)配置

为云数据库 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:ModifyInstanceSSLupdate
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
  • kvstore:SSLEnabled

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

r-bp1zxszhcgatnx****
SSLEnabledstring

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

  • Disable:关闭。
  • Enable:开启。
  • Update:更新证书。
Enable

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

实例 ID。

r-bp1zxszhcgatnx****
TaskIdstring

任务 ID。

32184****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidParameters.FormatSpecified parameters is not valid.参数无效
403IncorrectCharacterTypeCurrent DB instance CharacterType does not support this operation.-
403IncorrectEngineVersionCurrent engine version does not support operations.当前Redis版本不支持此操作。请查阅该操作的相关文档,了解该操作对于Redis版本的要求。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.由于实例的状态不允许该操作,实例状态是运行中才能操作
403IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.当前的实例锁定模式不支持此操作。
404EnabledSSLNotSupportSpecified region does not support enable ssl.-

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

变更历史

变更时间变更内容概要操作
暂无变更历史